---
title: "Partial update invoice"
method: PATCH
path: "/invoices/{id}/"
tags: ["Invoices"]
---

# Partial update invoice

`PATCH /invoices/{id}/`

Endpoint for partially updating an existing invoice.

## Path parameters

- `id` string, required

## Headers

- `X-Wafeq-Idempotency-Key` string

## Request body

- PatchedInvoice — Adds nested create feature
  - `amount` number, double — The total amount of the invoice, including taxes.
  - `attachments` string[] — Any files or documents attached to this invoice.
  - `balance` number, double — The remaining balance of the invoice.
  - `branch` string, nullable — The branch associated with this invoice.
  - `contact` string — The contact (customer) associated with this invoice.
  - `created_ts` string, date-time — The timestamp in UTC when the invoice was created.
  - `credit_notes` InvoiceCreditNote[] — The credit notes applied to this invoice.
    - `amount` number, double, required — The amount of the credit note applied to the invoice.
    - `credit_note` string, required — The unique identifier of the credit note applied to the invoice.
    - `date` string, date — The date when the credit note was applied to the invoice.
  - `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' — * `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](currencyenum)
  - `custom_fields` object — A mapping of custom field IDs to their values.
  - `discount_account` string — The account to which the discount will be booked, if applicable.
  - `discount_amount` number, double — The discount amount to apply to the invoice.
  - `discount_cost_center` string — The cost center associated with the discount, if applicable.
  - `discount_tax_rate` string — The tax rate applied to the discount, if applicable.
  - `exchange_rate` number, double, nullable — The exchange rate to the organization base currency at the time of the document.
  - `external_id` string — External identifier for the invoice.
  - `id` string — The unique identifier of the invoice.
  - `invoice_date` string, date — The date when the invoice was issued.
  - `invoice_due_date` string, date — The date by which the invoice should be paid.
  - `invoice_number` string — The unique number assigned to this invoice.
  - `language` 'ar' | 'en' — * `ar` - Arabic * `en` - English Full information for [LanguageEnum](languageenum)
  - `legacy_id` string — [Deprecated] The legacy identifier of the invoice.
  - `line_items` InvoiceLineItem[] — The individual line items included in this invoice.
    - `account` string, required — The account associated with this line item.
    - `cost_center` string — The cost center associated with this line item.
    - `created_ts` string, date-time, required — The timestamp in UTC when the line item was created.
    - `custom_fields` object — A mapping of custom field IDs to their values.
    - `description` string, required — The detailed description of the line item.
    - `discount` number, double, nullable — The discount as the percentage.
    - `id` string, required — The unique identifier of the line item.
    - `item` string — The item associated with this line item.
    - `item_unit_of_measure` string, nullable — The item unit of measure for this line item.
    - `legacy_id` string, required — [Deprecated] The legacy identifier of the line item.
    - `line_amount` number, double, required — The total amount for this line item (quantity * unit_amount).
    - `modified_ts` string, date-time, required — The timestamp in UTC when the line item was last modified.
    - `order` integer
    - `quantity` number, double, required — The quantity of the item or service.
    - `revenue_recognition` RevenueRecognitionInput
      - `account` string, required — The revenue account used for revenue recognition.
      - `amount` number, double, required — The total amount to recognize.
      - `description` string, required — The description of the revenue recognition.
      - `duration` '3_MONTHS' | '4_MONTHS' | '6_MONTHS' | '12_MONTHS' | '24_MONTHS' | 'CUSTOM', required — * `3_MONTHS` - 3 Months * `4_MONTHS` - 4 Months * `6_MONTHS` - 6 Months * `12_MONTHS` - 12 Months * `24_MONTHS` - 24 Months * `CUSTOM` - Custom Full information for [DurationEnum](durationenum)
      - `end_date` string, date, required — The end date of the revenue recognition schedule.
      - `recognition_type` 'DAILY' | 'MONTHLY', required — * `DAILY` - Daily * `MONTHLY` - Monthly Full information for [RecognitionTypeEnum](recognitiontypeenum)
      - `start_date` string, date, required — The start date of the revenue recognition schedule.
      - `use_entity_date` boolean, required — Whether the revenue recognition start date follows the invoice date.
    - `revenue_recognition_id` string, nullable, required — The unique identifier of the revenue recognition linked to this line item, if any.
    - `tax_amount` number, double, required — The total tax amount for this line item.
    - `tax_rate` string — The tax rate applied to this line item.
    - `unit_amount` number, double, required — The price per unit of the item or service.
  - `modified_ts` string, date-time — The timestamp in UTC when the invoice was last modified.
  - `notes` string — Additional notes or comments about the invoice.
  - `place_of_supply` string — 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.
  - `project` string, nullable — The project associated with this invoice, if applicable.
  - `purchase_order` string — An optional purchase order number or code for this invoice.
  - `reference` string — An optional reference number or code for this invoice.
  - `status` 'DRAFT' | 'SENT' | 'FINALIZED' — * `DRAFT` - DRAFT * `SENT` - SENT * `FINALIZED` - FINALIZED Full information for [Status730Enum](status730enum)
  - `tax_amount` number, double — 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](taxamounttypeenum)
  - `warehouse` string, nullable — The warehouse associated with this invoice, if applicable.

