Invoice
SERVICE_COMMERCIAL_INVOICE_CREATED
{
"eventId": "GUID",
"eventType": "SERVICE_COMMERCIAL_INVOICE_CREATED",
"tenantId": "GUID",
"eventDate": "YYYY-MM-DD 00:00:00",
"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": "string",
"email": "string"
}
}
},
"invoiceIdentifier": "string",
"invoiceDate": "2023-09-15",
"dueDate": "2023-09-25",
"invoicePeriod": {
"startDate": "2023-09-01",
"endDate": "2023-09-30"
},
"invoiceLanguage": "string",
"invoiceMedia": "string",
"invoiceMediaCharge": {
"chargeDescription": "string",
"chargeExcludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"chargeIncludingVAT": {
"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": 0,
"currencyCode": "string"
},
"totalCancellationsIncludingVAT": {
"amount": 0,
"currencyCode": "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"
},
"paymentMethod": {
"paymentType": "string",
"paymentMethodIdentifier": "string"
},
"adjustments": {
"credits": [
{
"amountExcludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"amountIncludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"description": "string"
}
],
"charges": [
{
"amountExcludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"amountIncludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"description": "string"
}
]
},
"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"
},
"totalExemptVAT": {
"amount": 0,
"currencyCode": "string"
},
"totalVAT": {
"amount": 0,
"currencyCode": "string"
},
"totalIncludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"subscriptions": [
{
"serviceName": "string",
"serviceType": "string",
"serviceStatus": "string",
"agreementIdentifier": "string",
"taxCode": "string",
"charges": [
{
"pricingIdentifier": "string",
"period": {
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
},
"amountExcludingVAT": {
"amount": 0,
"currencyCode": "string"
}
},
{
"pricingIdentifier": "string",
"period": {
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
},
"amountExcludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"priceOverride": {
"overrideIdentifier": "string",
"status": "string",
"description": "string",
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
}
}
],
"discounts": [
{
"pricingIdentifier": "string",
"discountIdentifier": "string",
"period": {
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
},
"name": "string",
"amount": {
"amount": 0,
"currencyCode": "GBP"
}
}
],
"adjustments": [
{
"period": {
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
},
"name": "string",
"amount": {
"amount": 0,
"currencyCode": "string"
}
}
]
},
{
"serviceName": "string",
"serviceType": "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"
},
"totalExemptVAT": {
"amount": 0,
"currencyCode": "string"
},
"totalVAT": {
"amount": 0,
"currencyCode": "string"
},
"totalIncludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"oneOffs": [
{
"serviceName": "string",
"serviceType": "string",
"serviceStatus": "string",
"agreementIdentifier": "string",
"taxCode": "string",
"charges": [
{
"pricingIdentifier": "string",
"purchaseDate": "YYYY-MM-DD",
"amountExcludingVAT": {
"amount": 0,
"currencyCode": "string"
}
}
],
"discounts": [
{
"name": "string",
"amount": {
"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"
},
"totalExemptVAT": {
"amount": 0,
"currencyCode": "string"
},
"totalVAT": {
"amount": 0,
"currencyCode": "string"
},
"totalIncludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"oneOffs": [
{
"serviceName": "string",
"serviceStatus": "string",
"serviceType": "string",
"agreementIdentifier": "string",
"taxCode": "string",
"charges": [
{
"purchaseDate": "YYYY-MM-DD",
"pricingIdentifier": "string",
"amountExcludingVAT": {
"amount": 0,
"currencyCode": "string"
},
"spreadCharge": {
"description": "string",
"repeatNumber": 1,
"totalNumberOfRepeats": 10
}
}
]
}
]
}
],
"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"
}
Updated 8 days ago