API Documentation

DocBridge Document API — request payload & integration reference for sale orders, sales, purchases and returns.

POST Basic Auth JSON
All documents are sent to a single endpoint. Your X-Organization-Id and Basic-auth credentials are shared during onboarding. Request access →

Introduction

The DocBridge Document API lets your application create and send business documents — sale orders, sales, purchases and returns — to BUSY through DocBridge. Every request is a JSON POST to the same endpoint; the document_type decides which document is created.

This documentation is intended for developers and integration teams implementing DocBridge integrations.

One endpoint 6 document types JSON payloads

Request Header Reference

Send these headers with every request.

HeaderExample / Rule
URLhttps://docbridge.bignext.in/api/documents/send/
X-Organization-IdUnique organization ID provided by the integrating organization.
AuthorizationBasic (Base64)
Content-Typeapplication/json
Endpoint
POST https://docbridge.bignext.in/api/documents/send/

Authentication

Authorization Rule: Basic (Base64) — use Basic Authentication with the required credentials encoded using Base64 (Username:Password).

Headers
X-Organization-Id: YOUR_ORGANIZATION_ID
Authorization: Basic base64(USERNAME:PASSWORD)
Content-Type: application/json
Keep your credentials on the server — never expose them in browser or mobile app code.

Request Envelope

Every request uses a standard envelope containing document_type, receiver and payload. The business data is contained inside the payload object.

PropertyTypeRequiredDescription
document_typestringYesType of document to create — see Document Types.
receiverUUID / stringYesFixed receiver ID for the integration: 8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2
payloadobjectYesContains the complete document header and item-level data.

Document Types

Use the matching document_type and transaction_type for each document.

Documentdocument_typetransaction_type
Sale Ordersale_order12
Salesale9
Sale Returnsale_return3
Purchase Orderpurchase_order13
Purchasepurchase2
Purchase Returnpurchase_return10
POST/api/documents/send/ sale_order

Sale Order API

Defines the JSON request structure used by DocBridge for creating or sending a Sale Order document. The request uses the standard envelope containing document_type, receiver and payload; the Sale Order business data is contained inside the payload object.

Integration Constants

ParameterValue / Rule
document_typesale_order
receiver8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2
transaction_type12

1. Request Overview

PropertyTypeRequiredDescription
document_typestringYesMust be sale_order.
receiverUUID / stringYesFixed receiver ID for the integration.
payloadobjectYesContains the complete Sale Order header and item-level data.

2. Sale Order Payload Fields

FieldTypeRequiredDescription
remarksstringNoGeneral remarks associated with the Sale Order.
party_namestringYesCustomer / party name.
item_entriesarrayYesOne or more Sale Order item lines. See Item Entry Structure.
location_namestringYesLocation / branch / warehouse associated with the sale order.
transaction_datedate stringYesTransaction/order date in YYYY-MM-DD format.
transaction_typeintegerYesTransaction type code. Value for Sale Order is 12.
transaction_numberstringYesUnique transaction/order number.
transaction_tax_typestringYesTax classification. Example: Central-ItemWise.
transaction_series_namestringYesTransaction series under which the sale order is recorded.
3. Item Entry Structure11 fields · each object in item_entries is one item line
#FieldTypeRequiredDescription
1serial_nointegerYesSequential item line number.
2item_namestringYesName of the item/product being ordered.
3quantitynumberYesQuantity ordered.
4list_pricenumberYesList price of the item.
5discount_percentnumberNoDiscount percentage applied to the item.
6net_pricenumberYesNet unit price.
7net_amountnumberYesNet amount of the item line.
8tax_ratenumberYesApplicable tax rate percentage.
9tax_amountnumberYesTax amount calculated for the item line.
10descriptionstringNoAdditional item-level description.
11short_remarksstringNoShort remarks associated with the item line.

4. Complete Sale Order Request

