searchCollectionInvoices

POST

/api/v0/invoice/search

Request

Query Params

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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

Delete Invoice Collection

getInvoice