Example: Get a List of Invoices

Endpoint with Optional Query Parameters
GET
https://apitest.cybersource.com
/invoicing/v2/invoices?offset=0&limit=5&status=DRAFT
Request
{}
Response to a Successful Request
{ "_links": { "self": { "href": "/v2/invoices/?offset=0&limit=5", "method": "GET" }, "next": { "href": "/v2/invoices/?offset=5&limit=5", "method": "GET" } }, "submitTimeUtc": "2024-07-24T18:44:11.469054445Z", "totalInvoices": 38449, "invoices": [ { "_links": { "self": { "href": "/v2/invoices/2670", "method": "GET" }, "update": { "href": "/v2/invoices/2670", "method": "PUT" }, "deliver": { "href": "/v2/invoices/2670/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/2670/cancelation", "method": "POST" } }, "id": "2670", "status": "SENT", "customerInformation": { "name": "Tanya Lee" }, "invoiceInformation": { "dueDate": "2019-07-11", "paymentLink": "https://developer.cybersource.com/ebc2/invoicing/payInvoice/W447tdnINi5t5wu6QA0KUE2HYWY2rQQ0zXL5b5z6M50w4Ea9FFlcYrEmp09pFlzl?version=v2.1" }, "orderInformation": { "amountDetails": { "totalAmount": 247.86, "currency": "USD" } } }, { "_links": { "self": { "href": "/v2/invoices/2669", "method": "GET" }, "update": { "href": "/v2/invoices/2669", "method": "PUT" }, "deliver": { "href": "/v2/invoices/2669/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/2669/cancelation", "method": "POST" } }, "id": "2669", "status": "DRAFT", "customerInformation": { "name": "Tanya Lee" }, "invoiceInformation": { "dueDate": "2019-07-11" }, "orderInformation": { "amountDetails": { "totalAmount": 247.86, "currency": "USD" } } }, { "_links": { "self": { "href": "/v2/invoices/2668", "method": "GET" }, "update": { "href": "/v2/invoices/2668", "method": "PUT" }, "deliver": { "href": "/v2/invoices/2668/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/2668/cancelation", "method": "POST" } }, "id": "2668", "status": "DRAFT", "customerInformation": { "name": "Tanya Lee" }, "invoiceInformation": { "dueDate": "2019-07-11" }, "orderInformation": { "amountDetails": { "totalAmount": 2623.64, "currency": "USD" } } }, { "_links": { "self": { "href": "/v2/invoices/2667", "method": "GET" }, "update": { "href": "/v2/invoices/2667", "method": "PUT" }, "deliver": { "href": "/v2/invoices/2667/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/2667/cancelation", "method": "POST" } }, "id": "2667", "status": "DRAFT", "customerInformation": { "name": "Tanya Lee" }, "invoiceInformation": { "dueDate": "2019-07-11" }, "orderInformation": { "amountDetails": { "totalAmount": 2623.64, "currency": "USD" } } }, { "_links": { "self": { "href": "/v2/invoices/2666", "method": "GET" }, "update": { "href": "/v2/invoices/2666", "method": "PUT" }, "deliver": { "href": "/v2/invoices/2666/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/2666/cancelation", "method": "POST" } }, "id": "2666", "status": "CREATED", "customerInformation": { "name": "Tanya Lee" }, "invoiceInformation": { "dueDate": "2019-07-11", "paymentLink": "https://developer.cybersource.com/ebc2/invoicing/payInvoice/i0wUKECHxctWAjRPKFgyEtZiSWxwgtZljBVSrxfFjbBVGgLpET8ROvOPdnhwCJTC?version=v2.1" }, "orderInformation": { "amountDetails": { "totalAmount": 2623.64, "currency": "USD" } } } ] }