Request body · sale_order
{
    "document_type": "sale_order",
    "receiver": "8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2",
    "payload": {
        "remarks": "Automation is must",
        "party_name": "BIGNEXT TECHNOLOGIES",
        "item_entries": [
            {
                "serial_no": 1,
                "item_name": "PG ALU TWIN F 10.0 SQ PVC INS 90M B",
                "quantity": 16,
                "list_price": 5213,
                "discount_percent": 0,
                "net_price": 5213,
                "net_amount": 83408,
                "tax_rate": 18,
                "tax_amount": 15013.4,
                "description": "#U2KLJP-2026-10-666",
                "short_remarks": "Automation is must, Order confim 25 august discount 49"
            }
        ],
        "location_name": "LUDHIANA",
        "transaction_date": "2026-10-07",
        "transaction_type": 12,
        "transaction_number": "#123",
        "transaction_tax_type": "Central-ItemWise",
        "transaction_series_name": "Main"
    }
}

Code Samples

POST/api/documents/send/ sale

Sale API

Defines the JSON request structure used by DocBridge for creating or sending a Sale (sales invoice) document. The request uses the standard envelope containing document_type, receiver and payload; the Sale business data is contained inside the payload object.

Integration Constants

ParameterValue / Rule
document_typesale
receiver8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2
transaction_type9

1. Request Overview

PropertyTypeRequiredDescription
document_typestringYesMust be sale.
receiverUUID / stringYesFixed receiver ID for the integration.
payloadobjectYesContains the complete Sale header and item-level data.

2. Sale Payload Fields

FieldTypeRequiredDescription
remarksstringNoGeneral remarks associated with the Sale.
party_namestringYesCustomer / party name.
item_entriesarrayYesOne or more Sale item lines. See Item Entry Structure.
location_namestringYesLocation / branch / warehouse associated with the sale.
transaction_datedate stringYesTransaction/invoice date in YYYY-MM-DD format.
transaction_typeintegerYesTransaction type code. Value for Sale is 9.
transaction_numberstringYesUnique transaction/invoice number.
transaction_tax_typestringYesTax classification. Example: Central-ItemWise.
transaction_series_namestringYesTransaction series under which the sale is recorded.
3. Item Entry Structure11 fields · each object in item_entries is one item line
#FieldTypeRequiredDescription
1serial_nointegerYesSequential item line number.
2item_namestringYesName of the item/product being billed.
3quantitynumberYesQuantity billed.
4list_pricenumberYesList price of the item.
5discount_percentnumberNoDiscount percentage applied to the item.
6net_pricenumberYesNet unit price.
7net_amountnumberYesNet amount of the item line.
8tax_ratenumberYesApplicable tax rate percentage.
9tax_amountnumberYesTax amount calculated for the item line.
10descriptionstringNoAdditional item-level description.
11short_remarksstringNoShort remarks associated with the item line.

4. Complete Sale Request

Request body · sale
{
    "document_type": "sale",
    "receiver": "8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2",
    "payload": {
        "remarks": "Invoice against order #123",
        "party_name": "BIGNEXT TECHNOLOGIES",
        "item_entries": [
            {
                "serial_no": 1,
                "item_name": "PG ALU TWIN F 10.0 SQ PVC INS 90M B",
                "quantity": 16,
                "list_price": 5213,
                "discount_percent": 0,
                "net_price": 5213,
                "net_amount": 83408,
                "tax_rate": 18,
                "tax_amount": 15013.4,
                "description": "#U2KLJP-2026-10-667",
                "short_remarks": "Dispatched via road transport"
            }
        ],
        "location_name": "LUDHIANA",
        "transaction_date": "2026-10-07",
        "transaction_type": 9,
        "transaction_number": "#124",
        "transaction_tax_type": "Central-ItemWise",
        "transaction_series_name": "Main"
    }
}

Code Samples

POST/api/documents/send/ sale_return

Sale Return API

Defines the JSON request structure used by DocBridge for creating or sending a Sale Return document. The request uses the standard envelope containing document_type, receiver and payload; the Sale Return business data is contained inside the payload object.

