Create Invoice

curl --request POST \
  --url https://api.billclap.com/api/web/invoice/create-invoice \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "type": "<string>",
  "issue_date": "<string>",
  "due_date": "<string>",
  "receive_amount": 123,
  "party_detail": {
    "party_detail.party_name": "<string>",
    "party_detail.mobile_no": "<string>",
    "party_detail.gst_no": "<string>",
    "party_detail.address": "<string>",
    "party_detail.city": "<string>",
    "party_detail.state": "<string>",
    "party_detail.country": "<string>",
    "party_detail.pin_code": "<string>"
  },
  "product_details": [
    {
      "product_details.0.product_name": "<string>",
      "product_details.0.product_sell_price": 123,
      "product_details.0.product_sell_price_tax_type": "<string>",
      "product_details.0.product_gst": 123,
      "product_details.0.product_hsn": "<string>",
      "product_details.0.product_quantity": 123
    }
  ],
  "additional_charges": [
    {
      "additional_charges.0.chargeName": "<string>",
      "additional_charges.0.chargeValue": 123,
      "additional_charges.0.tax": 123,
      "additional_charges.0.hsn_code": "<string>"
    }
  ]
}
'

{
  "result.status": true,
  "result.message": "<string>",
  "result.invoice_id": 123,
  "result.link": "<string>",
  "result.code": 123
}

POST

api

web

invoice

create-invoice

Create Invoice

curl --request POST \
  --url https://api.billclap.com/api/web/invoice/create-invoice \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "type": "<string>",
  "issue_date": "<string>",
  "due_date": "<string>",
  "receive_amount": 123,
  "party_detail": {
    "party_detail.party_name": "<string>",
    "party_detail.mobile_no": "<string>",
    "party_detail.gst_no": "<string>",
    "party_detail.address": "<string>",
    "party_detail.city": "<string>",
    "party_detail.state": "<string>",
    "party_detail.country": "<string>",
    "party_detail.pin_code": "<string>"
  },
  "product_details": [
    {
      "product_details.0.product_name": "<string>",
      "product_details.0.product_sell_price": 123,
      "product_details.0.product_sell_price_tax_type": "<string>",
      "product_details.0.product_gst": 123,
      "product_details.0.product_hsn": "<string>",
      "product_details.0.product_quantity": 123
    }
  ],
  "additional_charges": [
    {
      "additional_charges.0.chargeName": "<string>",
      "additional_charges.0.chargeValue": 123,
      "additional_charges.0.tax": 123,
      "additional_charges.0.hsn_code": "<string>"
    }
  ]
}
'

{
  "result.status": true,
  "result.message": "<string>",
  "result.invoice_id": 123,
  "result.link": "<string>",
  "result.code": 123
}

Create an invoice (or related document) for the business associated with your API token. The endpoint runs in a database transaction: party and line items are created or matched, totals are calculated, inventory and ledger entries are updated when applicable, and a shareable preview link is returned.

Your BillClap plan must include the API integration feature. See Authentication.

For full field reference, validation rules, and error codes, see the Create Invoice guide.

Request

Content-Type

string

default:"application/json"

required

Must be application/json.

x-api-token

string

required

API token from Settings → API Integration in the BillClap app.

type

string

required

Document type. Common values: SALESINVOICE, QUOTATION, SALESRETURN, PURCHASEBILL, PURCHASERETURN, DELIVERYCHALLAN, ORDER, PURCHASEORDER, SELLORDER, SALEORDER.

issue_date

string

Invoice issue date (YYYY-MM-DD).

due_date

string

Payment due date (YYYY-MM-DD).

receive_amount

number

Amount received against the invoice. Cannot exceed the calculated total.

party_detail

object

required

Customer or supplier details.

Show properties

party_detail.party_name

string

Display name when creating a new party.

party_detail.mobile_no

string

Required when creating or matching a party unless party_id or cash_sale is used.

party_detail.gst_no

string

GSTIN.

party_detail.address

string

Billing address.

party_detail.city

string

Billing city.

party_detail.state

string

Billing state.

party_detail.country

string

Billing country.

party_detail.pin_code

string

Billing PIN code.

product_details

object[]

required

Line items. At least one entry with product_name is required.

Show item properties

product_details.0.product_name

string

required

Product name (matched or created in catalog).

product_details.0.product_sell_price

number

Unit price for new products.

product_details.0.product_sell_price_tax_type

string

With Tax or Without Tax.

product_details.0.product_gst

number

GST rate percentage.

product_details.0.product_hsn

string

HSN/SAC code.

product_details.0.product_quantity

number

Quantity.

additional_charges

object[]

Optional extra charges with tax.

Show item properties

additional_charges.0.chargeName

string

Charge label.

additional_charges.0.chargeValue

number

Taxable amount before GST on the charge.

additional_charges.0.tax

number

GST percentage on the charge.

additional_charges.0.hsn_code

string

HSN for the charge.

Response

result.status

boolean

true on success.

result.message

string

Human-readable success message.

result.invoice_id

number

Internal BillClap invoice id.

result.link

string

Shareable preview URL for the created document.

result.code

number

Application status code (200 on success).

​Request

​Response

Request

Response