Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
invoiceNumber
string
Minimum string length: 1
clientId
string<uuid>

A crm.companies id — never a clients_orgs id.

contactId
string<uuid>
status
enum<string>
Available options:
draft,
sent,
paid,
overdue,
void
issueDate
string
dueDate
string
currency
string
Required string length: 3
amount
number | null
taxAmount
number | null
totalAmount
number | null
notes
string
branchId
string<uuid>
placeOfSupply
string

2-digit GST state code, e.g. "27" for Maharashtra — never a state abbreviation like "MH".

Pattern: ^\d{2}$
gstTreatment
enum<string>
Available options:
business_gst,
business_none,
overseas,
composition,
consumer,
sez
projectId
string<uuid>
dealId
string<uuid>
periodStart
string<date>
periodEnd
string<date>
recurrenceType
enum<string>

none|weekly|biweekly|monthly|quarterly|annually (or "yearly", normalized to "annually"). On create, a non-"none" value requires nextInvoiceDate.

Available options:
none,
weekly,
biweekly,
monthly,
quarterly,
annually,
yearly
recurrenceInterval
integer
Required range: x >= 1
nextInvoiceDate
string<date>

Required when recurrenceType is not "none" — the recurring-invoice job only picks up invoices with this set.

recurrenceEndDate
string<date>
sourceSystem
string

Both sourceSystem and sourceId must be set, or both omitted.

Required string length: 1 - 100
sourceId
string

Dedup key with sourceSystem: creating again with the same pair returns the existing invoice.

Required string length: 1 - 200
recipientGstin
string
Pattern: ^\d{2}[A-Z]{5}\d{4}[A-Z][1-9A-Z]Z[0-9A-Z]$
expectedVersion
integer | null

Response

200 - application/json

Success

data
object
required