WAwafeq
Debit Notes

Update debit note

Changed on

Endpoint for updating an existing debit note.

put/debit-notes/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/debit-notes/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: attachments, branch, contact, contact.persons, journal, line_items, line_items.account, line_items.cost_center, line_items.item, line_items.tax_rate, project. Nested relations are joined with a dot. Pass journal to replace the journal ID with its object (ID, date, currency, reference, notes and timestamps). Documents without a journal still return null. Journal line items are retrieved separately with GET /v1/journal-line-items/?journal={journal_id}.

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

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

An ISO 4217 currency code.

View the enum reference

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.

rounding_amountnumber double required

The payable rounding amount for tax inclusive documents.

status'DRAFT' | 'POSTED'

The posting status of a document.

View the enum reference

tax_amountnumber double required

The total tax amount applied to this debit note.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

Whether amounts include or exclude tax.

View the enum reference

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

An ISO 4217 currency code.

View the enum reference

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.

rounding_amountnumber double required

The payable rounding amount for tax inclusive documents.

status'DRAFT' | 'POSTED'

The posting status of a document.

View the enum reference

tax_amountnumber double required

The total tax amount applied to this debit note.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

Whether amounts include or exclude tax.

View the enum reference

Changes

  • b8f5e10134b4Revision changes
    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • info

      added the new optional query request parameter expand

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status