Update Invoice

patch

https://app.moderntreasury.com/api/invoices/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Attributes of an invoice other than status and metadata can only be updated when the invoice is in the draft state.

Path Params

string

required

The ID of the invoice.

Body Params

counterparty_id

string

counterparty_billing_address

object

counterparty_shipping_address

object

currency

string

description

string

due_date

date

invoicer_name

string

Will update the issuer name if included. Passing in a null or empty string will default the value to the Organization name in Modern Treasury.

invoicer_address

object

originating_account_id

string

payment_method

string

enum

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

Allowed:

status

string

enum

Invoice status must be updated in an individual PATCH request that does not modify any other invoice attributes. Valid state transitions are draft to unpaid, draft or unpaid to void and unpaid to paid

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.

receiving_account_id

string

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

payment_type

string

enum

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

Allowed:

fallback_payment_method

string

enum

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

Allowed:

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

Language

Credentials

Basic

base64

Loading…

Response

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