API Reference

Partial update invoice

patch
https://api.wafeq.com/v1/invoices//

Endpoint for partially updating an existing invoice.

Path Params
string
required
Body Params
attachments
array of strings

Any files or documents attached to this invoice.

attachments
string | null

The branch associated with this invoice.

string

The contact (customer) associated with this invoice.

credit_notes
array of objects

The credit notes applied to this invoice.

credit_notes
string
enum
  • 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

string

The account to which the discount will be booked, if applicable.

double
≥ 0

The discount amount to apply to the invoice.

string

The cost center associated with the discount, if applicable.

string

The tax rate applied to the discount, if applicable.

double | null

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

string
length ≤ 255

External identifier for the invoice.

date

The date when the invoice was issued.

date

The date by which the invoice should be paid.

string

The unique number assigned to this invoice.

string
enum
Defaults to en
  • ar - Arabic
  • en - English

Full information for LanguageEnum

Allowed:
line_items
array of objects

The individual line items included in this invoice.

line_items
string

Additional notes or comments about the invoice.

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.

string | null

The project associated with this invoice, if applicable.

string

An optional purchase order number or code for this invoice.

string

An optional reference number or code for this invoice.

string
enum
Defaults to DRAFT
  • DRAFT - DRAFT
  • SENT - SENT
  • FINALIZED - FINALIZED

Full information for Status730Enum

Allowed:
string
enum
  • TAX_INCLUSIVE - inc. tax
  • TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

Allowed:
string | null

The warehouse associated with this invoice, if applicable.

Headers
string

Client-provided UUID to uniquely identify a request

Response

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago