Skip to main content
GET
/
v1
/
invoices
/
{invoiceId}
Get Invoice
curl --request GET \
  --url https://api.cadanapay.com/v1/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "paid",
  "invoiceNumber": "INV-2024-001",
  "date": "2024-03-15",
  "dueDate": "2024-03-30",
  "from": {
    "name": "Acme Corp",
    "address": "123 Business St, Suite 100, San Francisco, CA 94105",
    "email": "billing@example.com",
    "phoneNumber": {
      "countryCode": "1",
      "number": "4155551234"
    }
  },
  "billTo": {
    "name": "Example Corp",
    "address": "456 Innovation Ave, Austin, TX 78701",
    "email": "accounts@example.com",
    "phoneNumber": {
      "countryCode": "1",
      "number": "5125555678"
    }
  },
  "items": [
    {
      "personId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "description": "John Doe - Consulting Services",
      "category": "NET_PAYROLL",
      "amount": {
        "amount": 350000,
        "currency": "USD"
      },
      "quantity": 1,
      "total": {
        "amount": 350000,
        "currency": "USD"
      }
    },
    {
      "personId": "8d7f5678-8536-51ef-c55c-f18gd2g01bf8",
      "description": "Jane Smith - Development Work",
      "category": "NET_PAYROLL",
      "originalAmount": {
        "amount": 150000,
        "currency": "EUR"
      },
      "amount": {
        "amount": 162500,
        "currency": "USD"
      },
      "fxRate": 1.0833,
      "quantity": 1,
      "total": {
        "amount": 162500,
        "currency": "USD"
      }
    },
    {
      "description": "International Transfer Fees",
      "category": "PAYMENT_PROCESSING_FEE",
      "amount": {
        "amount": 2500,
        "currency": "USD"
      },
      "quantity": 1,
      "total": {
        "amount": 2500,
        "currency": "USD"
      }
    },
    {
      "description": "Service Fee",
      "category": "CONTRACTOR_FEE",
      "amount": {
        "amount": 5000,
        "currency": "USD"
      },
      "quantity": 2,
      "total": {
        "amount": 10000,
        "currency": "USD"
      }
    }
  ],
  "subtotal": {
    "amount": 525000,
    "currency": "USD"
  },
  "total": {
    "amount": 525000,
    "currency": "USD"
  },
  "baseCurrency": "USD",
  "fxRates": {
    "USD-EUR": 0.92,
    "EUR-USD": 1.0833
  },
  "purpose": "Professional Services",
  "notes": "Payment for services rendered in March 2024",
  "createdTimestamp": 1710504000,
  "lastUpdatedTimestamp": 1710590400
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
invoiceId
string<uuid>
required

The unique identifier for the invoice

Response

get invoice response

An invoice document

​
id
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

​
status
enum<string>
Available options:
pending,
paid,
overdue,
cancelled
Example:

"paid"

​
invoiceNumber
string

Human-readable invoice number

Example:

"1764332528"

​
date
string<date>

Invoice date

Example:

"2025-11-28"

​
dueDate
string<date>

Payment due date

Example:

"2025-11-26"

​
from
object

Invoice issuer

​
billTo
object

Invoice recipient

​
items
object[]
​
subtotal
object

Subtotal before any adjustments

​
total
object

Total amount due

​
baseCurrency
string

Base currency for the invoice

Example:

"USD"

​
fxRates
object

Exchange rates used in this invoice

Example:
{ "USD-EUR": 0.863673, "USD-PHP": 58.208258 }
​
purpose
string

Purpose of the invoice

Example:

"Payment Processing Fee"

​
notes
string

Additional notes

Example:

"Payment for services rendered"

​
createdTimestamp
integer<int64>

Unix timestamp when invoice was created

Example:

1764332530

​
lastUpdatedTimestamp
integer<int64>

Unix timestamp when invoice was last updated

Example:

1764339673