Create Invoice

post

https://app.moderntreasury.com/api/invoices

Create a new invoice

Body Params

auto_advance

boolean

Defaults to false

When true, the invoice will progress to unpaid automatically and cannot be edited after entering that state. If the invoice fails to progress to unpaid, the errors will be returned and the invoice will not be created.

contact_details

array of objects

The invoicer's contact details displayed at the top of the invoice.

contact_details

counterparty_id

string

required

counterparty_billing_address

object

The counterparty's billing address.

counterparty_shipping_address

object

The counterparty's shipping address where physical goods should be delivered.

currency

string

Defaults to USD

Defaults to USD if not provided.

description

string

due_date

date

required

A date

fallback_payment_method

string

enum

Defaults to manual

When payment_method is automatic: fallback payment method to use when an automatic payment fails.

Allowed:

invoice_line_items

array of objects

An array of invoice line items. The API supports a maximum of 50 invoice line items per invoice. If a greater number of invoice line items is required, please contact support.

invoice_line_items

invoicer_name

string

Name of the issuer for the invoice. Defaults to the Organization name in Modern Treasury.

invoicer_address

object

The invoice issuer's business address.

originating_account_id

string

required

The internal account the invoice should be paid to.

payment_method

string

enum

Defaults to manual

When opening an invoice, whether to show the embedded payment UI, automatically create a payment or rely on manual payment from the recipient.

Allowed:

payment_effective_date

date

When payment_method is automatic: the date that the transaction resulting from the automatically created payment order is to be posted to the participants’ account.

payment_type

string

enum

When payment_method is automatic: payment_type on the automatically created payment order

Allowed:

receiving_account_id

string

When payment_method is automatic: receiving_account_id on the automatically created payment order

notifications_enabled

boolean

If true, the invoice will send email notifications to the invoice recipients about invoice status changes.

notification_email_addresses

array of strings

Emails in addition to the counterparty email to send invoice status notifications to. At least one email is required if notifications are enabled and the counterparty doesn't have an email.

notification_email_addresses

virtual_account_id

string

The virtual account associated with an invoice. The virtual account routing and accounts numbers will be shown on the invoice in place of the internal account information.

recipient_name

string

The name of the recipient of the invoice. Leaving this value as null will fallback to using the counterparty's name.

recipient_email

string

The email of the recipient of the invoice. Leaving this value as null will fallback to using the counterparty's email.

remind_after_overdue_days

array of int32s

A list of days after the due date on which overdue reminder emails should be sent. Maximum length of 3, and maximum value of 365, email notifications must be enabled

remind_after_overdue_days

metadata

json

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