Partial update debit note

patch

https://api.wafeq.com/v1/debit-notes/{id}/

Endpoint for partially updating an existing debit note.

Path Params

string

required

Body Params

A debit note received from a supplier.

attachments

array of strings

Any files or documents attached to this debit note.

attachments

branch

string | null

The branch associated with this debit note.

contact

string

The contact (customer) associated with this debit note.

currency

string

enum

The currency used for this debit note.

View the enum reference

custom_fields

object

A mapping of custom field IDs to their values.

debit_note_date

date

The date when the debit note was issued.

debit_note_number

string

The unique number assigned to this debit note.

exchange_rate

double | null

The exchange rate to the organization base currency at the time of the document.

external_id

string

length ≤ 255

External identifier for the debit note.

line_items

array of objects

The individual line items included in this debit note.

line_items

notes

string

Any additional notes or comments related to this debit note.

order_number

string

length ≤ 100

An optional order number associated with this debit note.

project

string | null

The project associated with this debit note, if applicable.

reference

string

An optional reference number or code for this debit note.

status

string

enum

Defaults to DRAFT

The current status of the debit note (draft or posted).

View the enum reference

Allowed:

tax_amount_type

string

enum

Specifies whether the tax amount is inclusive or exclusive.

View the enum reference

Allowed:

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200