v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Retrieve Invoice

get/v1/invoices/{id}

Path parameters

idstring required

The unique ID of the invoice you want to retrieve.

Response

200

collectionMethodstring

createdAtstring

currencystring

dueDatestring

idstring

memostring

numberstring

objectstring

recipientIdstring

clientIdstring

companyIdstring

sentDatestring

statusstring

taxAmountinteger

taxPercentageinteger

totalinteger

receiptNumberstring

receiptUrlstring

fileUrlstring

billingReasonstring

updatedAtstring

Example response

{
  "collectionMethod": "sendInvoice",
  "createdAt": "2024-06-06T18:08:05.618445Z",
  "currency": "usd",
  "dueDate": "2024-06-14T18:08:01.292Z",
  "id": "in_1POkjGFdviIHOKAncZ4XrBe0",
  "lineItems": [
    {
      "amount": 10000,
      "description": "Product A",
      "priceId": "F0tsrfYSg",
      "productId": "aae1c02f-c524-4601-bbcb-34d6379e76e3",
      "quantity": 1
    }
  ],
  "memo": "Invoice amount",
  "object": "invoice",
  "recipientId": "fe818b15-431f-4e8b-82b6-85574ef35820",
  "clientId": "fe818b15-431f-4e8b-82b6-85574ef35820",
  "companyId": "fe818b15-431f-4e8b-82b6-85574ef35820",
  "sentDate": "2024-06-06T14:08:05.618421-04:00",
  "status": "draft",
  "total": 10000,
  "fileUrl": "<url to download file>",
  "billingReason": "manual",
  "paymentMethodPreferences": [
    {
      "type": "creditCard"
    }
  ]
}