updateInvoice - Enkash Developer Portal

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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