Accounts5

API Keys2

Approvals1

Balances1

Bill Pay8

Bills17

Cards20

Collection Accounts1

Contacts6

Customers3

Entities19

Feature Access2

Invoices4

Limits2

Line Items2

Partner Onboarding6

Partner Webhooks8

Payment Methods1

Payment Networks2

Products3

Reimbursements1

Routing Numbers1

Security Policies1

Simulations9

Tax Forms2

Transactions2

Transfers18

Users2

Webhooks17

Wire Drawdowns7

get/healthHealth Check

Invoices

Create Invoice

Creates a new invoice. Set save_as_draft to save it as a draft for review in the Meow dashboard instead of sending it.

post/billing/invoices

Request

Base URL
https://api.meow.com/v1
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/meow/apis/meow-api/docs/billing/invoices/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

customer_idstring uuid required

Invoicing customer to bill. Use list_invoicing_customers to find one.

invoice_datestring date required

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

due_datestring date required

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

payment_method_typesPaymentMethodType[] required

Payment method types to enable on the invoice. BANK_TRANSFER is always enabled.

recurring_schedulestring nullable

RFC 5545 RRULE string. Required: DTSTART, RRULE. Allowed frequencies: WEEKLY, MONTHLY.

send_email_on_creationboolean required

If true, sends an email to the customer (and any additional recipients) on the invoice_date. For a draft (save_as_draft), nothing is sent until a Meow user publishes it.

additional_recipient_emailsstring[] nullable

Additional recipient emails to send the invoice and any reminders to.

notestring nullable

Note to include on the invoice.

namestring nullable

Name of the invoice.

collection_account_idstring uuid required

The collection account ID where payments on this invoice will be deposited.

show_contact_addressboolean

Whether to show the customer's address on the invoice, if it exists.

save_as_draftboolean

If true, saves the invoice as a draft. A draft has no invoice number, is not sent, and sends no email, even when send_email_on_creation is true. A Meow user reviews and publishes it in the Meow dashboard. Not supported with recurring_schedule. If false, the invoice is published, and an invoice_date of today or earlier sends it immediately.

Response

Successful Response

idstring uuid required

The unique identifier for the invoice.

namestring nullable

The name of the invoice.

customer_idstring uuid required

The unique identifier for the customer.

amountstring required

The total amount of the invoice.

amount_paidstring required

The amount that has been paid on the invoice.

amount_duestring required

The remaining amount due on the invoice.

invoice_numberstring nullable

The public-facing invoice number.

line_item_idsstring[] required

List of line item IDs associated with the invoice.

invoice_datestring date

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

due_datestring date

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

payment_method_typesPaymentMethodType[] required

List of allowed payment method types for the invoice.

send_email_on_creationboolean required

Whether to send an email upon invoice creation.

additional_recipient_emailsstring[] required

List of additional email addresses to receive the invoice.

notestring nullable

A note associated with the invoice.

collection_account_idstring uuid required

The collection account ID where funds will be collected.

created_atstring date-time required