List Invoices

GET /invoices

List Invoices

cURL

curl --request GET \
  --url https://api.xplenty.com/{account_id}/api/invoices \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'

200

[
  {
    "id": "<string>",
    "date": "2023-12-25",
    "amount": 123,
    "currency": "<string>",
    "status": "<string>",
    "pdf_url": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Query Parameters

offset · integer · default: 0

Index of the first object to retrieve (starting from 0)

Required range: x >= 0

limit · integer · default: 20

Number of items to return (max 100)

Required range: 1 <= x <= 100

Response

200 - application/vnd.xplenty+json; version=2

Successful response

id · string

date · string<date>

amount · number

currency · string

status · string

pdf_url · string<uri>