| type |
str |
See Invoice Types |
[optional] |
| contact |
Contact |
|
[optional] |
| line_items |
list[LineItem] |
See LineItems |
[optional] |
| date |
date |
Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation |
[optional] |
| due_date |
date |
Date invoice is due – YYYY-MM-DD |
[optional] |
| line_amount_types |
LineAmountTypes |
|
[optional] |
| invoice_number |
str |
ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) |
[optional] |
| reference |
str |
ACCREC only – additional reference number |
[optional] |
| branding_theme_id |
str |
See BrandingThemes |
[optional] |
| url |
str |
URL link to a source document – shown as “Go to [appName]” in the Xero app |
[optional] |
| currency_code |
CurrencyCode |
|
[optional] |
| currency_rate |
float |
The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) |
[optional] |
| status |
str |
See Invoice Status Codes |
[optional] |
| sent_to_contact |
bool |
Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved |
[optional] |
| expected_payment_date |
date |
Shown on sales invoices (Accounts Receivable) when this has been set |
[optional] |
| planned_payment_date |
date |
Shown on bills (Accounts Payable) when this has been set |
[optional] |
| cis_deduction |
float |
CIS deduction for UK contractors |
[optional] |
| cis_rate |
float |
CIS Deduction rate for the organisation |
[optional] |
| sub_total |
float |
Total of invoice excluding taxes |
[optional] |
| total_tax |
float |
Total tax on invoice |
[optional] |
| total |
float |
Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts |
[optional] |
| total_discount |
float |
Total of discounts applied on the invoice line items |
[optional] |
| invoice_id |
str |
Xero generated unique identifier for invoice |
[optional] |
| repeating_invoice_id |
str |
Xero generated unique identifier for repeating invoices |
[optional] |
| has_attachments |
bool |
boolean to indicate if an invoice has an attachment |
[optional] [default to False] |
| is_discounted |
bool |
boolean to indicate if an invoice has a discount |
[optional] |
| payments |
list[Payment] |
See Payments |
[optional] |
| prepayments |
list[Prepayment] |
See Prepayments |
[optional] |
| overpayments |
list[Overpayment] |
See Overpayments |
[optional] |
| amount_due |
float |
Amount remaining to be paid on invoice |
[optional] |
| amount_paid |
float |
Sum of payments received for invoice |
[optional] |
| fully_paid_on_date |
date |
The date the invoice was fully paid. Only returned on fully paid invoices |
[optional] |
| amount_credited |
float |
Sum of all credit notes, over-payments and pre-payments applied to invoice |
[optional] |
| updated_date_utc |
datetime |
Last modified date UTC format |
[optional] |
| credit_notes |
list[CreditNote] |
Details of credit notes that have been applied to an invoice |
[optional] |
| attachments |
list[Attachment] |
Displays array of attachments from the API |
[optional] |
| has_errors |
bool |
A boolean to indicate if a invoice has an validation errors |
[optional] [default to False] |
| status_attribute_string |
str |
A string to indicate if a invoice status |
[optional] |
| validation_errors |
list[ValidationError] |
Displays array of validation error messages from the API |
[optional] |
| warnings |
list[ValidationError] |
Displays array of warning messages from the API |
[optional] |
| invoice_addresses |
list[InvoiceAddress] |
An array of addresses used to auto calculate sales tax |
[optional] |