20.03.10 Billing Types

The BillingType Object

Object PropertyRequiredObject TypeDescriptionMax Character Length
BillingTypeYesStringBilling Type of Billing Type15
AccountBillingTypeIdNoIntegerBilling Type Id of Billing Type10
IsDisabledNoBooleanDisabled Status of Billing Type1

List All BillingTypes

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

Example Request

curl "https://demo.unitektime.com/api/BillingTypes" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
    {
        "AccountBillingTypeId": 0001,
        "BillingType": "Hourly",
        "BillingCategory": "Employee",
        "IsDisabled": "No"
    },
    {
        "AccountBillingTypeId": 0002,
        "BillingType": "Monthly",
        "BillingCategory": "Employee",
        "IsDisabled": "No"
    }
]

Retrieve a BillingType

Retrieves the BillingType with the given ID. Returns a BillingType object and a 200 OK response code if a valid identifier was provided.
GET /API/BillingTypes/{BillingType_ID}

Example Request

curl "https://demo.unitektime.com/api/BillingTypes/0002" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
    {
        "AccountBillingTypeId": 0002,
        "BillingType": "Monthly",
        "BillingCategory": "Employee",
        "IsDisabled": "No"
    }
]

Create a BillingType

Creates a BillingType in your UNItekTIME account and returns the Response Message.
POST /API/BillingTypes
Object PropertyRequiredObject TypeDescriptionMax Character Length
BillingTypeYesStringBilling Type of Billing Type15

Example Request

curl "https://demo.unitektime.com/api/BillingTypes" \
      -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 "{'BillingType':"Hourly"}"

Example Response

[
    {
        "id": "00000",
        "message": "Billing Type Added Successfully"
    }
]

Update a BillingType

Update an BillingType in your UNItekTIME account and returns the Response Message.
POST /API/BillingTypes/{BillingType_ID}

Example Request

curl "https://demo.unitektime.com/api/BillingTypes/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 "{"BillingType":"Monthly"}"

Example Response

[
    {
        "id": "00002",
        "message": "Billing Type Update Successfully"
    }
]

Delete a BillingType

Delete a BillingType. Returns a 200 OK response code if the call succeeded.
DELETE /API/BillingType/{BillingType_ID}

Example Request

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