Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. invoice-controller
  • 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
      • Verify VPA
    • 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
        • 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
          POST
        • invoiceBulkUpload
          POST
        • Dispatch Invoice Collection
          POST
        • Delete Invoice Collection
          POST
        • searchCollectionInvoices
          POST
        • getInvoice
          GET
        • updateInvoice
          PATCH
    • 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-controller

updateInvoice

PATCH
/api/v0/invoice/{invoiceId}
invoice-controller

Request

Path Params
invoiceId
string 
required
invoiceId
Query Params
sellerId
string 
optional
sellerId
Match pattern:
^CEK[A-Z0-9]{7}$
Body Params application/json
approvalStatus
object (JsonNullable«string») 
optional
Approval status of the invoice
balanceAmount
object (JsonNullable«bigdecimal») 
optional
Balance amount of the invoice
baseAmount
object (JsonNullable«bigdecimal») 
optional
Base amount of the invoice
cgst
object (JsonNullable«bigdecimal») 
optional
Central Goods and Services Tax amount
chargeCustomer
object (JsonNullable«boolean») 
optional
Indicates if the customer is to be charged
customerId
string 
optional
Unique identifier for the customer
Match pattern:
^KC[A-Z0-9]{14}$
description
object (JsonNullable«string») 
optional
Description of the invoice
dispatchNow
object (JsonNullable«boolean») 
optional
Indicates if the invoice should be dispatched immediately
dueDate
object (JsonNullable«LocalDate») 
optional
Due date for the invoice payment
emailAddress
object (JsonNullable«string») 
optional
Email address associated with the invoice
gstExclusive
object (JsonNullable«boolean») 
optional
Indicates if the GST is exclusive
igst
object (JsonNullable«bigdecimal») 
optional
Integrated Goods and Services Tax amount
invoiceDate
object (JsonNullable«LocalDateTime») 
optional
Date of the invoice
invoiceNumber
object (JsonNullable«string») 
optional
Unique number of the invoice
mobileNumber
object (JsonNullable«string») 
optional
Mobile number associated with the invoice
netAmount
object (JsonNullable«bigdecimal») 
optional
Net amount of the invoice
partialPaymentAllowed
object (JsonNullable«boolean») 
optional
Indicates if partial payment is allowed
payableReferenceId
object (JsonNullable«string») 
optional
Reference ID for the payable
poNumber
object (JsonNullable«string») 
optional
Purchase order number associated with the invoice
receivableStatus
object (JsonNullable«string») 
optional
Status of the receivable
sgst
object (JsonNullable«bigdecimal») 
optional
State Goods and Services Tax amount
tds
object (JsonNullable«bigdecimal») 
optional
Tax Deducted at Source amount
totalReceived
object (JsonNullable«bigdecimal») 
optional
Total amount received for the invoice
via
object (JsonNullable«string») 
optional
Method through which the invoice was sent
Example
{
  "approvalStatus": {},
  "balanceAmount": {},
  "baseAmount": {},
  "cgst": {},
  "chargeCustomer": {},
  "customerId": "string",
  "description": {},
  "dispatchNow": {},
  "dueDate": {},
  "emailAddress": {},
  "gstExclusive": {},
  "igst": {},
  "invoiceDate": {},
  "invoiceNumber": {},
  "mobileNumber": {},
  "netAmount": {},
  "partialPaymentAllowed": {},
  "payableReferenceId": {},
  "poNumber": {},
  "receivableStatus": {},
  "sgst": {},
  "tds": {},
  "totalReceived": {},
  "via": {}
}

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 PATCH 'https://test.your-api-server.com/api/v0/invoice/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "approvalStatus": {},
    "balanceAmount": {},
    "baseAmount": {},
    "cgst": {},
    "chargeCustomer": {},
    "customerId": "string",
    "description": {},
    "dispatchNow": {},
    "dueDate": {},
    "emailAddress": {},
    "gstExclusive": {},
    "igst": {},
    "invoiceDate": {},
    "invoiceNumber": {},
    "mobileNumber": {},
    "netAmount": {},
    "partialPaymentAllowed": {},
    "payableReferenceId": {},
    "poNumber": {},
    "receivableStatus": {},
    "sgst": {},
    "tds": {},
    "totalReceived": {},
    "via": {}
}'

