{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"595ed4e1-9a21-481a-9243-49a63b028eb7","name":"GRA E-VAT API - VER 8.1","description":"GRA E-VAT API Documentation, API for E-VAT INTEGRATION DOCUMENTATION VCIS/VSDC\n\nThis document describes the API specification to integrate with Electronic Invoicing Systems (E-VAT)\n\nOverview  \nThe following specific requirements are for the systems to communicate with E-VAT VCIS, the Certified Invoicing System to be used together with a Virtual Sales Data Controller (VSDC).\n\n[Data Flow Diagram](https://gra.evatgra.com/DataFlow.php)\n\nThis Api have an Authentication\n\nIn the Request Header  \n\"SECURITY_KEY\": \"1234567890987UIEGRTEIIIWOWPPWOOW\"\n\nE-VAT API Receive data in two ways\n\n2.JSON FORMAT.\n\nLEVIES Mapping:\n\n\\* **LEVY_A : NHIL 2.5 %**  \n\\* **LEVY_B : GETFL 2.5 %**  \n\\* **LEVY_C : COVID 1 %**  \n\\* **LEVY_D : CST 5%**  \n\\* **LEVY_E : TOURISM 1%**\n\nTAX RATE Mapping:\n\n\\* **TAX_A : 0 % \\[Exempted\\]**  \n\\* **TAX_B : 15 % \\[Vaxable\\]**  \n\\* **TAX_C : 0 % \\[Export\\]**  \n\\* **TAX_D : 0 % \\[Non Taxable\\]**\n\n**EXCEL TEMPLATE OF TAXE CALCULATION**:  \n[https://docs.google.com/spreadsheets/d/1DAcDUBVdoHD7A_yOqMcrzuX4rNc4VGLC/edit?usp=drive_link&amp;ouid=114670877025048538475&amp;rtpof=true&amp;sd=true](https://docs.google.com/spreadsheets/d/1DAcDUBVdoHD7A_yOqMcrzuX4rNc4VGLC/edit?usp=drive_link&ouid=114670877025048538475&rtpof=true&sd=true)\n\n**SAMPLE INVOICE**\n\n<img src=\"https://content.pstmn.io/62e2217a-b4a9-4128-8892-eb634a42999e/aW1hZ2UucG5n\" alt=\"Invoice%20sample\" width=\"538\" height=\"680\">\n\n**TAG DESCRIPTIONS**\n\n| TAG NAME | TAG VALUE EXAMPLE | TAG DESCRIPTION | LENGTH AND TYPE | MANDATORY |\n| --- | --- | --- | --- | --- |\n| \"currency\" | \"GHS\" | CURRENCY | VARCHAR(20) | YES |\n| \"exchangeRate\" | 1 | CURRENT EXCHANGE RATE: DEFAULT 1 FOR GHS | 10 | YES |\n| \"businessPartnerName\" | \"James Kofi\" | CLIENT NAME | VARCHAR(100) | YES |\n| \"invoiceNumber\" | \"2306219003\" | SOFTWARE UNIQUE TRANSACTION IDENTIFIER | VARCHAR(100) | YES |\n| \"totalLevy\" | 30 | TOTAL LEVY AMOUNT | NUMERIC | YES |\n| \"userName\" | \"happy\" | USER NAME | VARCHAR(100) | YES |\n| \"flag\" | \"INVOICE\" | TRANSACTON TYPE :\"INVOICE\",\"PURCHASE\",\"REFUND\" IF FULL CANCELING THE ORIGINAL, \"PARTIAL_REFUND \" IF PARTIAL CANCELING THE ORIGINAL,\"PURCHASE_RETURN\",\"REFUND_CANCELLATION\" | VARCHAR(20) | YES |\n| \"totalVat\" | 13.04 | TOTAL VAT OF THE INVOICE | NUMERIC | YES |\n| \"groupReferenceId\" | \"\" | REFERENCE ID TO A GROUP OF INVOICES | VARCHAR(50) | NO |\n| \"transactionDate\" | \"2023-06-14\" | INVOICE DATE (POSTED DATE IS THE ONE USED) | VARCHAR(50) | YES |\n| \"businessPartnerTin\" | \"VC00000009055\" | CLIENT TIN NUMBER | VARCHAR(15) | YES B2B, NO B2C |\n| \"totalAmount\" | 100.0 | TOTAL AMOUNT ON THE INVOICE | NUMERIC | YES |\n| \"voucherAmount\" | 0.0 | VOUCHER AMOUNT | NUMERIC | NO |\n| \"saleType\" | \"NORMAL\" | NORMAL(For General case),EXEMPTED(for exempted client) & EXPORT(for Export) | VARCHAR(20) | YES |\n| \"discountType\" | \"GENERAL\" | \"SELECTIVE\" if discount on whole Invoice total amount  <br>\"GENERAL\" if  <br>discount on each line of item | VARCHAR(300) | NO |\n| \"discountAmount\" | 0.0 | TOTAL DISCOUNTED AMOUNT ON INVOICE | NUMERIC | NO |\n| \"reference\" | \"39083a038d2940f78eca7931106d3c40\" | REFUND_ID TO USE FOR PARTIAL_CANCELING | VARCHAR(50) | YES |\n| \"itemCode\" | \"TXC005918138\" | ITEM CODE UNIQUE | VARCHAR(50) | YES |\n| \"expire\" | \"\" | EXPIREDATE OF ITEM IF EXIST | VARCHAR(45) | NO |\n| \"description\" | \"Bowl\" | ITEM NAME | VARCHAR(100) | YES |\n| \"quantity\" | 10.0 | ITEM QUANTITY | NUMERIC | YES |\n| \"levyAmountA\" | 2.05 | LEVY_AMOUNT ON NHIL | NUMERIC | YES |\n| \"levyAmountB\" | 2.05 | LEVY_AMOUNT ON GETFUND | NUMERIC | YES |\n| \"levyAmountC\" | 0.82 | LEVY_AMOUNT ON COVID | NUMERIC | YES |\n| \"levyAmountD\" | 0.0 | LEVY_AMOUNT ON CST | NUMERIC | YES |\n| \"levyAmountE\" | 0.0 | LEVY_AMOUNT ON TOURISM | NUMERIC | YES |\n| \"discount\" | 0.0 | DISCOUNT ON ITEM | NUMERIC | NO |\n| \"batch\" | \"5MAKD1\" | BATCH NUMBER OPTIONAL | VARCHAR(100) | NO |\n| \"itemCategory\" | \"\" | ITEM CATEGORY (\"CST\"-CST ITEM, \"TRSM\"-TOURISM ITEM, \"EXM\"-EXEMPTED/NON TAXABLE ITEM). \"\"-FOR STANDARD ITEMS | VARCHAR(50) | NO |\n| \"unitPrice\" | 10.0 | UNITY PRICE VAT INCLUSIVE | NUMERIC | YES |\n| \"purchaseOrderReference\" | \"PO-230822-00001\" | PURCHASE ORDER NUMBER | VARCHAR(50) | NO |\n\n**INVOICE RESPONSE**\n\n| **FIELD** | **DESCRIPTION** |\n| --- | --- |\n| \"distributor_tin\" | TIN of Taxpayer issuing the invoice |\n| \"num\" | Invoice Number sent to the VSDC |\n| \"ysdcid\" | The ID of the SDC (Sales Data Controller) |\n| \"ysdcrecnum\" | Show the number of transactions stamped by the SDC |\n| \"ysdcintdata\" | References the Internal Data of the Invoice |\n| \"ysdcregsig\" | Invoice Signature |\n| \"ysdcmrctim | Date/Time invoice is received at the backend |\n| \"ysdctime\" | Date/Time invoice is stamped |\n| \"flag\" | Type of Invoice |\n| \"ysdcitems\" | Number of Items on the invoice |\n| \"qr_code\": | URL link to be converted to QR CODE |\n| \"status\": | Status of invoice request |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10845416","team":2012770,"collectionId":"595ed4e1-9a21-481a-9243-49a63b028eb7","publishedId":"2s946mbqRQ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/10845416/2s946mbqRQ","privateUrl":"https://go.postman.co/documentation/10845416-595ed4e1-9a21-481a-9243-49a63b028eb7","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2023-09-06T16:26:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f610dd5cb02b4005b2c8f6e60a6a5b333c9a4382e522dd2b050dd5f120d08cbd","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s946mbqRQ"}