Credit Notes

Endpoints

GET /v1/credit-notes/
GET /v1/credit-notes/:id/
POST /v1/credit-notes/
PATCH /v1/credit-notes/:id/
DELETE /v1/credit-notes/:id/
GET /v1/credit-notes/:id/download/
GET /v1/credit-notes/:id/line-items/
POST /v1/credit-notes/:id/line-items/:line_item_id/
PATCH /v1/credit-notes/:id/line-items/:line_item_id/
DELETE /v1/credit-notes/:id/line-items/:line_item_id/

Credit Note object

Attributes	Type	Description
id	`string`	The id of the object.
amount	`number`	The credit note amount.
contact	`string`	The id of the contact.
currency	`string`	The currency used in the credit note.
credit_note_number	`string`	The credit note number.
credit_note_date	`string`	The date of the credit note.
language	`string`	The language used in the credit note.
line_items	`array`	The line items of the credit note.
place_of_supply	`string`	Only required if your organization is in the UAE: one of `ABU_DHABI`, `AJMAN`, `DUBAI`, `FUJAIRAH`, `RAS_AL_KHAIMAH`, `SHARJAH`, `UMM_AL_QUWAIN` or `OUTSIDE_UAE`
reference	`string`	The reference of the credit note.
status	`string`	The status of the credit note.
tax_amount	`number`	The tax amount.
tax_amount_type	`string`	Either `TAX_INCLUSIVE` or `TAX_EXCLUSIVE`.

Example

{
    "amount": 115.0,
    "contact": "co_HS9cspuVZJUHdqVsS9CFfY",
    "currency": "AED",
    "id": "cn_YEdmVKecVi45RYWcrt2rJe",
    "credit_note_date": "2022-10-05",
    "credit_note_number": "CN-000100",
    "language": "en",
    "line_items": [
        {
            "account": "acc_7jpGSFEGGF9cK39vwoDPBt",
            "description": "Line item",
            "id": "cnli_Zhf8cUxzjiRRs8Ga7MCgWE",
            "line_amount": 115.0,
            "quantity": 1.0,
            "tax_amount": 15.0,
            "tax_rate": "tax_c8TkJLeXZYJmWuSjqGzGzj",
            "unit_amount": 100.0
        }
    ],
    "place_of_supply": "SHARJAH",
    "reference": "",
    "status": "DRAFT",
    "tax_amount": 15.0,
    "tax_amount_type": "TAX_EXCLUSIVE"
}

Get credit note

Endpoint

GET /v1/credit-notes/:id/

Response sample

{
    "amount": 115.0,
    "contact": "co_HS9cspuVZJUHdqVsS9CFfY",
    "currency": "AED",
    "id": "cn_YEdmVKecVi45RYWcrt2rJe",
    "credit_note_date": "2022-10-05",
    "credit_note_number": "CN-000100",
    "language": "en",
    "line_items": [
        {
            "account": "acc_7jpGSFEGGF9cK39vwoDPBt",
            "description": "Line item",
            "id": "cnli_Zhf8cUxzjiRRs8Ga7MCgWE",
            "line_amount": 115.0,
            "quantity": 1.0,
            "tax_amount": 15.0,
            "tax_rate": "tax_c8TkJLeXZYJmWuSjqGzGzj",
            "unit_amount": 100.0
        }
    ],
    "reference": "",
    "status": "DRAFT",
    "tax_amount": 15.0,
    "tax_amount_type": "TAX_EXCLUSIVE"
}

List credit notes

Endpoint

GET /v1/credit-notes/

Filters

Query param	Type	Description
contact	`string`	The id of the contact.
credit_note_date	`string`	The credit note date in `YYYY-MM-DD` e.g. `2021-01-01`.

Request

curl --location \
    --request GET 'https://api.wafeq.com/v1/credit-notes/' \
    --header 'Authorization: Api-Key <api_key>' \
    --header 'Content-Type: application/json'

Create credit note

Endpoint

POST /v1/credit-notes/

Request body

