Skip to main content
GET
/
v1
/
invoices
/
view
/
{number}
Get invoice by number
curl --request GET \
  --url https://api.platnova.com/v1/invoices/view/{number} \
  --header 'X-API-KEY: <api-key>'
{
  "status": true,
  "data": {
    "id": "<string>",
    "invoice_number": "<string>",
    "items": "<array>",
    "subtotal": "<string>",
    "total": "<string>",
    "charges": {},
    "note": "<string>",
    "payment_schedule": {},
    "payment_details": {
      "account_name": "<string>",
      "account_number": "<string>",
      "bank_name": "<string>",
      "currency": "<string>",
      "swift_code": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z"
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.platnova.com/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Retrieve invoice details by invoice number. This endpoint can be used by customers to view their invoices or by your system to retrieve invoice information.

Authorizations

X-API-KEY
string
header
required

API key for authentication.

Path Parameters

number
string
required

Invoice number (e.g. INVxxxxxxxxxx)

Response

Invoice retrieved successfully

status
boolean
data
object
error
any[]
message
string