The VAT Care API is designed to simplify and automate your VAT and e-invoicing processes. With a secure and reliable system, it helps your business stay compliant with VAT regulations while saving time and reducing errors.
\nUsing this API, you can:
\nEasily generate and share VAT-compliant invoices.
\nCancel or update invoices whenever needed.
\nKeep track of all transactions with detailed logs.
\nEnsure smooth integration with your existing business systems.
\nThis documentation provides clear guidance on how the VAT Care API works, so your business can focus on growth while we handle the complexity of VAT compliance in the background.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4829790","collectionId":"816f917f-fcbd-4453-afd9-76ba039194e8","publishedId":"2sA3dvirr3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-01T09:43:19.000Z"},"item":[{"name":"Authentication","item":[{"name":"Company Login","id":"63576fa8-49c7-47d8-8f70-dd50b6ffbaaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"abcmanager@gmail.com","type":"text"},{"key":"password","value":"123456","type":"text"}]},"url":"https://api.dev.v2.vatcare.app/api/login","description":"This API allows a user to log in to the VAT-Care portal and generates a Bearer Token, which must be included in the Authorization header for all other APIs in this collection.
\nOnly the user account specifically set up for API integration with VAT-Care services can use this endpoint. Other company users can continue to access their accounts through the VAT-Care web portal.
\nThe response provides important details that you will use in other APIs:
\nid – This will serve as the user_id wherever required.
access_token – This will be your Bearer Token, included in the Authorization header of subsequent API requests.
To keep your data safe and ensure only authorized users can access the VAT Care API, every request must be authenticated. The API uses secure API keys (or tokens) that act like a digital pass for your business.
\nEach business receives a unique key or token.
\nThis key must be included in your requests to prove your identity.
\nWithout the correct authentication, the system will block the request for security reasons.
\nThink of it as your business’s secure ID card when interacting with the API—it ensures that only you can create, cancel, or view your invoices.
\n","_postman_id":"7ac2c29c-dfb1-4962-aa1c-0fa89060f0a7"},{"name":"Invoice","item":[{"name":"Generate Invoice","id":"53f389b9-a539-4ecc-908f-582aaec54efa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer abcd"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"scope\": {\r\n \"qr_html\": false,\r\n \"qr_base64\": false,\r\n \"qr_base64_format\": \"jpg\",\r\n \"qr_svg\": false,\r\n \"qr_string\": true,\r\n \"invoice_pdf\": false,\r\n \"invoice_xml\": false\r\n },\r\n \"origin\": \"API\",\r\n \"user_id\": 22,\r\n \"invoice_number\": \"CS-001702\",\r\n \"invoice_date\": \"2024-09-17\",\r\n \"supply_date\": \"2024-09-17\",\r\n \"invoice_type\": \"Standard\",\r\n \"document_reference\": \"\",\r\n \"advance_invoice_uuid\": \"\",\r\n \"business_type\": \"B2B\",\r\n \"time_stamp\": \"2024-09-17 18:46:04\",\r\n \"operator_name\": \"\",\r\n \"invoice_id\": \"123458\",\r\n \"vc_uuid\": \"\",\r\n \"seller_id\": 3,\r\n \"buyer_id\": 2482,\r\n \"allowance\": [],\r\n \"charges\": [],\r\n \"seller_english\": {\r\n \"name\": \"HAL TEST SERVER\",\r\n \"building_number\": \"1234\",\r\n \"street_name_1\": \"King Salman Road\",\r\n \"street_name_2\": \"line two\",\r\n \"district\": \"Riyadh\",\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"123456\",\r\n \"vat_number\": \"311278518500003\",\r\n \"cr_number\": \"4030605038\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"seller_arabic\": {\r\n \"name\": \"\",\r\n \"building_number\": \"\",\r\n \"street_name_1\": \"\",\r\n \"street_name_2\": \"\",\r\n \"district\": \"\",\r\n \"city\": \"\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"123456\",\r\n \"vat_number\": \"311278518500003\",\r\n \"cr_number\": \"4030605038\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"buyer_english\": {\r\n \"name\": \"Udaya\",\r\n \"building_number\": \"-\",\r\n \"street_name_1\": \"-\",\r\n \"street_name_2\": \"-\",\r\n \"district\": \"-\",\r\n \"city\": \"-\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"00000\",\r\n \"vat_number\": \"-\",\r\n \"cr_number\": \"\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\",\r\n \"other_buyer_id\": \"123ABC12\"\r\n },\r\n \"buyer_arabic\": {\r\n \"name\": null,\r\n \"building_number\": \"-\",\r\n \"street_name_1\": \"-\",\r\n \"street_name_2\": \"-\",\r\n \"district\": \"-\",\r\n \"city\": \"-\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"00000\",\r\n \"vat_number\": \"-\",\r\n \"cr_number\": \"\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"items\": [\r\n {\r\n \"item_id\": 30469,\r\n \"name_english\": \"Charging Base for Sonos Move White\",\r\n \"description_english\": \"Enter Item Description\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 1000,\r\n \"quantity\": \"4.0000\",\r\n \"item_price\": 1000,\r\n \"discount_percent\": 50,\r\n \"discount_amount\": 2000,\r\n \"taxable_amount\": 1739.13,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 260.87,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 2000,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n },\r\n {\r\n \"item_id\": 30470,\r\n \"name_english\": \"Era 300 Stand WW (White)\",\r\n \"description_english\": \"Enter Item Description\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 2000,\r\n \"quantity\": \"5.0000\",\r\n \"item_price\": 2000,\r\n \"discount_percent\": 10,\r\n \"discount_amount\": 1000,\r\n \"taxable_amount\": 7826.09,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 1173.91,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 9000,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n },\r\n {\r\n \"item_id\": 30471,\r\n \"name_english\": \"Fabircation\",\r\n \"description_english\": \"Non Inventory\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 3000,\r\n \"quantity\": \"7.0000\",\r\n \"item_price\": 3000,\r\n \"discount_percent\": \"40\",\r\n \"discount_amount\": 8400,\r\n \"taxable_amount\": 10956.52,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 1643.48,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 12600,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n }\r\n ],\r\n \"total\": {\r\n \"sub_total\": 23600,\r\n \"discount\": 11400,\r\n \"taxable_total\": 20521.74,\r\n \"vat_total\": 3078.26,\r\n \"net_amount\": 23600\r\n },\r\n \"additional_data\": {\r\n \"request_id\": \"JPeffczzYAvTFYAM7xDNuyiWQ6u7tjVpQaMEH3CBSMVwLw5lZa\",\r\n \"rootmodel_id\": 12900,\r\n \"valtranstypes_id\": 3\r\n }\r\n}"},"url":"https://api.dev.v2.vatcare.app/api/invoice/generate","description":"Response from VATCare Portal is as follows
\n$response = [
'status' => 'success', // string: success or error
'code' => $code, // int
'message' => $message, // string
'data' => $data, // array (sometimes this may not be included)
];
Reason Codes - https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm
\nRequired Response parameters can be flagged through this object
\n","urlObject":{"path":["generate"],"host":["https://api.dev.v2.vatcare.app/api/invoice"],"query":[],"variable":[]}},"response":[],"_postman_id":"53f389b9-a539-4ecc-908f-582aaec54efa"},{"name":"Generate Invoice - Doc Level Allowance and Charges","id":"230b13fb-36c4-43dd-9d82-1e2afd6313f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer abcd"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"scope\": {\r\n \"qr_html\": false,\r\n \"qr_base64\": false,\r\n \"qr_base64_format\": \"jpg\",\r\n \"qr_svg\": false,\r\n \"qr_string\": true,\r\n \"invoice_pdf\": false,\r\n \"invoice_xml\": false\r\n },\r\n \"origin\": \"API\",\r\n \"user_id\": 22,\r\n \"invoice_number\": \"CS-001702\",\r\n \"invoice_date\": \"2024-09-17\",\r\n \"supply_date\": \"2024-09-17\",\r\n \"invoice_type\": \"Standard\",\r\n \"document_reference\": \"\",\r\n \"advance_invoice_uuid\": \"\",\r\n \"business_type\": \"B2B\",\r\n \"time_stamp\": \"2024-09-17 18:46:04\",\r\n \"operator_name\": \"\",\r\n \"invoice_id\": \"123458\",\r\n \"vc_uuid\": \"\",\r\n \"seller_id\": 3,\r\n \"buyer_id\": 2482,\r\n \"allowance\": [\r\n {\r\n \"reason_code\": \"47\",\r\n \"reason\": \"Retention or Contractual charges\",\r\n \"taxable_amount\": 100,\r\n \"rate_of_tax\": 0,\r\n \"tax_exemption_code\": \"VATEX-SA-OOS\",\r\n \"tax_exemption_reason\": \"Retention or Contractual charges\"\r\n }\r\n ],\r\n \"charges\": [\r\n {\r\n \"reason_code\" : \"47\",\r\n \"reason\" : \"Handling\",\r\n \"taxable_amount\" : 0,\r\n \"rate_of_tax\" : 0,\r\n \"tax_exemption_code\" : \"VATEX-SA-OOS\",\r\n \"tax_exemption_reason\" : \"Discount\"\r\n }\r\n ],\r\n \"seller_english\": {\r\n \"name\": \"HAL TEST SERVER\",\r\n \"building_number\": \"1234\",\r\n \"street_name_1\": \"King Salman Road\",\r\n \"street_name_2\": \"line two\",\r\n \"district\": \"Riyadh\",\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"123456\",\r\n \"vat_number\": \"311278518500003\",\r\n \"cr_number\": \"4030605038\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"seller_arabic\": {\r\n \"name\": \"\",\r\n \"building_number\": \"\",\r\n \"street_name_1\": \"\",\r\n \"street_name_2\": \"\",\r\n \"district\": \"\",\r\n \"city\": \"\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"123456\",\r\n \"vat_number\": \"311278518500003\",\r\n \"cr_number\": \"4030605038\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"buyer_english\": {\r\n \"name\": \"Udaya\",\r\n \"building_number\": \"-\",\r\n \"street_name_1\": \"-\",\r\n \"street_name_2\": \"-\",\r\n \"district\": \"-\",\r\n \"city\": \"-\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"00000\",\r\n \"vat_number\": \"-\",\r\n \"cr_number\": \"\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\",\r\n \"other_buyer_id\": \"123ABC12\"\r\n },\r\n \"buyer_arabic\": {\r\n \"name\": null,\r\n \"building_number\": \"-\",\r\n \"street_name_1\": \"-\",\r\n \"street_name_2\": \"-\",\r\n \"district\": \"-\",\r\n \"city\": \"-\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"00000\",\r\n \"vat_number\": \"-\",\r\n \"cr_number\": \"\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"items\": [\r\n {\r\n \"item_id\": 30469,\r\n \"name_english\": \"Charging Base for Sonos Move White\",\r\n \"description_english\": \"Enter Item Description\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 1000,\r\n \"quantity\": \"4.0000\",\r\n \"item_price\": 1000,\r\n \"discount_percent\": 50,\r\n \"discount_amount\": 2000,\r\n \"taxable_amount\": 1739.13,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 260.87,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 2000,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n },\r\n {\r\n \"item_id\": 30470,\r\n \"name_english\": \"Era 300 Stand WW (White)\",\r\n \"description_english\": \"Enter Item Description\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 2000,\r\n \"quantity\": \"5.0000\",\r\n \"item_price\": 2000,\r\n \"discount_percent\": 10,\r\n \"discount_amount\": 1000,\r\n \"taxable_amount\": 7826.09,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 1173.91,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 9000,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n },\r\n {\r\n \"item_id\": 30471,\r\n \"name_english\": \"Fabircation\",\r\n \"description_english\": \"Non Inventory\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 3000,\r\n \"quantity\": \"7.0000\",\r\n \"item_price\": 3000,\r\n \"discount_percent\": \"40\",\r\n \"discount_amount\": 8400,\r\n \"taxable_amount\": 10956.52,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 1643.48,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 12600,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n }\r\n ],\r\n \"total\": {\r\n \"sub_total\": 23600,\r\n \"discount\": 11400,\r\n \"taxable_total\": 20521.74,\r\n \"vat_total\": 3078.26,\r\n \"net_amount\": 23600\r\n },\r\n \"additional_data\": {\r\n \"request_id\": \"JPeffczzYAvTFYAM7xDNuyiWQ6u7tjVpQaMEH3CBSMVwLw5lZa\",\r\n \"rootmodel_id\": 12900,\r\n \"valtranstypes_id\": 3\r\n }\r\n}"},"url":"https://api.dev.v2.vatcare.app/api/invoice/generate","description":"Required Response parameters can be flagged through this object
\n","urlObject":{"path":["generate"],"host":["https://api.dev.v2.vatcare.app/api/invoice"],"query":[],"variable":[]}},"response":[],"_postman_id":"230b13fb-36c4-43dd-9d82-1e2afd6313f4"},{"name":"Generate Invoice - Item Level Allowance and Charges","id":"003133c7-2c15-41ed-80db-3d784f3b8fae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer abcd"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"scope\": {\r\n \"qr_html\": false,\r\n \"qr_base64\": false,\r\n \"qr_base64_format\": \"jpg\",\r\n \"qr_svg\": false,\r\n \"qr_string\": true,\r\n \"invoice_pdf\": false,\r\n \"invoice_xml\": false\r\n },\r\n \"origin\": \"API\",\r\n \"user_id\": 22,\r\n \"invoice_number\": \"CS-001702\",\r\n \"invoice_date\": \"2024-09-17\",\r\n \"supply_date\": \"2024-09-17\",\r\n \"invoice_type\": \"Standard\",\r\n \"document_reference\": \"\",\r\n \"advance_invoice_uuid\": \"\",\r\n \"business_type\": \"B2B\",\r\n \"time_stamp\": \"2024-09-17 18:46:04\",\r\n \"operator_name\": \"\",\r\n \"invoice_id\": \"123458\",\r\n \"vc_uuid\": \"\",\r\n \"seller_id\": 3,\r\n \"buyer_id\": 2482,\r\n \"allowance\": [],\r\n \"charges\": [],\r\n \"seller_english\": {\r\n \"name\": \"HAL TEST SERVER\",\r\n \"building_number\": \"1234\",\r\n \"street_name_1\": \"King Salman Road\",\r\n \"street_name_2\": \"line two\",\r\n \"district\": \"Riyadh\",\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"123456\",\r\n \"vat_number\": \"311278518500003\",\r\n \"cr_number\": \"4030605038\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"seller_arabic\": {\r\n \"name\": \"\",\r\n \"building_number\": \"\",\r\n \"street_name_1\": \"\",\r\n \"street_name_2\": \"\",\r\n \"district\": \"\",\r\n \"city\": \"\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"123456\",\r\n \"vat_number\": \"311278518500003\",\r\n \"cr_number\": \"4030605038\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"buyer_english\": {\r\n \"name\": \"Udaya\",\r\n \"building_number\": \"-\",\r\n \"street_name_1\": \"-\",\r\n \"street_name_2\": \"-\",\r\n \"district\": \"-\",\r\n \"city\": \"-\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"00000\",\r\n \"vat_number\": \"-\",\r\n \"cr_number\": \"\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\",\r\n \"other_buyer_id\": \"123ABC12\"\r\n },\r\n \"buyer_arabic\": {\r\n \"name\": null,\r\n \"building_number\": \"-\",\r\n \"street_name_1\": \"-\",\r\n \"street_name_2\": \"-\",\r\n \"district\": \"-\",\r\n \"city\": \"-\",\r\n \"country\": \"SAU\",\r\n \"postal_code\": \"00000\",\r\n \"vat_number\": \"-\",\r\n \"cr_number\": \"\",\r\n \"additional_number\": \"\",\r\n \"other_id\": \"\"\r\n },\r\n \"items\": [\r\n {\r\n \"item_id\": 30469,\r\n \"name_english\": \"Charging Base for Sonos Move White\",\r\n \"description_english\": \"Enter Item Description\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 1000,\r\n \"quantity\": \"4.0000\",\r\n \"item_price\": 1000,\r\n \"discount_percent\": 50,\r\n \"discount_amount\": 2000,\r\n \"taxable_amount\": 1739.13,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 260.87,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 2000,\r\n \"additional_data\": [],\r\n \"allowance\": [\r\n {\r\n \"reason_code\" : \"47\",\r\n \"reason\" : \"Retention\",\r\n \"amount\" : 0\r\n }\r\n ],\r\n \"charges\": [\r\n {\r\n \"reason_code\" : \"47\",\r\n \"reason\" : \"Handling\",\r\n \"amount\" : 0\r\n }\r\n ]\r\n },\r\n {\r\n \"item_id\": 30470,\r\n \"name_english\": \"Era 300 Stand WW (White)\",\r\n \"description_english\": \"Enter Item Description\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 2000,\r\n \"quantity\": \"5.0000\",\r\n \"item_price\": 2000,\r\n \"discount_percent\": 10,\r\n \"discount_amount\": 1000,\r\n \"taxable_amount\": 7826.09,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 1173.91,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 9000,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n },\r\n {\r\n \"item_id\": 30471,\r\n \"name_english\": \"Fabircation\",\r\n \"description_english\": \"Non Inventory\",\r\n \"name_arabic\": null,\r\n \"description_arabic\": \"-\",\r\n \"unit_of_measurement\": \"\",\r\n \"unit_price\": 3000,\r\n \"quantity\": \"7.0000\",\r\n \"item_price\": 3000,\r\n \"discount_percent\": \"40\",\r\n \"discount_amount\": 8400,\r\n \"taxable_amount\": 10956.52,\r\n \"rate_of_tax\": 15,\r\n \"tax_amount\": 1643.48,\r\n \"tax_mode\": \"Inclusive\",\r\n \"exemption_code\": \"\",\r\n \"exemption_reason\": \"\",\r\n \"sub_total\": 12600,\r\n \"additional_data\": [],\r\n \"allowance\": [],\r\n \"charges\": []\r\n }\r\n ],\r\n \"total\": {\r\n \"sub_total\": 23600,\r\n \"discount\": 11400,\r\n \"taxable_total\": 20521.74,\r\n \"vat_total\": 3078.26,\r\n \"net_amount\": 23600\r\n },\r\n \"additional_data\": {\r\n \"request_id\": \"JPeffczzYAvTFYAM7xDNuyiWQ6u7tjVpQaMEH3CBSMVwLw5lZa\",\r\n \"rootmodel_id\": 12900,\r\n \"valtranstypes_id\": 3\r\n }\r\n}"},"url":"https://api.dev.v2.vatcare.app/api/invoice/generate","description":"Required Response parameters can be flagged through this object
\n","urlObject":{"path":["generate"],"host":["https://api.dev.v2.vatcare.app/api/invoice"],"query":[],"variable":[]}},"response":[],"_postman_id":"003133c7-2c15-41ed-80db-3d784f3b8fae"},{"name":"Get Invoice","id":"e2c307a9-fe76-4767-83cb-62e54b492a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer abcd"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"scope\": {\r\n\t\t\"qr_html\": true,\r\n\t\t\"qr_base64\": true,\r\n\t\t\"qr_svg\": true,\r\n\t\t\"qr_string\": true,\r\n\t\t\"qr_base64_format\": \"jpg\",\r\n \"invoice_pdf\": true,\r\n\t\t\"invoice_xml\": true\r\n\t},\r\n \"invoice_id\":\"16\"\r\n}\r\n"},"url":"https://api.dev.v2.vatcare.app/api/invoice/get","urlObject":{"path":["get"],"host":["https://api.dev.v2.vatcare.app/api/invoice"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2c307a9-fe76-4767-83cb-62e54b492a5a"}],"id":"939c610c-5f9d-43e9-aa55-a775304d4896","description":"Generate Invoice API : This API can be used to generate E-Invoices conforming to ZATCA regulations related to VAT. For Authorization, please use 'Bearer Token' which you have retrieved as 'access_token' through 'Company Login' API
\nGet Invoice API : This API can be used to access the already generated E-Invoices. For Authorization, please use 'Bearer Token' which you have retrieved as 'access_token' through 'Company Login' API
\n","_postman_id":"939c610c-5f9d-43e9-aa55-a775304d4896"},{"name":"SSL Certificate","item":[{"name":"Secret","id":"27d58b20-191f-454b-9b2e-1b47d8adaeb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer abcd"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.dev.v2.vatcare.app/api/sslcerts/fetch?get=secret","description":"To fetch SSL Certificate (Public Key)
\n","urlObject":{"path":["fetch"],"host":["https://api.dev.v2.vatcare.app/api/sslcerts"],"query":[{"key":"get","value":"secret"}],"variable":[]}},"response":[],"_postman_id":"27d58b20-191f-454b-9b2e-1b47d8adaeb4"},{"name":"Key","id":"c3bcf8b8-755b-4834-bd21-973353712c83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer abcd"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.dev.v2.vatcare.app/api/sslcerts/fetch?get=key","description":"To fetch SSL Certificate (Private Key)
\n","urlObject":{"path":["fetch"],"host":["https://api.dev.v2.vatcare.app/api/sslcerts"],"query":[{"key":"get","value":"key"}],"variable":[]}},"response":[],"_postman_id":"c3bcf8b8-755b-4834-bd21-973353712c83"}],"id":"96265661-61ed-4618-b5a6-4e82ccf56670","description":"SSL Secret : This API can be used to provide you SSL Certificate.
\nSSL Key : This API can be used to provide you SSL Key.
\nNote: For Authorization, please use 'Bearer Token' which you have retrieved as 'access_token' through 'Company Login' API
\n","_postman_id":"96265661-61ed-4618-b5a6-4e82ccf56670"},{"name":"Company Creation","item":[{"name":"Create Company","id":"f15e8484-7e44-4022-81cc-e389e69aa496","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer abcd","type":"text"}],"body":{"mode":"raw","raw":"{\n \"origin\": \"API\",\n \"user_id\": 1,\n \"company\": {\n \"business_name\": \"Test Company\",\n \"vat_number\": \"123456789032124\",\n \"vat_group_number\": \"\",\n \"company_crn\": \"\",\n \"branch_name\": \"Test Server\",\n \"short_address\": \"ABCD\",\n \"industry\": \"IT\",\n \"status\": \"Applied\" \n },\n \"configs\": {\n \"fatoora\": \"Yes\", \n \"live_mode\": \"No\", \n \"push_to_zatca\": \"Yes\", \n \"logs\": \"Yes\", \n \"needs_auth_for_scope_assets\": \"Y\", \n \"send_optimized_url_to_fetch_assets\": \"Y\", \n \"skip_revoke_previous_token\": \"Y\" \n },\n \"task\": \"add\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dev.v2.vatcare.app/api/company/create","description":"This API is used to update an existing company’s information in the VAT-Care system. It allows you to keep your company profile accurate and up to date for VAT compliance and invoicing.
\nWith this API, you can:
\nModify company details such as name, VAT number, address, or industry.
\nUpdate configurations (e.g., live/simulation mode, logging, or ZATCA push settings).
\nEnsure that all future invoices and reports reflect the latest company information.
\nThis API is used to retrieve details of a company registered in the VAT-Care system. It helps you view the company’s profile, VAT registration details, and configuration settings that are currently active.
\nWith this API, you can:
\nFetch company information by providing the company_id.
\nView key details such as business name, VAT number, branch, and industry.
\nCheck the company’s configuration (e.g., live/simulation mode, logging, ZATCA push).
\nEnsure that you are working with the most up-to-date company data before creating or managing invoices.
\nThe response will include both company details and configuration details, which can be used across other APIs in this collection.
\nThis API is used to register a new company in the VAT-Care system. By creating a company profile, you enable VAT-Care to manage all VAT compliance and e-invoicing activities under that business entity.
\nWith this API, you can:
\nCreate a unique company record in VAT-Care.(VAT No and CR No must be unique for each company)
\nStore key company details such as name, tax registration, and contact information.
\nPrepare the company profile for issuing and managing VAT-compliant invoices.
\nThis API is used to update an existing user’s details in the VAT-Care system. It allows companies to manage user information, update login credentials, or change account status while keeping the user linked to the correct company.
\nWith this API, you can:
\nUpdate user details such as name, email, mobile, or password.
\nChange the company association of a user if required.
\nActivate, deactivate, or modify user access settings.
\nYou will need to provide the user’s ID (id) to identify which user account should be updated.
This API is used to retrieve details of users created under a company in the VAT-Care system. It helps administrators view and manage all user accounts associated with their company.
\nWith this API, you can:
\nFetch a list of all users linked to a company.
\nView user details such as name, email, mobile number, company ID, and status.
\nVerify user information before assigning roles, generating invoices, or updating accounts.
\nThe response will return one or more user records, each containing the user’s ID, contact details, company association, and status.
\nThis API is used to add a new user account under a company in the VAT-Care system. By creating users, companies can provide controlled access to team members who need to work with VAT compliance, e-invoicing, or reporting.
\nWith this API, you can:
\nCreate a user profile linked to a specific company.
\nDefine user details such as name, email, role, and status.
\nEach newly created user will be assigned a unique user_id, which can be referenced in other API requests when needed.
\n","_postman_id":"504842b4-fd0a-4f63-9d8f-f6514f8da612"},{"name":"CSR-Certificate","item":[{"name":"Generate CSR","id":"c18723f2-3e40-4639-8f41-234b505fd1a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer abcd","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"origin\": \"API\",\n \"user_id\": 137, \n \"company_id\": 135, \n \"csr_certificates\": {\n \"type\": \"Local\", \n \"standard_tax_invoice\": \"Yes\", \n \"simplified_tax_invoice\": \"Yes\", \n \"otp\": \"123456\" \n },\n \"task\": \"add\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dev.v2.vatcare.app/api/csrcertificates/create","description":"FATOORA Portal Guide – https://zatca.gov.sa/en/E-Invoicing/Introduction/Guidelines/Documents/Fatoora_Portal_User_Manual_English.pdf
\nAs per the FATOORA portal guide, please obtain the OTP (Simulation/Production) from the FATOORA portal using the Company Login before proceeding with CSR certificate creation or onboarding an EGS unit.
\nThis API is used to retrieve all CSRs generated for a company in the VAT-Care system. It allows administrators to:
\nView CSR details such as type, invoice settings, and submission status.
\nTrack the CSR workflow for certificate issuance with ZATCA.
\nEnsure that digital certificates are ready and properly linked to the company for secure e-invoicing.
\nThe response includes all CSR records associated with the authenticated user and company.
\nRoot Level
\n","urlObject":{"path":["fetch"],"host":["https://api.dev.v2.vatcare.app/api/csrcertificates"],"query":[],"variable":[]}},"response":[],"_postman_id":"546adfb2-86f5-41cd-bc6a-baa8c16f45bc"}],"id":"e25b088d-41c0-4c23-9865-ba3d35edff93","description":"This API is used to generate a Certificate Signing Request (CSR) for a company in the VAT-Care system. A CSR is required for issuing digital certificates, which are necessary for secure e-invoicing and VAT compliance with ZATCA.
\nWith this API, you can:
\nGenerate a CSR for a company registered in VAT-Care.
\nEnable the company to request and obtain a digital certificate.
\nEnsure all invoices and transactions are signed and encrypted for compliance and security.
\nThe response will include CSR details that must be submitted to the certification authority (ZATCA) to complete the onboarding process.
\n","_postman_id":"e25b088d-41c0-4c23-9865-ba3d35edff93"}],"event":[{"listen":"prerequest","script":{"id":"900000c5-fae8-42ac-8ca1-67bfbe18c096","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"25bb58a9-bfae-457d-b5e7-da65bf54d6de","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.dev.v2.vatcare.app/api/"},{"key":"bearer_token","value":"abcd"}]}