165a6d16a9a0

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Post Invoice

Create a new invoice.

Must reference a valid account via account_id.

Request Body (InvoiceRequest):

  • invoice_num (required): Unique invoice number / identifier.
  • invoice_type (default: "sales"): Values: sales, credit, refund, reimbursement.
  • account_id (required): FK to the customer account.
  • contact_id (optional): FK to the billing contact.
  • stage (default: "draft"): Values: draft, open, paid, cancelled, void, uncollectible.
  • description (optional): Invoice notes.
  • total_amount (required): Final total.
  • invoice_date (optional): Epoch timestamp.
  • invoice_line_list (required): Array of line items, e.g. [{"description":"Widget","amount":99.99,"line_detail_dict":{"qty":1,"unit_price":99.99}}].

Response: The created invoice object.

post/crm/invoices

Request body

invoice_numstring required

Unique invoice number / identifier

invoice_typestring

Possible values: sales, credit, refund, reimbursement

account_idstring required

FK to Accounts (customer)

contact_idstring nullable

FK to AccountContacts (billing contact)

stagestring nullable

Possible values: draft, open, paid, cancelled, void, uncollectible

descriptionstring nullable

Invoice description / notes

total_amountnumber required

Final total amount

invoice_dateinteger nullable

Invoice date (epoch timestamp)

Response

Successful Response

idstring required
namestring nullable
stagestring nullable
descriptionstring nullable
invoice_numstring nullable
total_amountstring nullable
invoice_datestring nullable
created_tsstring nullable
created_ts_datestring nullable
updated_tsstring nullable
updated_ts_datestring nullable
contactstring nullable
opportunitystring nullable