- 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
- Orders
- Payments
- Refunds
- Settlements
- Split Settlements
- E-Commerce Plugins
- Payment Links
- Payment Button
- Qr Code
- UPI Mandate
- Payment Links
- Bharat Connect (BBPS)
- About Bharat Connect
- B2B Invoicing
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- 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
- Payouts
- Accounts Payable Management Tool
- Account Receivable
- Accounts Receivable Overview
- Get Authentication Token Copy
- Customer Management
- Customer Contacts Management
- Invoice Management
- Payment Reminders
- Bharat Connect 2.0 AR
- Expense Management
- Loyalty
- Card Management
- Verification Suite
updateInvoice
PATCH
/api/v0/invoice/{invoiceId}
invoice-controller
Request
Path Params
invoiceId
string
required
Query Params
sellerId
string
optional
Match pattern:
^CEK[A-Z0-9]{7}$
Body Params application/json
approvalStatus
object (JsonNullable«string»)
optional
balanceAmount
object (JsonNullable«bigdecimal»)
optional
baseAmount
object (JsonNullable«bigdecimal»)
optional
cgst
object (JsonNullable«bigdecimal»)
optional
chargeCustomer
object (JsonNullable«boolean»)
optional
customerId
string
optional
Match pattern:
^KC[A-Z0-9]{14}$
description
object (JsonNullable«string»)
optional
dispatchNow
object (JsonNullable«boolean»)
optional
dueDate
object (JsonNullable«LocalDate»)
optional
emailAddress
object (JsonNullable«string»)
optional
gstExclusive
object (JsonNullable«boolean»)
optional
igst
object (JsonNullable«bigdecimal»)
optional
invoiceDate
object (JsonNullable«LocalDateTime»)
optional
invoiceNumber
object (JsonNullable«string»)
optional
mobileNumber
object (JsonNullable«string»)
optional
netAmount
object (JsonNullable«bigdecimal»)
optional
partialPaymentAllowed
object (JsonNullable«boolean»)
optional
payableReferenceId
object (JsonNullable«string»)
optional
poNumber
object (JsonNullable«string»)
optional
receivableStatus
object (JsonNullable«string»)
optional
sgst
object (JsonNullable«bigdecimal»)
optional
tds
object (JsonNullable«bigdecimal»)
optional
totalReceived
object (JsonNullable«bigdecimal»)
optional
via
object (JsonNullable«string»)
optional
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 ''
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