Skip to main content
GET
/
v1
/
invoices
cURL
curl --request GET \
  --url https://api.paycashless.com/v1/invoices \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>'
{
  "hasMore": true,
  "cursor": "<string>",
  "data": [
    {
      "id": "<string>",
      "status": "draft",
      "description": "<string>",
      "currency": "NGN",
      "maxInstallments": 123,
      "number": "<string>",
      "reference": "<string>",
      "acceptPartialPayments": true,
      "amountDue": 123,
      "amountPaid": 123,
      "amountOverpaid": 123,
      "amountRemaining": 123,
      "subTotal": 123,
      "customerId": "<string>",
      "sendEmail": true,
      "totalInclusiveTaxAmount": 123,
      "totalExclusiveTaxAmount": 123,
      "cancellationReason": "<string>",
      "logo": "<string>",
      "invoicePdf": "<string>",
      "receiptPdf": "<string>",
      "callbackUrl": "<string>",
      "returnUrl": "<string>",
      "metadata": {},
      "daysUntilDue": 123,
      "dueDate": "2023-11-07T05:31:56Z",
      "paidAt": "2023-11-07T05:31:56Z",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "liveMode": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "items": [
        {
          "id": "<string>",
          "name": "<string>",
          "quantity": 123,
          "price": 1000,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "taxRateIds": [
        "<string>"
      ]
    }
  ]
}

Headers

​
Request-Signature
string
required

SHA-512 HMAC signature of the request payload using the API secret

Minimum length: 1
Example:

"5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d"

​
Request-Timestamp
string
required

UNIX timestamp when the request was created (in seconds)

Example:

"1712336881"

Query Parameters

​
limit
integer
default:10

The number of invoices to return

Required range: 1 <= x <= 100
Example:

10

​
cursor
string
​
status

The status of the invoice

Example:

"draft"

​
currency

The currency of the invoice

Example:

"USD"

​
reference
string
​
acceptPartialPayments
boolean | null
​
number
string

The number of the invoice

Example:

"000001"

​
createdAt.gte
integer

Minimum UNIX timestamp(in seconds) of when the invoice was created (inclusive)

Required range: x > 0
Example:

1712336881

​
createdAt.lte
integer

Maximum UNIX timestamp(in seconds) of when the invoice was created (inclusive)

Required range: x > 0
Example:

1712336881

​
createdAt.lt
integer

Maximum UNIX timestamp(in seconds) of when the invoice was created (exclusive)

Required range: x > 0
Example:

1712336881

​
createdAt.gt
integer

Minimum UNIX timestamp(in seconds) of when the invoice was created (exclusive)

Required range: x > 0
Example:

1712336881

Response

200 - application/json

Invoices retrieved

​
hasMore
boolean
required
​
cursor
string | null
required
​
data
object[]
required