Endpoints GET /v1/bills/
GET /v1/bills/:id/
POST /v1/bills/
PATCH /v1/bills/:id/
DELETE /v1/bills/:id/
GET /v1/bills/:id/download/
GET /v1/bills/:id/line-items/
POST /v1/bills/:id/line-items/:line_item_id/
PATCH /v1/bills/:id/line-items/:line_item_id/
DELETE /v1/bills/:id/line-items/:line_item_id/
Bill object Attributes Type Description id stringThe id of the object. amount numberThe bill amount. contact stringThe id of the contact. currency stringThe currency used in the bill. bill_number stringThe bill number. bill_date stringThe date of the bill. bill_due_date stringThe due date for the bill. language stringThe language used in the bill. line_items arrayThe line items of the bill. reference stringThe reference of the bill. status stringThe status of the bill. Either DRAFT, AUTHORIZED or PAID tax_amount numberThe tax amount. tax_amount_type stringEither TAX_INCLUSIVE or TAX_EXCLUSIVE.
Example { "amount" : 115.0 , "contact" : "co_MQcEMrcKsUXxTQBJiZqmP3" , "currency" : "SAR" , "id" : "bi_hT9Q7YcYFRFoVasEbAHcPy" , "bill_date" : "2023-02-19" , "bill_number" : "BILL-0121" , "language" : "en" , "line_items" : [ { "account" : "acc_6r7jjse7NGGw7j7j4yk6hr" , "description" : "Line Item" , "id" : "bli_hGr8a2RytAVrPcmpDALGVd" , "line_amount" : 115.0 , "quantity" : 1.0 , "tax_amount" : 15.0 , "tax_rate" : "tax_bMKW4KwKKuFqnevUHfhDVg" , "unit_amount" : 100.0 } ] , "reference" : "A reference to be reused" , "status" : "DRAFT" , "tax_amount" : 15.0 , "tax_amount_type" : "TAX_EXCLUSIVE" }
Get bill Endpoint GET /v1/bills/:id/
List bills Endpoint GET /v1/bills/
Filters Query param Type Description contact stringThe id of the contact. reference stringThe reference of the bill. bill_date stringThe bill date in YYYY-MM-DD e.g. 2021-01-01. bill_due_date stringThe bill due date in YYYY-MM-DD e.g. 2021-05-01.
Request curl --location \ --request GET 'https://api.wafeq.com/v1/bills/' \ --header 'Authorization: Api-Key <api_key>' \ --header 'Content-Type: application/json'
Try it
Create bill Endpoint POST /v1/bills/
Request body Attributes Type Description amount numberThe bill amount. contact stringThe id of the contact. currency stringThe currency used in the bill. bill_number stringThe bill number. bill_date stringThe date of the bill. bill_due_date stringThe due date for the bill. language stringThe language used in the bill. line_items arrayThe line items of the bill. reference stringThe reference of the bill. status stringThe status of the bill. Either DRAFT or AUTHORIZED tax_amount numberThe tax amount. tax_amount_type stringEither TAX_INCLUSIVE or TAX_EXCLUSIVE.
Request curl --location \ --request POST 'https://api.wafeq.com/v1/bills/' \ --header 'Authorization: Api-Key <api_key>' \ --header 'Content-Type: application/json' \ --data-raw '{
"currency": "SAR",
"bill_number": "BILL-0121",
"bill_date": "2023-02-19",
"bill_due_date": "2023-05-19",
"contact": "<contact>",
"language": "en",
"line_items": [
{
"account": "<account>",
"description": "Line Item",
"quantity": 1,
"tax_rate": "<tax_rate>",
"unit_amount": 100
}
],
"reference": "A reference to be reused",
"tax_amount_type": "TAX_EXCLUSIVE"
}'
Try it
Update bill PATCH /v1/bills/:id/
Request body Attributes Type Description id stringThe id of the object. amount numberThe bill amount. contact stringThe id of the contact. currency stringThe currency used in the bill. bill_number stringThe bill number. bill_date stringThe date of the bill. bill_due_date stringThe due date for the bill. language stringThe language used in the bill. reference stringThe reference of the bill. status stringThe status of the bill. Either DRAFT or AUTHORIZED tax_amount_type stringEither TAX_INCLUSIVE or TAX_EXCLUSIVE.
To update the line items, you need to use the bills line items endpoints.
Delete bill DELETE /v1/bills/:id/
Download bill GET /v1/bills/:id/download/
Bill line item object Attribute Type Description account stringThe id of the account. description stringThe description of the line item. id stringThe id of the object. line_amount numberThe line amount. quantity numberThe quantity. tax_amount numberThe tax amount. tax_rate stringThe id of the tax rate. unit_amount numberThe unit amount.
Example { "account" : "acc_7jpGSFEGGF9cK39vwoDPBt" , "description" : "Line item" , "id" : "bli_Zhf8cUxzjiRRs8Ga7MCgWE" , "line_amount" : 115.0 , "quantity" : 1.0 , "tax_amount" : 15.0 , "tax_rate" : "tax_c8TkJLeXZYJmWuSjqGzGzj" , "unit_amount" : 100.0 }
Get bill line item Endpoint POST /v1/bills/:id/line-item/
List bill line items Endpoint GET /v1/bills/:id/line-items/
Filters Query param Type Description account stringThe id of the account.
Create bill line item Endpoint POST /v1/bills/:id/line-items/
Request body Attributes Type Description account stringThe id of the account. description stringThe description of the line item. quantity numberThe quantity. tax_rate stringThe id of the tax rate. unit_amount numberThe unit amount.
Update bill line item PATCH /v1/bills/:id/line-items/:line_item_id/
Request body Attributes Type Description account stringThe id of the account. description stringThe description of the line item. quantity numberThe quantity. tax_rate stringThe id of the tax rate. unit_amount numberThe unit amount.
Delete bill line item DELETE /v1/bills/:id/line-items/:line_item_id/