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

Commercial invoice - multiple sites

Event contains subscription products at multiple sites

{
    "eventType": "SERVICE_COMMERCIAL_INVOICE_CREATED",
    "tenantId": "GUID",
    "eventDate": "YYYY-MM-DD HH:MM:SS",
    "data": {
        "accountIdentifier": "string",
        "taxInclusive": true,
        "invoiceFrequency": "string",
        "company": {
            "companyIdentifier": "string",
            "companyName": "string",
            "companyType": "string",
            "companyContact": {
                "contactIdentifier": "string",
                "name": {
                    "title": "string",
                    "forename": "string",
                    "surname": "string"
                },
                "address": {
                    "building": "string",
                    "line1": "string",
                    "line2": "string",
                    "line3": "string",
                    "city": "string",
                    "area": "string",
                    "postcode": "string",
                    "countryCode": "string",
                    "phone": "number",
                    "email": "email"
                }
            }
        },
        "invoiceIdentifier": "string",
        "invoiceDate": "YYYY-MM-DD",
        "dueDate": "YYYY-MM-DD",
        "invoicePeriod": {
            "startDate": "YYYY-MM-DD",
            "endDate": "YYYY-MM-DD"
        },
        "invoiceLanguage": "string",
        "invoiceMedia": "string",
        "invoiceMediaCharge": {
            "chargeDescription": "string",
            "charge": {
                "amount": 0,
                "currencyCode": "string"
            }
        },
        "invoiceType": "string",
        "accountBalance": {
            "amount": 0,
            "currencyCode": "string"
        },
        "latePaymentCharge": {
            "chargeDescription": "string",
            "charge": {
                "amount": 0,
                "currencyCode": "string"
            }
        },
        "totalSubscriptionCharges": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalOneOffCharges": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalCharges": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalSubscriptionDiscounts": {
            "amount": -0,
            "currencyCode": "string"
        },
        "totalOneOffDiscounts": {
            "amount": -0,
            "currencyCode": "string"
        },
        "totalDiscounts": {
            "amount": -0,
            "currencyCode": "string"
        },
        "totalAdjustments": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalCancellationsExcludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalCancellationsVAT": {
            "amount": 6,
            "currencyCode": "string"
        },
        "totalCancellationsIncludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalExcludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "totalIncludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "outstandingTotalIncludingVAT": {
            "amount": 0,
            "currencyCode": "string"
        },
        "paymentMethod": {
            "paymentType": "string",
            "paymentMethodIdentifier": "string"
        },
        "adjustments": {
            "credits": [
                {
                    "amount": {
                        "amount": -0,
                        "currencyCode": "string"
                    },
                    "description": "string",
                    "repeatNumber": 3
                }
            ],
            "charges": [
                {
                    "amount": {
                        "amount": 0,
                        "currencyCode": "string"
                    },
                    "description": "string",
                    "repeatNumber": 1,
                    "totalNumberOfRepeats": 10
                }
            ]
        },
        "sites": [
            {
                "site": {
                    "siteIdentifier": "string",
                    "siteName": "string",
                    "status": "string",
                    "sitePostcode": "string"
                },
                "totalSubscriptionCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalOneOffCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalSubscriptionDiscounts": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalOneOffDiscounts": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalDiscounts": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalAdjustments": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalCancellations": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalExcludingVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalIncludingVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "subscriptions": [
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "charges": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            },
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "discounts": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "adjustments": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ]
                    },
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "cancellationDate": "YYYY-MM-DD",
                        "cancelRequestedDate": "YYYY-MM-DD",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "cancellation": {
                            "cancellationCreditPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "cancellationCreditExcludingVAT": {
                                "amount": -0,
                                "currencyCode": "string"
                            },
                            "minTermPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "minTermChargeExcludingVAT": {
                                "amount": 0,
                                "currencyCode": "string"
                            }
                        }
                    },
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "cancellationDate": "YYYY-MM-DD",
                        "cancelRequestedDate": "YYYY-MM-DD",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "charges": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "discounts": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            },
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "cancellation": {
                            "minTermPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "minTermChargeExcludingVAT": {
                                "amount": 0,
                                "currencyCode": "string"
                            }
                        }
                    }
                ]
            },
            {
                "site": {
                    "siteIdentifier": "string",
                    "siteName": "string",
                    "status": "string",
                    "sitePostcode": "string"
                },
                "totalSubscriptionCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalOneOffCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalSubscriptionDiscounts": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalOneOffDiscounts": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalDiscounts": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalAdjustments": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalCancellations": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalExcludingVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalIncludingVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "subscriptions": [
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "charges": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            },
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "discounts": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "adjustments": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ]
                    },
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "cancellationDate": "YYYY-MM-DD",
                        "cancelRequestedDate": "YYYY-MM-DD",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "cancellation": {
                            "cancellationCreditPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "cancellationCreditExcludingVAT": {
                                "amount": -0,
                                "currencyCode": "string"
                            },
                            "minTermPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "minTermChargeExcludingVAT": {
                                "amount": 0,
                                "currencyCode": "string"
                            }
                        }
                    },
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "cancellationDate": "YYYY-MM-DD",
                        "cancelRequestedDate": "YYYY-MM-DD",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "charges": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "discounts": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            },
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "cancellation": {
                            "minTermPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "minTermChargeExcludingVAT": {
                                "amount": 0,
                                "currencyCode": "string"
                            }
                        }
                    }
                ]
            },
          {
                "site": {
                    "siteIdentifier": "string",
                    "siteName": "string",
                    "status": "string",
                    "sitePostcode": "string"
                },
                "totalSubscriptionCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalOneOffCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalCharges": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalSubscriptionDiscounts": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalOneOffDiscounts": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalDiscounts": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalAdjustments": {
                    "amount": -0,
                    "currencyCode": "string"
                },
                "totalCancellations": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalExcludingVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "totalIncludingVAT": {
                    "amount": 0,
                    "currencyCode": "string"
                },
                "subscriptions": [
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "charges": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            },
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "discounts": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "adjustments": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ]
                    },
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "cancellationDate": "YYYY-MM-DD",
                        "cancelRequestedDate": "YYYY-MM-DD",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "cancellation": {
                            "cancellationCreditPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "cancellationCreditExcludingVAT": {
                                "amount": -0,
                                "currencyCode": "string"
                            },
                            "minTermPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "minTermChargeExcludingVAT": {
                                "amount": 0,
                                "currencyCode": "string"
                            }
                        }
                    },
                    {
                        "serviceName": "string",
                        "serviceStatus": "string",
                        "cancellationDate": "YYYY-MM-DD",
                        "cancelRequestedDate": "YYYY-MM-DD",
                        "agreementIdentifier": "string",
                        "taxCode": "string",
                        "charges": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "amountExcludingVAT": {
                                    "amount": 0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "discounts": [
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            },
                            {
                                "period": {
                                    "startDate": "YYYY-MM-DD",
                                    "endDate": "YYYY-MM-DD"
                                },
                                "name": "string",
                                "amount": {
                                    "amount": -0,
                                    "currencyCode": "string"
                                }
                            }
                        ],
                        "cancellation": {
                            "minTermPeriod": {
                                "startDate": "YYYY-MM-DD",
                                "endDate": "YYYY-MM-DD"
                            },
                            "minTermChargeExcludingVAT": {
                                "amount": 0,
                                "currencyCode": "string"
                            }
                        }
                    }
                ]
            }
        ],
        "payments": [
            {
                "paymentDate": "YYYY-MM-DD",
                "paymentAmount": {
                    "amount": 0,
                    "currencyCode": "string"
                }
            }
        ],
        "sourceId": "GUID",
        "sourceName": "PW_SYSTEM",
        "sourceType": "USER",
        "entityId": "GUID",
        "entityType": "COMPANY",
        "entityOperation": "O",
        "auditMessage": "Invoice created"
    }
}