> ## Documentation Index
> Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt
> Use this file to discover all available pages before exploring further.
# GSTR-1 B2BA
> Get all B2B amended invoices for a return period for authenticated taxpayer
#### Response schema
For successful responses, these resources describe the GSTN payload at `data.data`.
## OpenAPI
````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/tax-payer/gstrs/gstr-1/b2ba/{year}/{month}
openapi: 3.0.1
info:
title: compliance
description: >-
**GST Compliance API** enables businesses to automate compliance
requirements like [Taxpayer
verification](https://developer.sandbox.co.in/reference/search-gstin-api),
[GSTR
Filing](https://developer.sandbox.co.in/reference/gst-taxpayer-authentication),
[Generating
E-Invoices](https://developer.sandbox.co.in/reference/e-invoice-authentication-api),
and [E-Way
Bills](https://developer.sandbox.co.in/reference/e-way-bill-authentication-api).We
provide these APIs from GSTN-authorised GST Suvidha Providers, handling the
encryption-decryption and signing so you don't have to handle the
complexities.
version: 1.0.0
servers:
- url: https://api.sandbox.co.in
- url: https://test-api.sandbox.co.in
security: []
tags:
- name: Public
- name: Taxpayer
- name: Taxpayer Auth
- name: Returns
- name: GSTR-1 Documents
- name: File GSTR-1
- name: GSTR-2A Documents
- name: GSTR-2B Document
- name: File GSTR-3B
- name: GSTR-4
- name: File GSTR-9
- name: Invoice Management System
- name: GSTR-1A Documents
- name: File GSTR-1A
- name: Ledgers
- name: e-Invoice
- name: Sales e-Invoices for return period
- name: Purchase e-Invoices for return period
- name: Front Office Notices
- name: Front Office
- name: AATO
- name: e-Invoice1
- name: Authentication
- name: e-Invoice12
- name: E-Way Bill
- name: E-Way Bill1
- name: Authentication1
- name: Consignor
- name: Consolidated E-Way Bill
- name: Multi-Vehicle Movement
- name: Consignee
- name: Transporter
- name: Consolidated E-Way Bill1
- name: Multi-vehicle Movement
- name: Common
paths:
/gst/compliance/tax-payer/gstrs/gstr-1/b2ba/{year}/{month}:
get:
tags:
- Taxpayer
- Returns
- GSTR-1 Documents
summary: GSTR-1 B2BA
description: "Get all B2B amended invoices for a return period for authenticated taxpayer\r\n\r\n"
operationId: getGstr1B2ba
parameters:
- name: year
in: path
description: ''
required: true
example: ''
schema:
type: string
- name: month
in: path
description: ''
required: true
example: ''
schema:
type: string
- name: action_required
in: query
description: >-
`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.
required: false
schema:
type: string
example: '{{action_required}}'
- name: from
in: query
description: From Date (DD/MM/YYYY)
required: false
schema:
type: string
example: '{{from}}'
- name: counterparty_gstin
in: query
description: '`optional` Counter party GSTIN'
required: false
schema:
type: string
example: '{{ctin}}'
- name: authorization
in: header
description: >-
GST taxpayer access token. For token-generation steps, refer to the
[Generate Taxpayer
Session](/recipes/gst/authentication/generate_tax_payer_session)
recipe, then pass the token in the authorization header.
required: true
example: ''
schema:
type: string
- name: x-api-key
in: header
description: API key for identification
required: true
example: ''
schema:
type: string
- name: x-api-version
in: header
description: API version
required: false
example: ''
schema:
type: string
default: 1.0.0
responses:
'200':
description: RET11416 No data found
content:
application/json:
schema:
$ref: '#/components/schemas/GetGstr1B2baResponse'
examples:
RET11416 No data found:
summary: RET11416 No data found
value:
code: 200
data:
status_cd: '0'
error:
error_cd: RET11416
message: >-
No document found in selected financial year. Either
this document exists in a different financial year or
the document number is incorrect.
timestamp: 1763446641000
transaction_id: 3c316991-4e59-434d-a477-b971f34b1cc4
headers: {}
deprecated: false
security: []
components:
schemas:
GetGstr1B2baResponse:
oneOf:
- $ref: '#/components/schemas/GetGstr1B2baSuccessResponse'
- $ref: '#/components/schemas/GstnBusinessErrorResponse'
description: >-
A GSTN success or GSTN business-failure response. Both variants use HTTP
200.
GetGstr1B2baSuccessResponse:
allOf:
- $ref: '#/components/schemas/TaxpayerResponseMetadata'
- type: object
required:
- data
properties:
data:
type: object
description: The GSTN success wrapper.
required:
- status_cd
- data
properties:
status_cd:
type: string
enum:
- '1'
description: GSTN success status.
example: '1'
data:
$ref: '#/components/schemas/GetGstr1B2baSuccessPayload'
GstnBusinessErrorResponse:
type: object
description: HTTP 200 response containing a GSTN business failure.
required:
- code
- timestamp
- transaction_id
- data
properties:
code:
type: integer
description: The HTTP status code reported in the response body.
enum:
- 200
example: 200
timestamp:
type: integer
format: int64
description: The response timestamp in Unix epoch milliseconds.
example: 1763446641000
transaction_id:
type: string
description: The transaction identifier used to trace the request.
example: 41bb8041-fb83-4654-8d75-85a19f329158
data:
type: object
description: The GSTN business-failure wrapper.
required:
- status_cd
- error
properties:
status_cd:
type: string
enum:
- '0'
description: GSTN business-failure status.
example: '0'
error:
$ref: '#/components/schemas/GstnBusinessError'
TaxpayerResponseMetadata:
type: object
description: Fields included in every taxpayer endpoint response.
required:
- code
- timestamp
- transaction_id
properties:
code:
type: integer
description: The HTTP status code reported in the response body.
enum:
- 200
example: 200
timestamp:
type: integer
format: int64
description: The response timestamp in Unix epoch milliseconds.
example: 1763446641000
transaction_id:
type: string
description: The transaction identifier used to trace the request.
example: 41bb8041-fb83-4654-8d75-85a19f329158
GetGstr1B2baSuccessPayload:
type: object
description: Successful GSTN payload for Get Gstr1 B2ba.
properties:
b2ba:
type: array
description: The b2ba value returned by GSTN.
items:
type: object
properties:
flag:
type: string
description: Status of Invoice
ctin:
type: string
description: GSTIN/UID of the Receiver taxpayer/UN,Govt Bodies
minLength: 15
maxLength: 15
inv:
type: array
description: The inv value returned by GSTN.
items:
type: object
properties:
cflag:
type: string
description: Status of counter party
etin:
type: string
description: Ecom Tin
minLength: 15
maxLength: 15
oinum:
type: string
description: Original Invoice Number
maxLength: 16
oidt:
type: string
description: Original Invoice Date
inum:
type: string
description: Supplier Invoice Number
maxLength: 16
chksum:
type: string
description: Invoice checksum value
minLength: 1
maxLength: 64
idt:
type: string
description: Supplier Invoice Date
inv_typ:
type: string
description: Invoice Type
diff_percent:
type: number
description: Differential percentage
opd:
type: string
description: Original Period
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
itm_det:
type: object
description: The itm det value returned by GSTN.
properties:
rt:
type: number
description: rate as per invoice
iamt:
type: number
description: IGST Amount as per invoice
camt:
type: number
description: CGST Amount as per invoice
samt:
type: number
description: SGST Amount as per invoice
txval:
type: number
description: >-
Taxable value of Goods or Service as per
invoice
num:
type: number
description: Serial no
pos:
type: string
description: Actual Place of Supply
minLength: 2
maxLength: 2
rchrg:
type: string
description: Reverse Charge
updby:
type: string
description: Uploaded by
val:
type: number
description: Supplier Invoice Value
GstnBusinessError:
type: object
description: A business error returned by GSTN.
required:
- error_cd
- message
properties:
error_cd:
type: string
description: The GSTN business error code.
example: RET11416
message:
type: string
description: A human-readable description of the GSTN business error.
example: No records found.
````