Skip to main content
GET
/
external
/
invoices
Handles GET requests for the /invoices route
curl --request GET \
  --url https://api.valyx.com/external/invoices \
  --header 'X-Valyx-Signature: <x-valyx-signature>'
{}

Headers

​
X-Valyx-Signature
string
required

Auth key for fetching ledger entries

Query Parameters

​
invoiceStatus
string[]

list of invoice statuses to filter by

​
paymentStatus
string[]

list of payment statuses to filter by

​
invoiceAcceptanceStatus
string[]

list of invoice acceptance statuses to filter by

​
tag
string[]

list of tag key-value pair to filter by

​
customerIds
string

List of customer IDs

​
ownerIds
string

List of owner IDs

​
buyerIds
string[]

List of buyer IDs

​
sort
enum<string>

Invoices support sorting by invoice date. Passing 'invoiceDate' sorts ascending. To reverse the order, prefix with a hyphen.

Available options:
invoiceDate,
-invoiceDate
​
amountType
enum<string>

Amount type filter

Available options:
TOTAL,
OUTSTANDING,
PAID,
ADJUSTED
​
amountMin
number

Minimum amount of the invoice amount type

​
amountMax
number

Maximum amount of the invoice amount type

​
dateType
enum<string>

DateType type filter

Available options:
INVOICE_DATE,
DUE_DATE,
PROMISE_TO_PAY_DATE
​
startDate
string

start date of the invoice for date type

​
endDate
string

end date of the invoice for date type

​
page
integer
required

page number of result to be fetched

​
pageSize
integer
required

number of entries per page

​
onlyFetchNonZero
boolean

should return invoices that have non zero amount type

​
invoiceNumber
string

invoice number

​
internalInvoiceIds
string[]

invoice ids

​
hasAttachment
string

should return invoices that have attachments (true/false)

​
attachmentPurpose
string[]

attachment purpose to search by (based on hasAttachment)

​
currencies
string[]

Currencies

Response

200 - application/json

Success

The response is of type object.