Alpha API ReferenceReporting
Get sales report
Aggregate sales data including revenue, orders, top products and clients
AuthorizationBearer <token>
In: header
Query Parameters
start*string
Format
date-timeend*string
Format
date-timegroupingScale?string
Default
"MONTH"Value in
"DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"targetCurrency?string
subsidiaryIds?array<string>
includeZeroSales?boolean
Default
falsesource?string
Default
"INVOICED"Value in
"INVOICED" | "ORDERS"includeVat?boolean
Default
trueResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/reporting/sales?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"{
"accessRestricted": true,
"agingBuckets": {
"property1": 0.1,
"property2": 0.1
},
"averageDaysToPayment": 0.1,
"averageOrderValue": 0.1,
"clientRevenueOverTime": [
{
"clientId": "string",
"clientName": "string",
"data": [
{
"date": "string",
"label": "string",
"value": 0.1
}
]
}
],
"collectionRate": 0.1,
"currencyMeta": {
"baseCurrency": "string",
"convertedAt": "2019-08-24T14:15:22Z",
"displayCurrency": "string",
"warnings": [
{
"asOfDate": "string",
"fromCurrency": "string",
"pivotCurrency": "string",
"reason": "MISSING_RATE",
"rowId": "string",
"toCurrency": "string"
}
]
},
"estimateRevenueOverTime": [
{
"date": "string",
"label": "string",
"value": 0.1
}
],
"includesZeroSales": true,
"orderStatusBreakdown": {
"property1": 0,
"property2": 0
},
"productPerformanceBySubsidiary": [
{
"lowByQuantity": [
{
"productId": "string",
"productInfo": {
"brand": "string",
"category": "string",
"description": "string",
"imageBlobId": "string",
"name": "string",
"productId": "string",
"salesPrice": 0.1,
"stockInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"baseUnit": {
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
},
"currency": "string",
"destinationProductInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"maximum": 0.1,
"minimum": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"totalAmount": 0.1
},
"imageBlobId": "string",
"maximum": 0.1,
"minimum": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"salesPrice": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"subsidiaryId": "string",
"totalAmount": 0.1,
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"totalQuantity": 0.1,
"totalRevenue": 0.1
}
],
"lowByRevenue": [
{
"productId": "string",
"productInfo": {
"brand": "string",
"category": "string",
"description": "string",
"imageBlobId": "string",
"name": "string",
"productId": "string",
"salesPrice": 0.1,
"stockInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"baseUnit": {
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
},
"currency": "string",
"destinationProductInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"maximum": 0.1,
"minimum": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"totalAmount": 0.1
},
"imageBlobId": "string",
"maximum": 0.1,
"minimum": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"salesPrice": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"subsidiaryId": "string",
"totalAmount": 0.1,
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"totalQuantity": 0.1,
"totalRevenue": 0.1
}
],
"name": "string",
"subsidiaryId": "string",
"topByQuantity": [
{
"productId": "string",
"productInfo": {
"brand": "string",
"category": "string",
"description": "string",
"imageBlobId": "string",
"name": "string",
"productId": "string",
"salesPrice": 0.1,
"stockInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"baseUnit": {
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
},
"currency": "string",
"destinationProductInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"maximum": 0.1,
"minimum": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"totalAmount": 0.1
},
"imageBlobId": "string",
"maximum": 0.1,
"minimum": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"salesPrice": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"subsidiaryId": "string",
"totalAmount": 0.1,
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"totalQuantity": 0.1,
"totalRevenue": 0.1
}
],
"topByRevenue": [
{
"productId": "string",
"productInfo": {
"brand": "string",
"category": "string",
"description": "string",
"imageBlobId": "string",
"name": "string",
"productId": "string",
"salesPrice": 0.1,
"stockInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"baseUnit": {
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
},
"currency": "string",
"destinationProductInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"maximum": 0.1,
"minimum": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"totalAmount": 0.1
},
"imageBlobId": "string",
"maximum": 0.1,
"minimum": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"salesPrice": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"subsidiaryId": "string",
"totalAmount": 0.1,
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"totalQuantity": 0.1,
"totalRevenue": 0.1
}
]
}
],
"recurringRevenueOverTime": [
{
"date": "string",
"label": "string",
"value": 0.1
}
],
"revenueBySubsidiary": [
{
"name": "string",
"revenue": 0.1,
"subsidiaryId": "string"
}
],
"revenueOverTime": [
{
"date": "string",
"label": "string",
"value": 0.1
}
],
"royaltyAmount": 0.1,
"royaltyPercentage": 0.1,
"source": "INVOICED",
"topClients": [
{
"averageOrderValue": 0.1,
"clientId": "string",
"clientName": "string",
"totalAmount": 0.1,
"totalOrders": 0
}
],
"topProducts": [
{
"productId": "string",
"productInfo": {
"brand": "string",
"category": "string",
"description": "string",
"imageBlobId": "string",
"name": "string",
"productId": "string",
"salesPrice": 0.1,
"stockInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"baseUnit": {
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
},
"currency": "string",
"destinationProductInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"maximum": 0.1,
"minimum": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"totalAmount": 0.1
},
"imageBlobId": "string",
"maximum": 0.1,
"minimum": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"salesPrice": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"subsidiaryId": "string",
"totalAmount": 0.1,
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"totalQuantity": 0.1,
"totalRevenue": 0.1
}
],
"totalEstimateRevenue": 0.1,
"totalOrders": 0,
"totalOutstanding": 0.1,
"totalOverdue": 0.1,
"totalRecurringRevenue": 0.1,
"totalRevenue": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}