Update simplified invoice

Endpoint for updating an existing simplified invoice.

idstring required

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double required

The total amount of the invoice.

branchstring nullable

The branch associated with this invoice.

contactstring

The contact 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

exchange_ratenumber double nullable

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

external_idstring

External identifier for the simplified invoice.

idstring required

The unique identifier of the invoice.

invoice_datestring date required

The date of the invoice.

invoice_numberstring

The unique number of the 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 for the invoice.

paid_through_accountstring required

The account through which the invoice was paid.

place_of_supplystring

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

projectstring nullable

The project associated with this invoice.

referencestring

The reference of the invoice.

status'DRAFT' | 'PAID'

DRAFT - DRAFT
PAID - PAID

Full information for SimplifiedInvoiceStatusEnum

tax_amountnumber double required

The total tax amount of the 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.

Response

amountnumber double required

The total amount of the invoice.

branchstring nullable

The branch associated with this invoice.

contactstring

The contact 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

exchange_ratenumber double nullable

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

external_idstring

External identifier for the simplified invoice.

idstring required

The unique identifier of the invoice.

invoice_datestring date required

The date of the invoice.

invoice_numberstring

The unique number of the 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 for the invoice.

paid_through_accountstring required

The account through which the invoice was paid.

place_of_supplystring

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

projectstring nullable

The project associated with this invoice.

referencestring

The reference of the invoice.

status'DRAFT' | 'PAID'

DRAFT - DRAFT
PAID - PAID

Full information for SimplifiedInvoiceStatusEnum

tax_amountnumber double required

The total tax amount of the 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.

v1

Update simplified invoice

Path parameters

Headers

Request body

Response