List Invoices API
The following endpoint retrieves the details of all Invoices created
/invoices
Query Attributes
from
String
Optional
Timestamp (in YYYY-MM-DD format) from when the Invoices should be fetched.
to
String
Optional
Timestamp (in YYYY-MM-DD format) up till when Invoices are to be fetched.
skip
Integer
Optional
The number of invoices to be skipped. The default value is 0. This can be used for pagination, in combination with count.
limit
Integer (default:25, max:100)
Optional
Number of invoices to be fetched. This can be used for pagination, in combination with the skip parameter.
status
String
Optional
Filter to fetch Invoices having a particular status. Supported values are: outstanding
, paid
.
Example
curl -u [Base64({Your_Server_Key}:)] \
-X GET https://api.durianpay.id/v1/invoices?limit=50&skip=10 \
-H "content-type: application/json"'
Response Code
200 - Success
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
{ invoices: [{ "id": "inv_0dIWbuDJQdsfn078", "customer_id": "cus_VigefX4iBYp24523", "title": "sample title", "invoice_ref_id": "inv_ref_001", "amount": "20001.00", "remaining_amount": "10001.00" "currency": "IDR", "status": "outstanding", "is_live": true, "is_partial_transaction_enabled": true, "partial_transaction_config": { "min_acceptable_amount": "10000.00" } "start_date": "2022-03-28T00:00:00Z" "due_date": "2022-03-29T00:00:00Z", "is_blocked": false, "invoice_url": "", "created_at": "2022-03-28T14:39:37.860426Z" }, { "id": "inv_0dIWbudjjf84078", "customer_id": "cus_ViPeX4iBYp2233", "invoice_ref_id": "inv_ref_001", "title": "sample title", "amount": "15001.00", "remaining_amount": "10001.00" "currency": "IDR", "status": "paid", "is_live": true, "is_partial_transaction_enabled": true, "partial_transaction_config": { "min_acceptable_amount": "10000.00" } "start_date": "2022-03-28T00:00:00Z" "due_date": "2022-03-29T00:00:00Z", "is_blocked": false, "invoice_url": "", "created_at": "2022-03-28T14:39:37.860426Z" }], "total": 2, "response_code": "0000" }
400 - Invalid Request
401 - Unauthorized Access
500 - Internal Server Error