The BillingRate Object
Object Property | Required | Object Type | Description | Max Character Length |
---|---|---|---|---|
BillingRate | Yes | Decimal | Billing Rate of Billing Rate | 10 |
AccountBillingRateId | No | Integer | Billing Rate Id of Billing Rate | 10 |
AccountWorkTypeId | No | Integer | Work Type Id of Billing Rate | 10 |
AccountProjectEmployeeId | No | Integer | Project Employee Id of Billing Rate | 10 |
AccountProjectRoleId | No | Integer | Project Role Id of Billing Rate | 10 |
StartDate | No | DateTime | Start Date of Billing Rate | 19 |
EndDate | No | DateTime | End Date of Billing Rate | 19 |
AccountEmployeeId | No | Integer | Employee Id of Billing Rate | 10 |
AccountProjectTaskId | No | Integer | Project Task Id of Billing Rate | 10 |
EmployeeRate | No | Decimal | Employee Rate of Billing Rate | 10 |
BillingRateCurrencyId | No | Integer | Billing Rate Currency Id of Billing Rate | 10 |
EmployeeRateCurrencyId | No | Integer | Employee Rate Currency Id of Billing Rate | 10 |
List All BillingRates
Returns a list of your all BillingRates in your TimeLive account.
GET /API/BillingRates
Example Request
curl "https://demo.livetecs.com/api/BillingRates" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountBillingRateId": 00001,
"AccountEmployeeId": 00001,
"AccountWorkTypeId": 00001,
"BillingRate": 50,
"EmployeeRate": 50,
"BillingRateCurrencyCode": "USD",
"EmployeeRateCurrencyCode": "USD",
"StartDate": "2017-11-01T00:00:00+00:00",
"EndDate": "2018-11-01T00:00:00+00:00"
}
]
Retrieve a BillingRate
Retrieves the BillingRate with the given ID. Returns a BillingRate object and a 200 OK response code if a valid identifier was provided.
GET /API/BillingRates/{BillingRate_ID}
Example Request
curl "https://demo.livetecs.com/api/BillingRates/00001" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountBillingRateId": 00001,
"AccountEmployeeId": 00001,
"AccountWorkTypeId": 00001,
"BillingRate": 50,
"EmployeeRate": 50,
"BillingRateCurrencyCode": "USD",
"EmployeeRateCurrencyCode": "USD",
"StartDate": "2017-11-01T00:00:00+00:00",
"EndDate": "2018-11-01T00:00:00+00:00"
}
]
Retrieve BillingRates of an Employee
Retrieves the BillingRates with the given ID. Returns a BillingRate object and a 200 OK response code if a valid identifier was provided.
GET /API/BillingRates/GetByEmployee/{Employee_ID}
Example Request
curl "https://demo.livetecs.com/api/BillingRates/GetByEmployee/00001" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountBillingRateId": 00001,
"AccountEmployeeId": 00001,
"AccountWorkTypeId": 00001,
"BillingRate": 50,
"EmployeeRate": 50,
"BillingRateCurrencyCode": "USD",
"EmployeeRateCurrencyCode": "USD",
"StartDate": "2017-11-01T00:00:00+00:00",
"EndDate": "2018-11-01T00:00:00+00:00"
}
]
Retrieve BillingRates of All Employees through SystemBillingRateTypeid
Retrieves the BillingRates for all employees through SystemBillingRateTypeid. Returns a BillingRate object and a 200 OK response code if a valid identifier was provided. BillingRateTypeID values to fetch different types of billing rates as below,
{BillingRateType_ID}
1 = Use Employee own Billing Rate, 2 = Use Project Roles Billing Rate, 3 = Use Project Employee Billing Rate, 4 = Use Project Task Billing RateGET /API/BillingRates/GetDataBySystemBillingRateTypeId/{BillingRateType_ID}
Example Request
curl "https://demo.livetecs.com/api/BillingRates/GetDataBySystemBillingRateTypeId/1" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountBillingRateId": 0,
"AccountEmployeeId": 0,
"AccountWorkTypeId": 0,
"BillingRate": 0.0,
"EmployeeRate": 0.0,
"BillingRateCurrencyCode": "AUD",
"EmployeeRateCurrencyCode": "AUD",
"StartDate": "2021-12-01T00:00:00+00:00",
"EndDate": "2021-12-01T00:00:00+00:00"
}
]
Retrieve BillingRates of Employee for given WorkType
Retrieves the BillingRates with the given ID. Returns a BillingRate object and a 200 OK response code if a valid identifier was provided.
GET /API/BillingRates/GetByEmployeeAndWorkType/{Employee_ID}/{WorkType_ID}
Example Request
curl "https://demo.livetecs.com/api/BillingRates/GetByEmployeeAndWorkType/00001/00001" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountBillingRateId": 00001,
"AccountEmployeeId": 00001,
"AccountWorkTypeId": 00001,
"BillingRate": 50,
"EmployeeRate": 50,
"BillingRateCurrencyCode": "USD",
"EmployeeRateCurrencyCode": "USD",
"StartDate": "2017-11-01T00:00:00+00:00",
"EndDate": "2018-11-01T00:00:00+00:00"
}
]
Create a BillingRate
Creates a BillingRate in your TimeLive account and returns the Response Message.
POST /API/BillingRates
Object Property | Required | Object Type | Description | Max Character Length |
---|---|---|---|---|
BillingRate | Yes | Decimal | Billing Rate of Billing Rate | 10 |
Example Request
curl "https://demo.livetecs.com/api/BillingRates" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json" \
-d "{"BillingRate":50}"
Example Response
[
{
"id": "00000",
"message": "Billing Rate Added Successfully"
}
]
Update a BillingRate
Update an BillingRate in your TimeLive account and returns the Response Message.
POST /API/BillingRates/{BillingRate_ID}
Example Request
curl "https://demo.livetecs.com/api/BillingRates/00002" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json" \
-d "{"BillingRate":60}"
Example Response
[
{
"id": "00002",
"message": "BillingRate Update Successfully"
}
]
Delete a BillingRate
Delete a BillingRate. Returns a 200 OK response code if the call succeeded.
DELETE /API/BillingRate/{BillingRate_ID}
Example Request
curl "https://demo.livetecs.com/api/BillingRates/00002" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X DELETE \
-H "Content-Type: application/json"
Example Response
[
{
"id": "00002",
"message": "Billing Rate Delete Succeed"
}
]