Update invoice

put

https://api.wafeq.com/v1/invoices/{id}/

Endpoint for updating an existing invoice.

Path Params

string

required

Body Params

An invoice issued to a customer.

attachments

array of strings

Any files or documents attached to this invoice.

attachments

branch

string | null

The branch associated with this invoice.

contact

string

required

The contact (customer) associated with this invoice.

credit_notes

array of objects

The credit notes applied to this invoice.

credit_notes

currency

string

enum

required

The currency code for the invoice.

View the enum reference

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

double

≥ 0

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

double | null

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

external_id

string

length ≤ 255

External identifier for the invoice.

invoice_date

date

required

The date when the invoice was issued.

invoice_due_date

date

required

The date by which the invoice should be paid.

invoice_number

string

required

The unique number assigned to this invoice.

is_summary

boolean

Whether this invoice summarizes transactions over a period.

language

string

enum

Defaults to en

The language in which the invoice is written.

View the enum reference

Allowed:

line_items

array of objects

required

The individual line items included in this invoice.

line_items*

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

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

string

enum

Defaults to DRAFT

The current status of the invoice (draft, sent, or finalized).

View the enum reference

Allowed:

summary_period_end

date | null

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

summary_period_start

date | null

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

tax_amount_type

string

enum

Specifies whether the tax amount is inclusive or exclusive.

View the enum reference

Allowed:

warehouse

string | null

The warehouse associated with this invoice, if applicable.

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200