Create an invoice

post

https://api.emaktalk.com/api/v1/billing/invoices

Creates a real invoice against a billing customer — it is issued and becomes payable, so do not use this endpoint to try things out. line_items must be nonempty and every item needs both rate and quantity; the numeric types are declared but not checked at runtime, so send numbers. The whole body is forwarded, and fields beyond the ones listed here are passed along untouched.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customer_id

string

required

The billing customer the invoice is issued to. Required.

date

string

required

Invoice date as YYYY-MM-DD. Required, though the format is not checked here.

line_items

array of objects

required

The invoice lines, at least one. Each needs rate and quantity, and may carry item_id, name, description, discount, tax_id, item_order and any other fields the billing system accepts.

line_items*

invoice_number

string

Invoice number to use instead of the next generated one.

payment_terms

number

Number of days until payment is due.

payment_terms_label

string

Human-readable label for the payment terms, such as Net 30.

due_date

string

Due date as YYYY-MM-DD.

discount

number

Discount applied to the invoice, read according to discount_type.

discount_type

string

Whether discount applies to the whole invoice or to each line — entity_level or item_level. Not validated here.

is_discount_before_tax

boolean

Whether the discount is applied before tax.

exchange_rate

number

Exchange rate to the base currency.

notes

string

Notes shown on the invoice.

terms

string

Terms and conditions shown on the invoice.

shipping_charge

number

Shipping charge added to the invoice.

adjustment

number

Adjustment added to or subtracted from the invoice total.

adjustment_description

string

Label shown beside the adjustment.

custom_fields

array of objects

Custom fields to set on the invoice, each with index, label and value.

custom_fields

allow_partial_payments

boolean

Whether the customer may pay the invoice in parts.

template_id

string

ID of the invoice template to render with.

salesperson_name

string

Salesperson recorded on the invoice.

Responses

201

The created invoice, unwrapped: its ID, number, reference, customer, date, currency, status, total, balance and last payment date, plus any other fields the billing system returns.

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400The body failed validation or could not be parsed, or the invoice could not be created.

403The customer_id is not a billing customer on your account.