HomeDocumentation

API Documentation

Developer Documentation

Comprehensive guides, API references, and code examples to help you integrate PeriOne APIs seamlessly.

Interactive examples

Copy-paste snippets

Complete API reference

Quick start guides

Ctrl+K

Quick API Reference

e-Invoice API

e-Waybill API

GST API

50+

API Endpoints

Fast

Response Time

High

Availability

6 Hours

Token Validity

Getting Started

Quick Start Guide

Get up and running with PeriOne APIs in just 4 simple steps. Our developer-friendly platform makes integration seamless.

Create Account

No credit card required
Instant sandbox access
Full API coverage

Get Free Sandbox Access

Create your login and activate sandbox access in real time

Login-based onboarding
Sandbox-ready access
Environment-specific

Authenticate

Obtain auth token using your GSTIN and credentials

6-hour token validity
Auto-refresh support
Secure JWT tokens

Make API Calls

Start integrating our APIs into your application

RESTful endpoints
JSON responses
Comprehensive SDKs

Security

API Authentication

All API requests require authentication using Bearer tokens. Obtain your token by calling the authenticate endpoint with your GSTIN credentials.

Base URLs

Production

https://api.perione.in/v1

Sandbox

https://sandbox.perione.in/v1

Required Headers

AuthorizationBearer token obtained from /authenticate endpoint

Content-Typeapplication/json

example.js

// Example: Generate e-Invoice IRN
const response = await fetch(
  'https://api.perione.in/v1/einvoice/generate',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      transaction: {
        supply_type: 'B2B',
        document_type: 'INV'
      },
      document_details: {
        document_number: 'INV-001',
        document_date: '2024-01-15'
      }
    })
  }
);

const { irn, status } = await response.json();

API Reference

Explore Our APIs

Comprehensive API documentation for all PeriOne services. Click on any API to view detailed endpoint specifications.

e-Invoice API

RESTful API

Complete e-invoice lifecycle management including IRN generation, cancellation, and retrieval.

Key Endpoints

POST/authenticate

POST/generate

GET/irn/{irn}

POST/cancel

View full documentation

e-Waybill API

RESTful API

Complete e-waybill operations including generate, update, cancel, and track shipments.

Key Endpoints

POST/generate

POST/update-partb

POST/cancel

GET/ewaybill/{ewbNo}

View full documentation

GST API

RESTful API

Complete GST filing, GSTIN validation, and real-time sales and purchase data access.

Key Endpoints

GET/gstin/{gstin}

GET/gstin/{gstin}/returns

POST/gstin/verify

GET/gstin/{gstin}/status

View full documentation

Response Handling

HTTP Status Codes

Standard HTTP response codes are used to indicate the success or failure of API requests.

200

Success

Request processed successfully

400

Bad Request

Invalid request parameters

401

Unauthorized

Invalid or expired token

429

Rate Limited

Too many requests

500

Server Error

Internal server error

Official e-Invoice error codes

Reference the GST portal IRN error code list for invoice validation and generation issues.

Official e-Waybill error codes

Use the official e-Waybill API error code list to troubleshoot transport and document flows.

Ready to Get Started?

Create your login, get free sandbox access in real time, and start building with PeriOne APIs today.

Get Free Sandbox Access Explore APIs