Invoices

Create a new invoice

Creates a new invoice with line items. Returns the invoice with calculated totals.

post/invoices

Request

  • Base URL: https://api.heffl.com/api/v1
  • URL: https://api.heffl.com/api/v1/invoices
  • Auth: API key in header x-api-key

Request body

clientIdstring required

Client public ID (required)

datestring date-time required

Invoice date

dueDatestring date-time required

Due date

isInclusiveTaxboolean

Whether prices include tax

status'DRAFT' | 'SENT'

Invoice status (DRAFT or SENT)

contactIdstring nullable

Contact public ID

subjectstring nullable

Invoice subject

notesstring nullable

Invoice notes

salesPersonIdstring nullable

Sales person user public ID

templateIdstring nullable

Document template public ID. If not provided, uses the team's default invoice template.

tagsnumber[]

Tag IDs to associate with the invoice

Response

OK

idstring required

Invoice public ID

numberstring required

Auto-generated invoice number

datestring date-time required

Invoice date

dueDatestring date-time required

Invoice due date

statusstring required

Invoice status

clientIdstring nullable

Client public ID

contactIdstring nullable

Contact public ID

currencystring required

Currency code

isInclusiveTaxboolean required

Whether prices include tax

subjectstring nullable

Invoice subject

notesstring nullable

Invoice notes

salesPersonIdnumber nullable

Sales person user ID

subTotalnumber required

Subtotal before tax

taxTotalnumber required

Total tax amount

discountTotalnumber required

Total discount amount

totalnumber required

Grand total

pendingTotalnumber required

Amount pending

paidTotalnumber required

Total amount paid

createdAtstring date-time required

When the invoice was created

customFieldsobject nullable

Custom field values

Changes

No recorded changes to this operation across all 1 revision of this API.