Responses

🟢200OK
application/json
Body
errorResponse
object (ErrorResponse) 
optional
apiSubErrors
array[object (ApiSubError)] 
optional
errorMessage
string 
optional
errorType
enum<string> 
optional
Allowed values:
CLIENT_REQUEST_ABORTCLIENT_REQUEST_ERRORINVALID_ACCESSRECORD_NOT_FOUNDSYSTEM_ERRORUNAUTHORIZEDUNKNOWN_ERRORUNPROCESSABLE_REQUESTVALIDATION_ERROR
requestId
string 
optional
timestamp
string 
optional
Example:
yyyy-MM-dd HH:mm:ss
payload
object (InvoiceResponse) 
optional
approvalStatus
object (EnumModel«string») 
optional
attachmentUrl
string 
optional
balanceAmount
number 
optional
baseAmount
number 
optional
cgst
number 
optional
createdBy
string 
optional
createdByEmail
string 
optional
createdByMobile
string 
optional
createdByName
string 
optional
createdOn
string <date-time>
optional
customerId
string 
optional
customerLegalName
string 
optional
description
string 
optional
dispatched
boolean 
optional
dispatchedOn
string <date-time>
optional
dueDate
string <date>
optional
externalId
string 
optional
hasKeyContacts
boolean 
optional
igst
number 
optional
invoiceAttachments
array[object (InvoiceAttachmentResponse) {12}] 
optional
invoiceDate
string <date-time>
optional
invoiceId
string 
optional
invoiceNumber
string 
optional
modifiedBy
string 
optional
modifiedByEmail
string 
optional
modifiedByMobile
string 
optional
modifiedByName
string 
optional
modifiedOn
string <date-time>
optional
netAmount
number 
optional
partialPaymentAllowed
boolean 
optional
payableReferenceId
string 
optional
paymentLink
string 
optional
payoutStatus
object (EnumModel«string») 
optional
poNumber
string 
optional
receivableStatus
object (EnumModel«string») 
optional
sellerId
string 
optional
sgst
number 
optional
tds
number 
optional
totalReceived
number 
optional
via
string 
optional
response_code
integer <int32>
optional
response_message
string 
optional
Example
{
  "errorResponse": {
    "apiSubErrors": [
      {}
    ],
    "errorMessage": "string",
    "errorType": "CLIENT_REQUEST_ABORT",
    "requestId": "string",
    "timestamp": "yyyy-MM-dd HH:mm:ss"
  },
  "payload": {
    "approvalStatus": {
      "label": "string",
      "name": "PAID"
    },
    "attachmentUrl": "string",
    "balanceAmount": 0,
    "baseAmount": 0,
    "cgst": 0,
    "createdBy": "string",
    "createdByEmail": "string",
    "createdByMobile": "string",
    "createdByName": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "customerId": "string",
    "customerLegalName": "string",
    "description": "string",
    "dispatched": true,
    "dispatchedOn": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24",
    "externalId": "string",
    "hasKeyContacts": true,
    "igst": 0,
    "invoiceAttachments": [
      {
        "attachmentSource": "TALLY_INVOICE",
        "createdBy": "string",
        "deleted": true,
        "fileExt": "string",
        "invoiceAttachmentId": "string",
        "modifiedBy": "string",
        "originalFilename": "string",
        "primary": true,
        "referenceId": "string",
        "remarks": "string",
        "shared": true,
        "url": "string"
      }
    ],
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceId": "string",
    "invoiceNumber": "string",
    "modifiedBy": "string",
    "modifiedByEmail": "string",
    "modifiedByMobile": "string",
    "modifiedByName": "string",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "netAmount": 0,
    "partialPaymentAllowed": true,
    "payableReferenceId": "string",
    "paymentLink": "string",
    "payoutStatus": {
      "label": "string",
      "name": "PAID"
    },
    "poNumber": "string",
    "receivableStatus": {
      "label": "string",
      "name": "PAID"
    },
    "sellerId": "string",
    "sgst": 0,
    "tds": 0,
    "totalReceived": 0,
    "via": "string"
  },
  "response_code": 0,
  "response_message": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Unprocessable Request
🔴500Server Error
Modified at 2024-10-10 08:34:46
Previous
getInvoice
Next
createCustomerReminder
Built with