Invoices

Create an invoice

Changed on

Create a new invoice for the organization

post/ar/invoices

Request

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

Request body

achDebitEnabledboolean required

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

ccEmailsEmail[] required

Emails to be CCed on invoice notifications/reminders.

creditCardEnabledboolean required

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

customerIdstring uuid required

The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first.

destinationAccountIdstring uuid required

The Mercury account where invoice payments will be deposited. Use the /api/v1/accounts endpoint to list your accounts and find the corresponding id. Only checking and savings accounts are supported.

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 nullable

The payer facing invoice number/identifier.

payerMemostring nullable

Memo for the payer of the invoice.

poNumberstring nullable

Purchase order number for the invoice, if applicable.

sendEmailOption'DontSend' | 'SendNow'
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. Virtual accounts are safer and are preferred in most cases.

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 subschema #2 from the request property allOf list

    • 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 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

  • 8d7175961454Revision changes
    • info

      added the new optional request property