{"id":270,"date":"2022-01-06T07:52:47","date_gmt":"2022-01-06T07:52:47","guid":{"rendered":"https:\/\/www.mastergst.com\/test\/?post_type=docs&#038;p=270"},"modified":"2022-05-18T13:10:12","modified_gmt":"2022-05-18T13:10:12","slug":"e-invoice-api-introduction","status":"publish","type":"docs","link":"https:\/\/mastergst.com\/blog\/guide\/e-invoice-api-introduction\/","title":{"rendered":"e-Invoice API Introduction"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-post\" data-elementor-id=\"270\" class=\"elementor elementor-270\" data-elementor-post-type=\"docs\">\n\t\t\t\t\t\t\t\t\t<section class=\"elementor-section elementor-top-section elementor-element elementor-element-942e05e elementor-section-boxed elementor-section-height-default elementor-section-height-default\" data-id=\"942e05e\" data-element_type=\"section\">\n\t\t\t\t\t\t<div class=\"elementor-container elementor-column-gap-default\">\n\t\t\t\t\t<div class=\"elementor-column elementor-col-100 elementor-top-column elementor-element elementor-element-b1f487d\" data-id=\"b1f487d\" data-element_type=\"column\">\n\t\t\t<div class=\"elementor-widget-wrap elementor-element-populated\">\n\t\t\t\t\t\t\t\t<section class=\"elementor-section elementor-inner-section elementor-element elementor-element-554e26e elementor-section-boxed elementor-section-height-default elementor-section-height-default\" data-id=\"554e26e\" data-element_type=\"section\">\n\t\t\t\t\t\t<div class=\"elementor-container elementor-column-gap-default\">\n\t\t\t\t\t<div class=\"elementor-column elementor-col-100 elementor-inner-column elementor-element elementor-element-d8a72c7\" data-id=\"d8a72c7\" data-element_type=\"column\">\n\t\t\t<div class=\"elementor-widget-wrap elementor-element-populated\">\n\t\t\t\t\t\t\t\t<div class=\"elementor-element elementor-element-9feb362 elementor-widget elementor-widget-heading\" data-id=\"9feb362\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.16.0 - 20-09-2023 *\/\n.elementor-heading-title{padding:0;margin:0;line-height:1}.elementor-widget-heading .elementor-heading-title[class*=elementor-size-]>a{color:inherit;font-size:inherit;line-height:inherit}.elementor-widget-heading .elementor-heading-title.elementor-size-small{font-size:15px}.elementor-widget-heading .elementor-heading-title.elementor-size-medium{font-size:19px}.elementor-widget-heading .elementor-heading-title.elementor-size-large{font-size:29px}.elementor-widget-heading .elementor-heading-title.elementor-size-xl{font-size:39px}.elementor-widget-heading .elementor-heading-title.elementor-size-xxl{font-size:59px}<\/style><h3 class=\"elementor-heading-title elementor-size-default\">Background<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-c98bed1 elementor-widget elementor-widget-text-editor\" data-id=\"c98bed1\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.16.0 - 20-09-2023 *\/\n.elementor-widget-text-editor.elementor-drop-cap-view-stacked .elementor-drop-cap{background-color:#69727d;color:#fff}.elementor-widget-text-editor.elementor-drop-cap-view-framed .elementor-drop-cap{color:#69727d;border:3px solid;background-color:transparent}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap{margin-top:8px}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap-letter{width:1em;height:1em}.elementor-widget-text-editor .elementor-drop-cap{float:left;text-align:center;line-height:1;font-size:50px}.elementor-widget-text-editor .elementor-drop-cap-letter{display:inline-block}<\/style>\t\t\t\t<p>The GST Council has approved the implementation of \u2018e-Invoicing\u2019 or \u2018electronic invoicing\u2019 in a phased manner for voluntarily reporting Business to Business (B2B) invoices to GST System starting from 1st January 2020. Being the first Invoice Registration Portal (IRP), National Informatics Centre has made the e-Invoice registration services available through API mode and other modes. The taxpayers and GSPs can integrate their business systems and processes with the e-Invoice system through these APIs for seamless registration of the invoices generated\/prepared on their systems.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<section class=\"elementor-section elementor-inner-section elementor-element elementor-element-b7a02dc elementor-section-boxed elementor-section-height-default elementor-section-height-default\" data-id=\"b7a02dc\" data-element_type=\"section\">\n\t\t\t\t\t\t<div class=\"elementor-container elementor-column-gap-default\">\n\t\t\t\t\t<div class=\"elementor-column elementor-col-100 elementor-inner-column elementor-element elementor-element-0e010ae\" data-id=\"0e010ae\" data-element_type=\"column\">\n\t\t\t<div class=\"elementor-widget-wrap elementor-element-populated\">\n\t\t\t\t\t\t\t\t<div class=\"elementor-element elementor-element-8dc38e6 elementor-widget elementor-widget-heading\" data-id=\"8dc38e6\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">Purpose of this portal\n<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-df7766b elementor-widget elementor-widget-text-editor\" data-id=\"df7766b\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p><span data-preserver-spaces=\"true\">This portal enables\/provides:<\/span><\/p><ul><li><span data-preserver-spaces=\"true\">Developers or System integrators of the taxpayers to understand the interfacing processes of e-Invoicing systems with their business systems.<\/span><\/li><li><span data-preserver-spaces=\"true\">Registration of the users to access the APIs<\/span><ul><li class=\"ql-indent-1\"><strong><span data-preserver-spaces=\"true\">Credentials:<\/span><\/strong><span data-preserver-spaces=\"true\">\u00a0The portal explains how to get the credentials to access the APIs on sandbox and production environments. The credentials include client-id, client-secret, username and password.<\/span><\/li><li class=\"ql-indent-1\"><strong><span data-preserver-spaces=\"true\">OTP:\u00a0<\/span><\/strong><span data-preserver-spaces=\"true\">The registration process involves validating the mobile number and the email address of the primary authorized signatory of the company (as registered with GST common portal) through OTP.<\/span><\/li><\/ul><\/li><li><span data-preserver-spaces=\"true\">API Documentation<\/span><ul><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">This portal provides all the information required by the application developers to integrate their systems with the e-Invoice system through APIs.<\/span><\/li><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">This includes the calling methods \/ URLs, JSON Schema of the request payloads, sample request payloads and sample responses, validations being applied etc., for each of the APIs.<\/span><\/li><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">Sample code extracts for reference are provided for understanding the logic and concepts.<\/span><\/li><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">Other references like the master data used in the system etc., are provided.<\/span><\/li><\/ul><\/li><li><span data-preserver-spaces=\"true\">Understanding \/ Testing the API methods through the sandbox portal. Through this portal, the developers can simulate the use of APIs end-to-end.<\/span><ul><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">Can understand how can the request payloads can be generated.<\/span><\/li><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">Can see how the encryption and decryption of the requests and responses work.<\/span><\/li><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">Can substitute the encrypted payload generated using their system and check for the correctness of encryption<\/span><\/li><\/ul><\/li><li><span data-preserver-spaces=\"true\">By changing the parameter values in the request payloads, developers can test the successful (valid) and unsuccessful (invalid) responses for a different combination of values.<\/span><ul><li style=\"list-style-type: none;\"><ul><li class=\"ql-indent-2\"><span data-preserver-spaces=\"true\">What will be the response if any of the credentials supplied are wrong?<\/span><\/li><li class=\"ql-indent-2\"><span data-preserver-spaces=\"true\">What will be the error response when any mandatory parameters are missing in the payload?<\/span><\/li><li class=\"ql-indent-2\"><span data-preserver-spaces=\"true\">What types of errors are displayed when the API fails?<\/span><\/li><\/ul><\/li><li class=\"ql-indent-1\"><span data-preserver-spaces=\"true\">What happens if the API is called without a valid token?<\/span><\/li><\/ul><\/li><\/ul>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>Background The GST Council has approved the implementation of \u2018e-Invoicing\u2019 or \u2018electronic invoicing\u2019 in a phased manner for voluntarily reporting Business to Business (B2B) invoices to GST System starting from 1st January 2020. Being the first Invoice Registration Portal (IRP), National Informatics Centre has made the e-Invoice registration services available through API mode and other [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":[],"doc_category":[],"doc_tag":[],"_links":{"self":[{"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/docs\/270"}],"collection":[{"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/comments?post=270"}],"version-history":[{"count":0,"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/docs\/270\/revisions"}],"wp:attachment":[{"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/media?parent=270"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/doc_category?post=270"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/mastergst.com\/blog\/wp-json\/wp\/v2\/doc_tag?post=270"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}