Skip to main content

Update invoice

PUT 
/api/v1/invoices/:id

PUT /api/v1/invoices/{id}​

Handles the updating of an invoice by id.

Triggered actions are available when updating or creating an invoice.
These are query parameters that can be chained in order to perform additional actions on the entity, these include:

?send_email=true [Saves and sends the invoice]
?mark_sent=true [Saves and marks the invoice as sent]
?paid=true [Saves and marks the invoice as paid]
?amount_paid=100 [Saves and marks the invoice as paid with the given amount]
?cancel=true [Saves and marks the invoice as cancelled]
?save_default_footer=true [Saves the current footer as the default footer]
?save_default_terms=true [Saves the current terms as the default terms]
?retry_e_send=true [Saves and retries the e-send for the invoice]
?redirect=https://example.com [Saves and redirects to the given url]

Request​

Responses​

Returns the invoice object

Response Headers
    X-MINIMUM-CLIENT-VERSION

    The API version

    X-RateLimit-Remaining

    The number of requests left for the time window.

    X-RateLimit-Limit

    The total number of requests in a given time window.

Last updated on