v2
latestOpenAPI 3.0.02026-08-08112115411.4 KBInvoices
Get an invoice
Get a single invoice by the ID provided.
get/invoices/{id}
Path parameters
idstring required
Invoice ID
Response
Invoice
Example response
{
"invoices": [
{
"id": "789-quotes",
"type": "invoices",
"number": "1000-01",
"displayStatus": "ACCEPTED",
"total": {
"amount": "3200.50",
"currency": "USD",
"formatted": "$3,200.50"
},
"productLineItems": [
{
"id": "1-quoteProductLineItems",
"position": 0,
"product": "100-products",
"name": "Consulting Services",
"description": "Monthly consulting retainer",
"sku": "CONS-001",
"quantity": 2,
"term": null,
"price": {
"amount": "1500.00",
"currency": "USD",
"formatted": "$1,500.00"
},
"total": {
"amount": "3000.00",
"currency": "USD",
"formatted": "$3,000.00"
},
"discountUnit": null,
"discountNumber": null
}
],
"subtotalLineItems": [
{
"id": "1-quoteSubtotalLineItems",
"position": 0,
"label": "Tax",
"modifierUnit": "%",
"modifierValue": 6.5,
"operation": "+",
"total": {
"amount": "200.50",
"currency": "USD",
"formatted": "$200.50"
}
}
],
"recipient": {
"id": "321-contacts",
"name": "Jane Doe",
"email": "jane@example.com"
},
"validThroughTime": "2024-12-31T23:59:59Z",
"createdTime": "2024-01-15T10:30:00Z",
"publishedTime": "2024-01-16T14:20:00Z",
"sentTime": "2024-01-17T09:15:00Z",
"paidTime": "2024-01-20T16:45:00Z",
"acceptedName": "Jane Customer",
"acceptedEmail": "jane@example.com",
"completionComment": "Paid via ACH",
"deletedTime": null,
"links": {
"lead": "456-leads"
}
}
]
}