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
  
  

• date string

  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.
  
  

• 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 filterSupports 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 filterSupports 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.
  
  

• payable string

  Payable amount filterSupports 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

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
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error