- APIs
- Webhooks
- Business Onboarding
- Invoice
- Payment
- Credit Note
- Purchase Order
- Send Purchase Order Request Webhook
- Send Purchase Order Response Webhook
- Confirm Purchase Order Request Webhook
- Confirm Purchase Order Response Webhook
- Edit Purchase Order Request Webhook
- Edit Purchase Order Response Webhook
- Status Change Purchase Order Request Webhook
- Status Change Purchase Order Response Webhook
- Financing
Send C/N RequestWebhook
Developing
POST
/api/v0/cd-note/req-send
Request
Body Params application/json
device
object
required
tag
object
required
b2bIds
object
required
buyerB2BId
string
required
supplierB2BId
string
required
cdNote
object
required
objectId
string
required
noteType
string
required
supplierCDNoteNumber
string
required
objectVersion
object
required
ts
string
required
cdNoteStatusTransition
object
required
eInvoiceInfo
object
required
transactionDetails
object
required
supplierDetails
object
required
buyerDetails
object
required
dispatchDetails
object
required
shippingDetails
object
required
itemLists
array [object {21}]
required
cdNoteValueDetails
object
required
supplierBankAccountDetails
object
required
advancePaymentDetails
object
required
invoiceReferenceDetails
object
required
precedingInvoiceDetails
array [object {3}]
required
poDetails
array [object {3}]
required
contractReferenceDetails
array [object {6}]
required
additionalDocumentDetails
array [object {3}]
required
exportDetails
object
required
ewayBillDetail
object
required
recurringPayments
object
required
paymentMilestones
array [object {2}]
required
shippingTermsDetails
object
required
additionalInfos
array [object {2}]
required
name
string
optional
value
string
optional
Example
{
"device": {
"tag": {
"name": "GEOCODE",
"value": "string"
}
},
"b2bIds": {
"buyerB2BId": "string",
"supplierB2BId": "string"
},
"cdNote": {
"objectId": "string",
"noteType": "string",
"supplierCDNoteNumber": "string",
"objectVersion": {
"currentVersion": 0,
"newVersion": 0
},
"ts": "string",
"cdNoteStatusTransition": {
"currentStatus": "CREATED",
"newStatus": "CREATED"
},
"eInvoiceInfo": {
"schemaVersion": "string",
"irnNumber": "string",
"irnTs": "string"
},
"transactionDetails": {
"taxScheme": "string",
"supplyType": "string",
"reverseChargeTax": "string",
"eCommerceGstin": "string",
"igstChargable": "string"
},
"supplierDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"buyerDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"placeOfSupply": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"dispatchDetails": {
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"shippingDetails": {
"gstin": "string",
"lglNm": "string",
"trdNm": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"itemLists": [
{
"serialno": "string",
"productDescription": "string",
"isService": "string",
"hsnCode": "string",
"barCode": "string",
"quantity": 0,
"freeQuantity": 0,
"unit": "string",
"unitPrice": 0,
"totalAmt": 0,
"assessmentAmount": 0,
"gstRate": 0,
"totalItemValue": 0,
"orderLineReference": "string",
"originCountry": "string",
"productSerialNumber": "string",
"itemValueDetails": [
{
"type": "string",
"value": 0
}
],
"rates": [
{
"type": "string",
"value": 0
}
],
"batchDetails": {
"batchNumber": "string",
"expiryDate": "string",
"batchWarrantyDate": "string"
},
"attributeDetails": [
{
"name": "string",
"value": "string"
}
],
"otherTaxes": [
{
"name": "string",
"rate": 0,
"amount": 0
}
]
}
],
"cdNoteValueDetails": {
"assessmentValue": 0,
"totalCDNoteValue": 0,
"otherValues": [
{
"type": "string",
"value": 0
}
]
},
"supplierBankAccountDetails": {
"maskedAccountNumber": "string",
"ifsc": "string",
"beneficiaryName": "string",
"businessVPA": "string"
},
"advancePaymentDetails": {
"payeeName": "string",
"mode": "string",
"paymentTerms": "string",
"paymentInstruction": "string",
"creditTransfer": "string",
"directDebit": "string",
"creditDays": 0,
"paidAmount": 0,
"pendingDueAmount": 0
},
"invoiceReferenceDetails": {
"invoiceRemarks": "string",
"invoiceStartDate": "string",
"invoiceEndDate": "string"
},
"precedingInvoiceDetails": [
{
"invoiceNumber": "string",
"date": "string",
"otherReferenceNo": "string"
}
],
"poDetails": [
{
"poObjId": "string",
"buyerPoId": "string",
"poDate": "string"
}
],
"contractReferenceDetails": [
{
"receiptAdviceNo": "string",
"receiptAdviceDate": "string",
"batchReferenceNo": "string",
"contractReferenceNo": "string",
"extraReferenceNo": "string",
"projectReferenceNo": "string"
}
],
"additionalDocumentDetails": [
{
"url": "string",
"document": "string",
"info": "string"
}
],
"exportDetails": {
"shipBillNo": "string",
"shipBillDate": "string",
"port": "string",
"refundClaim": "string",
"foreignCurrency": "string",
"countryCode": "string",
"exportDuty": 0
},
"ewayBillDetail": {
"transporterId": "string",
"transporterName": "string",
"transportMode": "string",
"distance": 0,
"transportDocumentNo": "string",
"transportDocumentDate": "string",
"vehicleNo": "string",
"vehicleType": "string"
},
"recurringPayments": {
"originalInvoiceId": "string",
"frequency": "string",
"startDate": "string",
"endDate": "string",
"mandateDetails": "string",
"mandateExecutionDate": "string",
"mandateAmount": 0
},
"paymentMilestones": [
{
"milestoneDate": "string",
"dueAmount": 0
}
],
"shippingTermsDetails": {
"terms": "string",
"bearingParty": "string",
"charges": 0
}
},
"additionalInfos": [
{
"name": "string",
"value": "string"
}
]
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v0/cd-note/req-send' \
--header 'Content-Type: application/json' \
--data-raw '{
"device": {
"tag": {
"name": "GEOCODE",
"value": "string"
}
},
"b2bIds": {
"buyerB2BId": "string",
"supplierB2BId": "string"
},
"cdNote": {
"objectId": "string",
"noteType": "string",
"supplierCDNoteNumber": "string",
"objectVersion": {
"currentVersion": 0,
"newVersion": 0
},
"ts": "string",
"cdNoteStatusTransition": {
"currentStatus": "CREATED",
"newStatus": "CREATED"
},
"eInvoiceInfo": {
"schemaVersion": "string",
"irnNumber": "string",
"irnTs": "string"
},
"transactionDetails": {
"taxScheme": "string",
"supplyType": "string",
"reverseChargeTax": "string",
"eCommerceGstin": "string",
"igstChargable": "string"
},
"supplierDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"buyerDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"placeOfSupply": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"dispatchDetails": {
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"shippingDetails": {
"gstin": "string",
"lglNm": "string",
"trdNm": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"itemLists": [
{
"serialno": "string",
"productDescription": "string",
"isService": "string",
"hsnCode": "string",
"barCode": "string",
"quantity": 0,
"freeQuantity": 0,
"unit": "string",
"unitPrice": 0,
"totalAmt": 0,
"assessmentAmount": 0,
"gstRate": 0,
"totalItemValue": 0,
"orderLineReference": "string",
"originCountry": "string",
"productSerialNumber": "string",
"itemValueDetails": [
{
"type": "string",
"value": 0
}
],
"rates": [
{
"type": "string",
"value": 0
}
],
"batchDetails": {
"batchNumber": "string",
"expiryDate": "string",
"batchWarrantyDate": "string"
},
"attributeDetails": [
{
"name": "string",
"value": "string"
}
],
"otherTaxes": [
{
"name": "string",
"rate": 0,
"amount": 0
}
]
}
],
"cdNoteValueDetails": {
"assessmentValue": 0,
"totalCDNoteValue": 0,
"otherValues": [
{
"type": "string",
"value": 0
}
]
},
"supplierBankAccountDetails": {
"maskedAccountNumber": "string",
"ifsc": "string",
"beneficiaryName": "string",
"businessVPA": "string"
},
"advancePaymentDetails": {
"payeeName": "string",
"mode": "string",
"paymentTerms": "string",
"paymentInstruction": "string",
"creditTransfer": "string",
"directDebit": "string",
"creditDays": 0,
"paidAmount": 0,
"pendingDueAmount": 0
},
"invoiceReferenceDetails": {
"invoiceRemarks": "string",
"invoiceStartDate": "string",
"invoiceEndDate": "string"
},
"precedingInvoiceDetails": [
{
"invoiceNumber": "string",
"date": "string",
"otherReferenceNo": "string"
}
],
"poDetails": [
{
"poObjId": "string",
"buyerPoId": "string",
"poDate": "string"
}
],
"contractReferenceDetails": [
{
"receiptAdviceNo": "string",
"receiptAdviceDate": "string",
"batchReferenceNo": "string",
"contractReferenceNo": "string",
"extraReferenceNo": "string",
"projectReferenceNo": "string"
}
],
"additionalDocumentDetails": [
{
"url": "string",
"document": "string",
"info": "string"
}
],
"exportDetails": {
"shipBillNo": "string",
"shipBillDate": "string",
"port": "string",
"refundClaim": "string",
"foreignCurrency": "string",
"countryCode": "string",
"exportDuty": 0
},
"ewayBillDetail": {
"transporterId": "string",
"transporterName": "string",
"transportMode": "string",
"distance": 0,
"transportDocumentNo": "string",
"transportDocumentDate": "string",
"vehicleNo": "string",
"vehicleType": "string"
},
"recurringPayments": {
"originalInvoiceId": "string",
"frequency": "string",
"startDate": "string",
"endDate": "string",
"mandateDetails": "string",
"mandateExecutionDate": "string",
"mandateAmount": 0
},
"paymentMilestones": [
{
"milestoneDate": "string",
"dueAmount": 0
}
],
"shippingTermsDetails": {
"terms": "string",
"bearingParty": "string",
"charges": 0
}
},
"additionalInfos": [
{
"name": "string",
"value": "string"
}
]
}'Responses
🟢200Success
application/json
Body
response_code
integer
required
response_message
string
required
payload
object (SendCdNoteResponse)
required
device
object
required
b2bIds
object
required
resp
object
required
cdNote
object
required
additionalInfos
array [object {2}]
required
Example
{
"response_code": 0,
"response_message": "string",
"payload": {
"device": {
"tag": {
"name": "string",
"value": "string"
}
},
"b2bIds": {
"buyerB2BId": "string",
"supplierB2BId": "string"
},
"resp": {
"reqMsgId": "string",
"result": "string",
"errorCd": "string",
"errorDtl": "string",
"errorField": "string"
},
"cdNote": {
"objectId": "string",
"noteType": "string",
"supplierCDNoteNumber": "string",
"objectVersion": {
"currentVersion": 0,
"newVersion": 0
},
"ts": "string",
"cdNoteStatusTransition": {
"currentStatus": "string",
"newStatus": "string"
},
"eInvoiceInfo": {
"schemaVersion": "string",
"irnNumber": "string",
"irnTs": "string"
},
"transactionDetails": {
"taxScheme": "string",
"supplyType": "string",
"reverseChargeTax": "string",
"eCommerceGstin": "string",
"igstChargable": "string"
},
"supplierDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"buyerDetails": {
"b2bId": "string",
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"placeOfSupply": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"dispatchDetails": {
"gstin": "string",
"legalName": "string",
"tradeName": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"shippingDetails": {
"gstin": "string",
"lglNm": "string",
"trdNm": "string",
"stateCode": "string",
"address": {
"type": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string"
},
"contactNumber": {
"type": "string",
"countryCode": "string",
"phoneNumber": "string"
},
"email": "string"
},
"itemLists": [
{
"serialno": "string",
"productDescription": "string",
"isService": "string",
"hsnCode": "string",
"barCode": "string",
"quantity": 0,
"freeQuantity": 0,
"unit": "string",
"unitPrice": 0,
"totalAmt": 0,
"assessmentAmount": 0,
"gstRate": 0,
"totalItemValue": 0,
"orderLineReference": "string",
"originCountry": "string",
"productSerialNumber": "string",
"itemValueDetails": [
{
"type": "string",
"value": 0
}
],
"rates": [
{
"type": "string",
"value": 0
}
],
"batchDetails": {
"batchNumber": "string",
"expiryDate": "string",
"batchWarrantyDate": "string"
},
"attributeDetails": [
{
"name": "string",
"value": "string"
}
],
"otherTaxes": [
{
"name": "string",
"rate": 0,
"amount": 0
}
]
}
],
"cdNoteValueDetails": {
"assessmentValue": 0,
"totalCDNoteValue": 0,
"otherValues": [
{
"type": "string",
"value": 0
}
]
},
"supplierBankAccountDetails": {
"maskedAccountNumber": "string",
"ifsc": "string",
"beneficiaryName": "string",
"businessVPA": "string"
},
"advancePaymentDetails": {
"payeeName": "string",
"mode": "string",
"paymentTerms": "string",
"paymentInstruction": "string",
"creditTransfer": "string",
"directDebit": "string",
"creditDays": 0,
"paidAmount": 0,
"pendingDueAmount": 0
},
"invoiceReferenceDetails": {
"invoiceRemarks": "string",
"invoiceStartDate": "string",
"invoiceEndDate": "string"
},
"precedingInvoiceDetails": [
{
"invoiceNumber": "string",
"date": "string",
"otherReferenceNo": "string"
}
],
"poDetails": [
{
"poObjId": "string",
"buyerPoId": "string",
"poDate": "string"
}
],
"contractReferenceDetails": [
{
"receiptAdviceNo": "string",
"receiptAdviceDate": "string",
"batchReferenceNo": "string",
"contractReferenceNo": "string",
"extraReferenceNo": "string",
"projectReferenceNo": "string"
}
],
"additionalDocumentDetails": [
{
"url": "string",
"document": "string",
"info": "string"
}
],
"exportDetails": {
"shipBillNo": "string",
"shipBillDate": "string",
"port": "string",
"refundClaim": "string",
"foreignCurrency": "string",
"countryCode": "string",
"exportDuty": 0
},
"ewayBillDetail": {
"transporterId": "string",
"transporterName": "string",
"transportMode": "string",
"distance": 0,
"transportDocumentNo": "string",
"transportDocumentDate": "string",
"vehicleNo": "string",
"vehicleType": "string"
},
"recurringPayments": {
"originalInvoiceId": "string",
"frequency": "string",
"startDate": "string",
"endDate": "string",
"mandateDetails": "string",
"mandateExecutionDate": "string",
"mandateAmount": 0
},
"paymentMilestones": [
{
"milestoneDate": "string",
"dueAmount": 0
}
],
"shippingTermsDetails": {
"terms": "string",
"bearingParty": "string",
"charges": 0
}
},
"additionalInfos": [
{
"name": "string",
"value": "string"
}
]
}
}Modified at 2025-07-06 06:24:51