Create Invoice

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
customer_idstringRequired

Required: Customer ID - must exist in customers table - “{{customer_id}}

invoice_typestringRequired

Optional: Invoice type - standard|recurring|progress|write_off - “standard”

payment_termsstringRequired

Optional: Payment terms - string - “net_30”

customer_notesstringRequired

Optional: Notes visible to customer - max 2000 chars - “Thank you for your business”

internal_notesstringRequired

Optional: Internal notes not visible to customer - max 2000 chars - “Priority customer”

billing_location_idstringRequired

Optional: Billing location UUID - must exist in customer_locations - “{{location_id}}

line_items[0][quantity]stringRequired

Required with line_items: Quantity - numeric min:0 - 2

line_items[0][unit_price]stringRequired

Required with line_items: Unit price - numeric min:0 - 150.00

line_items[0][description]stringRequired

Required with line_items: Line item description - string - “HVAC System Maintenance”. When used with work_order_ids, these are appended as additional ad-hoc charges.

customer_signature_requiredstringRequired

Optional: Whether customer signature is required - boolean - false

line_items[0][line_item_type]stringRequired

Required with line_items: Line item type - labor|parts|equipment_rental|service_fee|travel|discount|ad_hoc|service|material|fee|membership

Response

Successful response