{"info":{"_postman_id":"d65770d0-d011-490b-95a9-4e2d8ccdcc3e","name":"Wafeq Public API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"18349328","collectionId":"d65770d0-d011-490b-95a9-4e2d8ccdcc3e","publishedId":"2s9YsKgrqv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-10T08:08:32.000Z"},"item":[{"name":"Connected Account","item":[{"name":"List","id":"eb7a01d9-3c29-410b-b071-e3a93b7de4b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/connected-accounts/?page=&page_size=","description":"

Endpoint for retrieving a list of connected accounts.

\n","urlObject":{"path":["zatca","connected-accounts",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""}],"variable":[]}},"response":[{"id":"bfd26ba5-c93b-448a-8533-79a7af614502","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/connected-accounts/?page=&page_size=","host":["https://api.wafeq.com/v1"],"path":["zatca","connected-accounts",""],"query":[{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"address\": \"\",\n \"business_category\": \"\",\n \"city\": \"\",\n \"country\": \"BI\",\n \"id\": \"\",\n \"name\": \"\",\n \"tax_registration_number\": \"\"\n },\n {\n \"address\": \"\",\n \"business_category\": \"\",\n \"city\": \"\",\n \"country\": \"BN\",\n \"id\": \"\",\n \"name\": \"\",\n \"tax_registration_number\": \"\"\n }\n ]\n}"}],"_postman_id":"eb7a01d9-3c29-410b-b071-e3a93b7de4b1"},{"name":"Create","id":"dcec53c2-39d6-4d58-ad12-aac1346e2ef8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"address\": \"\",\n \"business_category\": \"\",\n \"city\": \"\",\n \"country\": \"MY\",\n \"id\": \"\",\n \"name\": \"\",\n \"tax_registration_number\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/connected-accounts/","description":"

Endpoint for creating a connected account.

\n","urlObject":{"path":["zatca","connected-accounts",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"2b13e2f5-71f4-410b-aa52-6e489aec73ca","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"address\": \"\",\n \"business_category\": \"\",\n \"city\": \"\",\n \"country\": \"MY\",\n \"id\": \"\",\n \"name\": \"\",\n \"tax_registration_number\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/connected-accounts/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"\",\n \"business_category\": \"\",\n \"city\": \"\",\n \"country\": \"MY\",\n \"id\": \"\",\n \"name\": \"\",\n \"tax_registration_number\": \"\"\n}"}],"_postman_id":"dcec53c2-39d6-4d58-ad12-aac1346e2ef8"},{"name":"Retrieve","id":"e569099d-46d9-4f6f-a8c1-78d2ed621c40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/connected-accounts/:id/","description":"

Endpoint for retrieving a single connected account.

\n","urlObject":{"path":["zatca","connected-accounts",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"9f7758dd-c0fd-476c-9dc6-89290a4c1712","description":{"content":"

(Required) A unique value identifying this connected account.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0b402765-be69-4aa5-be65-39d6c1967fc7","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/connected-accounts/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","connected-accounts",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"\",\n \"business_category\": \"\",\n \"city\": \"\",\n \"country\": \"MY\",\n \"id\": \"\",\n \"name\": \"\",\n \"tax_registration_number\": \"\"\n}"}],"_postman_id":"e569099d-46d9-4f6f-a8c1-78d2ed621c40"},{"name":"Delete","id":"3319e1d5-9072-4cc7-9819-66596d49f75f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.wafeq.com/v1/zatca/connected-accounts/:id/","description":"

Endpoint for deleting a connected account.

\n","urlObject":{"path":["zatca","connected-accounts",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"9984ec47-e57e-4a72-bf54-b0a3506ee98c","description":{"content":"

(Required) A unique value identifying this connected account.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"21f5c366-94fb-45b3-ab3d-99f1137f732b","name":"No response body","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.wafeq.com/v1/zatca/connected-accounts/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","connected-accounts",":id",""],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3319e1d5-9072-4cc7-9819-66596d49f75f"}],"id":"66c594b8-865e-4389-a354-6cb7134d3b35","_postman_id":"66c594b8-865e-4389-a354-6cb7134d3b35","description":""},{"name":"Credit Note","item":[{"name":"List credit notes\n","id":"216d9c67-dbb7-49c7-85f7-002157920a4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/credit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all credit notes.

\n","urlObject":{"path":["zatca","credit-notes",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"d1792b6b-e758-4847-baf7-76ad66b76b82","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/credit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","credit-notes",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"216d9c67-dbb7-49c7-85f7-002157920a4a"},{"name":"Retrieve an credit note\n","id":"fd40f621-5194-4941-897a-5d9e6a97b5bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/credit-notes/:id/","description":"

Retrieves a single credit note.

\n","urlObject":{"path":["zatca","credit-notes",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"b62273a9-2d35-4256-b6c2-30138e6d2c15","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6d388215-d8ca-4511-8387-a3eeaf4b19d8","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/credit-notes/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","credit-notes",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"fd40f621-5194-4941-897a-5d9e6a97b5bf"},{"name":"Download an credit note\n","id":"24d4f550-ba26-45a5-bf02-559f31399629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/credit-notes/:id/download/?type=pdf","description":"

Downloads a single credit note.

\n","urlObject":{"path":["zatca","credit-notes",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"7e62f845-ae4e-4ffc-ad1e-1dc54bfd9968","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c7a35b79-5cf6-4dc7-97eb-32f538b9d5ce","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/credit-notes/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","credit-notes",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"24d4f550-ba26-45a5-bf02-559f31399629"},{"name":"Report an existing credit note\n","id":"d8932c47-6a23-4599-9c94-51c10a8a39b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/credit-notes/:id/report/","description":"

Reports an existing credit note. This endpoint should be used in case the credit note is in a failed state.

\n","urlObject":{"path":["zatca","credit-notes",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"54a7062b-2701-493e-88f6-071ed602bc0a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6a64831d-1ba0-43a7-a679-b1f0bb2c0f1f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/credit-notes/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","credit-notes",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"d8932c47-6a23-4599-9c94-51c10a8a39b4"},{"name":"Send an existing credit note\n","id":"137d6cb5-746f-478c-94c8-f9f018b10ab4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/:id/send/","description":"

Send the credit note using specified channels.

\n","urlObject":{"path":["zatca","credit-notes",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"9ba468f9-305e-496d-96ef-5157680a67f0","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d7bcd441-7edd-4996-a31e-0963def2d0d1","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/credit-notes/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","credit-notes",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"137d6cb5-746f-478c-94c8-f9f018b10ab4"},{"name":"Bulk report credit notes\n","id":"ec755d93-2104-4f5f-82a1-77c285acc989","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"49\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"13\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACL\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"89\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/bulk-report/","description":"

Reports multiple credit notes. Optionally, send the credit note using specified channels.

