مرجع الواجهة البرمجية
عروض الأسعار
مسودات عروض الأسعار، وتأكيد كل منها إلى أمر بيع واحد. عرض السعر لا يستهلك رصيدًا.
الأوصاف التقنية أدناه بالإنجليزية كما يولّدها خادم الواجهة، وهي اللغة التي تُكتب بها رسائل الأخطاء أيضًا. العناوين والجداول بالعربية.
- POSTإنشاء عرض سعر
- GETعرض القائمة
- PUTتعديل عرض سعر
- GETقراءة مستند
- POSTالتأكيد إلى أمر بيع
- POSTإلغاء عرض سعر
- GETطباعة
إنشاء عرض سعر
POST/quotations
أرسل ترويسة Idempotency-Key.
A draft quotation. Lines name a product by productId or productCode (SKU, then barcode). Requires Idempotency-Key.
المعاملات
| الحقل | النوع | الوصف |
|---|---|---|
Idempotency-Keyالترويسةإلزامي | string | 1 to 100 visible ASCII characters, such as a UUID, unique to this request. Sent again with the same request, the first answer is replayed (Idempotent-Replayed: true); with another request, 422 IDEMPOTENCY_KEY_REUSED. |
جسم الطلب
29 حقلًا
| الحقل | النوع | الوصف |
|---|---|---|
lines | object[] | |
lines[].unitPrice | number | What it costs; a product needs no product. VAT-exclusive, as stored. |
lines[].quantity | number | |
lines[].taxRate | number | VAT percent: 5 (standard) or 0 (zero-rated). |
lines[].description | string | |
lines[].productId | string | A product of this company by id … |
lines[].productCode | string | … or by its internal reference (SKU), then its barcode. |
lines[].uom | string | |
lines[].discount | number | Discount percent, 0 to 100. |
lines[].kind | PRODUCT | SECTION | NOTE | |
customerId | string | Required on an invoice. |
issueDate | date | The document's day, YYYY-MM-DD. Defaults to today. |
dueDate | date | |
expiryDate | date | A quotation's expiry day. |
customerRef | string | |
notes | string | |
paymentTermId | string | |
fiscalPositionId | string | |
salespersonId | string | |
salesTeamId | string | |
emirate | ABU_DHABI | DUBAI | SHARJAH | AJMAN | UMM_AL_QUWAIN | RAS_AL_KHAIMAH | FUJAIRAH | |
taxMode | TAX_EXCLUDED | TAX_INCLUDED | |
invoiceAddressId | string | |
deliveryAddressId | string | |
externalId | string | Your system's id for it, kept for good; unique per company. Create only. |
paymentMeansCode | string | UNCL 4461 payment means, such as 30 (credit transfer). |
transactionFlags | FREE_TRADE_ZONE | DEEMED_SUPPLY | MARGIN_SCHEME | SUMMARY_INVOICE | CONTINUOUS_SUPPLY | DISCLOSED_AGENT_BILLING | ECOMMERCE | EXPORTS[] | |
invoicePeriodStart | string | |
invoicePeriodEnd | string |
أمثلة برمجية
curl -sS -X POST "https://app.kwn.tax/api/v1/quotations" \
-H "X-Api-Key: $KWN_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"customerId": "cus_4kq9w2m1",
"issueDate": "2026-10-15",
"dueDate": "2026-11-14",
"customerRef": "PO-7781",
"externalId": "SO-10045",
"lines": [
{
"description": "Office chair, mesh back",
"quantity": 4,
"unitPrice": 450,
"taxRate": 5,
"productCode": "CHR-MESH-01"
},
{
"description": "Delivery within Dubai",
"quantity": 1,
"unitPrice": 100,
"taxRate": 5
}
]
}'الاستجابات
201Created
الحقل النوع الوصف idstringtypeQUOTATION | ORDER | INVOICE | CREDIT_NOTE | DEBIT_NOTEnumberstringstatusDRAFT | SENT | CONFIRMED | ISSUED | SUBMITTED | PROCESSING | APPROVED | REJECTED | FAILED | PAID | CANCELLED | EXPIREDissueDatedatedueDatedateexpiryDatedatecustomerobjectemirateABU_DHABI | DUBAI | SHARJAH | AJMAN | UMM_AL_QUWAIN | RAS_AL_KHAIMAH | FUJAIRAHcurrencystringtaxModeTAX_EXCLUDED | TAX_INCLUDEDcustomerRefstringnotesstringpaymentTermIdstringfiscalPositionIdstringsalespersonIdstringsalesTeamIdstringinvoiceAddressIdstringdeliveryAddressIdstringlinesobject[]subtotalnumberdiscountTotalnumbertaxTotalnumbertotalnumberinvoicedTotalnumberpaidTotalnumbercreditedTotalnumbersourceobjectderivedobject[]originstringAPI, MANUAL, ODOO or POS. externalIdstringclearanceobjecteInvoiceobjectcreatedAtdateupdatedAtdate400Refused: the request or a business rule. The code says which (REQUEST_INVALID, RULE_REFUSED, …).
{ "error": "Lines: at least one line is required.", "code": "REQUEST_INVALID" }401No key, a key that is not ours, or one revoked (API_KEY_INVALID); a merchant not active (MERCHANT_INACTIVE).
{ "error": "That API key is not valid, or it was revoked.", "code": "API_KEY_INVALID" }403The key's scopes do not carry the capability (APP_NOT_GRANTED, ROLE_TOO_LOW), or the plan lacks the app (APP_LOCKED).
{ "error": "This key's scopes do not include sales.approve.", "code": "ROLE_TOO_LOW" }404Not found: another type under this route, or another company's (NOT_FOUND).
{ "error": "Not found.", "code": "NOT_FOUND" }409A conflict: an externalId taken, or a change that could not be saved (EXTERNAL_ID_TAKEN, CONFLICT).
{ "error": "That externalId is already used by another record of this company.", "code": "EXTERNAL_ID_TAKEN" }422That Idempotency-Key was used for a different request (IDEMPOTENCY_KEY_REUSED).
{ "error": "That Idempotency-Key was used for a different request.", "code": "IDEMPOTENCY_KEY_REUSED" }429Too many requests: wait retryAfter seconds (RATE_LIMITED).
{ "error": "Too many requests. Wait a little and try again.", "code": "RATE_LIMITED" }
عرض القائمة
GET/quotations
Newest first, a page at a time: send the previous page's next as cursor. Filter by status, partnerId (the customer), issueFrom/issueTo, number, externalId, createdFrom/createdTo, or updatedSince to poll for changes.
المعاملات
| الحقل | النوع | الوصف |
|---|---|---|
statusالاستعلام | string | A status, by name. |
partnerIdالاستعلام | string | The customer (sales) or the vendor (purchases). |
issueFromالاستعلام | date | Issued on or after this day. |
issueToالاستعلام | date | Issued on or before this day. |
numberالاستعلام | string | |
limitالاستعلام | integer | 1 to 200; 50 by default. |
cursorالاستعلام | string | The previous page's next. |
updatedSinceالاستعلام | date | Only rows changed at or after this instant. |
createdFromالاستعلام | date | |
createdToالاستعلام | date | |
externalIdالاستعلام | string | Only the row your system gave this id. |
أمثلة برمجية
curl -sS -X GET "https://app.kwn.tax/api/v1/quotations" \
-H "X-Api-Key: $KWN_API_KEY"الاستجابات
200OK
الحقل النوع الوصف dataobject[]The rows of this page. nextstringThe cursor of the next page, to send as ?cursor=; null on the last page. 400Refused: the request or a business rule. The code says which (REQUEST_INVALID, RULE_REFUSED, …).
{ "error": "Lines: at least one line is required.", "code": "REQUEST_INVALID" }401No key, a key that is not ours, or one revoked (API_KEY_INVALID); a merchant not active (MERCHANT_INACTIVE).
{ "error": "That API key is not valid, or it was revoked.", "code": "API_KEY_INVALID" }403The key's scopes do not carry the capability (APP_NOT_GRANTED, ROLE_TOO_LOW), or the plan lacks the app (APP_LOCKED).
{ "error": "This key's scopes do not include sales.approve.", "code": "ROLE_TOO_LOW" }404Not found: another type under this route, or another company's (NOT_FOUND).
{ "error": "Not found.", "code": "NOT_FOUND" }409A conflict: an externalId taken, or a change that could not be saved (EXTERNAL_ID_TAKEN, CONFLICT).
{ "error": "That externalId is already used by another record of this company.", "code": "EXTERNAL_ID_TAKEN" }429Too many requests: wait retryAfter seconds (RATE_LIMITED).
{ "error": "Too many requests. Wait a little and try again.", "code": "RATE_LIMITED" }
تعديل عرض سعر
PUT/quotations/{id}
Replaces the header and the lines of a quotation that is still a draft or sent.
المعاملات
| الحقل | النوع | الوصف |
|---|---|---|
idالمسارإلزامي | string |
جسم الطلب
29 حقلًا
| الحقل | النوع | الوصف |
|---|---|---|
lines | object[] | |
lines[].unitPrice | number | What it costs; a product needs no product. VAT-exclusive, as stored. |
lines[].quantity | number | |
lines[].taxRate | number | VAT percent: 5 (standard) or 0 (zero-rated). |
lines[].description | string | |
lines[].productId | string | A product of this company by id … |
lines[].productCode | string | … or by its internal reference (SKU), then its barcode. |
lines[].uom | string | |
lines[].discount | number | Discount percent, 0 to 100. |
lines[].kind | PRODUCT | SECTION | NOTE | |
customerId | string | Required on an invoice. |
issueDate | date | The document's day, YYYY-MM-DD. Defaults to today. |
dueDate | date | |
expiryDate | date | A quotation's expiry day. |
customerRef | string | |
notes | string | |
paymentTermId | string | |
fiscalPositionId | string | |
salespersonId | string | |
salesTeamId | string | |
emirate | ABU_DHABI | DUBAI | SHARJAH | AJMAN | UMM_AL_QUWAIN | RAS_AL_KHAIMAH | FUJAIRAH | |
taxMode | TAX_EXCLUDED | TAX_INCLUDED | |
invoiceAddressId | string | |
deliveryAddressId | string | |
externalId | string | Your system's id for it, kept for good; unique per company. Create only. |
paymentMeansCode | string | UNCL 4461 payment means, such as 30 (credit transfer). |
transactionFlags | FREE_TRADE_ZONE | DEEMED_SUPPLY | MARGIN_SCHEME | SUMMARY_INVOICE | CONTINUOUS_SUPPLY | DISCLOSED_AGENT_BILLING | ECOMMERCE | EXPORTS[] | |
invoicePeriodStart | string | |
invoicePeriodEnd | string |
أمثلة برمجية
curl -sS -X PUT "https://app.kwn.tax/api/v1/quotations/<id>" \
-H "X-Api-Key: $KWN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"customerId": "cus_4kq9w2m1",
"issueDate": "2026-10-15",
"dueDate": "2026-11-14",
"customerRef": "PO-7781",
"externalId": "SO-10045",
"lines": [
{
"description": "Office chair, mesh back",
"quantity": 4,
"unitPrice": 450,
"taxRate": 5,
"productCode": "CHR-MESH-01"
},
{
"description": "Delivery within Dubai",
"quantity": 1,
"unitPrice": 100,
"taxRate": 5
}
]
}'الاستجابات
200OK
الحقل النوع الوصف idstringtypeQUOTATION | ORDER | INVOICE | CREDIT_NOTE | DEBIT_NOTEnumberstringstatusDRAFT | SENT | CONFIRMED | ISSUED | SUBMITTED | PROCESSING | APPROVED | REJECTED | FAILED | PAID | CANCELLED | EXPIREDissueDatedatedueDatedateexpiryDatedatecustomerobjectemirateABU_DHABI | DUBAI | SHARJAH | AJMAN | UMM_AL_QUWAIN | RAS_AL_KHAIMAH | FUJAIRAHcurrencystringtaxModeTAX_EXCLUDED | TAX_INCLUDEDcustomerRefstringnotesstringpaymentTermIdstringfiscalPositionIdstringsalespersonIdstringsalesTeamIdstringinvoiceAddressIdstringdeliveryAddressIdstringlinesobject[]subtotalnumberdiscountTotalnumbertaxTotalnumbertotalnumberinvoicedTotalnumberpaidTotalnumbercreditedTotalnumbersourceobjectderivedobject[]originstringAPI, MANUAL, ODOO or POS. externalIdstringclearanceobjecteInvoiceobjectcreatedAtdateupdatedAtdate400Refused: the request or a business rule. The code says which (REQUEST_INVALID, RULE_REFUSED, …).
{ "error": "Lines: at least one line is required.", "code": "REQUEST_INVALID" }401No key, a key that is not ours, or one revoked (API_KEY_INVALID); a merchant not active (MERCHANT_INACTIVE).
{ "error": "That API key is not valid, or it was revoked.", "code": "API_KEY_INVALID" }403The key's scopes do not carry the capability (APP_NOT_GRANTED, ROLE_TOO_LOW), or the plan lacks the app (APP_LOCKED).
{ "error": "This key's scopes do not include sales.approve.", "code": "ROLE_TOO_LOW" }404Not found: another type under this route, or another company's (NOT_FOUND).
{ "error": "Not found.", "code": "NOT_FOUND" }409A conflict: an externalId taken, or a change that could not be saved (EXTERNAL_ID_TAKEN, CONFLICT).
{ "error": "That externalId is already used by another record of this company.", "code": "EXTERNAL_ID_TAKEN" }429Too many requests: wait retryAfter seconds (RATE_LIMITED).
{ "error": "Too many requests. Wait a little and try again.", "code": "RATE_LIMITED" }
قراءة مستند
GET/quotations/{id}
The document with its lines, where it came from and what came of it, its e-invoice readiness and, for an invoice or credit note, its clearance. A document of another type under this route is NOT_FOUND.
المعاملات
| الحقل | النوع | الوصف |
|---|---|---|
idالمسارإلزامي | string |
أمثلة برمجية
curl -sS -X GET "https://app.kwn.tax/api/v1/quotations/<id>" \
-H "X-Api-Key: $KWN_API_KEY"الاستجابات
200OK
الحقل النوع الوصف idstringtypeQUOTATION | ORDER | INVOICE | CREDIT_NOTE | DEBIT_NOTEnumberstringstatusDRAFT | SENT | CONFIRMED | ISSUED | SUBMITTED | PROCESSING | APPROVED | REJECTED | FAILED | PAID | CANCELLED | EXPIREDissueDatedatedueDatedateexpiryDatedatecustomerobjectemirateABU_DHABI | DUBAI | SHARJAH | AJMAN | UMM_AL_QUWAIN | RAS_AL_KHAIMAH | FUJAIRAHcurrencystringtaxModeTAX_EXCLUDED | TAX_INCLUDEDcustomerRefstringnotesstringpaymentTermIdstringfiscalPositionIdstringsalespersonIdstringsalesTeamIdstringinvoiceAddressIdstringdeliveryAddressIdstringlinesobject[]subtotalnumberdiscountTotalnumbertaxTotalnumbertotalnumberinvoicedTotalnumberpaidTotalnumbercreditedTotalnumbersourceobjectderivedobject[]originstringAPI, MANUAL, ODOO or POS. externalIdstringclearanceobjecteInvoiceobjectcreatedAtdateupdatedAtdate400Refused: the request or a business rule. The code says which (REQUEST_INVALID, RULE_REFUSED, …).
{ "error": "Lines: at least one line is required.", "code": "REQUEST_INVALID" }401No key, a key that is not ours, or one revoked (API_KEY_INVALID); a merchant not active (MERCHANT_INACTIVE).
{ "error": "That API key is not valid, or it was revoked.", "code": "API_KEY_INVALID" }403The key's scopes do not carry the capability (APP_NOT_GRANTED, ROLE_TOO_LOW), or the plan lacks the app (APP_LOCKED).
{ "error": "This key's scopes do not include sales.approve.", "code": "ROLE_TOO_LOW" }404Not found: another type under this route, or another company's (NOT_FOUND).
{ "error": "Not found.", "code": "NOT_FOUND" }409A conflict: an externalId taken, or a change that could not be saved (EXTERNAL_ID_TAKEN, CONFLICT).
{ "error": "That externalId is already used by another record of this company.", "code": "EXTERNAL_ID_TAKEN" }429Too many requests: wait retryAfter seconds (RATE_LIMITED).
{ "error": "Too many requests. Wait a little and try again.", "code": "RATE_LIMITED" }
التأكيد إلى أمر بيع
POST/quotations/{id}/confirm
Confirms the quotation into exactly one sales order and answers the order. Confirmed already: alreadyDone with that order. Costs no credit.
المعاملات
| الحقل | النوع | الوصف |
|---|---|---|
idالمسارإلزامي | string |
أمثلة برمجية
curl -sS -X POST "https://app.kwn.tax/api/v1/quotations/<id>/confirm" \
-H "X-Api-Key: $KWN_API_KEY"الاستجابات
200OK
الحقل النوع الوصف alreadyDonebooleanTrue when the document was already where the action takes it; nothing changed. documentobject400Refused: the request or a business rule. The code says which (REQUEST_INVALID, RULE_REFUSED, …).
{ "error": "Lines: at least one line is required.", "code": "REQUEST_INVALID" }401No key, a key that is not ours, or one revoked (API_KEY_INVALID); a merchant not active (MERCHANT_INACTIVE).
{ "error": "That API key is not valid, or it was revoked.", "code": "API_KEY_INVALID" }403The key's scopes do not carry the capability (APP_NOT_GRANTED, ROLE_TOO_LOW), or the plan lacks the app (APP_LOCKED).
{ "error": "This key's scopes do not include sales.approve.", "code": "ROLE_TOO_LOW" }404Not found: another type under this route, or another company's (NOT_FOUND).
{ "error": "Not found.", "code": "NOT_FOUND" }409A conflict: an externalId taken, or a change that could not be saved (EXTERNAL_ID_TAKEN, CONFLICT).
{ "error": "That externalId is already used by another record of this company.", "code": "EXTERNAL_ID_TAKEN" }429Too many requests: wait retryAfter seconds (RATE_LIMITED).
{ "error": "Too many requests. Wait a little and try again.", "code": "RATE_LIMITED" }
إلغاء عرض سعر
POST/quotations/{id}/cancel
Cancelled already: alreadyDone.
المعاملات
| الحقل | النوع | الوصف |
|---|---|---|
idالمسارإلزامي | string |
أمثلة برمجية
curl -sS -X POST "https://app.kwn.tax/api/v1/quotations/<id>/cancel" \
-H "X-Api-Key: $KWN_API_KEY"الاستجابات
200OK
الحقل النوع الوصف alreadyDonebooleanTrue when the document was already where the action takes it; nothing changed. documentobject400Refused: the request or a business rule. The code says which (REQUEST_INVALID, RULE_REFUSED, …).
{ "error": "Lines: at least one line is required.", "code": "REQUEST_INVALID" }401No key, a key that is not ours, or one revoked (API_KEY_INVALID); a merchant not active (MERCHANT_INACTIVE).
{ "error": "That API key is not valid, or it was revoked.", "code": "API_KEY_INVALID" }403The key's scopes do not carry the capability (APP_NOT_GRANTED, ROLE_TOO_LOW), or the plan lacks the app (APP_LOCKED).
{ "error": "This key's scopes do not include sales.approve.", "code": "ROLE_TOO_LOW" }404Not found: another type under this route, or another company's (NOT_FOUND).
{ "error": "Not found.", "code": "NOT_FOUND" }409A conflict: an externalId taken, or a change that could not be saved (EXTERNAL_ID_TAKEN, CONFLICT).
{ "error": "That externalId is already used by another record of this company.", "code": "EXTERNAL_ID_TAKEN" }429Too many requests: wait retryAfter seconds (RATE_LIMITED).
{ "error": "Too many requests. Wait a little and try again.", "code": "RATE_LIMITED" }
طباعة
GET/quotations/{id}/pdf
The printed document as the app prints it, in English or Arabic (?lang=ar). Counted against the apikey-heavy budget.
المعاملات
| الحقل | النوع | الوصف |
|---|---|---|
idالمسارإلزامي | string | |
langالاستعلام | string |
أمثلة برمجية
curl -sS -X GET "https://app.kwn.tax/api/v1/quotations/<id>/pdf" \
-H "X-Api-Key: $KWN_API_KEY"الاستجابات
200OK
400Refused: the request or a business rule. The code says which (REQUEST_INVALID, RULE_REFUSED, …).
{ "error": "Lines: at least one line is required.", "code": "REQUEST_INVALID" }401No key, a key that is not ours, or one revoked (API_KEY_INVALID); a merchant not active (MERCHANT_INACTIVE).
{ "error": "That API key is not valid, or it was revoked.", "code": "API_KEY_INVALID" }403The key's scopes do not carry the capability (APP_NOT_GRANTED, ROLE_TOO_LOW), or the plan lacks the app (APP_LOCKED).
{ "error": "This key's scopes do not include sales.approve.", "code": "ROLE_TOO_LOW" }404Not found: another type under this route, or another company's (NOT_FOUND).
{ "error": "Not found.", "code": "NOT_FOUND" }409A conflict: an externalId taken, or a change that could not be saved (EXTERNAL_ID_TAKEN, CONFLICT).
{ "error": "That externalId is already used by another record of this company.", "code": "EXTERNAL_ID_TAKEN" }429Too many requests: wait retryAfter seconds (RATE_LIMITED).
{ "error": "Too many requests. Wait a little and try again.", "code": "RATE_LIMITED" }