Send E-Invoice to Buyer

Create a valid E-Invoice with JSON payload and send it to the Buyer Endpoint via PEPPOL network.

Request Method

POST

Request URL

{{HOST}}/be/einvoice/v1/documents/send

Request Headers

Parameter	Data Type	Field Validations	Description
x-cleartax-auth-token	String	Cannot be empty	Mandatory. User auth token.
x-clear-vat	String	Cannot be empty	Mandatory. VAT of the entity.
x-clear-branch	String	Should be a valid branch from the user account	Optional. Branch name (store name) added in the user account which maps to a VAT of the entity.
x-request-id	UUID	Should be unique for every request	Optional. Unique request ID. Used for Debugging Support Issues
Content-Type	String	application/json	application/json

Request Path Params

There are no path params for this API.

Request Query Params

Parameter	Data Type	Field Validations	Description
einvoice-type	ENUM	Currently, only SALES is supported	Default: SALES

Request Body

Parameter	Data Type	Field Validations	Description
Documents	Array	MinListLength: 1 MaxListLength: 10	Mandatory. List of Documents
Version	String	NA	Mandatory, "BE_GENERATE_UBL_2_1_V1"

Documents Object

Parameter	Data Type	Field Validations	Description
DocumentData	String	NA	Mandatory. Base64 of the document data in JSON format. Details.
DocumentFormat	ENUM	JSON	Mandatory. Describes the data received is in the JSON Format
CustomFields	Object	NA	Map of Custom fields with key-value pair eg : ( { “Internal Number” : “INV000012” })

Custom Fields Object

This is a custom object of key-value pairs that can be used to display custom fields in custom output PDF templates or in certain reports. For example:

{
    "country_of_origin": "IN",
    "total_containers": "3"
}

Response Status Codes

HTTP Status Code	Description
200	For successfully submitted document or with validation errors
400	For any kind of Invalid Payload issues
401	If the user is not authenticated for the operation
403	If the user is not authorized for the operation

Response Schema

Parameter	Data Type	Field Validations	Description
Success	Boolean	true/false	Always present. Indicates the request was successful or not
DocumentResponses	Array	-	-

Document Details Object

Parameter	Data Type	Field Validations	Description
DocumentId	String		Unique document ID, generated by database. To be used in Status Check API.
UniqueId	String		Unique ID generated by ClearTax to distinctly identify the document.
Success	Boolean	true/false	Indicates, if the request for this document was successfully processed or not
ErrorDetails	Array<ErrorDetail>	Error details	Optional. Error list from ClearTax
WarningDetails	Array<ErrorDetail>	Warning details	Optional. Warning list from ClearTax

Sample Request and Response

Request

