Create Invoice Line Item

post

https://app.moderntreasury.com/api/invoices/{invoice_id}/invoice_line_items

Create a new invoice line item

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Invoice line items can only be added to an invoice in the draft state.
unit_amount is a required attribute. quantity is optional and defaults to 1 when not provided. amount is computed as unit_amount * quantity.

Path Params

invoice_id

string

required

The ID of the invoice the line item belongs to.

Body Params

name

string

required

Name of the line item, typically a product or SKU name.

description

string

An optional free-form description of the line item.

quantity

int32

The number of units of a product or service that this line item is for. Must be a whole number. Defaults to 1 if not provided.

unit_amount

int32

The cost per unit of the product or service that this line item is for, specified in the invoice currency's smallest unit.

unit_amount_decimal

string

The cost per unit of the product or service that this line item is for, specified in the invoice currency's smallest unit. Accepts decimal strings with up to 12 decimals.

direction

string

enum

Defaults to debit

debit indicates that the counterparty owes the business money and increases the invoice's total_amount due. credit has the opposite intention and effect.

Allowed:

metadata

json

Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here!