Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• id string

  Purchase invoice ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• supplierId string

  Supplier contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• reference string

  Supplier invoice reference filter

• currency string

  Currency code filter

• netAmount string

  Net amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• totalAmount string

  Total amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• status string

  Invoice status filter

  Values are UNPAID, OVERDUE, PAID, PARTIALLY_PAID, WIRED, or DRAFT.

• validated boolean

  Whether the invoice is validated

• hasWarnings boolean

  Whether the invoice has warnings

• hasComments boolean

  Whether the invoice has comments

• isInWorkflow boolean

  Whether the invoice is currently part of an active workflow

• date string

  Invoice date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• description string

  Free-text description filter

• vatAmount string

  VAT amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• chartOfAccountsId string

  Chart of accounts (expense category) ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• invoiceLineDepartmentId string

  Invoice line department ID filter.
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• orderId string

  Order ID filter
  
  Multi-value supported. Example: value1;value2
  
  

• invoiceLineOfficeId string

  Invoice line office ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• reBill boolean

  Whether the attribution should be rebilled to the client

• reBilled boolean

  Whether the attribution has already been rebilled

• reBilledDate string(date)

  ReBilled date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• articleId string

  Article ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• quantity string

  Quantity filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• ruleName string

  Allocation rule name

• paidAmount string

  Paid amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• bankCharges string

  Bank charges filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• payableByAccount string

  Payable-by chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• paymentType string

  Payment type filter

  Values are BANK_TRANSFER, BVR, or QR_BILL.

• paymentAccountId string

  Payment chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• vatType string

  VAT type filter

  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.

• documentsExist boolean

  Whether documents (attachments) exist for the invoice

• requestedDate string(date)

  Requested payment date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• plannedDate string(date)

  Planned payment date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• sentDate string(date)

  Sent payment date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• valueDate string(date)

  Payment value date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• payable string

  Payable amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• showOpenInvoices boolean

  Show open invoices.
  
  Requires 'openDate' when set to true.
  
  

• openDate string(date-time)

  Open date filter.
  
  Used only when 'showOpenInvoices' is set to true.
  
  

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • organizationId integer(int64)
  • journalEntryId integer(int64)
  • date string(date-time)
  • supplier string
  • supplierId integer(int64)
  • reference string
  • currency string
  • netAmount number
  • totalAmount number
  • payable number
  • status string

    Values are UNPAID, OVERDUE, PAID, PARTIALLY_PAID, WIRED, or DRAFT.

  • validated boolean
  • comment string
  • warnings string
  • fileId integer(int64)
  • fileExtension string
  • hasWarnings boolean
  • shipmentsCount integer(int64)
  • creatorContactId integer(int64)
  • workflowPermissions string
  • hasComments boolean
  • isInWorkflow boolean
  • flagsAmount integer(int32)
  • systemValidated boolean
  • description string
  • vatAmount number
  • attributionId integer(int64)
  • chartOfAccountsId integer(int64)
  • attributionAccountNumber integer(int64)
  • invoiceLineDepartmentId integer(int64)
  • departmentName string
  • orderId integer(int64)
  • orderIdToDisplay string
  • invoiceLineOfficeId integer(int64)
  • invoiceLineOfficeName string
  • reBill boolean
  • reBilled boolean
  • reBilledDate string(date-time)
  • articleId integer(int64)
  • articleIdToDisplay string
  • quantity number
  • ruleName string
  • dateFrom string(date-time)
  • dateTo string(date-time)
  • attributionNet number
  • percent number
  • paymentId integer(int64)
  • requestedDate string(date-time)
  • plannedDate string(date-time)
  • sentDate string(date-time)
  • valueDate string(date-time)
  • paidAmount number
  • bankCharges number
  • payableByAccount integer(int64)
  • payableByAccountNumber integer(int64)
  • paymentType string

    Values are BANK_TRANSFER, BVR, or QR_BILL.

  • requestedCurrency string
  • paidCurrency string
  • requestedAmount number
  • paymentAccountId integer(int64)
  • vatType string

    Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.

  • documentsExist boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error