Update Invoice

patch

https://api.operating.app/v1/invoices/{id}

Updates the invoice with the given id.

Invoices are financial documents between a company and a client. They include details such as the invoice date, number, amount, and status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique id of this record.

Body Params

name

string

length between 1 and 5000

The name of the invoice

companyId

string

The ID of the invoicer company

clientId

string

The ID of the recipient client

invoiceDate

string

The date of the invoice

invoicePeriodFrom

string

The start date of the invoice period

invoicePeriodThrough

string

The end date of the invoice period

dueDate

string

The due date of the invoice

paymentTermDays

integer

0 to 1095

The payment term of the invoice in days

status

string

enum

The status of the invoice

Allowed:

note

The note of the invoice

clientAddressId

The ID of the recipient client address

clientContactPersonId

The ID of the recipient client contact person

invoicerContactPersonId

The ID of the invoicer contact person

purchaseOrderNumber

The purchase order number of the invoice

internalNote

The internal note of the invoice

deliveryDate

The delivery date of the invoice

invoiceFooterText

The footer text of the invoice

lineItems

array of objects

lineItems

expenseIds

array of strings

expenseIds

timeEntryIds

array of strings

timeEntryIds

projectAmountAllocations

array of objects

The amount allocated to each project of this invoice. The projects included in this array will be linked to the invoice.

projectAmountAllocations

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

200Successful response

400Invalid input data

401Authorization not provided

403Insufficient access

404Not found

500Internal server error