Invoice detail
The /reports/invoices-detail endpoint returns detailed invoice records for a specific customer, including line items and payment information.
GET /reports/invoices-detail
Query parameters
| Parameter | Type | Description |
|---|
customer | string | Customer external ID to retrieve invoices for. |
baseCurrency | string | Target currency for conversion. Defaults to account base currency. |
Example response
200 OK
{
"result": {
"list": [
{
"invoice_ref": "in_abc123",
"invoice_number": "INV-2025-001",
"invoice_date": "2025-01-01",
"invoice_status": "paid",
"payment_date": "2025-01-01",
"customer_id": "cus_123",
"customer_name": "Acme Corp",
"customer_email": "[email protected]",
"description": "Pro Plan",
"currency": "usd",
"total": 9900,
"total_base_currency": 9900,
"transaction_count": 1,
"lines": [
{
"description": "Pro Plan - Monthly",
"amount": 9900,
"quantity": 1,
"period_start": "2025-01-01",
"period_end": "2025-02-01"
}
]
}
]
}
}
Response fields
| Field | Type | Description |
|---|
invoice_ref | string | Invoice reference ID from billing source |
invoice_number | string | Invoice number |
invoice_date | string | Invoice date |
invoice_status | string | Payment status |
payment_date | string | Date payment was received |
customer_id | string | Customer external ID |
customer_name | string | Customer name |
customer_email | string | Customer email |
description | string | Invoice description |
currency | string | Original invoice currency |
total | number | Total in original currency (cents) |
total_base_currency | number | Total in base currency (cents) |
transaction_count | integer | Number of transactions on invoice |
lines | array | Invoice line items |