{
    "Documents": [
        {
            "DocumentData": "{
  "ID": "BELgium2",
  "IssueDate": "2025-08-07",
  "InvoiceTypeCode": "388",
  "Note": "Sample note",
  "DocumentCurrencyCode": "USD",
  "TaxCurrencyCode": "INR",
  "BuyerReference": "BUYER-REF-001",
  "InvoicePeriod": {
    "StartDate": "2025-08-05",
    "EndDate": "2025-08-07"
  },
  "OrderReference": {
    "ID": "ORD-2025-001"
  },
  "BillingReference": [
    {
      "InvoiceDocumentReference": {
        "ID": "LINKED-001",
        "IssueDate": "2025-08-01"
      }
    }
  ],
  "ContractDocumentReference": {
    "ID": "CONTRACT-001"
  },
  "ProjectReference": {
    "ID": "PROJECT-001"
  },
  "AccountingSupplierParty": {
    "Party": {
      "EndpointID": {
        "Value": "BE1234567890",
        "SchemeID": "9925"
      },
      "PartyIdentification": [
        {
          "ID": {
            "Value": "Party-identification-supplier",
            "SchemeID": "0002"
          }
        }
      ],
      "PostalAddress": {
        "StreetName": "Sample street",
        "AdditionalStreetName": "Sample additional street",
        "CityName": "Belgium",
        "PostalZone": "2000",
        "CountrySubentity": "Sample seller state",
        "AddressLine": [
          {
            "Line": "Address line 3"
          }
        ],
        "Country": {
          "IdentificationCode": "BE"
        }
      },
      "PartyTaxScheme": [
        {
          "CompanyID": "BE0120240102",
          "TaxScheme": {
            "ID": "VAT"
          }
        }
      ],
      "PartyLegalEntity": {
        "RegistrationName": "Sample seller name"
      },
      "Contact": {
        "Name": "Sample seller contact name",
        "Telephone": "3232328210",
        "ElectronicMail": "seller@clear.in"
      }
    }
  },
  "AccountingCustomerParty": {
    "Party": {
      "EndpointID": {
        "Value": "01202401021129",
        "SchemeID": "0193"
      },
      "PartyIdentification": [
        {
          "ID": {
            "Value": "BE9872222222",
            "SchemeID": "0003"
          }
        }
      ],
      "PostalAddress": {
        "StreetName": "Sample buyer street",
        "AdditionalStreetName": "Sample buyer add. street",
        "CityName": "Sample buyer city",
        "PostalZone": "9000",
        "CountrySubentity": "Sample buyer state",
        "AddressLine": [
          {
            "Line": "Buyer address line 3"
          }
        ],
        "Country": {
          "IdentificationCode": "US"
        }
      },
      "PartyLegalEntity": {
        "RegistrationName": "Sample buyer name"
      },
      "Contact": {
        "Name": "Sample buyer contact name",
        "Telephone": "32 89 84 52 58",
        "ElectronicMail": "buyer@clear.in"
      }
    }
  },
  "Delivery": {
    "ActualDeliveryDate": "2025-08-04",
    "DeliveryLocation": {
      "ID": {
        "Value": "22873",
        "SchemeID": "0085"
      },
      "Address": {
        "StreetName": "Delivery street",
        "AdditionalStreetName": "Delivery add. street",
        "CityName": "Sample delivery city",
        "PostalZone": "1000",
        "CountrySubentity": "Sample delivery state",
        "AddressLine": [
          {
            "Line": "Delivery line 3"
          }
        ],
        "Country": {
          "IdentificationCode": "BE"
        }
      }
    },
    "DeliveryParty": {
      "PartyName": {
        "Name": "Sample delivery recp. name"
      }
    }
  },
  "PaymentMeans": {
    "PaymentMeansCode": "10",
    "PayeeFinancialAccount": {
      "ID": "BE88 4567 8901 2345",
      "Name": "Supplier Theta Ltd",
      "FinancialInstitutionBranch": {
        "ID": "KREDBEBB"
      }
    }
  },
  "PaymentTerms": {
    "Note": "Payment within 14 days"
  },
  "AllowanceCharge": [
    {
      "ChargeIndicator": false,
      "AllowanceChargeReasonCode": "41",
      "MultiplierFactorNumeric": 0.0,
      "Amount": {
        "Value": 0.00
      },
      "BaseAmount": {
        "Value": 0.000
      },
      "TaxCategory": {
        "ID": "S",
        "Percent": 12.00,
        "TaxScheme": {
          "ID": "VAT"
        }
      }
    },
    {
      "ChargeIndicator": true,
      "AllowanceChargeReasonCode": "ZZZ",
      "MultiplierFactorNumeric": 0.00,
      "Amount": {
        "Value": 0.0000
      },
      "BaseAmount": {
        "Value": 0.0000000
      },
      "TaxCategory": {
        "ID": "S",
        "Percent": 21.00,
        "TaxScheme": {
          "ID": "VAT"
        }
      }
    }
  ],
  "TaxTotal": [
    {
      "TaxAmount": {
        "Value": 318.3
      },
      "TaxSubtotal": [
        {
          "TaxableAmount": {
            "Value": 990.00
          },
          "TaxAmount": {
            "Value": 118.8
          },
          "TaxCategory": {
            "ID": "S",
            "Percent": 12.00,
            "TaxScheme": {
              "ID": "VAT"
            }
          }
        },
        {
          "TaxableAmount": {
            "Value": 950.00
          },
          "TaxAmount": {
            "Value": 199.5
          },
          "TaxCategory": {
            "ID": "S",
            "Percent": 21.00,
            "TaxScheme": {
              "ID": "VAT"
            }
          }
        }
      ]
    },
    {
      "TaxAmount": {
        "Value": 31830.0,
        "CurrencyID": "INR"
      }
    }
  ],
  "LegalMonetaryTotal": {
    "LineExtensionAmount": {
      "Value": 1940.00
    },
    "TaxExclusiveAmount": {
      "Value": 1940.00
    },
    "TaxInclusiveAmount": {
      "Value": 2258.30
    },
    "AllowanceTotalAmount": {
      "Value": 0.00
    },
    "ChargeTotalAmount": {
      "Value": 0.00
    },
    "PrepaidAmount": {
      "Value": 100.00
    },
    "PayableRoundingAmount": {
      "Value": -0.3
    },
    "PayableAmount": {
      "Value": 2158.00
    }
  },
  "InvoiceLine": [
    {
      "ID": "1",
      "InvoicedQuantity": {
        "Quantity": 2.00,
        "UnitCode": "AE"
      },
      "LineExtensionAmount": {
        "Value": 950.00
      },
      "AllowanceCharge": [
        {
          "ChargeIndicator": false,
          "AllowanceChargeReasonCode": "41",
          "MultiplierFactorNumeric": 10.0,
          "Amount": {
            "Value": 100.00
          },
          "BaseAmount": {
            "Value": 1000.00
          }
        },
        {
          "ChargeIndicator": true,
          "AllowanceChargeReasonCode": "ZZZ",
          "MultiplierFactorNumeric": 5.0,
          "Amount": {
            "Value": 50.00
          },
          "BaseAmount": {
            "Value": 1000.00
          }
        }
      ],
      "Item": {
        "Description": "Item 1 description",
        "Name": "Item 1 name",
        "OriginCountry": {
          "IdentificationCode": "JP"
        },
        "CommodityClassification": [
          {
            "ItemClassificationCode": {
              "SchemeID": "AA",
              "Value": "09348023"
            }
          }
        ],
        "ClassifiedTaxCategory": [
          {
            "ID": "S",
            "Percent": 21.00,
            "TaxScheme": {
              "ID": "VAT"
            }
          }
        ]
      },
      "Price": {
        "PriceAmount": {
          "Value": 500
        }
      }
    },
    {
      "ID": "2",
      "InvoicedQuantity": {
        "Quantity": 5.00,
        "UnitCode": "AE"
      },
      "LineExtensionAmount": {
        "Value": 990.00
      },
      "AllowanceCharge": [
        {
          "ChargeIndicator": false,
          "AllowanceChargeReasonCode": "41",
          "MultiplierFactorNumeric": 2.0,
          "Amount": {
            "Value": 20.00
          },
          "BaseAmount": {
            "Value": 1000.00
          }
        },
        {
          "ChargeIndicator": true,
          "AllowanceChargeReasonCode": "ZZZ",
          "MultiplierFactorNumeric": 1.0,
          "Amount": {
            "Value": 10.00
          },
          "BaseAmount": {
            "Value": 1000.00
          }
        }
      ],
      "Item": {
        "Description": "Item 2 description",
        "Name": "Item 2 name",
        "OriginCountry": {
          "IdentificationCode": "JP"
        },
        "CommodityClassification": [
          {
            "ItemClassificationCode": {
              "SchemeID": "AB",
              "Value": "09348023"
            }
          }
        ],
        "ClassifiedTaxCategory": [
          {
            "ID": "S",
            "Percent": 12.00,
            "TaxScheme": {
              "ID": "VAT"
            }
          }
        ]
      },
      "Price": {
        "PriceAmount": {
          "Value": 200
        }
      }
    }
  ]
}",
            "DocumentFormat": "JSON",
            "CustomFields": {
                "Internal Number": "INVBELGIUM1"
            }
        }
    ]
}