Integration Constants

ParameterValue / Rule
document_typesale_return
receiver8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2
transaction_type3

1. Request Overview

PropertyTypeRequiredDescription
document_typestringYesMust be sale_return.
receiverUUID / stringYesFixed receiver ID for the integration.
payloadobjectYesContains the complete Sale Return header and item-level data.

2. Sale Return Payload Fields

FieldTypeRequiredDescription
remarksstringNoGeneral remarks associated with the Sale Return.
party_namestringYesCustomer / party name returning the goods.
item_entriesarrayYesOne or more Sale Return item lines. See Item Entry Structure.
location_namestringYesLocation / branch / warehouse associated with the sale return.
transaction_datedate stringYesTransaction/return date in YYYY-MM-DD format.
transaction_typeintegerYesTransaction type code. Value for Sale Return is 3.
transaction_numberstringYesUnique transaction/return number.
transaction_tax_typestringYesTax classification. Example: Central-ItemWise.
transaction_series_namestringYesTransaction series under which the sale return is recorded.
3. Item Entry Structure11 fields · each object in item_entries is one item line
#FieldTypeRequiredDescription
1serial_nointegerYesSequential item line number.
2item_namestringYesName of the item/product being returned.
3quantitynumberYesQuantity returned.
4list_pricenumberYesList price of the item.
5discount_percentnumberNoDiscount percentage applied to the item.
6net_pricenumberYesNet unit price.
7net_amountnumberYesNet amount of the item line.
8tax_ratenumberYesApplicable tax rate percentage.
9tax_amountnumberYesTax amount calculated for the item line.
10descriptionstringNoAdditional item-level description.
11short_remarksstringNoShort remarks associated with the item line.

4. Complete Sale Return Request

Request body · sale_return
{
    "document_type": "sale_return",
    "receiver": "8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2",
    "payload": {
        "remarks": "Goods returned against invoice #124",
        "party_name": "BIGNEXT TECHNOLOGIES",
        "item_entries": [
            {
                "serial_no": 1,
                "item_name": "PG ALU TWIN F 10.0 SQ PVC INS 90M B",
                "quantity": 16,
                "list_price": 5213,
                "discount_percent": 0,
                "net_price": 5213,
                "net_amount": 83408,
                "tax_rate": 18,
                "tax_amount": 15013.4,
                "description": "#U2KLJP-2026-10-668",
                "short_remarks": "Damaged in transit"
            }
        ],
        "location_name": "LUDHIANA",
        "transaction_date": "2026-10-07",
        "transaction_type": 3,
        "transaction_number": "#SR-15",
        "transaction_tax_type": "Central-ItemWise",
        "transaction_series_name": "Main"
    }
}

Code Samples

POST/api/documents/send/ purchase_order

Purchase Order API

Defines the JSON request structure used by DocBridge for creating or sending a Purchase Order document. The request uses the standard envelope containing document_type, receiver and payload; the Purchase Order business data is contained inside the payload object.

Integration Constants

ParameterValue / Rule
document_typepurchase_order
receiver8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2
transaction_type13

1. Request Overview

PropertyTypeRequiredDescription
document_typestringYesMust be purchase_order.
receiverUUID / stringYesFixed receiver ID for the integration.
payloadobjectYesContains the complete Purchase Order header and item-level data.

2. Purchase Order Payload Fields

