HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
Guides

Credit note

SERVICE_COMMERCIAL_CREDIT_NOTE

{
    "eventId": "guid",
    "eventType": "SERVICE_COMMERCIAL_CREDIT_NOTE",
    "tenantId": "guid",
    "eventDate": "YYYY-MM-DD 00:00:00",
    "data": {
        "accountIdentifier": "string",
        "accountBalance": {
            "amount": 0,
            "currencyCode": "string"
        },
        "taxInclusive": true,
        "company": {
            "companyIdentifier": "string",
            "companyName": "string",
            "companyType": "string",
            "companyContact": {
                "contactIdentifier": "string",
                "name": {
                    "forename": "string",
                    "surname": "string"
                },
                "address": {
                    "line1": "string",
                    "city": "string",
                    "postcode": "string",
                    "countryCode": "string"
                }
            }
        },
        "invoiceFrequency": "string",
        "invoiceIdentifier": "string",
        "originalInvoiceIdentifier": "string",
        "invoiceDate": "YYYY-MM-DD",
        "dueDate": "YYYY-MM-DD",
        "invoicePeriod": {
            "startDate": "YYYY-MM-DD",
            "endDate": "YYYY-MM-DD"
        },
        "invoiceLanguage": "string",
        "invoiceMedia": "string",
        "invoiceType": "string",
        "totalExcludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalExemptVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalIncludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "outstandingTotalIncludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "creditDetails": {
            "creditIdentifier": "string",
            "creditDescription": "string",
            "creditDateTime": "YYYY-MM-DD",
            "amountExcludingVAT": {
                "amount": 0,
                "currencyCode": "string"
            },
            "amountIncludingVAT": {
                "amount": 0,
                "currencyCode": "string"
            }
        }
    },
    "sourceId": "guid",
    "sourceName": "PW_SYSTEM",
    "sourceType": "USER",
    "entityId": "guid",
    "entityType": "COMPANY",
    "entityOperation": "O",
    "auditMessage": "Account credit"
}