Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. webhook-invoice
  • 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
      • About Authorization
      • Get Authorization Token
    • Orders
      • About Order
      • Create Order
      • Get Order Status
      • Get Order By Merchant Order Id
      • Get BNPL Payment Modes
      • Get Dynamic QR Code
      • UPI Intent Links
    • Payments
      • About Payment
      • Submit Payment Detail
      • Get Transaction Status
      • Validate OTP
      • Resend OTP
      • Payment Notify Request
      • Get UPI Transaction Status
    • Refunds
      • About Refund
      • Refund
    • Settlements
      • About Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
      • Search Settlement Payouts
    • Split Settlements
      • About Split Settlements
      • Create Split Settlement Account
      • Update Split Settlement Account
      • Get All Split Settlement Account
      • Deactivate Split Settlement Account
      • Activate Split Settlement Account
      • Submit Payment with Split Details
      • Edit/Deferred Split Settlement
    • E-Commerce Plugins
    • Payment Links
    • Payment Button
    • Qr Code
      • Create Qr Code
      • Get QR Code
      • Search QR Code
      • createCustomer
      • searchCustomer
      • Cancel QR Code
    • UPI Mandate
      • Create UPI Mandate
      • Update UPI Mandate
      • Revoke UPI Mandate
      • Get UPI Mandate
      • UPI mandate create callback
      • Mandate Pre-debit Notification
      • Execute mandate debit
      • Mandate Debit callback
  • Payment Links
    • Payment Links Overview
    • Payment Link APIs
    • Payment Link
      • Create Payment Link
      • Get Payment Link Details
      • Delete Payment Link
    • Payment Link Webhook
      • Payment Link Webhook Request
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • B2B Invoicing
      • Invoice
        • Create Invoice
        • Confirm Invoice
        • Status Change Invoice
        • Edit Invoice
      • Payment
        • Pay Invoices
        • Payment Confirmation
      • Financing
        • Request Financing
        • Share Bid
        • Respond Bid
      • Onboarding
        • Register Check Entity
        • Search Entity
        • Register Entity
        • Registration Id
      • cdNote
        • Send CdNote Request
        • Confirm CdNote Request
        • Status Change CdNote Request
      • Purchase Order
        • Send Purchase Order Request
        • Confirm Purchase Order Request
        • Edit Purchase Order Request
        • Status Change Purchase Order Request
      • webhook-invoice
        • Webhook Create Invoice Request
          POST
        • Webhook Create Invoice Response
          POST
        • Webhook Confirm Invoice Request
          POST
        • Webhook Confirm Invoice Response
          POST
        • Webhook Status Change Invoice Request
          POST
        • Webhook Status Change Invoice Response
          POST
        • Webhook Edit Invoice Request
          POST
        • Webhook Edit Invoice Response
          POST
      • webhook-payments
        • Webhook Payment Request
        • Webhook Payment Confirmation Request
        • Webhook Payment Response
        • Webhook Payment Confirmation Response
      • webhook-business-onboarding
        • Webhook Check Entity Response
        • Webhook Register Entity Response
        • Webhook Search Entity Response
        • Webhook Registration Id Response
      • webhook-financing
        • Webhook Financing Response
        • Webhook Respond Bid Response
        • Webhook Share Bid Request
      • webhook-cdNote
        • Webhook Send CdNote Request
        • Webhook Send CdNote Response
        • Webhook Confirm CdNote Request
        • Webhook Confirm CdNote Response
        • Webhook Status Change CdNote Request
        • Webhook Status Change CdNote Response
      • Webhook Purchase Order
        • Webhook 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
    • Bill Payments
      • Bill Payments Overview
      • Get Authentication Token
      • Get BillerTypes
      • Get Billers
      • Fetch Bill
      • Create Bill API
      • Create Bill Without Bill Fetch
      • Bill Payment
      • Utility Bill Approval API
      • Get Utility Bill Status
      • Get Utility Bill by Reference Id
      • Get Utility Bills Detail
      • Bill Payment Webhook
  • 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
      • Get Authentication Token
    • Beneficiary Apis
      • Create Beneficiary
      • Search Beneficiary
      • Delete Beneficiary
    • Transfer Apis
      • Create Payout
      • Search Payouts
      • Create Batch Payout
    • Payout Account Apis
      • Get Balance
      • Get Source Bank Account Details
      • Add Source Bank Account
      • Fetch Bank Statement
    • Webhook Data Apis
      • Get Webhook Data
      • Create Webhook Data
  • Accounts Payable Management Tool
    • About AP Management Tool
    • Vendor Management
      • Create Vendor
      • Create Bulk Vendors
      • Update Bulk Vendors
      • Get Beneficiaries (V1)
      • Get Beneficiaries
      • Change Vendor Status
      • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • validateInvoices
        • initiate
        • Search Payouts V1
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
      • Payment Request
    • Update Beneficiary
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • deleteCustomerByCustomerId
        • updateCustomer
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
    • Invoice Management
      • invoice-controller
        • createInvoice
        • invoiceBulkUpload
        • Dispatch Invoice Collection
        • Delete Invoice Collection
        • searchCollectionInvoices
        • getInvoice
        • updateInvoice
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
        • getCustomerReminders
        • getCustomerReminder
        • deleteReminder
        • updateCustomerReminder
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
      • Change Invoice Status Request
      • Bulk Create Invoice
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • Token Api
      • About Authorization
      • Token API
    • Expenses
    • Advance
  • Loyalty
    • Overview
    • Sign Up
    • Employee R&R
      • API Integration Guide
      • Common Fields passed in API requests
      • Token Api
        • Client Authentication
        • SSO LOGIN (Single Sign On)
      • Create And Allocate point
      • Bulk Create And Allocate Points
      • Get Card Account Details
      • Get Transaction details
      • List Users Details
      • Get User Card Details
    • Channel Incentives
      • Incentive Create And Allocate point
      • Reward Get Transaction details
      • Incentive Get User Details
    • Points Redemption
      • User Authentication
      • Get Cart for User
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
      • Add to cart
      • Update Cart
      • Create Order
      • Order Search
      • create order
      • Fetch Order Info by Partner order Reference id
    • Point Management APIs
      • Overview
      • Create Event
      • Get Event
      • Update Event
      • Allocate Coins
      • Get Balance
  • 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
      • Partner auth Token
    • Gift Card
      • Create
      • Request Physical
      • Block
      • Replace
      • Get User Details
      • Get Transaction Details
      • Get All Transaction details
    • Meal Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Prepaid Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Fuel_cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Advance Card Feature
      • Create Card Account
      • Set Pin
      • Get Card Account Details
      • Generate Otp Card
      • View Card
      • Update Card Velocity Rules
      • Get Card Velocity Rules
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
    • GSTN Verification
      • Gstin Verification
    • PAN Verification
      • Pan Verification
    • UPI(VPA) Verification
      • Vpa Verification
  1. webhook-invoice

Webhook Edit Invoice Request

POST
api/v0/invoice/req-edit-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-edit-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
Previous
Webhook Status Change Invoice Response
Next
Webhook Edit Invoice Response
Built with