EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. invoice-controller
  • EnKash APIs
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment APIs
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • Order Overview
      • About Order
      • Create Order
      • Get Order Status
      • Get BNPL Payment Modes
    • Payments
      • Payment Overview
      • About Payment
      • Get Transaction Status
      • Submit Payment Detail
    • Refunds
      • About Refund
      • Refund
    • Payment Links
      • Upi Intent Link Detail
    • Settlements
      • About Settlement
      • Get Settlement Payout By Id
      • Search Settlement Payouts
    • QR Generation API
      • Get Dynamic QR Code
    • Payment Button
    • Qr Code
      • Create QR
      • Create QR Customer
      • Search QR Code
      • Get QR Code
      • Cancel QR Code
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payouts Integration Steps
    • Ecrypting and Decrypting Payload
    • 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 Source Bank Account Details
      • Add Source Bank Account
      • Get Balance
  • Account Payables
    • Accounts Payable Overview
    • Vendor Management
      • Beneficiary Apis
        • Update Beneficiary
        • Create Beneficiary
        • Update Bulk Beneficiary
        • Create Bulk Beneficiary
        • Get Beneficiaries V1
        • Get Beneficiaries
        • Change beneficiary status
        • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • Search Payouts V1
        • initiate
        • validateInvoices
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • createCustomer
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • searchCustomer
        • 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
  • Loyalty
    • Loyalty Overview
    • Sign Up - Loyalty
    • Use Cases
    • Reward APIs
    • Authorization
      • SSO LOGIN
      • Client Authentication
    • Employee R&R
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • Channel Incentives
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • brand loyalty
      • Get Coin Event
      • Create Coin Event Configuration
      • Update Coin Event Configuration
      • Allocate Coins to User
    • Voucher Processing
      • Get Cart for User
      • Add to cart
      • Update Cart
      • Order Search
      • Get Order Details
      • Create Order
    • Voucher Catalog
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
  • Corporate Cards
    • Corporate Cards Overview
    • Sign Up - Corporate Cards
    • Corporate Cards Integration Steps
    • Authorization
      • Get Authorization Token
    • Meal Cards
      • Card APIs
        • Create Card
        • View Card
        • Set Pin Card
        • Search Cards
        • Replace Card
        • Physical Card
        • Block Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
    • Fuel Cards
      • Card APIs
        • Create Card
        • Search Cards
        • View Card
        • Block Card
        • Physical Card
        • Set Pin Card
        • Replace Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
    • GSTN Verification
    • PAN Verification
    • UPI(VPA) Verification
  • Payout Data Apis
  • Beneficiary Apis
  • tiny-url-controller
  • test-controller
  • company-category-limits-controller
  • bank-holiday-controller
  • Authentication Apis
  • utility-payment-controller-v-1
  • user-controller-v-1
  • Payout Apis
  • gst-payment-controller
  • biller-controller-v-1
  • Virtual Account Apis
  • Vendor Payment Entry Controller
  • Utm Based Config Apis
  • User Apis
  • User Group Apis
  • axis-nodal-controller-v-1
  • icici-nodal-controller
  • axis-nodal-controller
  • subscription-controller
  • Sign Up API's
  • sftp-detail-controller
  • sanction-screening-controller
  • risk-check-controller
  • Reward Page Notification Apis
  • refund-transaction-controller
  • purchase-order-controller
  • Pricing Plan
  • Pre Qualification Apis
  • Pg Balance Apis
  • Payout Transaction Apis
  • payment-request-controller
  • Payment Gateway Apis
  • pay-by-link-controller
  • Partner Integration Apis
  • outstanding-amount-controller
  • otp-controller
  • OnBoarding Config Apis
  • Nudge Apis
  • Multi Factor Auth Apis
  • mail-callback-controller
  • M2P Apis
  • anchor-partner-api-controller
  • amazon-sn-s-notification-controller
  • Karza Controller
  • Instant Payout Apis
  • ICICI Connected Banking Apis
  • gstin-data-controller
  • Generate Pdf APIs
  • fin-bit-controller
  • File Store Apis
  • file-transfer-controller
  • feedback-controller
  • Fd Payment Histories
  • Favorite Api
  • Expense Product Apis
  • equifax-controller
  • Encryption Apis
  • early-payment-offer-controller
  • Document
  • digital-signature-controller
  • digital-locker-controller
  • Credit Provider Risk Check API
  • credit-provider-detail-controller
  • Config Apis
  • company-pg-controller
  • company-branch-code-controller
  • communication-controller
  • Chat Bot Apis
  • card-token-controller
  • Card Product Master Apis
  • card-product-controller
  • Card Application Memo Apis
  • Card Application Apis
  • CardAccountTenant Apis
  • Card Account Addition Mapping Apis
  • Cam Automation Apis
  • bulk-file-detail-controller
  • bulk-file-data-controller
  • Bill Payment Apis
  • Company Biller Apis
  • Beneficiary Detail Apis
  • Bbps Complaint Management Apis
  • Bank IFSC
  • Bank Detail Apis
  • Bank Card Controller
  • AWS Secret Manager Properties Apis
  • Authority Apis
  • Anchor Detail Apis
  • penny-drop-controller
  • Mobile Otp Apis
  • Mobile Authentication Apis
  • oauth-client-detail-controller
  • url-generator-controller
  • Health Check Apis
  • Single Sign On Apis
  • Bulk Upload Sample File Apis
  • credit-policy-controller
  • Payout Logs
  • Help Apis
  • Geo Location Controller
  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 '/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
Previous
getInvoice
Next
createCustomerReminder
Built with