GSTR-1 B2B

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month} \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}"

headers = {
    "authorization": "<authorization>",
    "x-api-key": "<x-api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};

fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}")
  .header("authorization", "<authorization>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "data": {
      "b2b": [
        {
          "cfs": "N",
          "ctin": "07ABCCD6123D1YZ",
          "inv": [
            {
              "cflag": "N",
              "chksum": "4b571a762c1c17818ff448fef1d690c95931868b72299f0671936720ba427fcd",
              "flag": "U",
              "idt": "29-12-2023",
              "inum": "78618",
              "inv_typ": "R",
              "irn": "qoycq59t30429eb5dfa38d3b6efa65346dcff127abf439c76e3afd8fo3vtf9rn",
              "irngendate": "03-01-2024",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 719.82,
                    "rt": 18,
                    "samt": 0,
                    "txval": 3999
                  },
                  "num": 1
                }
              ],
              "pos": "07",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "updby": "S",
              "val": 4718.82
            }
          ]
        }
      ]
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "25411a6e-3fa0-4e49-b5d6-d27efc595237"
}

GET

gst

compliance

tax-payer

gstrs

gstr-1

b2b

{year}

{month}

GSTR-1 B2B

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month} \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}"

headers = {
    "authorization": "<authorization>",
    "x-api-key": "<x-api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};

fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}")
  .header("authorization", "<authorization>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "data": {
      "b2b": [
        {
          "cfs": "N",
          "ctin": "07ABCCD6123D1YZ",
          "inv": [
            {
              "cflag": "N",
              "chksum": "4b571a762c1c17818ff448fef1d690c95931868b72299f0671936720ba427fcd",
              "flag": "U",
              "idt": "29-12-2023",
              "inum": "78618",
              "inv_typ": "R",
              "irn": "qoycq59t30429eb5dfa38d3b6efa65346dcff127abf439c76e3afd8fo3vtf9rn",
              "irngendate": "03-01-2024",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 719.82,
                    "rt": 18,
                    "samt": 0,
                    "txval": 3999
                  },
                  "num": 1
                }
              ],
              "pos": "07",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "updby": "S",
              "val": 4718.82
            }
          ]
        }
      ]
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "25411a6e-3fa0-4e49-b5d6-d27efc595237"
}

Response schema

For successful responses, these resources describe the GSTN payload at data.data.

View JSON schema

View Excel field reference

Headers

authorization

string

required

GST taxpayer access token. For token-generation steps, refer to the Generate Taxpayer Session recipe, then pass the token in the authorization header.

x-api-key

string

required

API key for identification

x-api-version

string

default:1.0.0

API version

Path Parameters

year

string

required

month

string

required

Query Parameters

action_required

string

optional Status filter for filtering the invoices. Possible values: Y or N. Status filter for filtering the invoices. Use filter value Y to fetches the invoices where tax payer need to take action. Already accepted or uploaded invoices can be fetched by using filter value N.

Example:

"{{action_required}}"

from

string

From Date (DD/MM/YYYY)

Example:

"{{from}}"

counterparty_gstin

string

optional Counter party GSTIN

Example:

"{{gstin}}"

Response

200 - application/json

200 Success / 200 Filtered by counterparty GSTIN / RET11416 No data found

Option 1
Option 2

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code

enum<integer>

required

The HTTP status code reported in the response body.

Available options:

200

Example:

200

timestamp

integer<int64>

required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id

string

required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data

object

required

The GSTN success wrapper.

Show child attributes

GSTR-1 ATA

GSTR-1 B2BA

Analytics

Compliance

Annexures

GSTR-1 B2B

Response schema

View JSON schema

View Excel field reference

Headers

Path Parameters

Query Parameters

Response

​Response schema

View JSON schema

View Excel field reference

Headers

Path Parameters

Query Parameters

Response

Response schema