patch/invoices/{id}

Request

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

Path parameters

idstring required

The ID of the invoice.

Request body

counterparty_idstring
currencystring
descriptionstring
due_datestring date
invoicer_namestring

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.

originating_account_idstring
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.

status'unpaid' | 'paid' | 'voided'

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, unpaid or paid to voided and draft or unpaid to paid

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.

receiving_account_idstring

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

payment_type'ach' | 'eft'

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

fallback_payment_method'ui' | 'manual'

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

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

Changes

    • breaking

      removed the enum value void of the request property

    • info

      added the new paid enum value to the request property

    • info

      added the new voided enum value to the request property