Invoices
Get invoices
Retrieve all existing invoices. By default, invoices with status open
are not included.
GET
/
v1
/
invoices
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
take
number | null
default: 50Required range:
0 < x < 100
skip
number | null
default: 0Required range:
x > 0
id
string
id__not
string
id__isNull
string
id__isNotNull
string
id__equals
string
id__contains
string
id__startsWith
string
id__endWith
string
customerId
string
customerId__not
string
customerId__isNull
string
customerId__isNotNull
string
customerId__equals
string
customerId__contains
string
customerId__startsWith
string
customerId__endWith
string
customerName
string
customerName__not
string
customerName__isNull
string
customerName__isNotNull
string
customerName__equals
string
customerName__contains
string
customerName__startsWith
string
customerName__endWith
string
invoiceNumber
string
invoiceNumber__not
string
invoiceNumber__isNull
string
invoiceNumber__isNotNull
string
invoiceNumber__equals
string
invoiceNumber__contains
string
invoiceNumber__startsWith
string
invoiceNumber__endWith
string
dueDate
string
dueDate__not
string
dueDate__isNull
string
dueDate__isNotNull
string
dueDate__equals
string
dueDate__lt
string
dueDate__lte
string
dueDate__gt
string
dueDate__gte
string
emissionDate
string
emissionDate__not
string
emissionDate__isNull
string
emissionDate__isNotNull
string
emissionDate__equals
string
emissionDate__lt
string
emissionDate__lte
string
emissionDate__gt
string
emissionDate__gte
string
periodStart
string
periodStart__not
string
periodStart__isNull
string
periodStart__isNotNull
string
periodStart__equals
string
periodStart__lt
string
periodStart__lte
string
periodStart__gt
string
periodStart__gte
string
periodEnd
string
periodEnd__not
string
periodEnd__isNull
string
periodEnd__isNotNull
string
periodEnd__equals
string
periodEnd__lt
string
periodEnd__lte
string
periodEnd__gt
string
periodEnd__gte
string
updatedAt
string
updatedAt__not
string
updatedAt__isNull
string
updatedAt__isNotNull
string
updatedAt__equals
string
updatedAt__lt
string
updatedAt__lte
string
updatedAt__gt
string
updatedAt__gte
string
settledAt
string
settledAt__not
string
settledAt__isNull
string
settledAt__isNotNull
string
settledAt__equals
string
settledAt__lt
string
settledAt__lte
string
settledAt__gt
string
settledAt__gte
string
subscriptionId
string
subscriptionId__not
string
subscriptionId__isNull
string
subscriptionId__isNotNull
string
subscriptionId__equals
string
subscriptionId__contains
string
subscriptionId__startsWith
string
subscriptionId__endWith
string
invoicingEntityId
string
invoicingEntityId__not
string
invoicingEntityId__isNull
string
invoicingEntityId__isNotNull
string
invoicingEntityId__equals
string
invoicingEntityId__contains
string
invoicingEntityId__startsWith
string
invoicingEntityId__endWith
string
status
Available options:
all
, open
, grace_period
, to_pay
, to_reconcile
, error
, paid
, partially_paid
, outstanding
, refunded
, document
, late
, draft
status__in
Available options:
all
, open
, grace_period
, to_pay
, to_reconcile
, error
, paid
, partially_paid
, outstanding
, refunded
, document
, late
, draft
status__notIn
Available options:
all
, open
, grace_period
, to_pay
, to_reconcile
, error
, paid
, partially_paid
, outstanding
, refunded
, document
, late
, draft
type
Available options:
invoice
, refund
, document
type__in
Available options:
invoice
, refund
, document
type__notIn
Available options:
invoice
, refund
, document
paymentMethod
Available options:
card
, transfer
, external
, missing
, direct_debit
, direct_debit_sepa
, direct_debit_ach
, direct_debit_bacs
, wallet
paymentMethod__in
Available options:
card
, transfer
, external
, missing
, direct_debit
, direct_debit_sepa
, direct_debit_ach
, direct_debit_bacs
, wallet
paymentMethod__notIn
Available options:
card
, transfer
, external
, missing
, direct_debit
, direct_debit_sepa
, direct_debit_ach
, direct_debit_bacs
, wallet
search
string
category
Available options:
refund
, subscription
, otp
category__in
Available options:
refund
, subscription
, otp
category__notIn
Available options:
refund
, subscription
, otp
Response
200 - application/json
meta
object
requireddata
object[]
requiredList of Invoice.
Was this page helpful?