Partial update debit note

Endpoint for partially updating an existing debit note.

idstring required

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double

The total amount of the debit note, including taxes.

attachmentsstring[]

Any files or documents attached to this debit note.

balancenumber double

The remaining balance of the debit note.

branchstring nullable

The branch associated with this debit note.

contactstring

The contact (customer) associated with this debit note.

created_tsstring date-time

The timestamp in UTC when the debit note was created

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW'

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
...

Full information for CurrencyEnum

custom_fieldsobject

A mapping of custom field IDs to their values.

debit_note_datestring date

The date when the debit note was issued.

debit_note_numberstring

The unique number assigned to this debit note.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the debit note.

idstring

The unique identifier of the debit note.

legacy_idstring

[Deprecated] The legacy identifier of the debit note.

modified_tsstring date-time

The timestamp in UTC when the debit note was last modified

notesstring

Any additional notes or comments related to this debit note.

order_numberstring

An optional order number associated with this debit note.

projectstring nullable

The project associated with this debit note, if applicable.

referencestring

An optional reference number or code for this debit note.

status'DRAFT' | 'POSTED'

DRAFT - DRAFT
POSTED - POSTED

Full information for Status313Enum

tax_amountnumber double

The total tax amount applied to this debit note.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

TAX_INCLUSIVE - inc. tax
TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

Response

amountnumber double required

The total amount of the debit note, including taxes.

attachmentsstring[]

Any files or documents attached to this debit note.

balancenumber double required

The remaining balance of the debit note.

branchstring nullable

The branch associated with this debit note.

contactstring required

The contact (customer) associated with this debit note.

created_tsstring date-time required

The timestamp in UTC when the debit note was created

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
...

Full information for CurrencyEnum

custom_fieldsobject

A mapping of custom field IDs to their values.

debit_note_datestring date required

The date when the debit note was issued.

debit_note_numberstring required

The unique number assigned to this debit note.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the debit note.

idstring required

The unique identifier of the debit note.

legacy_idstring required

[Deprecated] The legacy identifier of the debit note.

modified_tsstring date-time required

The timestamp in UTC when the debit note was last modified

notesstring

Any additional notes or comments related to this debit note.

order_numberstring

An optional order number associated with this debit note.

projectstring nullable

The project associated with this debit note, if applicable.

referencestring

An optional reference number or code for this debit note.

status'DRAFT' | 'POSTED'

DRAFT - DRAFT
POSTED - POSTED

Full information for Status313Enum

tax_amountnumber double required

The total tax amount applied to this debit note.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

TAX_INCLUSIVE - inc. tax
TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

v1

Partial update debit note

Path parameters

Headers

Request body

Response