Retrieve distribution Information

Returns a paginated or filtered list of invoices with print and distribution status for each — how and when the invoice was produced and sent, plus links to related files when available.
Intended for creditor integrations that need to track distribution and payment-control handoff (including case identifiers for follow-up calls).

Save the case id

When you process the response, persist the case identifier with each invoice—you need it to retrieve case details for that invoice later.

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "metaData": {
        "totalCount": 0,
        "successfulCount": 0,
        "failedCount": 0,
        "filtersApplied": {
            "invoiceNumber": 0,
            "fromInvDate": "string",
            "toInvDate": "string",
            "fetchType": "string",
            "defaultLast30DaysApplied": true
        }
    },
    "invoices": [
        {
            "invoiceNumber": 0,
            "distributionStatus": "string",
            "distributionMethod": "string",
            "distributionMessage": "string",
            "dates": {
                "createdAt": "string",
                "printedAt": "string",
                "distributedAt": "string",
                "paymentControlActivatedAt": "string"
            },
            "file": {
                "url": "string"
            },
            "paymentControl": {
                "enabled": true,
                "agency": "string",
                "status": "string",
                "caseId": 0
            },
            "errors": [
                {
                    "errorCode": "string",
                    "errorDescription": "string",
                    "errorType": "string",
                    "errorCreatedTs": "2019-08-24T14:15:22.123Z"
                }
            ]
        }
    ]
}

🟠401Unauthorized

🟠404Not found

🟠400Bad request

Request

Responses