Invoices

  1. Columns

    Name

    Type

    ReadOnly

    Description

    Id [KEY]

    String

    True

    The line item index combined with the Id of the invoice.

    InvoiceId

    String

    False

    The Id of the invoice. This field is assigned by Xero.

    Type

    String

    False

    The type of the invoice. The valid values are ACCPAY and ACCREC.

    ContactId

    String

    False

    The Id of the contact.

    ContactName

    String

    False

    The name of the contact. This value is required when inserting.

    LineItem_LineItemId

    String

    False

    The Xero generated identifier for a LineItem. If LineItemIDs are not included with line items in an update request then the line items are deleted and recreated.

    LineItem_Description

    String

    False

    The description for the line item. This field must contain at least 1 character and is required to create an approved invoice.

    LineItem_Quantity

    Double

    False

    The quantity of the associated item in the line item. This field is required for invoice approval and must be zero or positive.

    LineItem_UnitAmount

    Decimal

    False

    The unit amount of the associated item in the line item. This field is required for invoice approval.

    LineItem_ItemCode

    String

    False

    The code that identifies the associated item.

    LineItem_AccountCode

    String

    False

    The account code. This must be active for the organisation. This field is required for invoice approval.

    LineItem_Item_ItemId

    String

    False

    The ID of the item the lineitem refers to.

    LineItem_Item_Name

    String

    False

    The name of the item the lineitem refers to.

    LineItem_Item_Code

    String

    False

    The code of the item the lineitem refers to.

    LineItem_TaxType

    String

    False

    The tax type. This field is used to override AccountCode, the default tax code for the selected account.

    LineItem_TaxAmount

    Decimal

    False

    The automatically calculated percentage of tax, based on the tax rate, for the line amount.

    LineItem_LineAmount

    Decimal

    False

    The total of the quantity multiplied by the unit amount with any discounts applied.

    LineItem_TrackingCategory1_CategoryId

    String

    False

    The Id of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory1_CategoryName

    String

    False

    The name of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory1_OptionId

    String

    False

    The Id of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory1_OptionName

    String

    False

    The option of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory1_Option_Stat

    String

    False

    The status of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory2_CategoryId

    String

    False

    The Id of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory2_CategoryName

    String

    False

    The name of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory2_OptionId

    String

    False

    The Id of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory2_OptionName

    String

    False

    The option of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_TrackingCategory2_Option_Stat

    String

    False

    The status of a tracking category. The API allows two optional tracking categories to be defined.

    LineItem_DiscountRate

    Double

    False

    The discount percentage being applied to the line item. Discounts are only supported on ACCREC-type (sales) invoices.

    LineItem_DiscountAmount

    Decimal

    False

    The discount amount being applied to the line item. Discounts are only supported on ACCREC-type (sales) invoices.

    LineItemAggregate

    String

    False

    Used to define LineItem rows using XML values. Should be provided on INSERT only.

    Date

    Date

    False

    The date the invoice was created.

    DueDate

    Date

    False

    The date the invoice is due.

    LineAmountTypes

    String

    False

    This field specifies whether line amounts include tax (default). When this field is not specified, line amount totals do not include tax. The valid values are Exclusive, Inclusive, and NoTax.

    InvoiceNumber

    String

    False

    The unique, alphanumeric code identifying the invoice. For ACCREC-type invoices. When this field is missing it is automatically generated from the Organisation Invoice Settings. For ACCPAY-type invoices, this field stores a nonunique alphanumeric code identifying the invoice.

    Reference

    String

    False

    An additional reference number for ACCREC-type invoices.

    BrandingThemeId

    String

    False

    The Id of the branding theme.

    URL

    String

    False

    A URL to a source document.

    CurrencyCode

    String

    False

    The ISO 4217 currency code.

    CurrencyRate

    Decimal

    False

    The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used.

    Status

    String

    False

    The status code for the invoice. The valid values are DRAFT, SUBMITTED, and AUTHORISED.

    SentToContact

    Boolean

    False

    This field indicates whether the invoice should be marked as sent. This field can be set on only invoices that have been approved.

    ExpectedPaymentDate

    Date

    True

    The expected payment date. This field is shown on sales invoices (accounts receivable).

    PlannedPaymentDate

    Date

    True

    The planned payment date. This field is shown on bills (accounts payable).

    SubTotal

    Decimal

    True

    The subtotal for the invoice, which excludes taxes.

    TotalTax

    Decimal

    True

    The total tax for the invoice.

    Total

    Decimal

    True

    The total for the invoice, including tax -- the sum of SubTotal and TotalTax.

    TotalDiscount

    Decimal

    True

    Total of discounts applied on the invoice line items.

    HasAttachments

    Boolean

    True

    This field indicates whether the invoice has an attachment.

    PaymentIds

    String

    True

    A comma-delimited list of payment Ids associated with the invoice.

    PrePaymentIds

    String

    True

    A comma-delimited list of prepayment Ids associated with the invoice.

    OverPaymentIds

    String

    True

    A comma-delimited list of overpayment Ids associated with the invoice.

    CreditNoteIds

    String

    True

    A comma-delimited list of credit note Ids applied to the invoice.

    AmountDue

    Decimal

    True

    The amount remaining to be paid on the invoice.

    AmountPaid

    Decimal

    True

    The sum of payments received for the invoice.

    CISDeduction

    Decimal

    True

    The deduction withheld by a contractor to be paid to HMRC. Only available for UK organizations.

    FullyPaidOnDate

    Date

    True

    The date the invoice was fully paid. Only returned on fully paid invoices.

    AmountCredited

    Decimal

    True

    The sum of all credit notes, overpayments, and prepayments applied to the invoice.

    UpdatedDateUTC

    Datetime

    True

    The date when the invoice was last updated.

    TenantId

    String

    False

    The ID of the tenant to query instead of the connection tenant

PreviousHistoryPurchaseOrdersNextItems

Last updated