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

Commercial invoice - single site

Event contains one-off and subscription products at a single site. One-off contains spread charges and discount.

{
	"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.00,
				"currencyCode": "string"
			}
		},
		"invoiceType": "string",
		"accountBalance": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"latePaymentCharge": {
			"chargeDescription": "string",
			"charge": {
				"amount": 0.00,
				"currencyCode": "string"
			}
		},
		"totalSubscriptionCharges": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalOneOffCharges": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalCharges": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalSubscriptionDiscounts": {
			"amount": -0.00,
			"currencyCode": "string"
		},
		"totalOneOffDiscounts": {
			"amount": -0.00,
			"currencyCode": "string"
		},
		"totalDiscounts": {
			"amount": -0.00,
			"currencyCode": "string"
		},
		"totalAdjustments": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalCancellationsExcludingVAT": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalCancellationsVAT": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalCancellationsIncludingVAT": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalExcludingVAT": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalVAT": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"totalIncludingVAT": {
			"amount": 0.00,
			"currencyCode": "string"
		},
		"outstandingTotalIncludingVAT": {
			"amount": 0.00,
			"currencyCode": "string"
		},
    "paymentMethod": {
            "paymentType": "string",
            "paymentMethodIdentifier": "string"
        },
		"adjustments": {
			"credits": [{
				"amount": {
					"amount": -0.00,
					"currencyCode": "string"
				},
				"description": "string",
				"repeatNumber": 3
			}],
			"charges": [{
				"amount": {
					"amount": 0.00,
					"currencyCode": "GBP"
				},
				"description": "string",
				"repeatNumber": 1,
				"totalNumberOfRepeats": 0.00
			}]
		},
		"sites": [{
			"site": {
				"siteIdentifier": "string",
				"siteName": "string",
				"status": "stringE",
				"sitePostcode": "string"
			},
			"totalSubscriptionCharges": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalOneOffCharges": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalCharges": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalSubscriptionDiscounts": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalOneOffDiscounts": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalDiscounts": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalAdjustments": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalCancellations": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalExcludingVAT": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalVAT": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"totalIncludingVAT": {
				"amount": 0.00,
				"currencyCode": "string"
			},
			"oneOffs": [{
				"serviceName": "string",
				"serviceStatus": "string",
				"taxCode": "string",
				"charges": [{
					"purchaseDate": "YYYY-MM-DD",
					"amountExcludingVAT": {
						"amount": 0.00,
						"currencyCode": "string"
					},
					"spreadCharge": {
						"description": "string",
						"repeatNumber": 0.00,
						"totalNumberOfRepeats": 0.00
					}
				}]
			}]
		}],
		"payments": [{
			"paymentDate": "YYYY-MM-DD",
			"paymentAmount": {
				"amount": 0.00,
				"currencyCode": "string"
			}
		}],
		"sourceId": "GUID",
		"sourceName": "PW_SYSTEM",
		"sourceType": "USER",
		"entityId": "GUID",
		"entityType": "COMPANY",
		"entityOperation": "O",
		"auditMessage": "Invoice created"
	}
}