API Reference

Partial update bill

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

Endpoint for partially updating an existing bill.

Path Params
string
required
Body Params
attachments
array of strings

List of attachments linked to this bill.

attachments
date

The date when the bill was issued.

date

The date by which the bill should be paid.

string

The unique identifier or number assigned to this bill.

string | null

The branch associated with this bill, if applicable.

string

The contact (vendor) associated with this bill.

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

custom_fields
object

A mapping of custom field IDs to their values.

debit_notes
array of objects

The debit notes applied to this bill for payment or adjustment.

debit_notes
double | null

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

string
length ≤ 255

External identifier for the bill.

string
enum
  • ar - Arabic
  • en - English

Full information for LanguageEnum

Allowed:
line_items
array of objects

The individual line items that make up the bill.

line_items
string

Any additional notes or comments related to the bill.

string

The order number associated with this bill, if any.

string | null

The project associated with this bill, if any.

string

Any additional reference information for this bill.

string
enum
Defaults to DRAFT
  • DRAFT - DRAFT
  • AUTHORIZED - AUTHORIZED
  • PAID - PAID

Full information for BillStatusEnum

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

Full information for TaxAmountTypeEnum

Allowed:
Headers
string

Client-provided UUID to uniquely identify a request

Response

Updated about 10 hours ago

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

Updated about 10 hours ago