Skip to main content
POST
Generate an advance invoice

Path Parameters

Request Body

Generates a single invoice that covers the specified number of upcoming billing periods. Each period appears as a separate line item on the invoice. The invoice is created with type: "advance" and is immediately finalized.

Example Request

Response

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Body

application/json
periods
integer
required
Required range: x >= 1

Response

Advance invoice created.

id
string<uuid>
tenant_id
string<uuid>
subscription_id
string<uuid> | null
customer_id
string<uuid>
invoice_number
string
billing_reason
string
amount_due
integer<int64>
amount_paid
integer<int64>
currency
string
subtotal
integer<int64>
tax_amount
integer<int64>
total
integer<int64>
tax_regime
enum<string>

Presentation regime (how the invoice is displayed, not how it was taxed), from the seller's jurisdiction. gst shows GSTIN/HSN/ CGST-SGST-IGST/IRN; sales_tax, vat and plain show a single tax line and hide every GST artifact. Computed at read time; not persisted.

Available options:
gst,
sales_tax,
vat,
plain
igst_amount
integer<int64>
cgst_amount
integer<int64>
sgst_amount
integer<int64>
hsn_code
string
irn
string

Invoice Reference Number issued by the IRP (Indian e-invoicing).

ack_no
string
signed_qr_code
string
e_invoice_status
string
ack_date
string
e_invoice_retry_count
integer
e_invoice_next_retry_at
string<date-time> | null
e_invoice_error_message
string
tds_amount
integer<int64>
status
enum<string>
Available options:
draft,
open,
paid,
void,
uncollectible,
past_due
created_at
string<date-time>
due_date
string<date-time>
paid_at
string<date-time>
payment_terms
string
exchange_rate
number
base_currency_total
integer<int64>
base_currency
string
next_retry_at
string<date-time>
retry_count
integer
payment_wall_active
boolean
line_items
object[]

Itemized invoice lines. Each line carries its own HSN/SAC code and per-line GST breakdown; line amounts and per-line taxes reconcile exactly to subtotal/tax_amount. Omitted for legacy invoices created before itemization.