\n","urlObject":{"path":["zatca","credit-notes","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"1fa2eb1c-ef9e-4bfc-9ce0-40e9e02fe418","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"49\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"13\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACL\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"89\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"ed26ba5e-6f47-4279-b02d-73775a8462c2","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"49\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"13\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACL\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"89\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"37385d74-955d-4f7e-936e-47fcca8467e5","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"49\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"13\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACL\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"89\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"8ce34454-f310-48cf-941d-56e168738e5b","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"49\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"13\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACL\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"89\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"ec755d93-2104-4f5f-82a1-77c285acc989"},{"name":"Bulk validate credit notes\n","id":"fd1f6e7d-7050-431d-b48f-a5fd78437b18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"49\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"13\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACL\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"89\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple credit notes without reporting them.

\n","urlObject":{"path":["zatca","credit-notes","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"5b24bdd2-e1e4-4a8a-82bf-b82795a175a1","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"49\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"13\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACL\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"89\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/credit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","credit-notes","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"fd1f6e7d-7050-431d-b48f-a5fd78437b18"},{"name":"Compliance check credit note\n","id":"10885830-995f-4f69-9808-56522d38534e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","credit-notes","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"94891d77-6775-46d4-8071-a7b3eb3ca7fe","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"10885830-995f-4f69-9808-56522d38534e"},{"name":"Report an credit note\n","id":"3527dbf6-caee-4fc7-aaba-435881c350cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/report/","description":"

Reports a single credit note. Optionally, send the credit note using specified channels.

\n","urlObject":{"path":["zatca","credit-notes","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"cc73f88e-5dc4-467c-846a-10acea3904f2","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"5d5dad53-2378-4814-a2ed-9db57d62078c","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"5ca48ae7-9b38-4c2e-a9e8-4f5a5ef089fb","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"1b94d8b1-c5ff-4404-b109-5c18cd9f793a","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"e391425f-3ffc-446f-bcac-d0f39a9ff64c","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"415aa86e-86ec-4d6b-9f20-cb682c874256","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"3527dbf6-caee-4fc7-aaba-435881c350cf"},{"name":"Status summary of credit notes\n","id":"bff44cca-19ae-48fd-8961-e3129e00bf71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/credit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of credit notes per status

\n","urlObject":{"path":["zatca","credit-notes","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"08dc21f5-13a3-4f43-8386-e98051d1b0ef","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/credit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","credit-notes","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"bff44cca-19ae-48fd-8961-e3129e00bf71"},{"name":"Validation check credit note\n","id":"4bf5f671-053a-4c32-8595-54119aeaa23a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","credit-notes","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"1cf1a3e0-f52a-4707-841e-54c057d830ff","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"ARS\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"AF\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"IQA\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"LF\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"23\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VA\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"55\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/credit-notes/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"4bf5f671-053a-4c32-8595-54119aeaa23a"}],"id":"1a551ade-a1b9-4867-bfff-0183620217ff","_postman_id":"1a551ade-a1b9-4867-bfff-0183620217ff","description":""},{"name":"Debit Note","item":[{"name":"List debit notes\n","id":"1dd97b41-ed83-4d7d-bd95-2841956e2537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/debit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all debit notes.

\n","urlObject":{"path":["zatca","debit-notes",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"0bf5ec7f-4d40-4dd1-ab62-109b6e1e2609","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/debit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","debit-notes",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"1dd97b41-ed83-4d7d-bd95-2841956e2537"},{"name":"Retrieve an debit note\n","id":"19373fb1-91b3-447e-84a3-3c700ffe9de3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/debit-notes/:id/","description":"

Retrieves a single debit note.

\n","urlObject":{"path":["zatca","debit-notes",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"f86e33a0-2e21-49ed-8bb9-a63fa3b3bde2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"cb47a05b-2cb3-408b-b190-5ac985e2a0f9","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/debit-notes/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","debit-notes",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"19373fb1-91b3-447e-84a3-3c700ffe9de3"},{"name":"Download an debit note\n","id":"b568c20f-98a5-40de-a188-eb36b1526c32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/debit-notes/:id/download/?type=pdf","description":"

Downloads a single debit note.

\n","urlObject":{"path":["zatca","debit-notes",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"3054bc3e-dc51-48f0-a9cc-ac13fea38a9a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1034e666-bf0f-4c0e-bd20-fab8b15afb13","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/debit-notes/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","debit-notes",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b568c20f-98a5-40de-a188-eb36b1526c32"},{"name":"Report an existing debit note\n","id":"6293258e-db2b-40a2-82da-944b7b4235a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/debit-notes/:id/report/","description":"

Reports an existing debit note. This endpoint should be used in case the debit note is in a failed state.

\n","urlObject":{"path":["zatca","debit-notes",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"2e4919b9-6b54-49db-b6c6-de09714382dc","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"cf387820-de06-4c71-ac52-e0b98d0eec7b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/debit-notes/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","debit-notes",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"6293258e-db2b-40a2-82da-944b7b4235a4"},{"name":"Send an existing debit note\n","id":"666beb86-027a-40f2-85c5-205e84b3dc14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/:id/send/","description":"

Send the debit note using specified channels.

\n","urlObject":{"path":["zatca","debit-notes",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"7ebf549d-c40f-4eda-97b9-b6e17247598d","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2fa03585-5e79-450b-82f3-2bc88c59cc3a","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/debit-notes/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","debit-notes",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"666beb86-027a-40f2-85c5-205e84b3dc14"},{"name":"Bulk report debit notes\n","id":"c0c97bcb-82bc-4427-8986-70f1c905e1cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"SEK\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAN\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"50\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"26\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"LB\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"YY\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"39\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/bulk-report/","description":"

Reports multiple debit notes. Optionally, send the debit note using specified channels.

\n","urlObject":{"path":["zatca","debit-notes","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"0731f405-a3ad-42b6-b65b-4a12f342b9b6","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"SEK\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAN\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"50\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"26\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"LB\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"YY\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"39\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"43b2a193-0bdf-4b3c-b0fd-b01226c83175","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"SEK\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAN\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"50\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"26\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"LB\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"YY\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"39\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"220ff264-548c-46bd-962b-d4a5c331d81e","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"SEK\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAN\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"50\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"26\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"LB\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"YY\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"39\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"6451d880-9838-4ee6-8698-bbb6f1b2985a","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"SEK\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAN\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"50\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"26\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"LB\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"YY\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"39\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"c0c97bcb-82bc-4427-8986-70f1c905e1cc"},{"name":"Bulk validate debit notes\n","id":"c3ad2243-ec49-4933-a6de-de57de7e1804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"SEK\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAN\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"50\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"26\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"LB\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"YY\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"39\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple debit notes without reporting them.

\n","urlObject":{"path":["zatca","debit-notes","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"43545696-8de8-472e-8c09-e9e5bbe01f26","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"SEK\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAN\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"50\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"26\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"LB\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"YY\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"39\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/debit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","debit-notes","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"c3ad2243-ec49-4933-a6de-de57de7e1804"},{"name":"Compliance check debit note\n","id":"46275d22-3ebc-4050-801f-60e80bb2a74e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","debit-notes","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"bf57e328-b42d-4ac3-962d-faba39957ffe","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"46275d22-3ebc-4050-801f-60e80bb2a74e"},{"name":"Report an debit note\n","id":"991a4406-7105-4ac6-bed1-9dcfaf037e49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/report/","description":"

Reports a single debit note. Optionally, send the debit note using specified channels.

\n","urlObject":{"path":["zatca","debit-notes","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"7c67c894-86c5-42b2-8ed9-2e649df6d736","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"cf321970-658f-44d2-aaa3-9b98443e56ab","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"9116349d-43f5-4f89-9315-e7df86bc4228","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"b6369fce-f298-4319-9a28-917912647b58","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"0b688175-adfc-4c6c-ac3e-74d93fb19de9","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"2fa77d1b-2810-44f8-8590-71fcc80899ef","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"991a4406-7105-4ac6-bed1-9dcfaf037e49"},{"name":"Status summary of debit notes\n","id":"ec33a0eb-a4af-4f88-b639-d883085a354f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/debit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of debit notes per status

\n","urlObject":{"path":["zatca","debit-notes","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"0b19c718-ea77-482e-8d95-c712420c085b","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/debit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","debit-notes","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"ec33a0eb-a4af-4f88-b639-d883085a354f"},{"name":"Validation check debit note\n","id":"bd5bb8a3-5bf5-48c9-a200-9a9eb8b929b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","debit-notes","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"5c676492-0637-4e50-8a4d-c0bffdc521cc","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"LYD\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-36\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AED\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"78\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"11\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"VU\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"9\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/debit-notes/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"bd5bb8a3-5bf5-48c9-a200-9a9eb8b929b6"}],"id":"ee75722a-8b6a-405c-9034-91c5d969637d","_postman_id":"ee75722a-8b6a-405c-9034-91c5d969637d","description":""},{"name":"Device","item":[{"name":"List","id":"a7320a81-234f-4506-8411-109deda6e6af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/devices/?page=&page_size=","description":"

Endpoint for retrieving a list of Devices.

\n","urlObject":{"path":["zatca","devices",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""}],"variable":[]}},"response":[{"id":"3c0a6938-1806-47d4-9a66-ec5ea0dd1af7","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/devices/?page=&page_size=","host":["https://api.wafeq.com/v1"],"path":["zatca","devices",""],"query":[{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"active\"\n },\n {\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"failed\"\n }\n ]\n}"}],"_postman_id":"a7320a81-234f-4506-8411-109deda6e6af"},{"name":"Retrieve","id":"09b78951-f835-4bf5-870d-b351f6342ca5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/devices/:id/","description":"

Endpoint for retrieving a single Device.

\n","urlObject":{"path":["zatca","devices",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"04b128f9-a79f-4152-bd2e-720dce1b1199","description":{"content":"

(Required) A unique value identifying this device.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c3586b52-e2ae-4322-ad42-2de40ac58266","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/devices/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","devices",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"revoked\"\n}"}],"_postman_id":"09b78951-f835-4bf5-870d-b351f6342ca5"},{"name":"Renew","id":"027297e2-cf9c-4922-8b67-7b73780c9f02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"otp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/devices/:id/renew/","description":"

Endpoint for renewing the specific device.

\n","urlObject":{"path":["zatca","devices",":id","renew",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"db4d54ef-0e2d-4b61-a8d6-dc9956376205","description":{"content":"

(Required) A unique value identifying this device.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0f9b8b46-282a-42b8-bc8a-cde3a827b1c4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"otp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/devices/:id/renew/","host":["https://api.wafeq.com/v1"],"path":["zatca","devices",":id","renew",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"revoked\"\n}"}],"_postman_id":"027297e2-cf9c-4922-8b67-7b73780c9f02"},{"name":"Revoke","id":"40df748c-d863-445e-ae24-1bf25e529ce3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"revoked\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/devices/:id/revoke/","description":"

Endpoint for revoking the specific device.

\n","urlObject":{"path":["zatca","devices",":id","revoke",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"5a0c34d2-823f-44b6-859a-a554183395c7","description":{"content":"

(Required) A unique value identifying this device.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"41c8b9a2-aac7-42ee-83ac-677105d059f5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"revoked\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/devices/:id/revoke/","host":["https://api.wafeq.com/v1"],"path":["zatca","devices",":id","revoke",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"revoked\"\n}"}],"_postman_id":"40df748c-d863-445e-ae24-1bf25e529ce3"},{"name":"Register","id":"6d680e13-868b-492b-a51a-39bf74603fa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"common_name\": \"\",\n \"otp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/devices/register/","description":"

Registers a new device.

\n","urlObject":{"path":["zatca","devices","register",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"daea40dd-0baa-4173-8562-30106cf57035","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"common_name\": \"\",\n \"otp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/devices/register/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"common_name\": \"\",\n \"id\": \"\",\n \"status\": \"revoked\"\n}"}],"_postman_id":"6d680e13-868b-492b-a51a-39bf74603fa6"}],"id":"648eeb4c-f170-4630-976b-2c37b2d3e552","_postman_id":"648eeb4c-f170-4630-976b-2c37b2d3e552","description":""},{"name":"Invoice","item":[{"name":"List invoices\n","id":"46ff945b-71e0-4d29-b8b8-ac0077996b47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all invoices.

\n","urlObject":{"path":["zatca","invoices",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"612f2802-06ab-405a-993c-4743df286836","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","invoices",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"46ff945b-71e0-4d29-b8b8-ac0077996b47"},{"name":"Retrieve an invoice\n","id":"4fea1859-ede7-4449-b12f-896653b0e403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/invoices/:id/","description":"

Retrieves a single invoice.

\n","urlObject":{"path":["zatca","invoices",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"e1d2affc-54cc-4183-9036-67797d70838a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1cc7bf1c-25ab-4e41-a094-26999cf30611","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/invoices/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","invoices",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"4fea1859-ede7-4449-b12f-896653b0e403"},{"name":"Download an invoice\n","id":"fb4dd544-ced4-4b6a-89a2-164322ee4fc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/invoices/:id/download/?type=pdf","description":"

Downloads a single invoice.

\n","urlObject":{"path":["zatca","invoices",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"6e851f55-ac30-48b6-9264-a1127fec46a6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"28c4a7c8-3bd6-4686-b868-755acc358cd9","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/invoices/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","invoices",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fb4dd544-ced4-4b6a-89a2-164322ee4fc0"},{"name":"Report an existing invoice\n","id":"8081a3e8-753e-455f-86d1-321c529a1d26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/invoices/:id/report/","description":"

Reports an existing invoice. This endpoint should be used in case the invoice is in a failed state.

\n","urlObject":{"path":["zatca","invoices",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"4bbae947-e9bb-4846-968f-ce597ecab507","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a799763f-a0de-466c-86c9-87759cc0112f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/invoices/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","invoices",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"8081a3e8-753e-455f-86d1-321c529a1d26"},{"name":"Send an existing invoice\n","id":"1676fea6-4747-4a8b-a2d5-11e5f0afed1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/:id/send/","description":"

Send the invoice using specified channels.

\n","urlObject":{"path":["zatca","invoices",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"3d3bad1f-ffb3-4214-b6aa-0f2ae970b5d6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"aaaf9bcf-3ec9-48ed-8612-45b61ce420f7","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/invoices/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","invoices",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"1676fea6-4747-4a8b-a2d5-11e5f0afed1a"},{"name":"Bulk report invoices\n","id":"3696a72f-3e27-4028-a74a-975d4bbdf9e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"BND\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BW\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"PL\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"61\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MD\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"52\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"28\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/bulk-report/","description":"

Reports multiple invoices. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","invoices","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"08dc7038-8c3c-4c5a-9213-200edc9f29e3","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"BND\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BW\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"PL\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"61\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MD\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"52\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"28\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"2e594b30-fd09-4bb9-a687-1fa979860f60","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"BND\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BW\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"PL\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"61\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MD\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"52\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"28\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"7249e743-c213-436c-ba3e-8061158e0409","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"BND\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BW\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"PL\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"61\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MD\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"52\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"28\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"bd30c1aa-e728-4c02-8e97-2952860853dc","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"BND\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BW\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"PL\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"61\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MD\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"52\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"28\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"3696a72f-3e27-4028-a74a-975d4bbdf9e7"},{"name":"Bulk validate invoices\n","id":"46499629-5c6c-4fab-82ec-48b5c8b83f54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"BND\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BW\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"PL\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"61\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MD\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"52\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"28\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple invoices without reporting them.

\n","urlObject":{"path":["zatca","invoices","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"4931bdb8-517d-470c-aacc-b5d0c15025bb","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"BND\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"BW\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"PAS\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"PL\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"61\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MD\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"IS\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"52\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"28\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-33\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","invoices","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"46499629-5c6c-4fab-82ec-48b5c8b83f54"},{"name":"Compliance check invoice\n","id":"4c3d6bbb-282e-4b62-8a7d-a30f5195bfbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","invoices","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"4a2e68df-1c00-4f57-a3f1-98bd50adbbf2","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"4c3d6bbb-282e-4b62-8a7d-a30f5195bfbb"},{"name":"Report an invoice\n","id":"6eaca3aa-6aa0-4748-be10-0a73b8944f95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/report/","description":"

Reports a single invoice. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","invoices","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"dbdb45c9-1305-4b4a-b922-0eb8bf6bf85f","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"bb29e662-c989-414b-974f-96573e083737","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"856c85c8-0614-4f46-83a1-8470271e6b18","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"f06fbd7d-c32f-4afd-b263-a48fe55dba32","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"a424bef7-d7ba-4956-b468-dfd2f23ac9b4","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"a9fab0d3-e8bf-42b8-9941-7517855a5b4c","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"6eaca3aa-6aa0-4748-be10-0a73b8944f95"},{"name":"Status summary of invoices\n","id":"84a3546e-7ad3-4ba2-8c1b-138b4db4ea2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of invoices per status

\n","urlObject":{"path":["zatca","invoices","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"2fde7bfb-b704-496f-8413-66199a08fb2d","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","invoices","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"84a3546e-7ad3-4ba2-8c1b-138b4db4ea2d"},{"name":"Validation check invoice\n","id":"e81f7155-5a74-48a1-847e-262ac7ead08c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","invoices","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"fa91d832-f125-4809-815b-c0556e9e8e31","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"PAB\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FI\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"6\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"IO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"OTH\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"HD\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"3\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"42\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/invoices/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"e81f7155-5a74-48a1-847e-262ac7ead08c"}],"id":"b2e99ee9-5533-4cf5-99a8-334f14d72c9b","_postman_id":"b2e99ee9-5533-4cf5-99a8-334f14d72c9b","description":""},{"name":"Prepayment Invoice","item":[{"name":"List invoices\n","id":"36145b68-f026-4933-a214-eda0d8341cea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all invoices.

\n","urlObject":{"path":["zatca","prepayment-invoices",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"24989a89-966f-42d1-8b7d-d2e55cd4f680","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-invoices",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"36145b68-f026-4933-a214-eda0d8341cea"},{"name":"Retrieve an invoice\n","id":"f3a3637b-61d5-4c6d-ad94-4df4ad525824","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/","description":"

Retrieves a single invoice.

\n","urlObject":{"path":["zatca","prepayment-invoices",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"c6e6e1b9-8018-41e3-ab6d-7bbee4d3cc00","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"141564fc-9d93-4ab9-b925-e44259833f4c","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-invoices",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"f3a3637b-61d5-4c6d-ad94-4df4ad525824"},{"name":"Download an invoice\n","id":"b8b8f87f-edb8-45d7-abb9-9f59bdd9c1a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/download/?type=pdf","description":"

Downloads a single invoice.

\n","urlObject":{"path":["zatca","prepayment-invoices",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"2740598a-b3fe-41ea-8cdf-e35ebc48e2f2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"935836e4-7b12-4f47-91bb-402501f3352f","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-invoices",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b8b8f87f-edb8-45d7-abb9-9f59bdd9c1a2"},{"name":"Report an existing invoice\n","id":"ff78a2b7-02a0-4ee9-aa71-337d50a7ae7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/report/","description":"

Reports an existing invoice. This endpoint should be used in case the invoice is in a failed state.

\n","urlObject":{"path":["zatca","prepayment-invoices",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"c9ce03e6-e296-42c7-9a0d-bca9585db896","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"63abb6d3-f77d-499a-b8be-c77a546e9272","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-invoices",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"ff78a2b7-02a0-4ee9-aa71-337d50a7ae7d"},{"name":"Send an existing invoice\n","id":"055754e7-ac9e-4876-86c4-e8bb196d7d49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/send/","description":"

Send the invoice using specified channels.

\n","urlObject":{"path":["zatca","prepayment-invoices",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"9d657fea-3adc-47bf-8274-ba2c1da3173d","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"17f4818b-3d63-4709-b3ef-ea8be2b49d9b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-invoices/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-invoices",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"055754e7-ac9e-4876-86c4-e8bb196d7d49"},{"name":"Bulk report invoices\n","id":"306de273-d8e3-4182-9268-853d2010fa21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"HUF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"YE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"NAT\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"TL\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AEN\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"20\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/bulk-report/","description":"

Reports multiple invoices. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","prepayment-invoices","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"e10f6a82-297a-4cf6-ae2f-f2d975da57f4","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"HUF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"YE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"NAT\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"TL\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AEN\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"20\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"55111663-dffa-4968-84a4-815cad353f3c","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"HUF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"YE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"NAT\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"TL\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AEN\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"20\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"a5ed1b97-b0c4-4ce8-9fac-ccdea834f27c","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"HUF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"YE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"NAT\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"TL\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AEN\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"20\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"f4954c43-d790-4939-a894-d82a19b626f7","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"HUF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"YE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"NAT\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"TL\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AEN\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"20\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"306de273-d8e3-4182-9268-853d2010fa21"},{"name":"Bulk validate invoices\n","id":"4a92a5cf-0678-48de-aeca-7a3ad97035fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"HUF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"YE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"NAT\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"TL\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AEN\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"20\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple invoices without reporting them.

\n","urlObject":{"path":["zatca","prepayment-invoices","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"051ce8a1-6293-4c8d-9481-cc33a5771592","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"HUF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"YE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"NAT\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"TL\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"AEN\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"69\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"20\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-invoices","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"4a92a5cf-0678-48de-aeca-7a3ad97035fa"},{"name":"Compliance check invoice\n","id":"2f7dea3e-2e0b-43e9-bde2-e2a38442426a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","prepayment-invoices","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"ac8d7dbd-e7f9-454d-9b4a-1974d93fc9a8","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"2f7dea3e-2e0b-43e9-bde2-e2a38442426a"},{"name":"Report an invoice\n","id":"faf12046-6ba8-4a9f-b194-8b129873e064","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/report/","description":"

Reports a single invoice. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","prepayment-invoices","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"e34e64e1-dda3-439c-9e3d-7a695212a2f2","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"4f611f50-f09f-4765-896d-db5159cd516c","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"650c8ccd-5fef-429a-813f-804a266e0d93","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"51877791-1558-4347-9c0d-4222fc0a313a","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"ec4fadb4-dca4-4dad-b676-5735e33fcdc3","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"ab6c3fce-8c85-4ab6-a1b2-ef9069efacde","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"faf12046-6ba8-4a9f-b194-8b129873e064"},{"name":"Status summary of invoices\n","id":"2ed486fd-19cc-4656-afe6-5ee3a1263524","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of invoices per status

\n","urlObject":{"path":["zatca","prepayment-invoices","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"b807a426-28d8-4bf3-87a6-dbe5bb92349a","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-invoices","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"2ed486fd-19cc-4656-afe6-5ee3a1263524"},{"name":"Validation check invoice\n","id":"7f1f226e-b519-4b38-be6b-f82214e5c89a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","prepayment-invoices","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"dac32044-829c-48f2-83bf-30652ffa21de","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"BIF\",\n \"customer\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"name\": \"\",\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"59\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"EE\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"SU\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-33\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"68\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"66\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-invoices/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"7f1f226e-b519-4b38-be6b-f82214e5c89a"}],"id":"08753783-b017-4fa1-b88f-d53e070cb6cc","_postman_id":"08753783-b017-4fa1-b88f-d53e070cb6cc","description":""},{"name":"Prepayment Simplified Invoice","item":[{"name":"List invoices\n","id":"d4fbf97d-2f6a-4033-a4eb-7bb28058d736","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all invoices.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"4b118586-3fac-4c64-b324-705bc17472a5","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-simplified-invoices",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"d4fbf97d-2f6a-4033-a4eb-7bb28058d736"},{"name":"Retrieve an invoice\n","id":"16285e07-86ed-4540-b7b8-b1f2d8c17267","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/","description":"

Retrieves a single invoice.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"aa1960db-4b08-4be5-b6a2-bcaf09d49cac","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c05734af-246e-4540-8639-daa9092ecdd6","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-simplified-invoices",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"16285e07-86ed-4540-b7b8-b1f2d8c17267"},{"name":"Download an invoice\n","id":"b54f3576-aaa8-4bd4-bbfd-efaa2740b19f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/download/?type=pdf","description":"

Downloads a single invoice.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"49719220-1f14-4c4c-8d50-cb7b067a69cf","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8580efb9-83d4-49b6-b461-ac64acd68ac0","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-simplified-invoices",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b54f3576-aaa8-4bd4-bbfd-efaa2740b19f"},{"name":"Report an existing invoice\n","id":"2ed87d22-fc35-4bc4-8f07-d0688dcee476","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/report/","description":"

Reports an existing invoice. This endpoint should be used in case the invoice is in a failed state.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"8ec237e8-750c-4194-8884-ce3bd92a369f","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ac5664b8-a6f3-4605-95ef-a440bba03b8f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-simplified-invoices",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"2ed87d22-fc35-4bc4-8f07-d0688dcee476"},{"name":"Send an existing invoice\n","id":"67119071-19c8-45cd-a869-ddd89307d98b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/send/","description":"

Send the invoice using specified channels.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"95306802-f8ce-4ffb-b98b-76f833d3498a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"33c5e658-ddac-41eb-abd4-d8c1c8aefa2f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-simplified-invoices",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"67119071-19c8-45cd-a869-ddd89307d98b"},{"name":"Bulk report invoices\n","id":"c1e50a9d-dbca-4e5f-ae97-5c0a45352cd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"MKD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BG\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"TIN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AET\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"56\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"DZ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"V2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"57\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"64\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/bulk-report/","description":"

Reports multiple invoices. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"6477d8f2-dd42-417a-833d-976ace022b9a","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"MKD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BG\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"TIN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AET\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"56\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"DZ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"V2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"57\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"64\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"334aee09-4663-42ab-9059-2470d02db374","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"MKD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BG\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"TIN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AET\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"56\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"DZ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"V2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"57\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"64\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"83f90981-5c68-4aca-808e-08ebaac5eff3","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"MKD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BG\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"TIN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AET\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"56\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"DZ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"V2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"57\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"64\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"2ee22458-0090-4fd9-9c4f-88b8db891a2a","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"MKD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BG\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"TIN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AET\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"56\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"DZ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"V2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"57\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"64\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"c1e50a9d-dbca-4e5f-ae97-5c0a45352cd6"},{"name":"Bulk validate invoices\n","id":"d5626953-4d7d-4b19-aa42-d709b7209d8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"MKD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BG\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"TIN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AET\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"56\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"DZ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"V2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"57\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"64\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple invoices without reporting them.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"12a256ae-9497-4ed2-9c9f-dc8c2736168f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"MKD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BG\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"TIN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"AET\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"56\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"DZ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"V2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"57\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"64\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-simplified-invoices","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"d5626953-4d7d-4b19-aa42-d709b7209d8c"},{"name":"Compliance check invoice\n","id":"3aacd8cc-981e-4dec-9368-b2edd72659a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"1f1e8896-60c4-4b92-afcc-43757565909b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"3aacd8cc-981e-4dec-9368-b2edd72659a0"},{"name":"Report an invoice\n","id":"a11eb27c-c036-40ba-82c4-bc756fe6caf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/","description":"

Reports a single invoice. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"99a1c971-14a0-4b74-bbaf-2e078e72f9f8","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"a301e21f-1ed8-4e02-9610-731b1269a29b","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"19c69d4d-fb12-4ad1-aab4-b72e1b09740b","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"ee1066f8-9c3f-426a-a10b-d5048da6da28","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"6cf9d28f-ead3-44f3-9c02-daab267c926f","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"6125ba88-70bc-4425-ac94-e4ffafa39bf5","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"a11eb27c-c036-40ba-82c4-bc756fe6caf8"},{"name":"Status summary of invoices\n","id":"331a6e01-c8c0-4b72-8ded-13ab127f6839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of invoices per status

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"5bc3aae5-7c18-4961-b064-c55d41726eb0","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","prepayment-simplified-invoices","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"331a6e01-c8c0-4b72-8ded-13ab127f6839"},{"name":"Validation check invoice\n","id":"7f854c93-3b89-4b27-b79a-484dd0f40abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","prepayment-simplified-invoices","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"cf4e1482-8803-4ccb-94e1-69d50a6de090","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"DOP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"BW\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-2\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACM\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"74\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"NG\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"LAA\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"23\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-HEA\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"34\",\n \"payment_terms\": \"\"\n }\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"7f854c93-3b89-4b27-b79a-484dd0f40abb"}],"id":"0c7b4a48-0e24-40dc-be85-635012a3b533","_postman_id":"0c7b4a48-0e24-40dc-be85-635012a3b533","description":""},{"name":"Simplified Credit Note","item":[{"name":"List credit notes\n","id":"9adf74e9-c4dd-4a46-8c0c-dd59dbbec9e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all credit notes.

\n","urlObject":{"path":["zatca","simplified-credit-notes",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"5f43c4d0-1331-4293-b40b-92be48fb0c50","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-credit-notes",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"9adf74e9-c4dd-4a46-8c0c-dd59dbbec9e2"},{"name":"Retrieve an credit note\n","id":"879d2b9f-121f-45e1-bf7e-241751e0f912","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/","description":"

Retrieves a single credit note.

\n","urlObject":{"path":["zatca","simplified-credit-notes",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"3610cd8c-23d1-4c1d-b8c9-a602c4a79ab4","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"301831a9-17d8-4b37-885e-4c9fd27821ed","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-credit-notes",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"879d2b9f-121f-45e1-bf7e-241751e0f912"},{"name":"Download an credit note\n","id":"d7c677f3-d576-4db1-a1b8-7745e856c759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/download/?type=pdf","description":"

Downloads a single credit note.

\n","urlObject":{"path":["zatca","simplified-credit-notes",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"e9076ea7-c408-4b15-a6dc-4816eb11a2e6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"01a554eb-f1d7-4af4-a039-5caa9a14133e","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-credit-notes",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d7c677f3-d576-4db1-a1b8-7745e856c759"},{"name":"Report an existing credit note\n","id":"b046356d-2e31-4d2e-bb67-93a635122508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/report/","description":"

Reports an existing credit note. This endpoint should be used in case the credit note is in a failed state.

\n","urlObject":{"path":["zatca","simplified-credit-notes",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"ddd29895-c955-472d-b834-a9e0fbf58329","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e05c33cf-d25f-400d-8a47-e76bdb24eed5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-credit-notes",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"b046356d-2e31-4d2e-bb67-93a635122508"},{"name":"Send an existing credit note\n","id":"1414f8bb-5974-4183-85ea-2a6e82041a1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/send/","description":"

Send the credit note using specified channels.

\n","urlObject":{"path":["zatca","simplified-credit-notes",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"68eac1d6-591e-43a6-879a-9681604799d8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"92c6aad7-c027-4221-8147-a6161842b5b6","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-credit-notes",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"1414f8bb-5974-4183-85ea-2a6e82041a1b"},{"name":"Bulk report credit notes\n","id":"81b0d848-6101-4d11-b4c6-226aa1af1c39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"AZN\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"HU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"19\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"62\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"SK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MLS\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"TT\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/bulk-report/","description":"

Reports multiple credit notes. Optionally, send the credit note using specified channels.

\n","urlObject":{"path":["zatca","simplified-credit-notes","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"997be5ca-b5f0-41ff-aa9c-fba19b3a6e3a","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"AZN\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"HU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"19\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"62\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"SK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MLS\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"TT\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"686e69fd-94d3-48f3-b1d0-91181af58749","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"AZN\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"HU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"19\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"62\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"SK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MLS\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"TT\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"678b2061-20ea-4978-873a-a747a01a3a71","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"AZN\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"HU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"19\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"62\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"SK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MLS\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"TT\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"dc3107b7-5ef8-4a89-8fee-093ffb3c8c33","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"AZN\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"HU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"19\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"62\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"SK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MLS\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"TT\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"81b0d848-6101-4d11-b4c6-226aa1af1c39"},{"name":"Bulk validate credit notes\n","id":"a5676a00-63a6-401f-97e3-87439a55d1d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"AZN\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"HU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"19\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"62\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"SK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MLS\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"TT\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple credit notes without reporting them.

\n","urlObject":{"path":["zatca","simplified-credit-notes","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"f02498de-319a-44a7-bf6b-7a1bfe32f4d0","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"AZN\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"HU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"700\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CS\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"19\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"62\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"SK\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MLS\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"TT\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-1\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"2\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-credit-notes","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"a5676a00-63a6-401f-97e3-87439a55d1d1"},{"name":"Compliance check credit note\n","id":"6e04ca9a-c098-489a-bb18-d7833f53178a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","simplified-credit-notes","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"baad2410-d095-41ab-889f-5dd2a488653b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"6e04ca9a-c098-489a-bb18-d7833f53178a"},{"name":"Report an credit note\n","id":"8623c3f0-3976-439f-b868-7fe21aa4239a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/","description":"

Reports a single credit note. Optionally, send the credit note using specified channels.

\n","urlObject":{"path":["zatca","simplified-credit-notes","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"adc9bd79-9e27-44d1-800c-f947e381f5b8","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"43d447b7-b77a-4a7f-8340-78937f41233f","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"e7f42590-23b8-411c-9348-c6a4731df75f","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"0ef79db0-3a29-44ba-b8e7-f290803a7461","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"dae749d4-4a2f-4f2c-a3d1-4234093e8320","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"102b160a-a2ef-49dc-9a3f-f93e3268d00d","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"8623c3f0-3976-439f-b868-7fe21aa4239a"},{"name":"Status summary of credit notes\n","id":"b7244921-f41e-41e9-afb5-9b4628f814ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of credit notes per status

\n","urlObject":{"path":["zatca","simplified-credit-notes","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"50b33ef9-ebe4-4986-9d51-2083a6e280db","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-credit-notes","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"b7244921-f41e-41e9-afb5-9b4628f814ed"},{"name":"Validation check credit note\n","id":"32ad9eb1-657b-4baa-afd6-c1eaa7182c30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","simplified-credit-notes","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"3574002b-4e8a-45c2-8f42-7243a6a69f24","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SGD\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"GT\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"FAA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"22\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"64\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"GQ\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADW\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"8\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-OOS\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-credit-notes/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"32ad9eb1-657b-4baa-afd6-c1eaa7182c30"}],"id":"479494e2-4ec0-41de-afe6-83ea9d33eacd","_postman_id":"479494e2-4ec0-41de-afe6-83ea9d33eacd","description":""},{"name":"Simplified Debit Note","item":[{"name":"List debit notes\n","id":"83671361-5fab-40e1-98ca-4823c4fb51a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all debit notes.

\n","urlObject":{"path":["zatca","simplified-debit-notes",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"6622f852-f9de-4e7a-86e0-c65e7ab6206b","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-debit-notes",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"83671361-5fab-40e1-98ca-4823c4fb51a2"},{"name":"Retrieve an debit note\n","id":"45c5eaf9-c7f0-4f03-880b-84e389a24ea5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/","description":"

Retrieves a single debit note.

\n","urlObject":{"path":["zatca","simplified-debit-notes",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"3375423d-0f9a-4b1a-8e49-9d18bc5ac998","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"375982a9-733e-4331-933e-e28df908609f","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-debit-notes",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"45c5eaf9-c7f0-4f03-880b-84e389a24ea5"},{"name":"Download an debit note\n","id":"5b47cbba-9072-4a11-b990-c07a70328b03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/download/?type=pdf","description":"

Downloads a single debit note.

\n","urlObject":{"path":["zatca","simplified-debit-notes",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"ed119f91-49a5-4173-9332-255ba2194a70","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d3305887-8ec5-486e-8d64-3a40bd656f41","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-debit-notes",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b47cbba-9072-4a11-b990-c07a70328b03"},{"name":"Report an existing debit note\n","id":"9f7a00a1-116e-4596-946f-52bb9c24203f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/report/","description":"

Reports an existing debit note. This endpoint should be used in case the debit note is in a failed state.

\n","urlObject":{"path":["zatca","simplified-debit-notes",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"87b2791b-9924-460d-a8c3-f4deaef6d026","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"afbaf875-783e-4539-925f-c205948cbad5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-debit-notes",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"9f7a00a1-116e-4596-946f-52bb9c24203f"},{"name":"Send an existing debit note\n","id":"1f4babe5-c8d1-4836-9be6-7ba72d8ed547","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/send/","description":"

Send the debit note using specified channels.

\n","urlObject":{"path":["zatca","simplified-debit-notes",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"e888cebf-6eda-4533-bf25-75818ca558ce","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"71edbc02-7bdb-45b5-af20-87fd8c6edd3f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-debit-notes",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"1f4babe5-c8d1-4836-9be6-7ba72d8ed547"},{"name":"Bulk report debit notes\n","id":"9ff72edd-13ce-4ace-a8f9-149d205ea460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"TJ\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"2\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MT\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"7\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/bulk-report/","description":"

Reports multiple debit notes. Optionally, send the debit note using specified channels.

\n","urlObject":{"path":["zatca","simplified-debit-notes","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"9ea4a8a0-d5b2-45ac-ac35-6207262ae737","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"TJ\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"2\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MT\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"7\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"f87dd418-78d2-463d-8484-d1bdb74655a3","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"TJ\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"2\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MT\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"7\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"00647fdf-0062-498e-a1fb-b8237407d769","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"TJ\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"2\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MT\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"7\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"ba5a7ba8-2436-4e4a-b14c-f636b422bb62","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"TJ\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"2\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MT\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"7\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"9ff72edd-13ce-4ace-a8f9-149d205ea460"},{"name":"Bulk validate debit notes\n","id":"72e89ec9-011c-4211-8358-572e29fbac61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"TJ\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"2\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MT\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"7\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple debit notes without reporting them.

\n","urlObject":{"path":["zatca","simplified-debit-notes","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"9914fe75-48a0-4444-9681-5993002da325","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"TJ\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"E\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACG\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"1\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"2\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MT\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ACF\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"7\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-debit-notes","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"72e89ec9-011c-4211-8358-572e29fbac61"},{"name":"Compliance check debit note\n","id":"f9476bea-e36c-43ae-9520-d383c969fa94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","simplified-debit-notes","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"def0c228-3ab6-4bc9-96fb-c765b17a3224","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"f9476bea-e36c-43ae-9520-d383c969fa94"},{"name":"Report an debit note\n","id":"642b4bce-1154-435b-b0a2-ae4a6b7f0711","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/report/","description":"

Reports a single debit note. Optionally, send the debit note using specified channels.

\n","urlObject":{"path":["zatca","simplified-debit-notes","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"9472e915-b8e0-4380-ba3a-09f81d5de563","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"3f4cee10-3747-497e-8716-4fb91826101a","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"308d8821-6f02-417c-89ff-1179745d04d4","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"ae9fff3f-5d2f-4a70-8e87-b136275e466d","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"9082ca25-2e35-474f-b6a8-2113775f228f","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"33c591ab-c853-49ee-9295-1c3186a1a241","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"642b4bce-1154-435b-b0a2-ae4a6b7f0711"},{"name":"Status summary of debit notes\n","id":"3c255a94-c530-4bb0-acc1-a37a12d0f94f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of debit notes per status

\n","urlObject":{"path":["zatca","simplified-debit-notes","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"82c4efd8-67f9-46f3-afa0-077263faf13c","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-debit-notes","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"3c255a94-c530-4bb0-acc1-a37a12d0f94f"},{"name":"Validation check debit note\n","id":"4df5c4f8-9b45-404f-ac83-033c6c687f96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","simplified-debit-notes","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"8b0bf8b8-6e4d-434d-acf1-1bae436421ad","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"CH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"GCC\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-EDU\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"TV\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"96\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"payment_means\": {\n \"code\": \"75\",\n \"issue_reason\": \"\",\n \"account_id\": \"\",\n \"payment_terms\": \"\"\n },\n \"reference_document_number\": \"\",\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"MO\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAE\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-MLTRY\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"54\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-32\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {}\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-debit-notes/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"4df5c4f8-9b45-404f-ac83-033c6c687f96"}],"id":"f3ef8c9c-8cb9-4801-a791-877fc03f975d","_postman_id":"f3ef8c9c-8cb9-4801-a791-877fc03f975d","description":""},{"name":"Simplified Invoice","item":[{"name":"List invoices\n","id":"286a5b6a-06c9-4f11-b03c-eae82b791662","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","description":"

Lists all invoices.

\n","urlObject":{"path":["zatca","simplified-invoices",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

A page number within the paginated result set.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of results to return per page.

\n","type":"text/plain"},"key":"page_size","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"a0c926c2-2c62-4ed5-8b54-f02c6bb5cc96","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-invoices/?issue_datetime_after=&issue_datetime_before=&keyword=&page=&page_size=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-invoices",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"A page number within the paginated result set.","key":"page","value":""},{"description":"Number of results to return per page.","key":"page_size","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}"}],"_postman_id":"286a5b6a-06c9-4f11-b03c-eae82b791662"},{"name":"Retrieve an invoice\n","id":"ad125a9b-67a2-46e5-8cae-7af48dc6453f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/","description":"

Retrieves a single invoice.

\n","urlObject":{"path":["zatca","simplified-invoices",":id",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"72560955-78ef-40fd-a979-fa888e358603","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"77bb4273-6151-4989-8a0d-817327aa22c1","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-invoices",":id",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"ad125a9b-67a2-46e5-8cae-7af48dc6453f"},{"name":"Download an invoice\n","id":"445efbca-e4fb-4102-a9bc-b964a0c622e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/download/?type=pdf","description":"

Downloads a single invoice.

\n","urlObject":{"path":["zatca","simplified-invoices",":id","download",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

The type of the download format

\n
    \n
  • pdf - Portable Document Format (PDF) format
    • \n
  • xml - Extensible Markup Language (XML) format
    • \n
\n","type":"text/plain"},"key":"type","value":"pdf"}],"variable":[{"id":"ee090684-4431-40d3-bbb0-42e36e13c33c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8d68ce25-3f8a-4b4c-9d84-ca4d374cf9b7","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/download/?type=pdf","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-invoices",":id","download",""],"query":[{"description":"The type of the download format\n\n* `pdf` - Portable Document Format ([PDF](https://en.wikipedia.org/wiki/PDF)) format\n* `xml` - Extensible Markup Language ([XML](https://en.wikipedia.org/wiki/XML)) format","key":"type","value":"pdf"}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"445efbca-e4fb-4102-a9bc-b964a0c622e1"},{"name":"Report an existing invoice\n","id":"e84a3f88-0bb4-4b3f-a4ed-caee5d6b2ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/report/","description":"

Reports an existing invoice. This endpoint should be used in case the invoice is in a failed state.

\n","urlObject":{"path":["zatca","simplified-invoices",":id","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"55a5866d-7cff-4ccb-9cef-d9d6d82357af","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"dbf8278d-2683-4c52-9bc9-639c8e54a559","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/report/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-invoices",":id","report",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"e84a3f88-0bb4-4b3f-a4ed-caee5d6b2ad5"},{"name":"Send an existing invoice\n","id":"6c1ac8d2-7d7a-4469-b196-2c6ca90bd480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/send/","description":"

Send the invoice using specified channels.

\n","urlObject":{"path":["zatca","simplified-invoices",":id","send",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[{"id":"6e83f2ac-2b20-468f-854d-ef5222e9f694","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"edf5594c-fc61-475e-9e50-0a1f625f1176","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-invoices/:id/send/","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-invoices",":id","send",""],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"6c1ac8d2-7d7a-4469-b196-2c6ca90bd480"},{"name":"Bulk report invoices\n","id":"0fe59d01-a9a0-4105-b924-1f244a859249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"VU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"82\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"WS\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADQ\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"95\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"14\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/bulk-report/","description":"

Reports multiple invoices. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","simplified-invoices","bulk-report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"cb85784b-3994-42b3-819e-bcc93d5e1187","name":"The request was accepted and the documents will be processed in the background","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"VU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"82\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"WS\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADQ\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"95\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"14\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/bulk-report/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\"\n },\n \"status\": \"\"\n }\n]"},{"id":"602660de-edba-4cc5-8c85-0494c8531012","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"VU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"82\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"WS\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADQ\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"95\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"14\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/bulk-report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"bfcc7ef2-9759-4d15-9ada-9c946362109d","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"VU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"82\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"WS\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADQ\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"95\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"14\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/bulk-report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"38f48c1e-fea8-4bf5-946b-66e20b8c4f51","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"VU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"82\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"WS\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADQ\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"95\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"14\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/bulk-report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"0fe59d01-a9a0-4105-b924-1f244a859249"},{"name":"Bulk validate invoices\n","id":"2f8a6749-dc1c-41a9-a1fe-458ae449c2ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"VU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"82\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"WS\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADQ\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"95\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"14\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Validate multiple invoices without reporting them.

\n","urlObject":{"path":["zatca","simplified-invoices","bulk-validate",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"068eb8fa-a371-4eca-9e21-fead982f58e0","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"[\n {\n \"document\": {\n \"currency\": \"IRR\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"VU\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"Z\",\n \"exemption_reason\": \"VATEX-SA-29\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAJ\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"82\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"WS\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"MOM\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"ADQ\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-30\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"95\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-29-7\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"14\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-29\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-invoices/bulk-validate/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-invoices","bulk-validate",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n },\n {\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n }\n]"}],"_postman_id":"2f8a6749-dc1c-41a9-a1fe-458ae449c2ae"},{"name":"Compliance check invoice\n","id":"784ca650-4756-4585-a933-8978d9df840f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/compliance/","description":"

