Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Invoices

Update an invoice

Update an invoice (required scope finance:write)

patch/v1/finance/invoices/{invoiceId}

Path parameters

invoiceIdinteger required

The id of the invoice to update

Headers

Customer-Idinteger required

The customer identifier

Request body

deliverySiteContactIdinteger nullable

The unique identifier of the delivery site contact associated with this invoice, if applicable<br/><br/>Optional: Omit to retain current value or provide null to unset

clientNotesstring nullable

Notes on the invoice. Length must not exceed 3000 characters when provided.<br/><br/>Optional: Omit to retain current value or provide null to unset

internalNotesstring nullable

Internal notes not visible to the client. Length must not exceed 3000 characters when provided.<br/><br/>Optional: Omit to retain current value or provide null to unset

bankAccountIdinteger nullable

The unique identifier of the bank account associated with this invoice, if applicable.<br/>Validation: When provided and not null must be a positive integer within 32-bit bounds and must exist.<br/><br/>Optional: Omit to retain current value or provide null to unset

nominalCodeIdinteger nullable

The unique identifier of the nominal code associated with this invoice, if applicable.<br/>Validation: When provided and not null must be a positive integer within 32-bit bounds and must exist.<br/><br/>Optional: Omit to retain current value or provide null to unset

departmentCodeIdinteger nullable

The unique identifier of the department code associated with this invoice, if applicable.<br/>Validation: When provided and not null must be a positive integer within 32-bit bounds and must exist.<br/><br/>Optional: Omit to retain current value or provide null to unset

referencestring nullable

The reference code for the invoice.<br/>Validation: When provided and not null, must not be empty and can only contain alphanumeric characters, hyphens, underscores, and forward slashes.<br/><br/>Optional: Omit to retain current value or provide null to unset

Example request

{
  "deliverySiteContactId": 56789,
  "clientNotes": "Please pay within 30 days",
  "internalNotes": "Follow up in two weeks",
  "bankAccountId": 34567,
  "nominalCodeId": 45678,
  "departmentCodeId": 23456,
  "reference": "INV-2024/001_A",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content