Struct lexoffice::model::credit_notes::CreditNote

pub struct CreditNote {
    pub id: ReadOnly<Uuid>,
    pub organization_id: ReadOnly<Uuid>,
    pub created_date: ReadOnly<DateTime>,
    pub updated_date: ReadOnly<DateTime>,
    pub version: i64,
    pub language: Option<String>,
    pub archived: ReadOnly<bool>,
    pub voucher_status: ReadOnly<VoucherStatus>,
    pub voucher_number: ReadOnly<String>,
    pub voucher_date: DateTime,
    pub address: Address,
    pub line_items: Vec<LineItems>,
    pub total_price: TotalPrice,
    pub tax_amounts: ReadOnly<Vec<TaxAmounts>>,
    pub tax_conditions: TaxConditions,
    pub title: Option<String>,
    pub introduction: Option<String>,
    pub remark: Option<String>,
    pub files: ReadOnly<Files>,
}

{
    "id": "e9066f04-8cc7-4616-93f8-ac9ecc8479c8",
    "organizationId": "aa93e8a8-2aa3-470b-b914-caad8a255dd8",
    "createdDate": "2019-06-17T18:32:07.480+02:00",
    "updatedDate": "2019-06-17T18:32:07.551+02:00",
    "version": 1,
    "language": "de",
    "archived": false,
    "voucherStatus": "draft",
    "voucherNumber": "GS0007",
    "voucherDate": "2017-02-22T00:00:00.000+01:00",
    "address": {
        "name": "Bike & Ride GmbH & Co. KG",
        "supplement": "Gebäude 10",
        "street": "Musterstraße 42",
        "city": "Freiburg",
        "zip": "79112",
        "countryCode": "DE"
    },
    "lineItems": [
        {
            "type": "custom",
            "name": "Abus Kabelschloss Primo 590 ",
            "description": "· 9,5 mm starkes, smoke-mattes Spiralkabel mit integrierter Halterlösung zur Befestigung am Sattelklemmbolzen · bewährter Qualitäts-Schließzylinder mit praktischem Wendeschlüssel · KabelØ: 9,5 mm, Länge: 150 cm",
            "quantity": 2,
            "unitName": "Stück",
            "unitPrice": {
                "currency": "EUR",
                "netAmount": 13.4,
                "grossAmount": 15.946,
                "taxRatePercentage": 19
            },
            "lineItemAmount": 26.8
        },
        {
            "type": "custom",
            "name": "Energieriegel Testpaket",
            "quantity": 1,
            "unitName": "Stück",
            "unitPrice": {
                "currency": "EUR",
                "netAmount": 5,
                "grossAmount": 5,
                "taxRatePercentage": 0
            },
            "lineItemAmount": 5
        }
    ],
    "totalPrice": {
        "currency": "EUR",
        "totalNetAmount": 31.8,
        "totalGrossAmount": 36.89,
        "totalTaxAmount": 5.09
    },
    "taxAmounts": [
        {
            "taxRatePercentage": 0,
            "taxAmount": 0,
            "netAmount": 5
        },
        {
            "taxRatePercentage": 19,
            "taxAmount": 5.09,
            "netAmount": 26.8
        }
    ],
    "taxConditions": {
        "taxType": "net"
    },
    "title": "Rechnungskorrektur",
    "introduction": "Rechnungskorrektur zur Rechnung RE-00020",
    "remark": "Folgende Lieferungen/Leistungen schreiben wir Ihnen gut.",
    "files": {
      "documentFileId": "a79fea19-a892-4ea9-89ad-e879946329a3"
    }
}

Fields

id: ReadOnly<Uuid>

Unique id generated on creation by lexoffice.
Read-only.

organization_id: ReadOnly<Uuid>

Unique id of the organization the credit note belongs to.
Read-only.

created_date: ReadOnly<DateTime>

The instant of time when the credit note was created by lexoffice in format yyyy-MM-ddTHH:mm:ss.SSSXXX as described in RFC 3339/ISO 8601 (e.g. 2020-02-21T00:00:00.000+01:00).
Read-only.

updated_date: ReadOnly<DateTime>

The instant of time when the credit note was updated by lexoffice in format yyyy-MM-ddTHH:mm:ss.SSSXXX as described in RFC 3339/ISO 8601 (e.g. 2020-02-21T00:00:00.000+01:00).
Read-only.

version: i64

Version (revision) number which will be increased on each change to handle optimistic locking.
Read-only.

language: Option<String>

Specifies the language of the credit note which affects the print document but also set translated default text modules when no values are send (e.g. for introduction). Values accepted in ISO 639-1 code. Possible values are German de (default) and English en.

archived: ReadOnly<bool>

Specifies if the credit note is only available in the archive in lexoffice.
Read-only.

voucher_status: ReadOnly<VoucherStatus>

Specifies the status of the credit note. Possible values are draft (is editable), open (finalized and no longer editable but not yet paid off), paidoff (has been fully paid back to the customer), voided (cancelled)
Read-only.

voucher_number: ReadOnly<String>

The specific number a credit note is aware of. This consecutive number is set by lexoffice on creation.
Read-only.

voucher_date: DateTime

The date of credit note in format yyyy-MM-ddTHH:mm:ss.SSSXXX as described in RFC 3339/ISO 8601 (e.g. 2020-02-21T00:00:00.000+01:00).

address: Address

The address of the credit note recipient. For details see below.

line_items: Vec<LineItems>

The items of the credit note. For details see below.

total_price: TotalPrice

The total price of the credit note. For details see below.

tax_amounts: ReadOnly<Vec<TaxAmounts>>

The tax amounts for each tax rate. Please note: As done with every read-only element or object all submitted content (POST) will be ignored. For details see below.
Read-only.

tax_conditions: TaxConditions

The tax conditions of the credit note. For details see below.

title: Option<String>

(Optional) A title text. The organization’s default is used if no value was sent.

introduction: Option<String>

(Optional) An introductory text / header. The organization’s default is used if no value was send. We recommended to include the invoice number in the header when the credit note is related to an invoice.

remark: Option<String>

(Optional) A closing text note. The organization’s default is used if no value was send.

files: ReadOnly<Files>

The document id for the PDF version of the credit note. For details see below.
Read-only.

Implementations

impl CreditNote

pub fn builder() -> CreditNoteBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building CreditNote. On the builder, call .language(...)(optional), .voucher_date(...), .address(...), .line_items(...), .total_price(...), .tax_conditions(...), .title(...)(optional), .introduction(...)(optional), .remark(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreditNote.

Trait Implementations

impl Clone for CreditNote

fn clone(&self) -> CreditNote

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreditNote

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreditNote

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl HasId for CreditNote

fn id(&self) -> &ReadOnly<Uuid>

gets the id from an object.

impl PartialEq<CreditNote> for CreditNote

fn eq(&self, other: &CreditNote) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreditNote) -> bool

This method tests for !=.

impl Serialize for CreditNote

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreditNote