- EnKash Developer Portal Overview
- Payment Gateway
- Payment Gateway Overview
- Payment Gateway Sign Up
- Payment Methods
- Supported Integrations
- Payment Gateway APIs
- Web Integration
- Server to Server Integration
- Test Card Details
- Authorization
- Orders
- Payments
- Refunds
- Settlements
- Split Settlements
- E-Commerce Plugins
- Payment Links
- Payment Button
- Qr Code
- UPI Mandate
- Payment Links
- Bharat Connect (BBPS)
- About Bharat Connect
- B2B Invoicing
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- Webhook Purchase Order
- Webhook Send Purchase Order RequestPOST
- Webhook Send Purchase Order ResponsePOST
- Webhook Confirm Purchase Order RequestPOST
- Webhook Confirm Purchase Order ResponsePOST
- Webhook Edit Purchase Order RequestPOST
- Webhook Edit Purchase Order ResponsePOST
- Webhook Status Change Purchase Order RequestPOST
- Webhook Status Change Purchase Order ResponsePOST
- Bill Payments
- Bill Payments Overview
- Get Authentication TokenPOST
- Get BillerTypesGET
- Get BillersGET
- Fetch BillPOST
- Create Bill APIPOST
- Create Bill Without Bill FetchPOST
- Bill PaymentPOST
- Utility Bill Approval APIPUT
- Get Utility Bill StatusGET
- Get Utility Bill by Reference IdGET
- Get Utility Bills DetailPOST
- Bill Payment WebhookPOST
- Payouts
- Payouts Overview
- Payouts Sign Up
- Payout Methods
- Payout API Response Codes
- Payouts Integration Steps
- Encrypting and Decrypting Payload
- Payouts Status Codes
- Get Authentication Token
- Beneficiary Apis
- Transfer Apis
- Payout Account Apis
- Webhook Data Apis
- Accounts Payable Management Tool
- About AP Management Tool
- Vendor Management
- Invoice Management
- Bharat Connect 2.0 AP
- Update BeneficiaryPUT
- Account Receivable
- Accounts Receivable Overview
- Get Authentication Token Copy
- Customer Management
- Customer Contacts Management
- Customer Apis
- Invoice Management
- Payment Reminders
- Bharat Connect 2.0 AR
- Expense Management
- Loyalty
- Card Management
- EnKash Card Management Systems Overview
- Cards We Issue
- API Reference
- VKYC
- Developer Guide
- Cards Integration Steps
- Encryption / Decryption of API requests / Response
- Encryption & Decryption Guide
- Token Api
- Gift Card
- Meal Cards
- Prepaid Cards
- Fuel_cards
- Advance Card Feature
- Verification Suite
- Verification Suite Overview
- Bank Account Verification
- GSTN Verification
- PAN Verification
- UPI(VPA) Verification
Webhook Create Invoice Request
POST
/api/v0/invoice/req-send-invoice
Request
Body Params application/json
device
object (Device)Â
optional
tag
object (Tag)Â
required
b2bIds
object (NbblB2BIdsModel)Â
required
buyerB2BId
stringÂ
required
Match pattern:
^([^\\\"]){1,100}$
supplierB2BId
stringÂ
required
Match pattern:
^([^\\\"]){1,100}$
invoice
object (Invoice)Â
required
id
integer <int64>
optional
parentInvoiceId
integer <int64>
optional
invoiceNumber
stringÂ
optional
vendorInvoiceRefNo
stringÂ
optional
externalRefNumber
stringÂ
optional
purchaseNo
stringÂ
optional
supplierInvoiceNo
stringÂ
optional
supplierInvoiceDate
string <date>
optional
sourceCompany
integer <int64>
optional
targetCompany
integer <int64>
optional
totalAmount
numberÂ
optional
invoiceAmount
numberÂ
optional
amountPaidTillNow
numberÂ
optional
surcharge
numberÂ
optional
surchargeGst
numberÂ
optional
mdr
numberÂ
optional
mdrGst
numberÂ
optional
sgst
numberÂ
optional
cgst
numberÂ
optional
igst
numberÂ
optional
tds
numberÂ
optional
amountPaidByEnterprise
numberÂ
optional
amountToBePaidToVendor
numberÂ
optional
description
stringÂ
optional
createdBy
integer <int64>
optional
createdDate
string <date-time>
optional
dueDate
string <date-time>
optional
lastModifiedDate
string <date-time>
optional
lastModifiedBy
integer <int64>
optional
makerId
integer <int64>
optional
checkerId
integer <int64>
optional
approvalStatus
enum<string>Â
optional
Allowed values:
MAKER_APPROVAL_PENDINGMAKER_APPROVEDMAKER_REJECTEDCHECKER_APPROVAL_PENDINGCHECKER_APPROVEDCHECKER_REJECTEDAPPROVER_APPROVAL_PENDINGAPPROVER_APPROVEDAPPROVER_REJECTEDBANK_APPROVEDBANK_REJECTED
paymentStatus
enum<string>Â
optional
Allowed values:
INITPROCESSSUCCESSFAILEDPENDINGCANCELLEDEXPIREDPARTIAL_REFUNDEDREFUNDEDIN_PROCESSAUTHENTICATION_IN_PROCESSOTP_RENDEREDCHECKOUT_RENDEREDMPI_PROCESSEDMPI_RENDEREDREFUND_IN_PROGRESSREFUND_REQUESTEDPENDING_WITH_BANKSWAPPEDPAID_OFFLINEPARTIAL_PAID
invoiceStatus
enum<string>Â
optional
Allowed values:
PAIDUNPAIDPARTIAL_PAIDREFUNDED
autoRelease
booleanÂ
optional
invoiceDate
string <date>
optional
pgId
integer <int64>
optional
phone
stringÂ
optional
email
stringÂ
optional
paymentGatewayTransactions
array[object (PaymentGatewayTransaction) {30}]Â
optional
deleted
booleanÂ
optional
dateApproved
string <date-time>
optional
maskedCardNumber
stringÂ
optional
subscription
integer <int64>
optional
retryLeft
integer <int32>
optional
paymentMode
enum<string>Â
optional
Allowed values:
CREDIT_CARDDEBIT_CARDNET_BANKINGUPIPREPAID_CARDINVALID_PAYMENT_MODESEAMLESS_BANKINGVIRTUAL_ACCOUNTTALLY_PAYMENTENKASH_COINCASHCHEQUEACCOUNT_TRANSFER
payoutData
object (PayoutData)Â
optional
productCode
enum<string>Â
optional
Allowed values:
INV001INV002INV003INV004INV005
purchaseOrder
object (PurchaseOrder)Â
optional
hsnCode
stringÂ
optional
approverApprovedCount
integer <int32>
optional
attachment
booleanÂ
optional
companyBranchCodeId
integer <int64>
optional
bankApprovals
stringÂ
optional
bankCard
object (BankCard)Â
optional
approvalAuthorizations
array[object (ApprovalAuthorization) {13}]Â
optional
nextApprovalGroups
array[object (ApprovalGroup) {11}]Â
optional
earlyPaymentDetails
array[object (EarlyPaymentDetail) {12}]Â
optional
previousUserApprovals
array[object (ApprovalGroupUser) {11}]Â
optional
refundDate
string <date-time>
optional
refundBy
integer <int64>
optional
via
stringÂ
optional
collectionReferenceId
stringÂ
optional
collectionInvoiceId
stringÂ
optional
paidThrough
enum<string>Â
optional
Allowed values:
COLLECTIONSPAYABLES
collectionSyncRequired
booleanÂ
optional
invoiceDiscounting
booleanÂ
optional
remarks
stringÂ
optional
earlyPaymentEnabled
booleanÂ
optional
earlyPaymentMarkup
numberÂ
optional
>= 0<= 100
earlyPaymentBaseRate
numberÂ
optional
>= 0<= 100
earlyPaymentBaseRateSlab
stringÂ
optional
earlyPaymentStatus
enum<string>Â
optional
Allowed values:
PENDINGAPPROVEDREJECTEDEXPIRED
refundTransactions
array[object (RefundTransaction) {22}]Â
optional
additionalDataMapping
objectÂ
optional
invoiceAttachments
array[object (InvoiceAttachment) {16}]Â
optional
reverseSync
booleanÂ
optional
nbblEnabled
booleanÂ
optional
nbblInvoiceId
stringÂ
optional
billStartDate
string <date>
optional
billEndDate
string <date>
optional
penalty
numberÂ
optional
nbblInvoiceStatus
enum<string>Â
optional
Allowed values:
CREATEDSENT_TO_BUYERACCEPTEDREJECTEDUNDER_REVIEWCANCELLEDDELETEDPARTIALLY_PAIDFULLY_PAIDCLOSEDABANDONEDPAYMENT_INITIATEDPARTIALLY_PAID_AND_PAYMENT_INITIATED
nbblInvoiceData
objectÂ
optional
nbblInvoiceItems
array[object (NbblInvoiceItem) {13}]Â
optional
nbblPayments
array[object (NbblPayment) {18}]Â
optional
nbblInvoiceFinances
array[object (NbblInvoiceFinance) {12}]Â
optional
paymentAdviceUrl
stringÂ
optional
ponumber
stringÂ
optional
einvoice
booleanÂ
optional
Example
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/invoice/req-send-invoice' \
--header 'Content-Type: application/json' \
--data-raw ''
Responses
🟢200Success
application/json
Body
response_code
integerÂ
required
response_message
stringÂ
required
payload
object (CreateInvoiceResponse)Â
required
b2bIds
objectÂ
required
resp
objectÂ
required
invoice
objectÂ
required
additionalInfo
array [object {2}]Â
required
Example
{
"response_code": 0,
"response_message": "string",
"payload": {
"b2bIds": {
"buyerB2BId": "string",
"supplierB2BId": "string"
},
"resp": {
"reqMsgId": "string",
"result": "string",
"errorCd": "string",
"errorDtl": "string",
"errorField": "string"
},
"invoice": {
"objectId": "string",
"supplierInvoiceNumber": "string",
"objectVersion": {
"currentVersion": 0,
"newVersion": 0
},
"ts": "string",
"statusTransition": {
"currentStatus": "string",
"newStatus": "string"
},
"transactionDetails": {
"taxScheme": "string",
"supplyType": "string",
"reverseChargeTax": "string",
"igstChargable": "string",
"ecommerceGstin": "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
}
]
}
],
"valueDetails": {
"assessmentValue": 0,
"totalInvoiceValue": 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
},
"invoiceFinancingDetails": {
"dueAmount": 0,
"financingRequestAmount": 0
},
"einvoiceResponse": "string",
"eInvoiceInfo": {
"schemaVersion": "string",
"irnNumber": "string",
"irnTs": "string"
}
},
"additionalInfo": [
{
"name": "string",
"value": "string"
}
]
}
}
Modified at 2024-10-10 08:29:16