20.03.09 Billing Rates

The BillingRate Object

Object PropertyRequiredObject TypeDescriptionMax Character Length
BillingRateYesDecimalBilling Rate of Billing Rate10
AccountBillingRateIdNoIntegerBilling Rate Id of Billing Rate10
AccountWorkTypeIdNoIntegerWork Type Id of Billing Rate10
AccountProjectEmployeeIdNoIntegerProject Employee Id of Billing Rate10
AccountProjectRoleIdNoIntegerProject Role Id of Billing Rate10
StartDateNoDateTimeStart Date of Billing Rate19
EndDateNoDateTimeEnd Date of Billing Rate19
AccountEmployeeIdNoIntegerEmployee Id of Billing Rate10
AccountProjectTaskIdNoIntegerProject Task Id of Billing Rate10
EmployeeRateNoDecimalEmployee Rate of Billing Rate10
BillingRateCurrencyIdNoIntegerBilling Rate Currency Id of Billing Rate10
EmployeeRateCurrencyIdNoIntegerEmployee Rate Currency Id of Billing Rate10

List All BillingRates

Returns a list of your all BillingRates in your UNItekTIME account.
GET /API/BillingRates

Example Request

curl "https://demo.unitektime.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.unitektime.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 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.unitektime.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 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.unitektime.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 UNItekTIME account and returns the Response Message.
POST /API/BillingRates
Object PropertyRequiredObject TypeDescriptionMax Character Length
BillingRateYesDecimalBilling Rate of Billing Rate10

Example Request

curl "https://demo.unitektime.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 UNItekTIME account and returns the Response Message.
POST /API/BillingRates/{BillingRate_ID}

Example Request

curl "https://demo.unitektime.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.unitektime.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"
    }
]