Enkash Developer Portal
Home
Home
Login
  1. Invoice
  • Back to home
  • Vendor Payment
  • APIs
    • Business Onboarding
      • Initiate Entity Check
      • Register Entity
      • Bharat Connect B2B ID Registration
      • Search Entity
    • Invoice
      • Create Invoice
      • Confirm Invoice
      • Change Invoice Status
      • Edit Invoice
    • Payment
      • Pay Invoice
      • Payment Confirmation
    • Purchase Order
      • Send Purchase Order Request
      • Confirm Purchase Order
      • Edit Purchase Order
      • Change Purchase Order Status
    • Credit Note
      • Send C/N Request
      • Confirm C/N Request
      • Status Change C/N Request
    • Financing
      • Request Financing
      • Share Bid
      • Respond To Bid
  • Webhook
    • Business Onboarding
      • Check Entity Webhook
      • Entity Registration Response Webhook
      • Search Entity Response Webhook
      • Registration ID Response Webhook
    • Invoice
      • Create Invoice Request Webhook
        POST
      • Create Invoice Response Webhook
        POST
      • Confirm Invoice Request Webhook
        POST
      • Confirm Invoice Response Webhook
        POST
      • Status Change Invoice Request
        POST
      • Status Change Invoice Response Webhook
        POST
      • Edit Invoice Request Webhook
        POST
      • Edit Invoice Response Webhook
        POST
    • Payment
      • Payment Response Webhook
      • Payment Confirmation Response Webhook
      • Payment Request Webhook
      • Payment Confirmation Request Webhook
    • Credit Note
      • Send C/N RequestWebhook
      • Send C/N Response Webhook
      • Confirm C/N Request Webhook
      • Confirm C/N Response Webhook
      • Status Change C/N Request Webhook
      • Status Change C/N Response Webhook
    • 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
      • Financing Response Webhook
      • Respond Bid Response Webhook
      • Share Bid Request Webhook
  1. Invoice

Create Invoice Request Webhook

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 2025-07-06 06:21:30
Previous
Registration ID Response Webhook
Next
Create Invoice Response Webhook
Built with