v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Invoices

get/v1/invoices

Query parameters

nextTokenstring

Next token for pagination

limitinteger

Max number of records to fetch

Response

200

Example response

{
  "data": [
    {
      "collectionMethod": "sendInvoice",
      "createdAt": "2024-05-08T17:51:31.133240408Z",
      "currency": "usd",
      "dueDate": "2024-05-11T17:50:58.737Z",
      "id": "in_1PEEeKFdviIHOKAn8fX5x8Un",
      "lineItems": [
        {
          "amount": 9900,
          "description": "buying services",
          "quantity": 3
        }
      ],
      "memo": "example invoice memo",
      "number": "76997118-0001",
      "object": "invoice",
      "recipientId": "cf361905-1cce-4a28-af72-b05097bc89ff",
      "clientId": "cf361905-1cce-4a28-af72-b05097bc89ff",
      "companyId": "cf361905-1cce-4a28-af72-b05097bc89ff",
      "sentDate": "2024-05-08T17:51:31.133225679Z",
      "status": "paid",
      "taxAmount": 1010,
      "taxPercentage": 3.4,
      "total": 30710,
      "receiptNumber": "6463-6361",
      "receiptUrl": "https://example.com/receipt.pdf",
      "fileUrl": "https://example.com/invoice.pdf",
      "billingReason": "manual",
      "paymentMethodPreferences": [
        {
          "type": "creditCard"
        }
      ]
    }
  ]
}