Body Required

• id integer

  Entity ID. If negative value, a new entity will be created

• journalEntryId integer

  Journal entry ID

• number string

  Invoice number

• date string Required

  Invoice date (format dd/MM/yyyy)

• clientId integer

  Client contact ID

• clientAddressId integer

  Client address ID

• address object

  Invoice client address. If clientAddressId is not provided, a new invoice client address can be specified.

  Hide address attributes Show address attributes object

  • id integer

    Entity ID. If negative value, a new entity will be created

  • name string

    Address label / name

  • line1 string

    Address line 1

  • line2 string

    Address line 2

  • city string

    City

  • region object

    Region

    Hide region attribute Show region attribute object

    • id integer

      Region ID

  • countryCode2 string

    ISO 3166-1 alpha-2 country code

  • countryId integer

    Country ID

  • postCode string

    Postal code

  • houseNumber string

    House number

  • toTheAttentionOf string

    To the attention of

  • position integer(int32)

    Position order

  • service string

    Service label

• ourContactId integer

  Our contact ID

• yourContactId integer

  Client's internal contact ID

• clientName string

  Client name for display

• reference string

  Internal reference

• yourReference string

  Client's reference

• currencyId integer

  Currency ID

• description string

  Invoice description

• comments string

  Internal comments

• receivableAccountId integer

  Receivable chart of accounts ID

• vatTypeCodeId integer

  VAT type code ID

• excludedFromVat boolean

  Whether this invoice is excluded from VAT reporting

• accrualFrom string

  Accrual period start date (format dd/MM/yyyy)

• accrualTo string

  Accrual period end date (format dd/MM/yyyy)

• validated boolean

  Whether the invoice is validated. Only applied if the current user has validation permission

• invoiceLines array[object] Required

  Line item of a sales invoice

  Hide invoiceLines attributes Show invoiceLines attributes object

  Line item of a sales invoice

  • id integer

    Entity ID. If negative value, a new entity will be created

  • tempId integer

    Temporary negative ID used to reference this line from invoiceLinesLayout before it is saved

  • lineType string

    Line type

    Values are ARTICLE, NO_ARTICLE, TIMESHEET, EXPENSES, DISBURSEMENT, HEADER, or FIXED_ASSET.

  • quantity number

    Quantity

  • articleId integer

    Article ID

  • description string

    Line description

  • longDescription string

    Long description

  • netUnitPrice number

    Net unit price

  • discount number

    Discount percentage. Defaults to 0

  • totalNet number

    Net total

  • vatRateId integer

    VAT rate ID. Send null or -1 for no VAT

  • vat number

    VAT amount

  • totalPrice number

    Total price including VAT

  • saleAccountId integer

    Sale chart of accounts ID

  • departmentId integer

    Department ID

  • allocationKey string

    Allocation key

  • appliedAllocationRules array[string]

    Applied allocation rules

  • vatTypeCodeId integer

    VAT type code ID

  • officeId integer

    Office ID

• invoiceLinesLayout array[object]

  Layout tree node grouping and ordering sales invoice lines. Processed into a materialized path structure on the server; the recursive children field is required to define the tree since the server does not use a flat parentId reference for this endpoint.

  Hide invoiceLinesLayout attributes Show invoiceLinesLayout attributes object

  Layout tree node grouping and ordering sales invoice lines. Processed into a materialized path structure on the server; the recursive children field is required to define the tree since the server does not use a flat parentId reference for this endpoint.

  • id integer

    Layout node ID. Negative value = new node, will be created and not linked to an existing entity

  • name string

    Display name for HEADER type nodes

  • position integer(int32)

    Position among siblings

  • lineType string

    Layout node type

    Values are ARTICLE, NO_ARTICLE, TIMESHEET, EXPENSES, DISBURSEMENT, HEADER, or FIXED_ASSET.

  • salesInvoiceLineId integer

    ID of the sales invoice line this node refers to. Applicable when lineType is not HEADER. May be a negative temporary ID matching a new line's tempId

  • sourceOrderId integer

    Source order ID this layout node originates from

  • children array

    Child layout nodes (recursive)

• payments array[object] Required

  Payment record for a sales invoice

  Hide payments attributes Show payments attributes object

  Payment record for a sales invoice

  • id integer

    Entity ID. If negative value, a new entity will be created

  • receivableByAccountId integer

    Receivable chart of accounts ID

  • requestedDate string

    Requested payment date (format dd/MM/yyyy)

  • overdueDate string

    Overdue date (format dd/MM/yyyy)

  • valueDate string

    Value date of the payment (format dd/MM/yyyy)

  • sentDate string

    Date the payment was sent (format dd/MM/yyyy)

  • requestedAmount string

    Requested amount as string

  • paidAmount string

    Paid amount as string

  • bankCharges string

    Bank charges as string

  • lossOnDebtors string

    Loss on debtors as string. Defaults to 0

  • qrBillData string

    QR-bill data

  • qrReferenceNumber string

    QR reference number, write-only

• timesheetInfoItems array[object]

  Timesheet entry billed through a sales invoice

  Hide timesheetInfoItems attributes Show timesheetInfoItems attributes object

  Timesheet entry billed through a sales invoice

  • id integer

    Entity ID. If negative value, a new entity will be created

  • date string

    Date (format dd/MM/yyyy)

  • description string

    Description

  • time string

    Time spent as string, in hours

  • billableAmount string

    Billable amount as string

  • billableRate string

    Billable rate as string

  • employeeContactId integer

    Employee contact ID

  • originalTimesheetId integer

    Original timesheet entry ID this billing line originates from

  • employeeTaskId integer

    Employee task ID