searchCollectionInvoices

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

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

searchCollectionInvoices

Request

Request samples

Responses