HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
Guides

BACS allocation

Successful allocation

{
    "eventId": "GUID",
    "eventType": "SERVICE_COMMERCIAL_BACS_ALLOCATION",
    "tenantId": "GUID",
    "eventDate": "YYYY-MM-DD 00:00:00",
    "data": {
        "accountIdentifier": "string",
        "company": {
            "companyIdentifier": "string",
            "companyName": "string",
            "companyType": "string"
        },
        "invoices": [
            {
                "invoiceIdentifier": "string",
                "allocatedAmount": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "status": "string"
            }
        ],
        "payment": {
            "amount": 0,
            "currencyCode": "string",
            "paymentDate": "YYYY-MM-DD 00:00:00",
            "accountServicerReference": "string",
            "name": "string",
            "address": "string"
        },
        "allocation": {
            "status": "ALLOCATED",
            "amount": 0,
            "currencyCode": "string",
            "allocationDate": "YYYY-MM-DD 00:00:00"
        }
    },
    "sourceId": "GUID",
    "sourceName": "PW_SYSTEM",
    "sourceType": "USER",
    "entityId": "GUID",
    "entityType": "COMPANY",
    "entityOperation": "O",
    "auditMessage": "BACS payment allocation result"
}

Unsuccessful allocation

{
    "eventId": "GUID",
    "eventType": "SERVICE_COMMERCIAL_BACS_ALLOCATION",
    "tenantId": "GUID",
    "eventDate": "YYYY-MM-DD 00:00:00",
    "data": {
        "payment": {
            "amount": 0,
            "currencyCode": "string",
            "paymentDate": "YYYY-MM-DD 00:00:00",
            "accountServicerReference": "string",
            "name": "string",
            "address": "string"
        },
        "allocation": {
            "status": "UNALLOCATED",
            "amount": 0,
            "reason": "string"
        }
    },
    "sourceId": "GUID",
    "sourceName": "PW_SYSTEM",
    "sourceType": "USER",
    "entityId": "GUID",
    "entityType": "UNKNOWN",
    "entityOperation": "O",
    "auditMessage": "BACS payment allocation result"
}