API ReferenceInvoices

Update Invoice

Update an existing invoice. Supports partial updates. Updatable fields: - `title`: Invoice title - `calculationMethod`: Must be "LINE_ITEMS" or "PERCENTAGE" - `lineItems`: Array of line items if calculationMethod is "LINE_ITEMS" - `percentage`: Percentage if calculationMethod is "PERCENTAGE" - `dueDate`: ISO 8601 datetime string - `description`: Invoice description

Authentication

x-api-keystring
API Key authentication via header

Path parameters

invoiceIdstringRequired
Invoice identifier

Request

This endpoint expects an object.
titlestringOptional>=1 character
Invoice title
calculationMethodenumOptional
Calculation method
Allowed values:
statusenumOptional
Invoice status
lineItemslist of objectsOptional
Array of line items
dueDatestringOptionalformat: "date-time"

Due date (ISO 8601 datetime string)

descriptionstring or nullOptional
Invoice description

Response

Invoice updated successfully
idinteger
Invoice identifier
uidinteger
Unique invoice number
titlestring
Invoice title
statusenum
Invoice status
amountdouble
Total invoice amount
amountPaiddouble
Amount paid
calculationMethodstring

Calculation method (e.g., LINE_ITEMS)

createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
descriptionstring or null
Invoice description
typeenum or null
Invoice type
Allowed values:
basedOnIdinteger or null
ID of the record this invoice is based on
basedOnUidinteger or null
UID of the record this invoice is based on
dueDatestring or nullformat: "date-time"
Due date
isArchivedboolean or null
Whether the invoice is archived
sharedWithPortalboolean or null
Whether the invoice is shared with portal
percentagedouble or null
Percentage if applicable
baseAmountdouble or null
Base amount if applicable
accountobject or null
recordobject or null
lineItemslist of objects or null

Errors