Body Required

• id integer

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

• journalEntryId integer

  Journal entry ID

• date string Required

  Invoice date (format dd/MM/yyyy)

• supplierId integer Required

  Supplier contact ID

• currencyId integer Required

  Currency ID

• reference string Required

  Supplier invoice reference

• description string

  Invoice description

• comment string

  Internal comment

• validated boolean

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

• vatType string

  VAT type

  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.

• vatTypeCodeId integer

  VAT type code ID

• paymentAccountId integer

  Payment chart of accounts ID. Auto-filled from organization defaults when creating and left empty

• isDraft boolean

  Whether to save the invoice as a draft, bypassing strict validation. Forced to true by the server if validation fails for a not-yet-existing or draft invoice

• amounts array[object] Required

  Invoice amount lines (VAT breakdown). Required, must not be empty

  Hide amounts attributes Show amounts attributes object

  • id integer

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

  • vatRateId integer

    VAT rate ID

  • amountType string

    Purchase amount type

    Values are NO_VAT, VAT_RATE, or MANUAL.

  • net string

    Net amount as string

  • vat string

    VAT amount as string

  • vatType string

    VAT type. Auto-filled from the invoice's vatType when not provided and this is a new line

    Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.

  • vatTypeCodeId integer

    VAT type code ID. Auto-filled from the invoice's vatTypeCodeId when not provided and this is a new line

• attributions array[object] Required

  Cost attributions, must not be empty

  Hide attributions attributes Show attributions attributes object

  • id integer

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

  • chartOfAccountsId integer

    Chart of accounts (expense category) ID

  • dateFrom string

    Accrual start date (format dd/MM/yyyy)

  • dateTo string

    Accrual end date (format dd/MM/yyyy)

  • net string

    Net amount as string

  • percent string

    Percentage of the total invoice amount as string

  • departmentId integer

    Department ID

  • orderId integer

    Order ID this attribution is charged to

  • reBill boolean

    Whether this attribution should be rebilled to the client

  • articleId integer

    Article ID

  • quantity string

    Quantity as string

  • shipments array[object]

    Shipment records for this attribution

    Hide shipments attributes Show shipments attributes object

    • id integer

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

    • shipmentDate string

      Shipment date (format dd/MM/yyyy)

    • articleId integer

      Article ID

    • quantity string

      Quantity as string

    • totalCost number

      Total cost

    • generatedStockMovementId integer

      ID of the stock movement generated for this shipment

    • officeId integer

      Office ID

  • fixedAssetId integer

    Fixed asset ID this attribution creates or is linked to

  • officeId integer

    Office ID

• payments array[object] Required

  Payment records. Required, must not be empty

  Hide payments attributes Show payments attributes object

  • id integer

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

  • requestedDate string

    Requested payment date (format dd/MM/yyyy)

  • plannedDate string

    Planned payment date (format dd/MM/yyyy)

  • sentDate string

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

  • valueDate string

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

  • requestedAmount string

    Requested amount as string

  • paidAmount string

    Paid amount as string

  • bankCharges string

    Bank charges as string

  • payableByAccountId integer

    Chart of accounts ID used as the payable-by account

  • paymentType string

    Payment type

    Values are BANK_TRANSFER, BVR, or QR_BILL.

  • payableToBankId integer

    Bank ID to pay to

  • lineCode string

    Payment line code

  • accountNumber string

    Account number

  • referenceNumber string

    Payment reference number

  • qrBillData string

    QR-bill data

  • paymentPurposeCodeId integer

    Payment purpose code ID