The Task Object

Object Property Required Object Type Description Max Character Length
ClientName Yes String Name Of Client 200
AccountClientId No Integer Unique Client Id Of Client 10
ClientCode No String Client Code Of Client 4000
EMailAddress No String Email Address Of Client 50
Address1 No String Address 1 Of Client 20
Address2 No String Address 2 Of Client 20
CountryId No Short Country Id Of Client 3
State No String State Of Client 10
City No String City Of Client 10
ZipCode No String ZipCode Of Client 10
Telephone1 No String Telephone 1 Of Client 15
Telephone2 No String Telephone 2 Of Client 15
Fax No String Fax No Of Client 15
DefaultBillingRate No Double Default Billing Rate Of Client 10
Website No String Website Of Client 50
Notes No String Notes Of Client 100
IsDisabled No Boolean Disabled Status Of Client 2000
CustomField1 No String CustomField 1 Of Client 2000
CustomField2 No String CustomField 2 Of Client 2000
CustomField3 No String CustomField 3 Of Client 2000
CustomField4 No String CustomField 4 Of Client 2000
CustomField5 No String CustomField 5 Of Client 2000
CustomField6 No String CustomField 6 Of Client 2000
CustomField7 No String CustomField 7 Of Client 2000
CustomField8 No String CustomField 8 Of Client 2000
CustomField9 No String CustomField 9 Of Client 2000
CustomField11 No String CustomField 10 Of Client 2000
CustomField10 No String CustomField 11 Of Client 2000
CustomField12 No String CustomField 12 Of Client 2000
CustomField13 No String CustomField 13 Of Client 2000
CustomField14 No String CustomField 14 Of Client 2000
CustomField15 No String CustomField 15 Of Client 2000
FixedCost No Float Fixed Cost Of Client 10
FixedBidBillingMode No String Fixed Bid Billing Mode Of Client 18

List All Clients

Returns a list of your all Clients in your TimeLive account.

GET /API/Clients

Example Request

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

Example Response

[
    {
        "AccountClientId": 00001,
        "ClientName": "Barth Gross Electric Company Inc",
        "ClientCode": "BGE",
        "EMailAddress": "info@barthgross.com",
        "Address1": "110 West 26th Street",
        "Address2": null,
        "State": "NY",
        "City": "New York",
        "Country": "United States"
        "ZipCode": 10001,
        "Telephone1": "+1 (212) 645-7452",
        "Telephone2": null,
        "Fax": null,
        "Website": "http://www.example.com",
        "Notes": null,
        "CreatedOn": "2017-12-27T13:57:34.78+00:00",
        "ModifiedOn": "2017-12-27T13:57:34.78+00:00",
        "CustomField1": null,
        "CustomField2": null,
        "CustomField3": null,
        "CustomField4": null,
        "CustomField5": null,
        "CustomField6": null,
        "CustomField7": null,
        "CustomField8": null,
        "CustomField9": null,
        "CustomField11": null,
        "CustomField10": null,
        "CustomField12": null,
        "CustomField13": null,
        "CustomField14": null,
        "CustomField15": null
    },
    {
        "AccountClientId": 00002,
        "ClientName": "Clutch Design Inc.",
        "ClientCode": "CLUTCH",
        "EMailAddress": "info@clutchdesign.com",
        "Address1": "320 Wilshire Blvd",
        "Address2": null,
        "State": "CA",
        "City": "Santa Monica",
        "Country": "United States"
        "ZipCode": 90401,
        "Telephone1": "+1 (310) 899-0522",
        "Telephone2": null,
        "Fax": null,
        "Website": "http://www.example.com",
        "Notes": null,
        "CreatedOn": "2017-12-27T13:57:34.78+00:00",
        "ModifiedOn": "2017-12-27T13:57:34.78+00:00",
        "CustomField1": null,
        "CustomField2": null,
        "CustomField3": null,
        "CustomField4": null,
        "CustomField5": null,
        "CustomField6": null,
        "CustomField7": null,
        "CustomField8": null,
        "CustomField9": null,
        "CustomField11": null,
        "CustomField10": null,
        "CustomField12": null,
        "CustomField13": null,
        "CustomField14": null,
        "CustomField15": null
    }
]

Retrieve a Client

Retrieves the client with the given ID. Returns a client object and a 200 OK response code if a valid identifier was provided.

GET /API/Clients/{CLIENT_ID}

Example Request

curl "https://demo.livetecs.com/api/clients/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

[
    {
        "AccountClientId": 00001,
        "ClientName": "Barth Gross Electric Company Inc",
        "ClientCode": "BGE",
        "EMailAddress": "info@barthgross.com",
        "Address1": "110 West 26th Street",
        "Address2": null,
        "State": "NY",
        "City": "New York",
        "Country": "United States"
        "ZipCode": 10001,
        "Telephone1": "+1 (212) 645-7452",
        "Telephone2": null,
        "Fax": null,
        "Website": "http://www.example.com",
        "Notes": null,
        "CreatedOn": "2017-12-27T13:57:34.78+00:00",
        "ModifiedOn": "2017-12-27T13:57:34.78+00:00",
        "CustomField1": null,
        "CustomField2": null,
        "CustomField3": null,
        "CustomField4": null,
        "CustomField5": null,
        "CustomField6": null,
        "CustomField7": null,
        "CustomField8": null,
        "CustomField9": null,
        "CustomField11": null,
        "CustomField10": null,
        "CustomField12": null,
        "CustomField13": null,
        "CustomField14": null,
        "CustomField15": null
    }
]

Create a Client

Creates a new client. Returns Response message and a 201 Created response code if the call succeeded.

POST /API/Clients
Object Property Required Object Type Description Max Character Length
ClientName Yes String Name of Client 200

Example Request

curl "https://demo.livetecs.com/api/clients" \
      -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 "{'clientname':'LEGO'}"

Example Response

[
    {
        "id": "00003",
        "message": "Client Added Successfully"
    }
]

Update a Client

Updates the specific client by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Returns Response message and a 200 OK response code if the call succeeded.

POST /API/Clients/{CLIENT_id}

Example Request

curl "https://demo.livetecs.com/api/clients/00003" \
      -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 "{'clientcode':'LEGO'}"

Example Response

[
    {
        "id": "00003",
        "message": "Client Updated Successfully"
    }
]

Delete a Client

Delete a client. Returns a 200 OK response code if the call succeeded.

DELETE /API/Clients/{CLIENT_ID}

Example Request

curl "https://demo.livetecs.com/api/clients/00003" \
      -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

bc.[ { “id”: “00003”, “message”: “Client Deleted Successfully” }
]