Enkash Developer Portal
Home
Home
Login
  1. invoice-controller
  • Back to home
  • Account Receivable APIs
  • 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
  1. invoice-controller

searchCollectionInvoices

POST
/api/v0/invoice/search
invoice-controller

Request

Query Params
direction
enum<string> 
optional
Allowed values:
ASCDESC
limit
integer <int32>
optional
<= 5000
offset
integer <int32>
optional
orderBy
string 
optional
Body Params application/json
approvalStatuses
array[string]
optional
Allowed values:
APPROVER_APPROVAL_PENDINGAPPROVER_APPROVEDAPPROVER_REJECTEDBANK_APPROVEDCHECKER_APPROVAL_PENDINGCHECKER_APPROVEDCHECKER_REJECTEDMAKER_APPROVAL_PENDINGMAKER_APPROVEDMAKER_REJECTED
balanceAmountFrom
number 
optional
Minimum balance amount for the invoice
balanceAmountTo
number 
optional
Maximum balance amount for the invoice
baseAmountFrom
number 
optional
Minimum base amount for the invoice
baseAmountTo
number 
optional
Maximum base amount for the invoice
collectionMode
array[string]
optional
Modes of collection for the invoice
createdOnFrom
string 
optional
Start date and time for invoice creation
Example:
yyyy-MM-dd HH:mm:ss
createdOnTo
string 
optional
End date and time for invoice creation
Example:
yyyy-MM-dd HH:mm:ss
createdVia
string 
optional
Method through which the invoice was created
customerDeleted
boolean 
optional
Indicates if the customer is deleted
customerIds
array[string]
optional
List of customer IDs associated with the invoice
customerLegalName
string 
optional
Legal name of the customer
customerStatus
enum<string> 
optional
Status of the customer
Allowed values:
ACTIVEALLINACTIVE
dispatched
boolean 
optional
Indicates if the invoice has been dispatched
dispatchedOnFrom
string 
optional
Start date and time for invoice dispatch
Example:
yyyy-MM-dd HH:mm:ss
dispatchedOnTo
string 
optional
End date and time for invoice dispatch
Example:
yyyy-MM-dd HH:mm:ss
dueDateFrom
string 
optional
Start date and time for invoice due date
Example:
yyyy-MM-dd HH:mm:ss
dueDateTo
string 
optional
End date and time for invoice due date
Example:
yyyy-MM-dd HH:mm:ss
invoiceDateFrom
string 
optional
Start date and time for invoice date
Example:
yyyy-MM-dd HH:mm:ss
invoiceDateTo
string 
optional
End date and time for invoice date
Example:
yyyy-MM-dd HH:mm:ss
invoiceIds
array[string]
optional
List of invoice IDs
invoiceNumber
string 
optional
Unique number of the invoice
modifiedOnFrom
string 
optional
Start date for last modification of the invoice
Example:
yyyy-MM-dd
modifiedOnTo
string 
optional
End date for last modification of the invoice
Example:
yyyy-MM-dd
name
string 
optional
Name associated with the invoice
netAmountFrom
number 
optional
Minimum net amount of the invoice
netAmountTo
number 
optional
Maximum net amount of the invoice
parentCompanyId
string 
optional
Parent company ID associated with the invoice
payoutStatus
array[string]
optional
Allowed values:
FAILEDIMPS_CALL_MADEINITIN_PROGRESSNEFT_CALL_MADEON_HOLDPAIDPENDINGREINITIATESUCCESS
poNumber
string 
optional
Purchase Order number associated with the invoice
receivableStatuses
array[string]
optional
Allowed values:
PAIDPARTIAL_PAIDREJECTUNPAID
sellerId
string 
optional
Unique identifier for the seller
Match pattern:
^CEK[A-Z0-9]{7}$
totalReceivedFrom
number 
optional
Minimum total amount received for the invoice
totalReceivedTo
number 
optional
Maximum total amount received for the invoice
Example
{
    "approvalStatuses": [
        "APPROVER_APPROVAL_PENDING"
    ],
    "balanceAmountFrom": 0,
    "balanceAmountTo": 0,
    "baseAmountFrom": 0,
    "baseAmountTo": 0,
    "collectionMode": [
        "string"
    ],
    "createdOnFrom": "yyyy-MM-dd HH:mm:ss",
    "createdOnTo": "yyyy-MM-dd HH:mm:ss",
    "createdVia": "string",
    "customerDeleted": true,
    "customerIds": [
        "string"
    ],
    "customerLegalName": "string",
    "customerStatus": "ACTIVE",
    "dispatched": true,
    "dispatchedOnFrom": "yyyy-MM-dd HH:mm:ss",
    "dispatchedOnTo": "yyyy-MM-dd HH:mm:ss",
    "dueDateFrom": "yyyy-MM-dd HH:mm:ss",
    "dueDateTo": "yyyy-MM-dd HH:mm:ss",
    "invoiceDateFrom": "yyyy-MM-dd HH:mm:ss",
    "invoiceDateTo": "yyyy-MM-dd HH:mm:ss",
    "invoiceIds": [
        "string"
    ],
    "invoiceNumber": "string",
    "modifiedOnFrom": "yyyy-MM-dd",
    "modifiedOnTo": "yyyy-MM-dd",
    "name": "string",
    "netAmountFrom": 0,
    "netAmountTo": 0,
    "parentCompanyId": "string",
    "payoutStatus": [
        "FAILED"
    ],
    "poNumber": "string",
    "receivableStatuses": [
        "PAID"
    ],
    "sellerId": "string",
    "totalReceivedFrom": 0,
    "totalReceivedTo": 0
}

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 POST 'https://test.your-api-server.com/api/v0/invoice/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "approvalStatuses": [
        "APPROVER_APPROVAL_PENDING"
    ],
    "balanceAmountFrom": 0,
    "balanceAmountTo": 0,
    "baseAmountFrom": 0,
    "baseAmountTo": 0,
    "collectionMode": [
        "string"
    ],
    "createdOnFrom": "yyyy-MM-dd HH:mm:ss",
    "createdOnTo": "yyyy-MM-dd HH:mm:ss",
    "createdVia": "string",
    "customerDeleted": true,
    "customerIds": [
        "string"
    ],
    "customerLegalName": "string",
    "customerStatus": "ACTIVE",
    "dispatched": true,
    "dispatchedOnFrom": "yyyy-MM-dd HH:mm:ss",
    "dispatchedOnTo": "yyyy-MM-dd HH:mm:ss",
    "dueDateFrom": "yyyy-MM-dd HH:mm:ss",
    "dueDateTo": "yyyy-MM-dd HH:mm:ss",
    "invoiceDateFrom": "yyyy-MM-dd HH:mm:ss",
    "invoiceDateTo": "yyyy-MM-dd HH:mm:ss",
    "invoiceIds": [
        "string"
    ],
    "invoiceNumber": "string",
    "modifiedOnFrom": "yyyy-MM-dd",
    "modifiedOnTo": "yyyy-MM-dd",
    "name": "string",
    "netAmountFrom": 0,
    "netAmountTo": 0,
    "parentCompanyId": "string",
    "payoutStatus": [
        "FAILED"
    ],
    "poNumber": "string",
    "receivableStatuses": [
        "PAID"
    ],
    "sellerId": "string",
    "totalReceivedFrom": 0,
    "totalReceivedTo": 0
}'

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 (GenericPaginationResponse«InvoiceResponse») 
optional
data
array[object (InvoiceResponse) {40}] 
optional
recordsCount
integer <int64>
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": {
        "data": [
            {
                "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"
            }
        ],
        "recordsCount": 0
    },
    "response_code": 0,
    "response_message": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Unprocessable Request
🔴500Server Error
Modified at 2025-07-07 18:44:45
Previous
Delete Invoice Collection
Next
getInvoice
Built with