Create an invoice

post

https://api.mercury.com/api/v1/ar/invoices

Create a new invoice for the organization

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint generates an invoice. If the sendEmailOption parameter is omitted or is set to sendNow, the invoice will be emailed immediately to the customer identified by the customerId.

If you do not provide an invoiceNumber parameter in the body, the system will attempt to generate one based on the last invoice sent to this customer.

🚧
When creditCardEnabled is set to true in the request body, the API validates that a Stripe account is connected to your organization's Mercury account and performs basic checks to ensure the Stripe account can accept card payments. If these checks fail, the invoice creation request will fail with a 400 response. However, intermittent Stripe errors may still cause credit card payments to fail.

Body Params

The request body to create an invoice.

achDebitEnabled

boolean

required

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

ccEmails

array of objects

required

Emails to be CCed on invoice 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.

currencyCode

string | null

ISO 4217 currency code for the invoice. Defaults to USD if not provided.

customerId

uuid

required

Id of the customer the invoice was sent to.

destinationAccountId

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.

dueDate

date

required

The due 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 and likely to be context specific to the type of transaction. For example, it could be a date a service was performed. YYYY-MM-DD

invoiceNumber

string | null

The payer facing invoice number/identifier.

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

Purchase order number for the invoice, if applicable.

sendEmailOption

string | null

enum

Rules for emailing the new invoice to payers. Can be "DontSend" to skip sending or "SendNow" to send immediately. If omitted, defaults to sending immediately.

Allowed:

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

Responses

400

Invalid body

200