Skip to main content
GET
/
api
/
v1
/
business
/
invoices
List invoices
curl --request GET \
  --url http://localhost:3001/api/v1/business/invoices \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "invoices": [
      {
        "id": "<string>",
        "businessId": "<string>",
        "invoiceNumber": "INV-0001",
        "status": "DRAFT",
        "amount": 123,
        "currency": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "customerEmail": "<string>",
        "customerName": "<string>",
        "description": "<string>",
        "lineItems": [
          {
            "description": "<string>",
            "quantity": 123,
            "unitPrice": 123,
            "amount": 123
          }
        ],
        "dueDate": "2023-11-07T05:31:56Z",
        "issuedAt": "2023-11-07T05:31:56Z",
        "paidAt": "2023-11-07T05:31:56Z",
        "reminderSentAt": "2023-11-07T05:31:56Z",
        "signedByName": "<string>",
        "signedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.useaxra.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

x-api-key
string
required

Query Parameters

status
string
page
number
limit
number

Response

OK

success
boolean
required
Example:

true

data
object
required