Object

Shown below is a sample bharat_connect.invoice object for Register Business.

{
    "id": "bcinv_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.invoice",
    "type": "OUTGOING"
    "supplier_invoice_number": "INV0012312",
    "supplier_details": {
        "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
        "gst_in": "22AAAAA0000A3Z9",
        "legal_name": "Open Financial",
        "trade_name": "Open Financial",
        "email": "[email protected]",
        "state_code": "32",
        "place_of_supply_code": "",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 123",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "buyer_details": {
        "b2b_id": "zwch_1731046715a8b539acf65f6707494305",
        "gst_in": "22AAAAA0000A1H2",
        "legal_name": "Surjava Test",
        "trade_name": "Surjava Test",
        "email": "[email protected]",
        "state_code": "06",
        "place_of_supply_code": "32",
        "address": {
            "type": "OTHER",
            "address": "RGA Tech park 456",
            "city": "Bangalore",
            "postal_code": "560035",
            "state_code": "",
            "state": "KARNATAKA"
        }
    },
    "transaction_detais": {
        "supply_type": "B2B",
        "reverse_charge_tax": "",
        "e_commerce_gstin": "",
        "igst_chargable": ""
    },
    "e_invoice_details": {
        "irn": "",
        "irn_ts": ""
    },
    "items_details": [
        {
            "serial_no": "1",
            "is_service": "NO",
            "hsn_code": "19059040",
            "quantity": 1,
            "unit_price": 2,
            "total_amount": 2,
            "assessment_amount": 2,
            "gst_rate": 18,
            "total_item_value": 4,
            "product_description": "xyz description test"
        }
    ],
    "value_details": {
        "assessment_value": 4,
        "total_invoice_value": 4
    },
    "supplier_bank_details": {
        "vpa": "test@vpa",
        "account_type": "",
        "bank_account_number": "3307",
        "name_of_account_holder": "John Doe",
        "bank_ifsc_code": "SBIN0070305",
        "bank_name": "SBI"
    },
    "metadata": {},
    "status": "CLOSED",
    "response":{
	    "status":"SUCCESS",
	    "message":""
    }
}

The table below lists the various parameters in the bharat_connect.invoice object.

Parameters	Type	Description
id	string	Unique identifier for the invoice. Example: bcinv_k3pbaALyh1CmzTPTOToHywYey
object	string	Type of the object. Example: bharat_connect.invoice
type	string	Type of invoice. Example: OUTGOING
supplier_invoice_number	string	Invoice number provided by the supplier. Example: INV0012312
supplier_details	object	Details about the supplier.
buyer_details	object	Details about the buyer.
transaction_detais	object	Transaction related details.
e_invoice_details	object	Details of e-invoice, if applicable.
items_details	array	List of items in the invoice.
value_details	object	Value-related details of the invoice.
supplier_bank_details	object	Bank details of the supplier.
metadata	object	Additional metadata for the invoice.
status	string	Current status of the invoice. Example: CLOSED
response	object	Response details for the invoice.
status	string	Response status. Example: SUCCESS
message	string	Additional response message. Example: "" for empty message

Child Object supplier_details

The table below lists the various parameters in the supplier_details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
b2b_id	string	Unique B2B ID for the supplier. Example: zwch_1731304320a8b539acf65f1337854926
gst_in	string	GSTIN of the supplier. Example: 22AAAAA0000A3Z9
legal_name	string	Legal name of the supplier. Example: Open Financial
trade_name	string	Trade name of the supplier. Example: Open Financial
email	string	Supplier's email address. Example: [email protected]
state_code	string	State code of the supplier. Example: 32
place_of_supply_code	string	Code for place of supply. Example: "" for empty
address	object	Address details of the supplier.

Child Object buyer_details

The table below lists the various parameters in the buyer_details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
b2b_id	string	Unique B2B ID for the buyer. Example: zwch_1731046715a8b539acf65f6707494305
gst_in	string	GSTIN of the buyer. Example: 22AAAAA0000A1H2
legal_name	string	Legal name of the buyer. Example: Surjava Test
trade_name	string	Trade name of the buyer. Example: Surjava Test
email	string	Buyer's email address. Example: [email protected]
state_code	string	State code of the buyer. Example: 06
place_of_supply_code	string	Place of supply code. Example: 32
address	object	Address details of the buyer.

Child Object transaction_details

The table below lists the various parameters in the transaction_details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
supply_type	string	Type of supply (e.g., B2B). Example: B2B
reverse_charge_tax	string	Reverse charge tax information. Example: "" for empty
e_commerce_gstin	string	GSTIN for e-commerce transactions. Example: "" for empty
igst_chargable	string	Whether IGST is chargeable. Example: "" for empty

Child Object E-Invoice Details

The table below lists the various parameters in the E-Invoice Details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
irn	string	Invoice Reference Number (IRN). Example: "" for empty
irn_ts	string	Timestamp of IRN generation. Example: "" for empty

Child Object Items Details Array

The table below lists the various parameters in the Items Details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
serial_no	string	Serial number of the item. Example: 1
is_service	string	Indicates whether the item is a service. Example: NO
hsn_code	string	HSN code of the item. Example: 19059040
quantity	integer	Quantity of the item. Example: 1
unit_price	integer	Unit price of the item. Example: 2
total_amount	integer	Total amount for the item. Example: 2
assessment_amount	integer	Assessment amount for the item. Example: 2
gst_rate	integer	GST rate for the item. Example: 18
total_item_value	integer	Total value of the item. Example: 4
product_description	string	Description of the product. Example: xyz description test

Child Object Value Details

The table below lists the various parameters in the Value Details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
assessment_value	integer	Assessment value of the invoice. Example: 4
total_invoice_value	integer	Total value of the invoice. Example: 4

Child Object Bank Details

The table below lists the various parameters in the Bank Details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
vpa	string	Virtual Payment Address (VPA) for the supplier. Example: test@vpa
account_type	string	Type of account (e.g., saving, current). Example: "" for empty
bank_account_number	string	Supplier's bank account number. Example: 3307
name_of_account_holder	string	Name of the account holder. Example: John Doe
bank_ifsc_code	string	IFSC code of the supplier's bank. Example: SBIN0070305
bank_name	string	Name of the supplier's bank. Example: SBI

Child Object Response

The table below lists the various parameters in the Bank Details object which is part of the bharat_connect.invoice object.

Parameters	Type	Description
status	string	Response status. Example: SUCCESS
message	string	Additional response message. Example: "" for empty message