WAwafeq
Simplified Invoices

Partial update simplified invoice

Changed on

Endpoint for partially updating an existing simplified invoice.

patch/simplified-invoices/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/simplified-invoices/{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: branch, contact, contact.persons, journal, line_items, line_items.account, line_items.cost_center, line_items.item, line_items.tax_rate, project, warehouse. 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

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

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'

An ISO 4217 currency code.

View the enum reference

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

The unique identifier of the invoice.

invoice_datestring date

The date of the invoice.

invoice_numberstring

The unique number of the invoice.

language'en' | 'ar'

The language of a document or response.

View the enum reference

legacy_idstring

[Deprecated] The legacy identifier of the invoice.

modified_tsstring date-time

The timestamp in UTC when the invoice was last modified

notesstring

Additional notes or comments for the invoice.

paid_through_accountstring

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.

rounding_amountnumber double

The payable rounding amount for tax inclusive documents.

status'DRAFT' | 'PAID'

The lifecycle status of a simplified invoice.

View the enum reference

tax_amountnumber double

The total tax amount of the invoice.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

Whether amounts include or exclude tax.

View the enum reference

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

An ISO 4217 currency code.

View the enum reference

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'en' | 'ar'

The language of a document or response.

View the enum reference

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.

rounding_amountnumber double required

The payable rounding amount for tax inclusive documents.

status'DRAFT' | 'PAID'

The lifecycle status of a simplified invoice.

View the enum reference

tax_amountnumber double required

The total tax amount of the invoice.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

Whether amounts include or exclude tax.

View the enum reference

warehousestring nullable

The warehouse associated with this invoice.

Changes

  • b8f5e10134b4Revision changes
    • info

      added the new optional query request parameter expand

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status