Body Required

• id integer

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

• organizationId integer

  Organization ID

• date string

  Invoice date (format dd/MM/yyyy)

• supplierId integer

  Supplier contact ID

• currencyId integer

  Currency ID

• reference string

  Supplier invoice reference

• description string

  Invoice description

• comment string

  Internal comment

• validated boolean

  Whether validated

• vatType string

  VAT type

  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.

• vatTypeCodeId integer

  VAT type code ID

• status string

  Scan processing status

  Values are NEW, PROCESS, CONVERT, or RECOGNIZING.

• paymentChartId integer

  Payment chart of accounts ID

• isOrganizationNameIncluded boolean

  Whether the organization name is included in the scan

• isTreatedByManagingOrganization boolean

  Whether treated by the managing organization

• payableTo integer

  Payable-to contact ID

• document object

  Attached document (scanned receipt)

  Hide document attributes Show document attributes object

  • id integer

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

  • entityId integer

    ID of the entity this document is attached to

  • name string

    Document name

  • fileId integer Required

    Uploaded document file ID

  • date string

    Document date (format dd/MM/yyyy)

  • tags array[object]

    Document tag reference. Only id is required

    Hide tags attribute Show tags attribute object

    Document tag reference. Only id is required

    • id integer Required

      Tag ID

  • contact object

    Contact this document is associated with. Only id is required

    Hide contact attribute Show contact attribute object

    • id integer Required

      Contact ID

  • module string

    Module this document belongs to

    Value is PURCHASE_INVOICES_SCAN.

  • comments string

    Comments

  • isSystem boolean

    Whether the document is system-generated

  • self boolean

    Whether the document is self-uploaded by the current user

• amounts array[object]

  Invoice amount lines (VAT breakdown)

  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]

  Cost attributions

  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

    • attributionId integer

      ID of the scan attribution this shipment belongs to

  • appliedAllocationRules array[string]

    Applied allocation rule identifiers

  • officeId integer

    Office ID

• payments array[object]

  Payment records

  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. Defaults to 0

  • 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