Partial update credit note

patch

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

Endpoint for partially updating an existing credit note.

Path Params

string

required

Body Params

A credit note issued to a customer.

attachments

array of strings

Any files or documents attached to this credit note.

attachments

branch

string | null

The branch associated with this credit note.

contact

string

The contact associated with this credit note.

credit_note_date

date

The date when the credit note was issued.

credit_note_number

string

The unique number assigned to this credit note.

currency

string

enum

The currency used for this credit note.

View the enum reference

custom_fields

object

A mapping of custom field IDs to their values.

discount_cost_center

string

The cost center to which the discount is applied, if applicable.

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 credit note.

language

string

enum

The language of the document.

View the enum reference

Allowed:

line_items

array of objects

The individual line items included in this credit note.

line_items

notes

string

Any additional notes or comments for this credit note.

place_of_supply

string

Only required if your organization is in the UAE: one of ABU_DHABI, AJMAN, DUBAI, FUJAIRAH, RAS_AL_KHAIMAH, SHARJAH, UMM_AL_QUWAIN or OUTSIDE_UAE

project

string | null

The project associated with this credit note, if applicable.

reference

string

An optional reference number or code for this credit note.

status

string

enum

Defaults to DRAFT

The current status of the credit note draft, sent, or finalized.

View the enum reference

Allowed:

tax_amount_type

string

enum

Specifies whether the tax amount is inclusive or exclusive.

View the enum reference

Allowed:

warehouse

string | null

The warehouse associated with this credit note, if applicable.

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

Language

Credentials

Header

Loading…

Response

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

application/json

200