Updates an invoice: its header fields, its status (approve only) and its lines.
Every field is optional, and a field left out keeps its value. Reference,
InvoiceTemplateId, InvoiceEmailTemplateId and BrandingThemeId clear
with null; with no template set, the service provider’s default applies.
InvoiceDate, DueDate, StatusId and LineItems are not clearable,
and null leaves them alone. DueDate may not be earlier than InvoiceDate.
Which invoices can change. Draft, Submitted and Approved, including an Approved
invoice that is part paid; if its new total falls below what has been paid,
AmountDue reads 0. A Paid or Void invoice is refused with 409 - reverse a payment
first; a void invoice is final.
Status.StatusId accepts only 5 (Approved), from Draft or Submitted. Approving
pushes the invoice to the connected accounting system, as the app does, and an invoice
whose total is 0 is recorded as Paid instead - check Status on the response. To mark
an invoice paid use POST /v1/payments; to void or delete it, DELETE.
Lines. Sending LineItems replaces the set, matched by line Id, so send
every line you want to keep (at most 100). An entry with an Id on this invoice is
updated in place and a field left out of it is kept; an entry with no Id is a new
line, needing ItemId and Quantity, with the same fallbacks to the item as
POST /v1/invoices; an existing line left out is removed, and the time, ticket charge
or contract charge it billed goes back to waiting to be invoiced. A bundle line’s
Id acts on the whole bundle. On a line billing a time entry Quantity can’t
change, and a new price or billable status carries through to the time entry. On a line,
Description and CoaCode clear with null and TaxId: null means
no tax. A line that isn’t Billable bills 0. Line amounts, tax and the invoice totals are
calculated, never accepted.
Returns the invoice in the GET /v1/invoices/{invoiceId} shape. Re-sending values
the invoice already holds changes nothing.
授权
Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.
路径参数
Invoice identifier.
请求体
Fields to change.
Partial update of an invoice. Every field is optional: a field left out keeps its value. A
clearable field clears with null.
5 (Approved) is the only value accepted, from Draft or Submitted. Approving pushes the invoice to the connected accounting system, as approving it in the app does. An invoice whose total is 0 is recorded as Paid instead. Sending 5 for an invoice that is already Approved changes nothing. Not clearable.
5
Date of issue, a calendar date. Not clearable.
"2026-09-15T00:00:00.0000000+00:00"
Date payment is due, a calendar date. May not be earlier than InvoiceDate. Not clearable.
"2026-10-15T00:00:00.0000000+00:00"
Free-text reference. Send null to clear it.
"PO-4471-REV"
PDF template for this invoice. Send null to clear it; the service provider's default then applies.
12
Email template for this invoice. Send null to clear it; the service provider's default then applies.
4
Branding theme the synced copy carries in the connected accounting system. Send null to clear it.
Replaces the invoice's lines, matched by line Id. An entry with an Id on this invoice is updated in place; an entry with no Id is added; an existing line left out is removed, and work it was billing (a time entry, a ticket charge, a prorated contract charge) goes back to waiting to be invoiced. A bundle line's Id acts on the whole bundle. An empty array is rejected. Omit the field to leave the lines alone.
响应
OK
100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511 An invoice with its line items, returned by GET /v1/invoices/{invoiceId}.
null