Create Invoice

Create a new invoice

post/invoices

Request

  • Base URL
    https://app.moderntreasury.com/api
  • URL
    https://app.moderntreasury.com/api/invoices
  • Auth
    HTTP basic

Request body

auto_advanceboolean

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.

counterparty_idstring required
currencystring

Defaults to USD if not provided.

descriptionstring
due_datestring date required

A date

fallback_payment_method'ui' | 'manual'

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

invoicer_namestring

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

originating_account_idstring required

The internal account the invoice should be paid to.

payment_method'ui' | 'automatic' | 'manual'

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

payment_effective_datestring 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'ach' | 'eft'

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

receiving_account_idstring

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

notifications_enabledboolean

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

notification_email_addressesstring[]

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.

virtual_account_idstring

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_namestring

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

recipient_emailstring

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

remind_after_overdue_daysinteger[]

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

metadatastring json

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

Changes

No recorded changes to this operation across all 2 revisions of this API.