Update an invoice

post

https://api.mercury.com/api/v1/ar/invoices/{invoiceId}

Update an existing invoice

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
This endpoint requires you to send all data in full, including optional fields. For example, if an invoice has an internalNote, then sending a request without the internalNote parameter or with null in that field will result in the internal note being deleted. To avoid unintended changes, you can use the GET endpoint to retrieve the latest data for an invoice before updating it.

Path Params

invoiceId

uuid

required

ID for the invoice.

Body Params

The request body to update an invoice.

achDebitEnabled

boolean

required

Whether or not the invoice can be paid via ACH debit.

ccEmails

array of objects

required

List of emails to be CCed on notifications/reminders.

ccEmails*

creditCardEnabled

boolean

required

Whether or not the invoice can be paid via credit card. Requires Stripe to be setup for the Mercury account.

dueDate

date

required

The date the invoice should be paid by. YYYY-MM-DD

internalNote

string | null

Internal note for the invoice, visible by users in the organization but not visible to payers.

invoiceDate

date

required

The date of the invoice, set by the invoice creator. Does not have to be the day the invoice was created. It can be business specific i.e. service/sale date. YYYY-MM-DD

invoiceNumber

string

required

The invoice number.

lineItems

array of objects

required

The line items for the invoice

lineItems*

payerMemo

string | null

Memo for the payer of the invoice.

poNumber

string | null

The purchase order number for the invoice if applicable.

servicePeriodEndDate

date | null

The end date for the service period this invoice covers, if applicable. YYYY-MM-DD

servicePeriodStartDate

date | null

The start date for the service period this invoice covers, if applicable. YYYY-MM-DD

useRealAccountNumber

boolean

required

Whether or not the invoice payment instructions will show the real account and routing number for the destination account or use virtual account numbers instead.

Responses

400

Invalid body

404

invoiceId not found

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200