Checks if the document is compliant.

\n","urlObject":{"path":["zatca","simplified-invoices","compliance",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"456f3d07-ea48-4dd7-af15-090d729e50e1","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/compliance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"}],"_postman_id":"784ca650-4756-4585-a933-8978d9df840f"},{"name":"Report an invoice\n","id":"354e0f1a-9472-4ef3-a811-269ed6c44df5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/report/","description":"

Reports a single invoice. Optionally, send the invoice using specified channels.

\n","urlObject":{"path":["zatca","simplified-invoices","report",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"317d3de4-13c4-4370-92d9-59438faac78f","name":"The document was created and reported/cleared to ZATCA successfully","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/report/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"465aec6a-296e-4f3a-a228-a27efd0ea2fe","name":"The document was created and reported/cleared to ZATCA successfully with warnings","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/report/"},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"created_ts\": \"\",\n \"document\": {\n \"document_number\": \"\",\n \"id\": \"\",\n \"issue_datetime\": \"\",\n \"supply_date\": \"\"\n },\n \"qr_code_data\": \"\",\n \"response\": {\n \"dolor1e\": {}\n },\n \"status\": \"\",\n \"updated_ts\": \"\"\n}"},{"id":"1a0c66e1-30e5-42cc-9784-82407d7cad7d","name":"The request was invalid or did not pass ZATCA validation rules","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/report/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"validation_error\"\n}"},{"id":"0df42f8e-b70d-45e9-815d-b49d721b2d8b","name":"No active device found, environment header is missing or invalid","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/report/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"attr\": \"\",\n \"code\": \"permission_denied\",\n \"detail\": \"\"\n}"},{"id":"5094ff28-3f33-4953-b590-9eb9d18e0ba2","name":"The request for reporting/clearing to ZATCA failed","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/report/"},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"parse_error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"client_error\"\n}"},{"id":"e18a5b89-a242-4d40-ae99-9563f90dd19d","name":"Unexpected error occurred while processing the request","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/report/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n },\n {\n \"attr\": \"\",\n \"code\": \"error\",\n \"detail\": \"\"\n }\n ],\n \"type\": \"server_error\"\n}"}],"_postman_id":"354e0f1a-9472-4ef3-a811-269ed6c44df5"},{"name":"Status summary of invoices\n","id":"01f257ab-eea6-4e89-a3c0-b2d75502ce17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","description":"

Summary of invoices per status

\n","urlObject":{"path":["zatca","simplified-invoices","summary",""],"host":["https://api.wafeq.com/v1"],"query":[{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_after","value":""},{"description":{"content":"

Issue datetime

\n","type":"text/plain"},"key":"issue_datetime_before","value":""},{"description":{"content":"

A search term.

\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"

Status

\n
    \n
  • failed - failed
    • \n
  • pending - pending
    • \n
  • processing - processing
    • \n
  • queued - queued
    • \n
  • reported - reported
    • \n
\n","type":"text/plain"},"key":"status","value":"reported"},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_after","value":""},{"description":{"content":"

Supply date

\n","type":"text/plain"},"key":"supply_date_before","value":""}],"variable":[]}},"response":[{"id":"74c9b1bb-403f-4b63-92a4-06a97e59c301","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Accept","value":"application/json; version=v1"}],"url":{"raw":"https://api.wafeq.com/v1/zatca/simplified-invoices/summary/?issue_datetime_after=&issue_datetime_before=&keyword=&status=reported&supply_date_after=&supply_date_before=","host":["https://api.wafeq.com/v1"],"path":["zatca","simplified-invoices","summary",""],"query":[{"description":"Issue datetime","key":"issue_datetime_after","value":""},{"description":"Issue datetime","key":"issue_datetime_before","value":""},{"description":"A search term.","key":"keyword","value":""},{"description":"Status\n\n* `failed` - failed\n* `pending` - pending\n* `processing` - processing\n* `queued` - queued\n* `reported` - reported","key":"status","value":"reported"},{"description":"Supply date","key":"supply_date_after","value":""},{"description":"Supply date","key":"supply_date_before","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": {\n \"failed\": 0,\n \"pending\": 0,\n \"processing\": 0,\n \"queued\": 0,\n \"reported\": 0\n }\n}"}],"_postman_id":"01f257ab-eea6-4e89-a3c0-b2d75502ce17"},{"name":"Validation check invoice\n","id":"16265988-7b34-48ee-ab4d-d7d276f18a4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name

\n","key":"X-ZATCA-Branch","value":""},{"description":"

The ID of the connected account you're operating on behalf of

\n","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"

(Required) The zatca environment to use, available options are ['production', 'simulation']

\n","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/validate/","description":"

Checks if the document is valid.

\n","urlObject":{"path":["zatca","simplified-invoices","validate",""],"host":["https://api.wafeq.com/v1"],"query":[],"variable":[]}},"response":[{"id":"778f5074-380d-4000-80db-9e2ff4e68947","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"description":"If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used for the branch name","key":"X-ZATCA-Branch","value":""},{"description":"The ID of the connected account you're operating on behalf of","key":"X-ZATCA-Connected-Account-Id","value":""},{"description":"(Required) The zatca environment to use, available options are ['production', 'simulation']","key":"X-ZATCA-Environment","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; version=v1"}],"body":{"mode":"raw","raw":"{\n \"document\": {\n \"currency\": \"SYP\",\n \"customer\": {\n \"name\": \"\",\n \"address\": {\n \"country\": \"KH\",\n \"building\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"SAG\",\n \"value\": \"\"\n },\n \"tax_registration_number\": \"\"\n },\n \"document_number\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"item\": \"\",\n \"quantity\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-35\"\n },\n \"unit_price\": \"\",\n \"charges\": [\n {\n \"reason\": \"SA\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"70\",\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"unit_of_measure\": \"\"\n }\n ],\n \"supplier\": {\n \"address\": {\n \"building\": \"\",\n \"city\": \"\",\n \"country\": \"FR\",\n \"district\": \"\",\n \"postal_code\": \"\",\n \"street\": \"\"\n },\n \"identification\": {\n \"type\": \"CRN\",\n \"value\": \"\"\n },\n \"name\": \"\"\n },\n \"supply_date\": \"\",\n \"charges\": [\n {\n \"reason\": \"CAO\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"S\",\n \"exemption_reason\": \"VATEX-SA-34-5\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"reason\": \"87\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-4\"\n },\n \"amount\": \"\",\n \"percent\": \"\",\n \"base_amount\": \"\"\n }\n ],\n \"note\": \"\",\n \"tax_amount_type\": \"E\",\n \"tax_total\": 0,\n \"template_context\": {},\n \"payment_means\": {\n \"account_id\": \"\",\n \"code\": \"38\",\n \"payment_terms\": \"\"\n },\n \"prepayments\": [\n {\n \"amount\": \"\",\n \"reference\": \"\",\n \"tax\": {\n \"percent\": \"\",\n \"type\": \"O\",\n \"exemption_reason\": \"VATEX-SA-34-3\"\n }\n }\n ]\n },\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"language\": \"en\",\n \"template\": {\n \"id\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.wafeq.com/v1/zatca/simplified-invoices/validate/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; version=v1"}],"cookie":[],"responseTime":null,"body":"{\n \"calculated_subtotal\": \"\",\n \"calculated_tax_total\": \"\",\n \"calculated_total\": \"\",\n \"channels\": [\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n },\n {\n \"data\": {\n \"message\": \"\",\n \"recipients\": {\n \"to\": [\n \"\",\n \"\"\n ]\n },\n \"subject\": \"\"\n },\n \"medium\": \"email\"\n }\n ],\n \"currency\": \"\",\n \"customer\": \"\",\n \"document_number\": \"\",\n \"provided_tax_total\": \"\"\n}"}],"_postman_id":"16265988-7b34-48ee-ab4d-d7d276f18a4d"}],"id":"f4847ae6-e604-43d8-ab2b-59abc3a2d334","_postman_id":"f4847ae6-e604-43d8-ab2b-59abc3a2d334","description":""}],"variable":[{"key":"baseUrl","value":"https://api.wafeq.com/v1"}]}