Create an invoice

post

https://api.maroo.us/v1/invoices

Invoices are created as active by default and the client is notified based on the delivery method. To create an invoice without notifying the client, set status to "Draft". Read more about draft invoice workflow.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Invoice information.

contact

object

required

Object that contains contact data. Either contact ID or contact information are required.

eventDate

date

required

Event date in ISO 8601 format.

totalAmount

integer

required

Total amount as a minor currency unit (e.g. cents).

paymentMethods

array of objects

length ≥ 1

Allowed payment methods to pay for the invoice. If omitted, allowed payment methods specified in the setting will be used.

paymentSchedule

array of objects

length ≥ 1

List of payments. If omitted, the invoice with one payment with due date as current date and amount as total amount will be created.

paymentSchedule

enableAutoreminders

boolean

Whether automatic reminders to clients enabled. If omitted, the automatic reminders will be enabled.

ccEmails

array of strings

List of emails to CC email notifications.

ccEmails

note

string

length between 1 and 2500

Note to client.

deliveryMethod

string

enum

Invoice delivery method.

Allowed:

status

string

enum

Invoice status.

Draft — Invoice is in draft state. No notifications are sent to the client. Fields can be updated freely.
Active — Invoice is active and visible to the client. Notifications are sent based on the delivery method.

Allowed:

Responses

201Invoice is created

400Bad request.

401Unauthorized.

422Business logic violation.