Partially update an invoice by ID

patch

https://api.maroo.us/v1/invoices/{invoiceId}

With this endpoint, you can perform a partial invoice update by specifying only the field(s) you intend to modify.

The paymentSchedule property expects a payment schedule to replace the previous one, meaning you should provide a new payment schedule which includes the payments you want to keep, new ones you want to add; do not include the payments you want to deleted in the new payment schedule. Complete payments cannot be edited or removed. Read more about updating payment schedules.

Once any payment of the invoice is complete the contact cannot be updated.

To activate a draft invoice, include status: "Active" in the update. This triggers the full activation workflow including client notifications based on the delivery method. You can combine field updates with activation in a single request. Read more about draft invoice workflow.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceId

uuid

required

Invoice ID

Body Params

Invoice information.

contact

object

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

totalAmount

integer

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

New payment schedule to replace the existing one.

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.

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

Error code	Description
`illegal_action`	Invoice cannot be edited (e.g. all payments are complete).
`illegal_action`	Contact not found for the given contact ID.
`illegal_action`	Contact cannot be changed once any payment is complete.
`illegal_action`	Payment cannot be removed because it is already complete or processing.
`illegal_action`	Payment cannot be edited because it is already complete or processing.
`illegal_action`	Payment ID in the schedule does not match any existing payment on this invoice.
`illegal_action`	Cannot revert an active invoice to draft status.
`payment_to_yourself`	Cannot issue an invoice to your own business email.
`plan_limit_exceeded`	Increasing the total amount would exceed your plan's invoice amount limit.

200Updated invoice

400Bad request. Possible causes: Request body validation failed (invalid field types, missing required fields, etc.)

401Unauthorized.

404The specified resource was not found. Error codeDescriptionentity_not_foundInvoice with the given ID was not found or does not belong to your business.