Skip to main content
POST
/
api
/
v1
/
business
/
invoices
Create an invoice
curl --request POST \
  --url http://localhost:3001/api/v1/business/invoices \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "customerName": "John Smith",
  "customerEmail": "john@example.com",
  "dueAt": "2026-04-16T00:00:00.000Z",
  "items": [
    {
      "description": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "amount": 123
    }
  ],
  "customerAddress": "123 Main St, New York, NY 10001",
  "customerPhone": "+1234567890",
  "taxRate": 0,
  "currency": "USD",
  "notes": "Payment due within 7 days",
  "terms": "Services described above have been delivered as agreed.",
  "purpose": "Website development services",
  "requireSignature": true,
  "nonDisputeClause": "<string>",
  "acceptsCard": true,
  "acceptsCrypto": false
}
'
{
  "success": true,
  "data": {
    "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"
  }
}

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

Body

application/json
​
customerName
string
required
Example:

"John Smith"

​
customerEmail
string
required
Example:

"john@example.com"

​
dueAt
string
required

Due date

Example:

"2026-04-16T00:00:00.000Z"

​
items
object[]
required
​
customerAddress
string
Example:

"123 Main St, New York, NY 10001"

​
customerPhone
string
Example:

"+1234567890"

​
taxRate
number

Tax rate as decimal (e.g. 0.075 = 7.5%)

Example:

0

​
currency
string
Example:

"USD"

​
notes
string
Example:

"Payment due within 7 days"

​
terms
string
Example:

"Services described above have been delivered as agreed."

​
purpose
string
Example:

"Website development services"

​
requireSignature
boolean

Require customer signature before payment

Example:

true

​
nonDisputeClause
string

Custom non-dispute clause text

​
acceptsCard
boolean
Example:

true

​
acceptsCrypto
boolean
Example:

false

Response

Created

​
success
boolean
required
Example:

true

​
data
object
required