Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
Example:

"desc"

sort
enum<string>

Field used to sort the results.

Available options:
created_at,
emitted_at
type
Available options:
invoice,
refund,
document,
child_invoice_ref,
child_creditnote_ref
type__in
Available options:
invoice,
refund,
document,
child_invoice_ref,
child_creditnote_ref
status
Available options:
all,
open,
grace_period,
to_pay,
to_reconcile,
error,
paid,
partially_paid,
outstanding,
refunded,
late,
draft,
voided,
closed,
uncollectible,
pending_consolidation,
consolidated
status__in
Available options:
all,
open,
grace_period,
to_pay,
to_reconcile,
error,
paid,
partially_paid,
outstanding,
refunded,
late,
draft,
voided,
closed,
uncollectible,
pending_consolidation,
consolidated
customer_id
string
customer_id__not
string
customer_id__isNull
string
customer_id__isNotNull
string
customer_id__equals
string
customer_id__contains
string
customer_id__startsWith
string
customer_id__endWith
string
customer_external_id
string
subscription_id
string
subscription_id__not
string
subscription_id__isNull
string
subscription_id__isNotNull
string
subscription_id__equals
string
subscription_id__contains
string
subscription_id__startsWith
string
subscription_id__endWith
string
invoicing_entity_id
string
invoicing_entity_id__not
string
invoicing_entity_id__isNull
string
invoicing_entity_id__isNotNull
string
invoicing_entity_id__equals
string
invoicing_entity_id__contains
string
invoicing_entity_id__startsWith
string
invoicing_entity_id__endWith
string
invoice_number
string
invoice_number__not
string
invoice_number__isNull
string
invoice_number__isNotNull
string
invoice_number__equals
string
invoice_number__contains
string
invoice_number__startsWith
string
invoice_number__endWith
string
original_invoice_id
string
original_invoice_id__not
string
original_invoice_id__isNull
string
original_invoice_id__isNotNull
string
original_invoice_id__equals
string
original_invoice_id__contains
string
original_invoice_id__startsWith
string
original_invoice_id__endWith
string
original_invoice_number
string
original_invoice_number__not
string
original_invoice_number__isNull
string
original_invoice_number__isNotNull
string
original_invoice_number__equals
string
original_invoice_number__contains
string
original_invoice_number__startsWith
string
original_invoice_number__endWith
string
line_item_id
string
period_start
string<date-time>
period_start__not
string<date-time>
period_start__isNull
string<date-time>
period_start__isNotNull
string<date-time>
period_start__equals
string<date-time>
period_start__lt
string<date-time>
period_start__lte
string<date-time>
period_start__gt
string<date-time>
period_start__gte
string<date-time>
period_end
string<date-time>
period_end__not
string<date-time>
period_end__isNull
string<date-time>
period_end__isNotNull
string<date-time>
period_end__equals
string<date-time>
period_end__lt
string<date-time>
period_end__lte
string<date-time>
period_end__gt
string<date-time>
period_end__gte
string<date-time>
emission_date
string<date-time>
emission_date__not
string<date-time>
emission_date__isNull
string<date-time>
emission_date__isNotNull
string<date-time>
emission_date__equals
string<date-time>
emission_date__lt
string<date-time>
emission_date__lte
string<date-time>
emission_date__gt
string<date-time>
emission_date__gte
string<date-time>
due_date
string<date-time>
due_date__not
string<date-time>
due_date__isNull
string<date-time>
due_date__isNotNull
string<date-time>
due_date__equals
string<date-time>
due_date__lt
string<date-time>
due_date__lte
string<date-time>
due_date__gt
string<date-time>
due_date__gte
string<date-time>
updated_at
string<date-time>
updated_at__not
string<date-time>
updated_at__isNull
string<date-time>
updated_at__isNotNull
string<date-time>
updated_at__equals
string<date-time>
updated_at__lt
string<date-time>
updated_at__lte
string<date-time>
updated_at__gt
string<date-time>
updated_at__gte
string<date-time>

Response

200 - application/json
meta
object
required
data
object[]
required

List of InvoiceV1.