Assets5

Assets Category5

Comments5

Company Profile2

Contracts2

Custom Fields5

Customers10

Estimates6

Invoices7

Items4

Jobs8

Lead Source1

Locations5

Material Lists8

Payments5

Pipeline Status1

Projects5

Purchase Orders5

Subtasks5

Tags5

Teams1

Timesheets5

Users1

Vendors2

Version1

Invoices

Create an invoice

Changed on Nov 3, 2026

Create an invoice

post/invoices

Request

Base URL
https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
URL
https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/invoices
Auth
API key in header x-api-key

Request body

customer_idinteger nullable

Required if job_id is not set and is_template is not set or false. Existing customer id.

job_idinteger nullable

Required if is_template is not set or false. Existing job id.

status2 | 3 | 4 | 5 | 6

2 = draft, 3 = invoiced, 4 = paid, 5 = partialy paid, 6 = void.

status_idinteger

Existing invoice type custom status id.

status_workflow_idinteger

Existing invoice type status workflow id.

notesstring

invoiced_dateinteger nullable

Unix timestamp.

due_dateinteger nullable

Unix timestamp.

tax_ratestring required

A number, sent as a string.

is_templateboolean

If true, the invoice will be template.

titlestring

author_idinteger nullable

Existing user id.

location_idinteger nullable

Existing location id.

contract_idinteger nullable

Existing contract id.

commission_typeinteger

commission_percentinteger

invoice_use_logoboolean nullable

invoice_show_line_item_unit_priceboolean nullable

invoice_show_line_item_qtyboolean nullable

invoice_show_line_item_taxedboolean nullable

invoice_show_line_item_totalboolean nullable

invoice_show_line_item_descboolean nullable

invoice_show_line_item_skuboolean nullable

invoice_show_total_taxboolean nullable

invoice_show_job_titleboolean nullable

invoice_show_job_locationboolean nullable

invoice_show_assigned_membersboolean nullable

invoice_show_authorboolean nullable

invoice_show_service_addressboolean nullable

invoice_contract_signature_linesinteger

invoice_amount_due_display_type'remaining_balance' | 'set_amount' | 'percentage_of_total' | 'none'

invoice_amount_due_display_valuestring

invoice_pdf_titlestring

estimate_statusinteger

theme_idinteger nullable

Existing theme id.

internal_notesstring nullable

referencestring nullable

hvinumber

company_profile_idinteger nullable

Existing alternate company profile id.

maintenance_agreement_idinteger nullable

Existing maintenance agreement id.

maintenance_occurrence_idinteger nullable

Existing maintenance occurrence id.

occurrence_datestring nullable

Required when maintenance agreement id is set and maintenance occurrence id is empty.

qbd_class_idinteger nullable

Existing Quickbook Class id.

qbd_discount_idinteger nullable

Existing Quickbook Discount Item id.

qbo_sales_tax_code_idinteger nullable

Existing Quickbook Tax Code id.

Response

Created

errorboolean

false when the request succeeds.

responseobject

The created record.

Changes

Nov 3, 2026ee9f1d863d51 Revision changes
- breaking
  added the new required request property
- breaking
  removed the success response with the status
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the success response with the status

Operation history

Create an invoice

Request

Request body

Response 201Created

Changes

Response