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.

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

See the "Examples" section for more details.

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 strings

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.

Responses

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.maroo.us/v1/invoices/invoiceId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated invoice

400Bad request.

401Unauthorized.

404The specified resource was not found.

422Business logic violation.