Qodex.ai

Get all invoices.

GET {{baseUrl}}/v4/invoices?locationUid=00000000-0000-0000-0000-000000000000&datePaid=2015-01-23T23:50:07Z&dateRefunded=2015-01-23T23:50:07Z&dateCreated=2015-01-23T23:50:07Z&limit=10&cursor=MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw

List of all invoices that match the query parameters.

Request Params

KeyDatatypeRequiredDescription
locationUidstringPodium unique identifier for location.
datePaidstringReturn invoices with a payment whose createdAt is greater or equal to this date.
dateRefundedstringReturn invoices with a refund whose createdAt is greater or equal to this date.
dateCreatedstringReturn invoices whose createdAt is greater or equal to this date.
limitnumberMax number of items to return per request. Defaults to 10.
cursorstringRetrieves the page of items that comes after or before the cursor.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"data":[{"canceledAt":"2015-01-23T23:50:07Z","canceledNote":"The wrong amount was entered.","channel":{"identifier":"email@email.com","type":"email"},"conversationUid":"00000000-0000-0000-0000-000000000000","createdAt":"2015-01-23T23:50:07Z","currencyRef":"USD","customerName":"Joe Orange","invoiceNumber":"abc-12345-def","lineItems":[{"amount":1099,"description":"Total"},{"amount":1099,"description":"Total"}],"location":{"uid":"00000000-0000-0000-0000-000000000000"},"paidAt":"2015-01-23T23:50:07Z","paymentNet":1000,"payments":[{"bankAccountLast4":"1245","bankAccountName":"The Bank","cardBrand":"visa","cardLast4":"4242","createdAt":"2015-01-23T23:50:07Z","fee":99,"interchangeFee":50,"refunds":[{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"requested_by_customer","settledAt":"2015-01-23T23:50:07Z","status":"failed_charge_for_pending_refund_disputed"},{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"requested_by_customer","settledAt":"2015-01-23T23:50:07Z","status":"failed_lost_or_stolen"}],"settledAt":"2015-01-23T23:50:07Z","status":"paid","uid":"00000000-0000-0000-0000-000000000000"},{"bankAccountLast4":"1245","bankAccountName":"The Bank","cardBrand":"visa","cardLast4":"4242","createdAt":"2015-01-23T23:50:07Z","fee":99,"interchangeFee":50,"refunds":[{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"fraudulent","settledAt":"2015-01-23T23:50:07Z","status":"failed_lost_or_stolen"},{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"duplicate","settledAt":"2015-01-23T23:50:07Z","status":"failed_lost_or_stolen"}],"settledAt":"2015-01-23T23:50:07Z","status":"paid","uid":"00000000-0000-0000-0000-000000000000"}],"readerUid":"00000000-0000-0000-0000-000000000000","requester":"John Apple","status":"paid","uid":"00000000-0000-0000-0000-000000000000"},{"canceledAt":"2015-01-23T23:50:07Z","canceledNote":"The wrong amount was entered.","channel":{"identifier":"email@email.com","type":"email"},"conversationUid":"00000000-0000-0000-0000-000000000000","createdAt":"2015-01-23T23:50:07Z","currencyRef":"USD","customerName":"Joe Orange","invoiceNumber":"abc-12345-def","lineItems":[{"amount":1099,"description":"Total"},{"amount":1099,"description":"Total"}],"location":{"uid":"00000000-0000-0000-0000-000000000000"},"paidAt":"2015-01-23T23:50:07Z","paymentNet":1000,"payments":[{"bankAccountLast4":"1245","bankAccountName":"The Bank","cardBrand":"visa","cardLast4":"4242","createdAt":"2015-01-23T23:50:07Z","fee":99,"interchangeFee":50,"refunds":[{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"requested_by_customer","settledAt":"2015-01-23T23:50:07Z","status":"failed_expired_or_cancelled"},{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"duplicate","settledAt":"2015-01-23T23:50:07Z","status":"failed_expired_or_cancelled"}],"settledAt":"2015-01-23T23:50:07Z","status":"paid","uid":"00000000-0000-0000-0000-000000000000"},{"bankAccountLast4":"1245","bankAccountName":"The Bank","cardBrand":"visa","cardLast4":"4242","createdAt":"2015-01-23T23:50:07Z","fee":99,"interchangeFee":50,"refunds":[{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"requested_by_customer","settledAt":"2015-01-23T23:50:07Z","status":"failed_expired_or_cancelled"},{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"requested_by_customer","settledAt":"2015-01-23T23:50:07Z","status":"failed_unknown"}],"settledAt":"2015-01-23T23:50:07Z","status":"paid","uid":"00000000-0000-0000-0000-000000000000"}],"readerUid":"00000000-0000-0000-0000-000000000000","requester":"John Apple","status":"refund_failed","uid":"00000000-0000-0000-0000-000000000000"}],"metadata":{"nextCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","previousCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","totalItems":-46257660,"url":"https://www.podium.com/"}}