GET api/consumer/v1/customers/{customerId}/dashboard?year={year}
Get the customer's dashboard summary
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId |
Customer Id |
integer |
Required |
| year |
Year (null for all) |
integer |
Default value is 0 |
Body Parameters
None
Response Information
Resource Description
The dashboard
CustomerDashboardDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Customer |
Customer details |
CustomerDto |
None |
| ProjectsTotal |
Number of projects |
integer |
None |
| ProjectsUsersTotal |
Number of users connected to the projects |
integer |
None |
| ProjectsHoursTotal |
Hours submitted |
decimal number |
None |
| OffersTotal |
Number of offers |
integer |
None |
| OpportunitiesTotal |
Number of opportunities |
integer |
None |
| TasksTotal |
Number of Tasks |
integer |
None |
| TasksActualCosts |
Costs amount |
decimal number |
None |
| TasksActualRevenues |
Revenues amount |
decimal number |
None |
| TasksActualMargin |
Costs - Revenues amount |
decimal number |
None |
| TasksBillingPlanned |
Billing planned |
decimal number |
None |
| TasksBillingActual |
Billing actual |
decimal number |
None |
| TasksBillingToDo |
Billing planned - actual |
decimal number |
None |
Response Formats
application/json, text/json
Sample:
{
"Customer": {
"BusinessUnit": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Address": "sample string 1",
"Cap": "sample string 2",
"City": "sample string 3",
"Country": "sample string 4",
"TelephoneNumber": "sample string 5",
"Fax": "sample string 6",
"WebSite": "sample string 7",
"Email": "sample string 8",
"Code": "sample string 9",
"Description": "sample string 10",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-01T19:37:37.6930765+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-01T19:37:37.6930765+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 12
},
"ProjectsTotal": 1,
"ProjectsUsersTotal": 2,
"ProjectsHoursTotal": 3.0,
"OffersTotal": 4,
"OpportunitiesTotal": 5,
"TasksTotal": 6,
"TasksActualCosts": 7.0,
"TasksActualRevenues": 8.0,
"TasksActualMargin": 9.0,
"TasksBillingPlanned": 10.0,
"TasksBillingActual": 11.0,
"TasksBillingToDo": 12.0
}
application/xml, text/xml
Sample:
<CustomerDashboardDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
<Customer>
<Id>12</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-11-01T19:37:37.6930765+01:00</CreationDate>
<LastUpdateDate>2024-11-01T19:37:37.6930765+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 9</Code>
<Description>sample string 10</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<Address>sample string 1</Address>
<BusinessUnit>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</BusinessUnit>
<Cap>sample string 2</Cap>
<City>sample string 3</City>
<Country>sample string 4</Country>
<Email>sample string 8</Email>
<Fax>sample string 6</Fax>
<TelephoneNumber>sample string 5</TelephoneNumber>
<WebSite>sample string 7</WebSite>
</Customer>
<OffersTotal>4</OffersTotal>
<OpportunitiesTotal>5</OpportunitiesTotal>
<ProjectsHoursTotal>3</ProjectsHoursTotal>
<ProjectsTotal>1</ProjectsTotal>
<ProjectsUsersTotal>2</ProjectsUsersTotal>
<TasksActualCosts>7</TasksActualCosts>
<TasksActualMargin>9</TasksActualMargin>
<TasksActualRevenues>8</TasksActualRevenues>
<TasksBillingActual>11</TasksBillingActual>
<TasksBillingPlanned>10</TasksBillingPlanned>
<TasksBillingToDo>12</TasksBillingToDo>
<TasksTotal>6</TasksTotal>
</CustomerDashboardDto>