Enkash APIs
Webhook Send CdNote Request
DevelopingPOST/api/v0/cd-note/req-sendRequest
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
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
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
Not configured
Last modified: 3 months ago