Create an invoice

post

https://api.digitax.tech/tz/v1/invoices

Creates an invoice with its line items and payments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customer_id

string

required

length ≥ 1

The DigiTax ID of the customer receiving the invoice.

invoice_date

string

required

The invoice date (YYYY-MM-DD)

invoice_amount_type

string

enum

required

Specifies how the invoice amount is represented.

Allowed:

trader_invoice_number

string

required

length ≥ 1

The trader's invoice number, which must be unique per business. This may be the invoice number assigned in the integrator's system.

items

array of objects

required

length ≥ 1

The line items to include in the invoice.

items*

item_id

string

required

length ≥ 1

The DigiTax ID of the item being invoiced.

quantity

number

required

> 0

The quantity of the item being invoiced. Must be greater than 0.

unit_amount

number

required

≥ 0

The amount charged per unit. Must be at least 0.

discount_rate

number

0 to 1

The discount rate applied to the invoice item. Must be between 0 and 1, inclusive, and cannot be positive when fixed_discount is positive.

fixed_discount

number

≥ 0

The fixed discount amount applied to the invoice item. Must be at least 0 and cannot be positive when discount_rate is positive.

description

string

The description of the invoice item.

payments

array of objects

required

length ≥ 1

The payments to record for the invoice.

payments*

type

string

enum

required

The type of payment received.

Allowed:

amount

number

required

> 0

The amount paid. Must be greater than 0.

201Success

defaultError response