HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
Guides
These docs are for v2023.12. 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": "8367f08d-ef04-4df8-9bf3-0ad519cf3be7",
	"eventDate": "2023-06-06 11:09:07",
	"data": {
		"accountIdentifier": "958fd61e-b9b9-4494-86dd-a94305434010",
		"taxInclusive": true,
		"company": {
			"companyIdentifier": "co20230606115816",
			"companyName": "Garden Bar Limited",
			"companyType": "INDEPENDENT"
		},
		"invoiceIdentifier": "10961",
		"invoiceDate": "2023-03-06",
		"dueDate": "2023-03-16",
		"invoicePeriod": {
			"startDate": "2023-03-01",
			"endDate": "2023-03-31"
		},
		"totalSubscriptionCharges": {
			"amount": 200,
			"currency": "GBP"
		},
		"totalOneOffCharges": {
			"amount": 75,
			"currency": "GBP"
		},
		"totalCharges": {
			"amount": 275,
			"currency": "GBP"
		},
		"totalSubscriptionDiscounts": {
			"amount": 0,
			"currency": "GBP"
		},
		"totalOneOffDiscounts": {
			"amount": 50,
			"currency": "GBP"
		},
		"totalDiscounts": {
			"amount": 50,
			"currency": "GBP"
		},
		"totalExcludingVAT": {
			"amount": 225,
			"currency": "GBP"
		},
		"totalVAT": {
			"amount": 0,
			"currency": "GBP"
		},
		"totalIncludingVAT": {
			"amount": 225,
			"currency": "GBP"
		},
		"sites": [{
			"site": {
				"siteIdentifier": "si20230606115846",
				"siteName": "The Daisy"
			},
			"totalSubscriptionCharges": {
				"amount": 200,
				"currency": "GBP"
			},
			"totalOneOffCharges": {
				"amount": 75,
				"currency": "GBP"
			},
			"totalCharges": {
				"amount": 275,
				"currency": "GBP"
			},
			"totalSubscriptionDiscounts": {
				"amount": 0,
				"currency": "GBP"
			},
			"totalOneOffDiscounts": {
				"amount": 50,
				"currency": "GBP"
			},
			"totalDiscounts": {
				"amount": 50,
				"currency": "GBP"
			},
			"totalExcludingVAT": {
				"amount": 225,
				"currency": "GBP"
			},
			"totalVAT": {
				"amount": 0,
				"currency": "GBP"
			},
			"totalIncludingVAT": {
				"amount": 225,
				"currency": "GBP"
			},
			"subscriptions": [{
				"serviceName": "Sport Channel Subscription",
				"serviceStatus": "ACTIVE",
				"taxCode": "ZERO",
				"charges": [{
					"period": {
						"startDate": "2023-03-01",
						"endDate": "2023-03-31"
					},
					"amountExcludingVAT": {
						"amount": 200,
						"currency": "GBP"
					}
				}]
			}],
			"oneOffs": [{
				"serviceName": "The Big Event",
				"serviceStatus": "ACTIVE",
				"taxCode": "ZERO",
				"charges": [{
					"purchaseDate": "2023-02-16",
					"amountExcludingVAT": {
						"amount": 75,
						"currency": "GBP"
					},
					"spreadCharge": {
						"description": "Spread charge",
						"repeatNumber": 1,
						"totalNumberOfRepeats": 2
					}
				}],
				"discounts": [{
					"name": "Spring Offer",
					"amount": {
						"amount": 50,
						"currency": "GBP"
					}
				}]
			}]
		}]
	},
	"sourceId": "95079b7c-eca2-1a78-e053-0100007f3c74",
	"sourceName": "PW_SYSTEM",
	"sourceType": "USER",
	"entityId": "fba6904f-8cbf-4933-84c0-061834f896c5",
	"entityType": "COMPANY",
	"entityOperation": "O",
	"auditMessage": "Invoice created"
}