| id |
int |
The invoice id. <span style='color:red'>Required</span> if you want to create or update an invoice position for an existing invoice |
[optional] |
| object_name |
string |
The invoice object name. |
[optional] [default to 'Invoice'] |
| invoice_number |
string |
The invoice number |
[optional] |
| contact |
\Itsmind\Sevdesk\Model\ModelInvoiceContact |
|
|
| contact_person |
\Itsmind\Sevdesk\Model\ModelInvoiceContactPerson |
|
|
| create |
\DateTime |
Date of invoice creation |
[optional] [readonly] |
| update |
\DateTime |
Date of last invoice update |
[optional] [readonly] |
| sev_client |
\Itsmind\Sevdesk\Model\ModelInvoiceSevClient |
|
[optional] |
| invoice_date |
string |
Needs to be provided as timestamp or dd.mm.yyyy Requirements: * For final invoices (invoiceType = 'ER'), the invoiceDate must be later than or equal to the invoiceDate of related advance (invoiceType = 'AR') / partial (invoiceType = 'TR') invoices.</li> |
|
| header |
string |
Normally consist of prefix plus the invoice number |
[optional] |
| head_text |
string |
Certain html tags can be used here to format your text |
[optional] |
| foot_text |
string |
Certain html tags can be used here to format your text |
[optional] |
| time_to_pay |
int |
The time the customer has to pay the invoice in days |
[optional] |
| discount |
int |
If you want to give a discount, define the percentage here. Otherwise provide zero as value |
|
| address |
string |
Complete address of the recipient including name, street, city, zip and country. * Line breaks can be used and will be displayed on the invoice pdf. |
[optional] |
| address_country |
\Itsmind\Sevdesk\Model\ModelInvoiceAddressCountry |
|
|
| pay_date |
\DateTime |
Needs to be timestamp or dd.mm.yyyy |
[optional] |
| create_user |
\Itsmind\Sevdesk\Model\ModelCreditNoteCreateUser |
|
[optional] |
| delivery_date |
\DateTime |
Timestamp. This can also be a date range if you also use the attribute deliveryDateUntil |
[optional] |
| delivery_date_until |
int |
If the delivery date should be a time range, another timestamp can be provided in this attribute * to define a range from timestamp used in deliveryDate attribute to the timestamp used here. |
[optional] |
| status |
string |
Please have a look in our <a href='#tag/Invoice/Types-and-status-of-invoices'>Types and status of invoices</a> to see what the different status codes mean |
|
| small_settlement |
bool |
Defines if the client uses the small settlement scheme. If yes, the invoice must not contain any vat |
[optional] |
| tax_rate |
float |
Is overwritten by invoice position tax rates |
|
| tax_rule |
\Itsmind\Sevdesk\Model\ModelCreditNoteResponseTaxRule |
|
|
| tax_text |
string |
A common tax text would be 'Umsatzsteuer 19%' |
|
| tax_type |
string |
Use this in sevDesk-Update 1.0 (instead of taxRule). Tax type of the invoice. There are four tax types: 1. default - Umsatzsteuer ausweisen 2. eu - Steuerfreie innergemeinschaftliche Lieferung (Europäische Union) 3. noteu - Steuerschuldnerschaft des Leistungsempfängers (außerhalb EU, z. B. Schweiz) 4. custom - Using custom tax set 5. ss - Not subject to VAT according to §19 1 UStG Tax rates are heavily connected to the tax type used. |
|
| tax_set |
\Itsmind\Sevdesk\Model\ModelInvoiceTaxSet |
|
[optional] |
| dunning_level |
int |
Defines how many reminders have already been sent for the invoice. Starts with 1 (Payment reminder) and should be incremented by one every time another reminder is sent. |
[optional] [readonly] |
| payment_method |
\Itsmind\Sevdesk\Model\ModelInvoicePaymentMethod |
|
[optional] |
| send_date |
\DateTime |
The date the invoice was sent to the customer |
[optional] |
| invoice_type |
string |
Type of the invoice. For more information on the different types, check <a href='#tag/Invoice/Types-and-status-of-invoices'>this</a> section |
|
| account_intervall |
string |
The interval in which recurring invoices are due as ISO-8601 duration.<br> Necessary attribute for all recurring invoices. |
[optional] [readonly] |
| account_next_invoice |
int |
Timestamp when the next invoice will be generated by this recurring invoice. |
[optional] [readonly] |
| currency |
string |
Currency used in the invoice. Needs to be currency code according to ISO-4217 |
|
| sum_net |
float |
Net sum of the invoice |
[optional] [readonly] |
| sum_tax |
float |
Tax sum of the invoice |
[optional] [readonly] |
| sum_gross |
float |
Gross sum of the invoice |
[optional] [readonly] |
| sum_discounts |
float |
Sum of all discounts in the invoice |
[optional] [readonly] |
| sum_net_foreign_currency |
float |
Net sum of the invoice in the foreign currency |
[optional] [readonly] |
| sum_tax_foreign_currency |
float |
Tax sum of the invoice in the foreign currency |
[optional] [readonly] |
| sum_gross_foreign_currency |
float |
Gross sum of the invoice in the foreign currency |
[optional] [readonly] |
| sum_discounts_foreign_currency |
float |
Discounts sum of the invoice in the foreign currency |
[optional] [readonly] |
| sum_net_accounting |
float |
Net accounting sum of the invoice. Is usually the same as sumNet |
[optional] [readonly] |
| sum_tax_accounting |
float |
Tax accounting sum of the invoice. Is usually the same as sumTax |
[optional] [readonly] |
| sum_gross_accounting |
float |
Gross accounting sum of the invoice. Is usually the same as sumGross |
[optional] [readonly] |
| paid_amount |
float |
Amount which has already been paid for this invoice by the customer |
[optional] [readonly] |
| show_net |
bool |
If true, the net amount of each position will be shown on the invoice. Otherwise gross amount |
[optional] |
| enshrined |
\DateTime |
Enshrined invoices cannot be changed. Can only be set via Invoice/{invoiceId}/enshrine. This operation cannot be undone. |
[optional] [readonly] |
| send_type |
string |
Type which was used to send the invoice. |
[optional] |
| origin |
\Itsmind\Sevdesk\Model\ModelInvoiceOrigin |
|
[optional] |
| customer_internal_note |
string |
Internal note of the customer. Contains data entered into field 'Referenz/Bestellnummer' |
[optional] |
| map_all |
bool |
|
|