Retrieve distribution Information

GET

https://staging-integrations.confirmafinance.com/api/v1/partner/invoice/distribution

invoicedistribution

This API Service is for the Creditor to retrieve a list of distribution information / details from the Cash-In Invoice and Distribution.

TIP

After retrieving distribution information for invoice, save the case identifier per invoice - this is needed to retrieve case details per invoice.

Request

Authorization

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Responses

🟢200

application/json

Body

Example

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

🟠401Unauthorized

Retrieve case details

Introduction to Payments