Attributes	Type	Description
amount	`number`	The credit note amount. (Required)
contact	`string`	The id of the contact. (Required)
currency	`string`	The currency used in the credit note. (Required)
credit_note_number	`string`	The credit note number. (Required)
credit_note_date	`string`	The date of the credit note. (Required)
language	`string`	The language used in the credit note.
line_items	`array`	The line items of the credit note. (Required)
place_of_supply	`string`	The place of supply in the UAE (Required if and only if the organization is in the UAE)
reference	`string`	The reference of the credit note.
tax_amount	`number`	The tax amount.
tax_amount_type	`string`	Either `TAX_INCLUSIVE` or `TAX_EXCLUSIVE`.

Request

curl --location \
    --request POST 'https://api.wafeq.com/v1/credit-notes/' \
    --header 'Authorization: Api-Key <api_key>' \
    --header 'Content-Type: application/json' \
      --data-raw '{
	"contact": "<contact>",
	"currency": "SAR",
	"credit_note_date": "2022-07-19",
	"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"
}'

Update credit note

PATCH /v1/credit-notes/:id/

Request body

Attributes	Type	Description
id	`string`	The id of the object.
amount	`number`	The credit note amount.
contact	`string`	The id of the contact.
currency	`string`	The currency used in the credit note.
credit_note_number	`string`	The credit note number.
credit_note_date	`string`	The date of the credit note.
language	`string`	The language used in the credit note.
place_of_supply	`string`	The place of supply in the UAE
reference	`string`	The reference of the credit note.
tax_amount_type	`string`	Either `TAX_INCLUSIVE` or `TAX_EXCLUSIVE`.

To update the line items, you need to use the credit notes line items endpoints.

Delete credit note

DELETE /v1/credit-notes/:id/

Download credit note

GET /v1/credit-notes/:id/download/

Credit Note line item object

Attribute	Type	Description
account	`string`	The id of the account.
description	`string`	The description of the line item.
id	`string`	The id of the object.
line_amount	`number`	The line amount.
quantity	`number`	The quantity.
tax_amount	`number`	The tax amount.
tax_rate	`string`	The id of the tax rate.
unit_amount	`number`	The unit amount.

Example

{
    "account": "acc_7jpGSFEGGF9cK39vwoDPBt",
    "description": "Line item",
    "id": "cnli_Zhf8cUxzjiRRs8Ga7MCgWE",
    "line_amount": 115.0,
    "quantity": 1.0,
    "tax_amount": 15.0,
    "tax_rate": "tax_c8TkJLeXZYJmWuSjqGzGzj",
    "unit_amount": 100.0
}

Get credit note line item

Endpoint

POST /v1/credit-notes/:id/line-item/

Response sample

{
    "account": "acc_7jpGSFEGGF9cK39vwoDPBt",
    "description": "Line item",
    "id": "cnli_Zhf8cUxzjiRRs8Ga7MCgWE",
    "line_amount": 115.0,
    "quantity": 1.0,
    "tax_amount": 15.0,
    "tax_rate": "tax_c8TkJLeXZYJmWuSjqGzGzj",
    "unit_amount": 100.0
}

List credit note line items

Endpoint

GET /v1/credit-notes/:id/line-items/

Filters

Query param	Type	Description
account	`string`	The id of the account.

Create credit note line item

Endpoint

POST /v1/credit-notes/:id/line-items/

Request body

Attributes	Type	Description
account	`string`	The id of the account.
description	`string`	The description of the line item.
quantity	`number`	The quantity.
tax_rate	`string`	The id of the tax rate.
unit_amount	`number`	The unit amount.

Update credit note line item

PATCH /v1/credit-notes/:id/line-items/:line_item_id/

Request body

Attributes	Type	Description
account	`string`	The id of the account.
description	`string`	The description of the line item.
quantity	`number`	The quantity.
tax_rate	`string`	The id of the tax rate.
unit_amount	`number`	The unit amount.

Delete credit note line item

DELETE /v1/credit-notes/:id/line-items/:line_item_id/