Invoices

Update an invoice

Changed on

Update an existing invoice

post/ar/invoices/{invoiceId}

Request

  • Base URL
    https://api.mercury.com/api/v1
  • URL
    https://api.mercury.com/api/v1/ar/invoices/{invoiceId}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

invoiceIdstring uuid required

ID for the invoice.

Request body

achDebitEnabledboolean required

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

ccEmailsEmail[] required

List of emails to be CCed on notifications/reminders.

creditCardEnabledboolean required

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

dueDatestring date required
internalNotestring nullable

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

invoiceDatestring date required
invoiceNumberstring required

The invoice number.

payerMemostring nullable

Memo for the payer of the invoice.

poNumberstring nullable

The purchase order number for the invoice if applicable.

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

Example request

{
  "dueDate": "2016-07-22",
  "invoiceDate": "2016-07-22"
}

Changes

  • ab652aa5aa8eRevision changes
    • breaking

      added to the // request property allOf list

    • breaking

      the response's property type changed from number to no type for status

    • breaking

      the // response's property type changed from number to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed subschema #2 from the request property allOf list

    • warning

      removed subschema #2 from the request property allOf list

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the // request property type was generalized from number to no type

    • info

      media type application/json was changed to application/json;charset=utf-8 for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

  • 57d0bcefe5d1Revision changes
    • info

      added the required property to the response with the status