Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. 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
          POST
        • Confirm Invoice
          POST
        • Status Change Invoice
          POST
        • Edit Invoice
          POST
      • 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
        • Webhook Create Invoice Response
        • Webhook Confirm Invoice Request
        • Webhook Confirm Invoice Response
        • Webhook Status Change Invoice Request
        • Webhook Status Change Invoice Response
        • Webhook Edit Invoice Request
        • Webhook Edit Invoice Response
      • 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. Invoice

Edit Invoice

POST
api/v0/invoice/req-edit-invoice

Request

Body Params application/json
device
object 
required
tag
object 
required
b2bIds
object 
required
buyerB2BId
string 
required
Match pattern:
^([^\\\"]){1,100}$
supplierB2BId
string 
required
Match pattern:
^([^\\\"]){1,100}$
invoice
object 
required
objectId
string 
required

Unique Identifier of
the invoice across all
entities, created by
the originator.
Format:
INV<ThreadID

Match pattern:
^[INV]{3}[A-Za-z0-9]{32,32}$
supplierInvoiceNumber
string 
required
Match pattern:
^([^\\\"]){1,50}$
objectVersion
object 
required
ts
string 
required
Timestamp at which
invoice was created.
2017-08-
10T17:57:35+05:30
statusTransition
object 
required
transactionDetails
object 
required
supplierDetails
object 
required
buyerDetails
object 
required
dispatchDetails
object 
optional
shippingDetails
object 
optional
itemLists
array [object {21}] 
required
valueDetails
object 
optional
supplierBankAccountDetails
object 
required
advancePaymentDetails
object 
optional
invoiceReferenceDetails
object 
optional
precedingInvoiceDetails
array [object {3}] 
optional
poDetails
array [object {3}] 
optional
contractReferenceDetails
array [object {6}] 
optional
additionalDocumentDetails
array [object {3}] 
optional
exportDetails
object 
optional
ewayBillDetail
object 
optional
recurringPayments
object 
optional
paymentMilestones
array [object {2}] 
optional
shippingTermsDetails
object 
optional
invoiceFinancingDetails
object 
optional
einvoiceResponse
string 
optional
eInvoiceInfo
object 
optional
Example
{
  "device": {
    "tag": {
      "name": "GEOCODE",
      "value": "string"
    }
  },
  "b2bIds": {
    "buyerB2BId": "string",
    "supplierB2BId": "string"
  },
  "invoice": {
    "objectId": "string",
    "supplierInvoiceNumber": "string",
    "objectVersion": {
      "currentVersion": 1,
      "newVersion": 1
    },
    "ts": "string",
    "statusTransition": {
      "currentStatus": "CREATED",
      "newStatus": "CREATED"
    },
    "transactionDetails": {
      "taxScheme": "GST",
      "supplyType": "B2B",
      "reverseChargeTax": "YES",
      "igstChargable": "YES",
      "ecommerceGstin": "string"
    },
    "supplierDetails": {
      "b2bId": "string",
      "gstin": "string",
      "legalName": "string",
      "tradeName": "string",
      "stateCode": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "buyerDetails": {
      "b2bId": "string",
      "gstin": "string",
      "legalName": "string",
      "tradeName": "string",
      "stateCode": "string",
      "placeOfSupply": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "dispatchDetails": {
      "gstin": "string",
      "legalName": "string",
      "tradeName": "string",
      "stateCode": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "shippingDetails": {
      "gstin": "string",
      "lglNm": "string",
      "trdNm": "string",
      "stateCode": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "itemLists": [
      {
        "serialno": "string",
        "productDescription": "string",
        "isService": "YES",
        "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"
    }
  }
}

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
payload
string 
required
response_code
integer 
required
response_message
string 
required
Example
{
  "payload": "string",
  "response_code": 0,
  "response_message": "string"
}
Modified at 2024-10-10 08:29:16
Previous
Status Change Invoice
Next
Pay Invoices
Built with