List All Invoices
You can list all invoices, or list the invoices for a specific updated time. The invoices are returned sorted by created date, with the most recently created invoices appearing first.
Attributes
external_id
string
The external id used during generation of invoice. Given that external_id is non-unique, by including external_id, it will return all invoices with that specific external_id.
statuses
array of strings
Indicates the status of the invoices that will be available in the list. It contains PENDING, PAID, SETTLED, EXPIRED.
example : ["SETTLED","EXPIRED"]
limit
number
A limit on the number of invoice objects to be returned. Limit can range between 1 and 100.
created_after
string (ISO 8601)
Return invoices where the created field is greater than this value. Both created_after and created_before field should be used in the same time for the filter to take effect.
Example :
created_before
string (ISO 8601)
Return invoices where the created field is less than this value.
Both created_after and created_before field should be used in the same time for the filter to take effect.
Example :
paid_after
string (ISO 8601)
Return invoices where the paid_at field is greater than this value.
Both paid_after and paid_before field should be used in the same time for the filter to take effect.
Example :
paid_before
string (ISO 8601)
Return invoices where the paid_at field is less than this value.
Both paid_after and paid_before field should be used in the same time for the filter to take effect.
Example :
expired_after
string (ISO 8601)
Return invoices where the expiry_date field is less than this value.
Both expired_after and expired_before field should be used in the same time for the filter to take effect.
Example :
last_invoice_id
string
A cursor for use in pagination.
last_invoice_id is an invoice ID that defines your starting point for the list. For instance, if you make a list request and receive 10 objects, starting with obj_bar, your subsequent call can include last_invoice_id=obj_bar in order to fetch the previous page of the list.
client_types
array of strings
Indicates the method used to create the invoice. It contains:
API_GATEWAY Invoice created via create invoice API
DASHBOARD Invoice created via dashboard
INTEGRATION Invoice created via 3rd party integration such as Shopify and Woocommerce
ON_DEMAND Invoice created via On Demand
RECURRING Invoice created via Recurring Payment
MOBILE Invoice created via Mobile App.
example :
payment_channels
array of strings
Indicates the channels used to pay the invoice.
on_demand_link
string
The link for the specific on demand. If you input on_demand_link, it will return invoices that created from that specific on demand link.
recurring_payment_id
string
The recurring payment id for specific recurring payment, it will return invoices that created from that specific recurring payment id.
GET https://us-central1-appgregator.cloudfunctions.net/xendit/invoices/
Headers
x-api-key*
String
U2Fsd...
Last updated