Skip to main content
GET
/
v1
/
invoices
List invoices
curl --request GET \
  --url https://api.platnova.com/v1/invoices \
  --header 'X-API-KEY: <api-key>'
{
  "status": true,
  "data": {
    "items": [
      {
        "id": "<string>",
        "invoice_number": "<string>",
        "items": "<array>",
        "subtotal": "<string>",
        "total": "<string>",
        "charges": {},
        "note": "<string>",
        "status": "pending",
        "payment_schedule": {},
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 123,
    "size": 123,
    "max_page": 123,
    "total_pages": 123,
    "total": 123,
    "last": true,
    "first": true,
    "visible": 123
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}

Overview

Retrieve a paginated list of all invoices associated with your account. This endpoint allows you to view all invoices with filtering and sorting options.

Authorizations

X-API-KEY
string
header
required

API key for authentication.

Query Parameters

page
integer

Page number (0-indexed)

size
integer

Number of items per page

sort
string

Sort field and direction

filters
string

Filter expression

Response

Invoices retrieved successfully

status
boolean
data
object
error
any[]
message
string