FieldTypeRequiredDescription
remarksstringNoGeneral remarks associated with the Purchase Order.
party_namestringYesSupplier / party name.
item_entriesarrayYesOne or more Purchase Order item lines. See Item Entry Structure.
location_namestringYesLocation / branch / warehouse associated with the purchase order.
transaction_datedate stringYesTransaction/order date in YYYY-MM-DD format.
transaction_typeintegerYesTransaction type code. Value for Purchase Order is 13.
transaction_numberstringYesUnique transaction/order number.
transaction_tax_typestringYesTax classification. Example: Central-ItemWise.
transaction_series_namestringYesTransaction series under which the purchase order is recorded.
3. Item Entry Structure11 fields · each object in item_entries is one item line
#FieldTypeRequiredDescription
1serial_nointegerYesSequential item line number.
2item_namestringYesName of the item/product being ordered.
3quantitynumberYesQuantity ordered.
4list_pricenumberYesList price of the item.
5discount_percentnumberNoDiscount percentage applied to the item.
6net_pricenumberYesNet unit price.
7net_amountnumberYesNet amount of the item line.
8tax_ratenumberYesApplicable tax rate percentage.
9tax_amountnumberYesTax amount calculated for the item line.
10descriptionstringNoAdditional item-level description.
11short_remarksstringNoShort remarks associated with the item line.

4. Complete Purchase Order Request

Request body · purchase_order
{
    "document_type": "purchase_order",
    "receiver": "8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2",
    "payload": {
        "remarks": "Urgent requirement",
        "party_name": "BIGNEXT TECHNOLOGIES",
        "item_entries": [
            {
                "serial_no": 1,
                "item_name": "PG ALU TWIN F 10.0 SQ PVC INS 90M B",
                "quantity": 16,
                "list_price": 5213,
                "discount_percent": 0,
                "net_price": 5213,
                "net_amount": 83408,
                "tax_rate": 18,
                "tax_amount": 15013.4,
                "description": "#U2KLJP-2026-10-669",
                "short_remarks": "Deliver before 15 October"
            }
        ],
        "location_name": "LUDHIANA",
        "transaction_date": "2026-10-07",
        "transaction_type": 13,
        "transaction_number": "#PO-201",
        "transaction_tax_type": "Central-ItemWise",
        "transaction_series_name": "Main"
    }
}

Code Samples

POST/api/documents/send/ purchase

Purchase API

Defines the JSON request structure used by DocBridge for creating or sending a Purchase (purchase invoice) document. The request uses the standard envelope containing document_type, receiver and payload; the Purchase business data is contained inside the payload object.

Integration Constants

ParameterValue / Rule
document_typepurchase
receiver8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2
transaction_type2

1. Request Overview

PropertyTypeRequiredDescription
document_typestringYesMust be purchase.
receiverUUID / stringYesFixed receiver ID for the integration.
payloadobjectYesContains the complete Purchase header and item-level data.

2. Purchase Payload Fields

FieldTypeRequiredDescription
remarksstringNoGeneral remarks associated with the Purchase.
party_namestringYesSupplier / party name.
item_entriesarrayYesOne or more Purchase item lines. See Item Entry Structure.
location_namestringYesLocation / branch / warehouse associated with the purchase.
transaction_datedate stringYesTransaction/bill date in YYYY-MM-DD format.
transaction_typeintegerYesTransaction type code. Value for Purchase is 2.
transaction_numberstringYesUnique transaction/bill number.
transaction_tax_typestringYesTax classification. Example: Central-ItemWise.
transaction_series_namestringYesTransaction series under which the purchase is recorded.
3. Item Entry Structure11 fields · each object in item_entries is one item line
#FieldTypeRequiredDescription
1serial_nointegerYesSequential item line number.
2item_namestringYesName of the item/product being billed.
3quantitynumberYesQuantity billed.
4list_pricenumberYesList price of the item.
5discount_percentnumberNoDiscount percentage applied to the item.
6net_pricenumberYesNet unit price.
7net_amountnumberYesNet amount of the item line.
8tax_ratenumberYesApplicable tax rate percentage.
9tax_amountnumberYesTax amount calculated for the item line.
10descriptionstringNoAdditional item-level description.
11short_remarksstringNoShort remarks associated with the item line.

4. Complete Purchase Request

