Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Invoices

Update invoice

Endpoint for updating an existing invoice.

put/invoices/{id}/

Path parameters

idstring required

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double required

The total amount of the invoice, including taxes.

attachmentsstring[]

Any files or documents attached to this invoice.

balancenumber double required

The remaining balance of the invoice.

branchstring nullable

The branch associated with this invoice.

contactstring required

The contact (customer) associated with this invoice.

created_tsstring date-time required

The timestamp in UTC when the invoice 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.

discount_accountstring

The account to which the discount will be booked, if applicable.

discount_amountnumber double

The discount amount to apply to the invoice.

discount_cost_centerstring

The cost center associated with the discount, if applicable.

discount_tax_ratestring

The tax rate applied to the discount, if applicable.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the invoice.

idstring required

The unique identifier of the invoice.

invoice_datestring date required

The date when the invoice was issued.

invoice_due_datestring date required

The date by which the invoice should be paid.

invoice_numberstring required

The unique number assigned to this invoice.

language'ar' | 'en'
  • ar - Arabic
  • en - English

Full information for LanguageEnum

legacy_idstring required

[Deprecated] The legacy identifier of the invoice.

modified_tsstring date-time required

The timestamp in UTC when the invoice was last modified.

notesstring

Additional notes or comments about the invoice.

place_of_supplystring

The place of supply for UAE organizations. Must be one of: ABU_DHABI, AJMAN, DUBAI, FUJAIRAH, RAS_AL_KHAIMAH, SHARJAH, UMM_AL_QUWAIN or OUTSIDE_UAE.

projectstring nullable

The project associated with this invoice, if applicable.

purchase_orderstring

An optional purchase order number or code for this invoice.

referencestring

An optional reference number or code for this invoice.

status'DRAFT' | 'SENT' | 'FINALIZED'
  • DRAFT - DRAFT
  • SENT - SENT
  • FINALIZED - FINALIZED

Full information for Status730Enum

tax_amountnumber double required

The total tax amount applied to this invoice.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'
  • TAX_INCLUSIVE - inc. tax
  • TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

warehousestring nullable

The warehouse associated with this invoice, if applicable.

Response

amountnumber double required

The total amount of the invoice, including taxes.

attachmentsstring[]

Any files or documents attached to this invoice.

balancenumber double required

The remaining balance of the invoice.

branchstring nullable

The branch associated with this invoice.

contactstring required

The contact (customer) associated with this invoice.

created_tsstring date-time required

The timestamp in UTC when the invoice 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.

discount_accountstring

The account to which the discount will be booked, if applicable.

discount_amountnumber double

The discount amount to apply to the invoice.

discount_cost_centerstring

The cost center associated with the discount, if applicable.

discount_tax_ratestring

The tax rate applied to the discount, if applicable.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the invoice.

idstring required

The unique identifier of the invoice.

invoice_datestring date required

The date when the invoice was issued.

invoice_due_datestring date required

The date by which the invoice should be paid.

invoice_numberstring required

The unique number assigned to this invoice.

language'ar' | 'en'
  • ar - Arabic
  • en - English

Full information for LanguageEnum

legacy_idstring required

[Deprecated] The legacy identifier of the invoice.

modified_tsstring date-time required

The timestamp in UTC when the invoice was last modified.

notesstring

Additional notes or comments about the invoice.

place_of_supplystring

The place of supply for UAE organizations. Must be one of: ABU_DHABI, AJMAN, DUBAI, FUJAIRAH, RAS_AL_KHAIMAH, SHARJAH, UMM_AL_QUWAIN or OUTSIDE_UAE.

projectstring nullable

The project associated with this invoice, if applicable.

purchase_orderstring

An optional purchase order number or code for this invoice.

referencestring

An optional reference number or code for this invoice.

status'DRAFT' | 'SENT' | 'FINALIZED'
  • DRAFT - DRAFT
  • SENT - SENT
  • FINALIZED - FINALIZED

Full information for Status730Enum

tax_amountnumber double required

The total tax amount applied to this invoice.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'
  • TAX_INCLUSIVE - inc. tax
  • TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

warehousestring nullable

The warehouse associated with this invoice, if applicable.