Change Invoice Status

POST

/api/v0/invoice/req-status-change-invoice

📌

Use this API to update the status of an existing invoice in your EnKash account.
This allows you to mark an invoice as paid, cancelled, or set it to any other supported status. Keeping invoice statuses up to date helps you maintain accurate financial records and automate your billing workflows.
Additionally, the updated status is synchronized with the Bharat Connect platform, ensuring that both suppliers and buyers have access to the latest status of the 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}$

invoiceStatus

object

required

objectId

string

required

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

Match pattern:

^[INV]{3}[A-Za-z0-9]{32,32}$

supplierInvoiceNumber

string

required

Match pattern:

^([^\\\"]){1,50}$

objectVersion

object

required

supplierAction

enum<string>

required

Allowed values:

CANCELCLOSEABANDON

supplierRemarks

string

required

Match pattern:

^([^\\\"]){1,100}$

statusTransition

object

required

Example

{
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "b2bIds": {
        "buyerB2BId": "string",
        "supplierB2BId": "string"
    },
    "invoiceStatus": {
        "objectId": "string",
        "supplierInvoiceNumber": "string",
        "objectVersion": {
            "currentVersion": 1,
            "newVersion": 1
        },
        "supplierAction": "CANCEL",
        "supplierRemarks": "string",
        "statusTransition": {
            "currentStatus": "CREATED",
            "newStatus": "CREATED"
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v0/invoice/req-status-change-invoice' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "b2bIds": {
        "buyerB2BId": "string",
        "supplierB2BId": "string"
    },
    "invoiceStatus": {
        "objectId": "string",
        "supplierInvoiceNumber": "string",
        "objectVersion": {
            "currentVersion": 1,
            "newVersion": 1
        },
        "supplierAction": "CANCEL",
        "supplierRemarks": "string",
        "statusTransition": {
            "currentStatus": "CREATED",
            "newStatus": "CREATED"
        }
    }
}'

Responses

🟢200Success

application/json

Body

payload

string

required

response_code

integer

required

response_message

string

required

Example

{
  "payload": "SUCCESS",
  "response_code": 0,
  "response_message": "SUCCESS"
}

Modified at 2025-07-08 19:23:01

Confirm Invoice

Edit Invoice