Request body · purchase
{
    "document_type": "purchase",
    "receiver": "8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2",
    "payload": {
        "remarks": "Material received against PO #PO-201",
        "party_name": "BIGNEXT TECHNOLOGIES",
        "item_entries": [
            {
                "serial_no": 1,
                "item_name": "PG ALU TWIN F 10.0 SQ PVC INS 90M B",
                "quantity": 16,
                "list_price": 5213,
                "discount_percent": 0,
                "net_price": 5213,
                "net_amount": 83408,
                "tax_rate": 18,
                "tax_amount": 15013.4,
                "description": "#U2KLJP-2026-10-670",
                "short_remarks": "Received in good condition"
            }
        ],
        "location_name": "LUDHIANA",
        "transaction_date": "2026-10-07",
        "transaction_type": 2,
        "transaction_number": "#PB-310",
        "transaction_tax_type": "Central-ItemWise",
        "transaction_series_name": "Main"
    }
}

Code Samples

POST/api/documents/send/ purchase_return

Purchase Return API

Defines the JSON request structure used by DocBridge for creating or sending a Purchase Return document. The request uses the standard envelope containing document_type, receiver and payload; the Purchase Return business data is contained inside the payload object.

Integration Constants

ParameterValue / Rule
document_typepurchase_return
receiver8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2
transaction_type10

1. Request Overview

PropertyTypeRequiredDescription
document_typestringYesMust be purchase_return.
receiverUUID / stringYesFixed receiver ID for the integration.
payloadobjectYesContains the complete Purchase Return header and item-level data.

2. Purchase Return Payload Fields

FieldTypeRequiredDescription
remarksstringNoGeneral remarks associated with the Purchase Return.
party_namestringYesSupplier / party name the goods are returned to.
item_entriesarrayYesOne or more Purchase Return item lines. See Item Entry Structure.
location_namestringYesLocation / branch / warehouse associated with the purchase return.
transaction_datedate stringYesTransaction/return date in YYYY-MM-DD format.
transaction_typeintegerYesTransaction type code. Value for Purchase Return is 10.
transaction_numberstringYesUnique transaction/return number.
transaction_tax_typestringYesTax classification. Example: Central-ItemWise.
transaction_series_namestringYesTransaction series under which the purchase return is recorded.
3. Item Entry Structure11 fields · each object in item_entries is one item line
#FieldTypeRequiredDescription
1serial_nointegerYesSequential item line number.
2item_namestringYesName of the item/product being returned.
3quantitynumberYesQuantity returned.
4list_pricenumberYesList price of the item.
5discount_percentnumberNoDiscount percentage applied to the item.
6net_pricenumberYesNet unit price.
7net_amountnumberYesNet amount of the item line.
8tax_ratenumberYesApplicable tax rate percentage.
9tax_amountnumberYesTax amount calculated for the item line.
10descriptionstringNoAdditional item-level description.
11short_remarksstringNoShort remarks associated with the item line.

4. Complete Purchase Return Request

Request body · purchase_return
{
    "document_type": "purchase_return",
    "receiver": "8bb8dd87-3dce-4f02-a6cc-9ef7d84056f2",
    "payload": {
        "remarks": "Returned against bill #PB-310",
        "party_name": "BIGNEXT TECHNOLOGIES",
        "item_entries": [
            {
                "serial_no": 1,
                "item_name": "PG ALU TWIN F 10.0 SQ PVC INS 90M B",
                "quantity": 16,
                "list_price": 5213,
                "discount_percent": 0,
                "net_price": 5213,
                "net_amount": 83408,
                "tax_rate": 18,
                "tax_amount": 15013.4,
                "description": "#U2KLJP-2026-10-671",
                "short_remarks": "Quality issue"
            }
        ],
        "location_name": "LUDHIANA",
        "transaction_date": "2026-10-07",
        "transaction_type": 10,
        "transaction_number": "#PR-22",
        "transaction_tax_type": "Central-ItemWise",
        "transaction_series_name": "Main"
    }
}

Code Samples

Support

Need credentials, help with an integration or a new document type? Our team is happy to help.