HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
Guides
These docs are for v2024.01. Click to read the latest docs for v2024.08.01.

Commercial invoice with adjustments

{
    "eventId": "41573e0d-78ba-431f-9c22-9004d8a0a663",
    "eventType": "SERVICE_COMMERCIAL_INVOICE_CREATED",
    "tenantId": "8367f08d-ef04-4df8-9bf3-0ad519cf3be7",
    "eventDate": "2024-01-24 13:16:34",
    "data": {
        "accountIdentifier": "ACCOUNT-20240124131416",
        "taxInclusive": true,
        "invoiceFrequency": "MONTHLY",
        "company": {
            "companyIdentifier": "co20240124131406",
            "companyName": "Ryan, Price and Hoeger",
            "companyType": "INDEPENDENT",
            "companyContact": {
                "contactIdentifier": "coco20240124131406",
                "name": {
                    "forename": "Jayson",
                    "surname": "Quitzon"
                },
                "address": {
                    "building": "Unit 23",
                    "line1": "8133 Verda Springs",
                    "line2": "Chapelton Retail Park",
                    "line3": "Chapel",
                    "city": "Flinty",
                    "area": "Fife",
                    "postcode": "KY2 6EW",
                    "countryCode": "GBR",
                    "phone": "077000000",
                    "email": "[email protected]"
                }
            }
        },
        "invoiceIdentifier": "21382",
        "invoiceDate": "2024-01-25",
        "dueDate": "2024-02-04",
        "invoicePeriod": {
            "startDate": "2024-01-24",
            "endDate": "2024-01-31"
        },
        "invoiceLanguage": "English",
        "invoiceMedia": "Paper Free",
        "invoiceType": "Summary",
        "accountBalance": {
            "amount": 65.93,
            "currencyCode": "GBP"
        },
        "totalSubscriptionCharges": {
            "amount": 51.61,
            "currencyCode": "GBP"
        },
        "totalOneOffCharges": {
            "amount": 0,
            "currencyCode": "GBP"
        },
        "totalCharges": {
            "amount": 55.61,
            "currencyCode": "GBP"
        },
        "totalSubscriptionDiscounts": {
            "amount": 0,
            "currencyCode": "GBP"
        },
        "totalOneOffDiscounts": {
            "amount": 0,
            "currencyCode": "GBP"
        },
        "totalDiscounts": {
            "amount": 0,
            "currencyCode": "GBP"
        },
        "totalAdjustments": {
            "amount": 4,
            "currencyCode": "GBP"
        },
        "totalCancellationsExcludingVAT": {
            "amount": 0,
            "currencyCode": "GBP"
        },
        "totalCancellationsVAT": {
            "amount": 0,
            "currencyCode": "GBP"
        },
        "totalCancellationsIncludingVAT": {
            "amount": 0,
            "currencyCode": "GBP"
        },
        "totalExcludingVAT": {
            "amount": 55.61,
            "currencyCode": "GBP"
        },
        "totalExemptVAT": {
            "amount": 4,
            "currencyCode": "GBP"
        },
        "totalVAT": {
            "amount": 10.32,
            "currencyCode": "GBP"
        },
        "totalIncludingVAT": {
            "amount": 65.93,
            "currencyCode": "GBP"
        },
        "outstandingTotalIncludingVAT": {
            "amount": 65.93,
            "currencyCode": "GBP"
        },
        "paymentMethod": {
            "paymentType": "Direct Debit",
            "paymentMethodIdentifier": "20324"
        },
        "adjustments": {
            "credits": [
                {
                    "amountExcludingVAT": {
                        "amount": -2,
                        "currencyCode": "GBP"
                    },
                    "amountIncludingVAT": {
                        "amount": -2,
                        "currencyCode": "GBP"
                    },
                    "description": "Credit adjustment to account ACCOUNT-20240124131416"
                },
                {
                    "amountExcludingVAT": {
                        "amount": -6,
                        "currencyCode": "GBP"
                    },
                    "amountIncludingVAT": {
                        "amount": -6,
                        "currencyCode": "GBP"
                    },
                    "description": "Credit adjustment to account ACCOUNT-20240124131416",
                    "repeatNumber": 1,
                    "totalNumberOfRepeats": 3
                },
                {
                    "amountExcludingVAT": {
                        "amount": -10,
                        "currencyCode": "GBP"
                    },
                    "amountIncludingVAT": {
                        "amount": -10,
                        "currencyCode": "GBP"
                    },
                    "description": "Credit adjustment to account ACCOUNT-20240124131416"
                }
            ],
            "charges": [
                {
                    "amountExcludingVAT": {
                        "amount": 15,
                        "currencyCode": "GBP"
                    },
                    "amountIncludingVAT": {
                        "amount": 15,
                        "currencyCode": "GBP"
                    },
                    "description": "Charge adjustment to account ACCOUNT-20240124131416"
                },
                {
                    "amountExcludingVAT": {
                        "amount": 2,
                        "currencyCode": "GBP"
                    },
                    "amountIncludingVAT": {
                        "amount": 2,
                        "currencyCode": "GBP"
                    },
                    "description": "Charge adjustment to account ACCOUNT-20240124131416"
                },
                {
                    "amountExcludingVAT": {
                        "amount": 5,
                        "currencyCode": "GBP"
                    },
                    "amountIncludingVAT": {
                        "amount": 5,
                        "currencyCode": "GBP"
                    },
                    "description": "Charge adjustment to account ACCOUNT-20240124131416",
                    "repeatNumber": 1,
                    "totalNumberOfRepeats": 3
                }
            ]
        },
        "sites": [
            {
                "site": {
                    "siteIdentifier": "si20240124131536",
                    "siteName": "The black Ball",
                    "status": "ACTIVE",
                    "sitePostcode": "Ky8 4QY"
                },
                "totalSubscriptionCharges": {
                    "amount": 51.61,
                    "currencyCode": "GBP"
                },
                "totalOneOffCharges": {
                    "amount": 0,
                    "currencyCode": "GBP"
                },
                "totalCharges": {
                    "amount": 51.61,
                    "currencyCode": "GBP"
                },
                "totalSubscriptionDiscounts": {
                    "amount": 0,
                    "currencyCode": "GBP"
                },
                "totalOneOffDiscounts": {
                    "amount": 0,
                    "currencyCode": "GBP"
                },
                "totalDiscounts": {
                    "amount": 0,
                    "currencyCode": "GBP"
                },
                "totalAdjustments": {
                    "amount": 0,
                    "currencyCode": "GBP"
                },
                "totalCancellations": {
                    "amount": 0,
                    "currencyCode": "GBP"
                },
                "totalExcludingVAT": {
                    "amount": 51.61,
                    "currencyCode": "GBP"
                },
                "totalExemptVAT": {
                    "amount": 0,
                    "currencyCode": "GBP"
                },
                "totalVAT": {
                    "amount": 10.32,
                    "currencyCode": "GBP"
                },
                "totalIncludingVAT": {
                    "amount": 61.93,
                    "currencyCode": "GBP"
                },
                "subscriptions": [
                    {
                        "serviceName": "New subscription",
                        "serviceType": "SUBSCRIPTION",
                        "serviceStatus": "ACTIVE",
                        "agreementIdentifier": "SUBS-240124-131541",
                        "taxCode": "STANDARD",
                        "charges": [
                            {
                                "pricingIdentifier": "40a06295-acb5-41a0-979e-a27b93f54e3c",
                                "period": {
                                    "startDate": "2024-01-24",
                                    "endDate": "2024-01-31"
                                },
                                "amountExcludingVAT": {
                                    "amount": 51.61,
                                    "currencyCode": "GBP"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "sourceId": "947e64e1-678e-42a0-e053-0100007f4dd6",
    "sourceName": "PW_SYSTEM",
    "sourceType": "USER",
    "entityId": "be5f598f-39f2-412a-aace-9646373d8890",
    "entityType": "COMPANY",
    "entityOperation": "O",
    "auditMessage": "Invoice created"
}