WAwafeq
Invoices

Update invoice

Changed on

Endpoint for updating an existing invoice.

put/invoices/{id}/

Request

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

An ISO 4217 currency code.

View the enum reference

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.

is_summaryboolean

Whether this invoice summarizes transactions over a period.

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 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.

rounding_amountnumber double required

The payable rounding amount for tax inclusive documents.

status'DRAFT' | 'SENT' | 'FINALIZED'

The processing status of a sales document.

View the enum reference

summary_period_endstring date nullable

The end date of the period covered by this summary invoice. Required when is_summary is true.

summary_period_startstring date nullable

The start date of the period covered by this summary invoice. Required when is_summary is true.

tax_amountnumber double required

The total tax amount applied to this 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, 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

An ISO 4217 currency code.

View the enum reference

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.

is_summaryboolean

Whether this invoice summarizes transactions over a period.

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 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.

rounding_amountnumber double required

The payable rounding amount for tax inclusive documents.

status'DRAFT' | 'SENT' | 'FINALIZED'

The processing status of a sales document.

View the enum reference

summary_period_endstring date nullable

The end date of the period covered by this summary invoice. Required when is_summary is true.

summary_period_startstring date nullable

The start date of the period covered by this summary invoice. Required when is_summary is true.

tax_amountnumber double required

The total tax amount applied to this 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, if applicable.

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)

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      added to the // response property oneOf list for the response status

    • 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 the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

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

    • info

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

    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • 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

      removed from the // response property oneOf 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

    • info

      added the required property to the response with the status