Response - Success:

HTTP Status Code - 200

{
    "ErrorDetails": null,
    "Success": "true",
    "DocumentResponses": [
        {
            "DocumentId": "68a2c61d2086c615843fd5b0",
            "Success": "true",
            "UniqueId": "BE1234567890_BELgium2_388_2025",
            "ErrorDetails": [],
            "WarningDetails": [
                {
                    "Code": "DUP-202",
                    "Message": "Invoice is already submitted, we are returning the response from the Previously submitted Invoice"
                }
            ]
        }
    ]
}

Response - Failure:

HTTP Status Code - 200

{
    "ErrorDetails": null,
    "Success": "true",
    "DocumentResponses": [
        {
            "DocumentId": "68a470572b3ac34d630779e2",
            "Success": "false",
            "UniqueId": "BE1234567890__388_2025",
            "ErrorDetails": [
                {
                    "ErrorCode": "BR-02",
                    "ErrorMessage": "[BR-02]-An Invoice shall have an Invoice number (BT-1).",
                    "ErrorSource": "CLEARTAX",
                    "Path": "Invoice"
                }
            ],
            "WarningDetails": null
        }
    ]
}

API Validations

Currently there are no known validations for this API.

API Constraints

1. This API needs to be authenticated with a valid user authentication token. If the auth token is not present or is invalid, the API will return HTTP Status Code 401.

2. If the auth token is valid, but the user does not have the authorization to generate an e-invoice for a document, then the API will return HTTP Status Code 403. The user, whose auth token is used, should have an Admin role for the particular TIN used in the request.