## Response `200`

- Invoice — Adds nested create feature
  - `amount` number, double, required — The total amount of the invoice, including taxes.
  - `attachments` string[] — Any files or documents attached to this invoice.
  - `balance` number, double, required — The remaining balance of the invoice.
  - `branch` string, nullable — The branch associated with this invoice.
  - `contact` string, required — The contact (customer) associated with this invoice.
  - `created_ts` string, date-time, required — The timestamp in UTC when the invoice was created.
  - `credit_notes` InvoiceCreditNote[] — The credit notes applied to this invoice.
    - `amount` number, double, required — The amount of the credit note applied to the invoice.
    - `credit_note` string, required — The unique identifier of the credit note applied to the invoice.
    - `date` string, date — The date when the credit note was applied to the invoice.
  - `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](currencyenum)
  - `custom_fields` object — A mapping of custom field IDs to their values.
  - `discount_account` string — The account to which the discount will be booked, if applicable.
  - `discount_amount` number, double — The discount amount to apply to the invoice.
  - `discount_cost_center` string — The cost center associated with the discount, if applicable.
  - `discount_tax_rate` string — The tax rate applied to the discount, if applicable.
  - `exchange_rate` number, double, nullable — The exchange rate to the organization base currency at the time of the document.
  - `external_id` string — External identifier for the invoice.
  - `id` string, required — The unique identifier of the invoice.
  - `invoice_date` string, date, required — The date when the invoice was issued.
  - `invoice_due_date` string, date, required — The date by which the invoice should be paid.
  - `invoice_number` string, required — The unique number assigned to this invoice.
  - `language` 'ar' | 'en' — * `ar` - Arabic * `en` - English Full information for [LanguageEnum](languageenum)
  - `legacy_id` string, required — [Deprecated] The legacy identifier of the invoice.
  - `line_items` InvoiceLineItem[], required — The individual line items included in this invoice.
    - `account` string, required — The account associated with this line item.
    - `cost_center` string — The cost center associated with this line item.
    - `created_ts` string, date-time, required — The timestamp in UTC when the line item was created.
    - `custom_fields` object — A mapping of custom field IDs to their values.
    - `description` string, required — The detailed description of the line item.
    - `discount` number, double, nullable — The discount as the percentage.
    - `id` string, required — The unique identifier of the line item.
    - `item` string — The item associated with this line item.
    - `item_unit_of_measure` string, nullable — The item unit of measure for this line item.
    - `legacy_id` string, required — [Deprecated] The legacy identifier of the line item.
    - `line_amount` number, double, required — The total amount for this line item (quantity * unit_amount).
    - `modified_ts` string, date-time, required — The timestamp in UTC when the line item was last modified.
    - `order` integer
    - `quantity` number, double, required — The quantity of the item or service.
    - `revenue_recognition` RevenueRecognitionInput
      - `account` string, required — The revenue account used for revenue recognition.
      - `amount` number, double, required — The total amount to recognize.
      - `description` string, required — The description of the revenue recognition.
      - `duration` '3_MONTHS' | '4_MONTHS' | '6_MONTHS' | '12_MONTHS' | '24_MONTHS' | 'CUSTOM', required — * `3_MONTHS` - 3 Months * `4_MONTHS` - 4 Months * `6_MONTHS` - 6 Months * `12_MONTHS` - 12 Months * `24_MONTHS` - 24 Months * `CUSTOM` - Custom Full information for [DurationEnum](durationenum)
      - `end_date` string, date, required — The end date of the revenue recognition schedule.
      - `recognition_type` 'DAILY' | 'MONTHLY', required — * `DAILY` - Daily * `MONTHLY` - Monthly Full information for [RecognitionTypeEnum](recognitiontypeenum)
      - `start_date` string, date, required — The start date of the revenue recognition schedule.
      - `use_entity_date` boolean, required — Whether the revenue recognition start date follows the invoice date.
    - `revenue_recognition_id` string, nullable, required — The unique identifier of the revenue recognition linked to this line item, if any.
    - `tax_amount` number, double, required — The total tax amount for this line item.
    - `tax_rate` string — The tax rate applied to this line item.
    - `unit_amount` number, double, required — The price per unit of the item or service.
  - `modified_ts` string, date-time, required — The timestamp in UTC when the invoice was last modified.
  - `notes` string — Additional notes or comments about the invoice.
  - `place_of_supply` string — 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.
  - `project` string, nullable — The project associated with this invoice, if applicable.
  - `purchase_order` string — An optional purchase order number or code for this invoice.
  - `reference` string — An optional reference number or code for this invoice.
  - `status` 'DRAFT' | 'SENT' | 'FINALIZED' — * `DRAFT` - DRAFT * `SENT` - SENT * `FINALIZED` - FINALIZED Full information for [Status730Enum](status730enum)
  - `tax_amount` number, 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](taxamounttypeenum)
  - `warehouse` string, nullable — The warehouse associated with this invoice, if applicable.

---

[API](https://skmtc.net/wafeq/apis/wafeq-public-api.md) · [All operations](https://skmtc.net/wafeq/apis/wafeq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wafeq/wafeq-public-api/versions/36816b4fce7f/schema)
