ClientAPI

string

sortDirection

query

Provide sort direction - ASC

No

string

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema` : List of Active client map. { ActiveClientMap }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful

Schema : List of Active client map.

{ ActiveClientMap }

Failure

Unexpected error

Schema : Result

/client.do?cmd=ListActiveClient

GET /client.do?cmd=ListActiveClient

Client

Summary

List active clients

Description

Get list of active clients for the login account.

Sorting can be applied to any of the column. Provide sort column and direction for it.

To get list of particular size, paging can be applied. For example to get first 50 clients, pass limit as 50 and start as 0. Paging details are given below with the parameters.

Access

Project Manager +

Parameters

Name

Located in

Description

Required

Schema

outputColumns

query

Provide comma separated list of output columns.

Eg=> name,code,numActiveProjects,numArchivedProjects

Refer to List of output columns.

No

string

sortColumn

query

Provide sort column from your output columns.

No

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page. If not provided default 5 records will be returned.

No

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema` : List of active clients. { Client }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful

Schema : List of active clients.

{ Client }

Failure

Unexpected error

Schema : Result

/client.do?cmd=ListDeletedClient

GET /client.do?cmd=ListDeletedClient

Client

Summary

List deleted clients

Description

Get list of deleted clients.

Sorting can be applied to any of the column. Provide sort column and direction for it.

To get list of particular size, paging can be applied. For example to get first 50 clients, pass limit as 50 and start as 0. Paging details are given below with the parameters.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

outputColumns

query

Provide comma separated column list from below,

name,code,modifiedOn,modifiedByUser

Yes

string

sortColumn

query

Provide sort column from your output columns.

No

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page. If not provided default 5 records will be returned.

No

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema` : List of deleted clients. { Client }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful

Schema : List of deleted clients.

{ Client }

Failure

Unexpected error

Schema : Result

/client.do?cmd=ListArchivedClient

GET /client.do?cmd=ListArchivedClient

Client

Summary

List archive clients.

Description

Get list of archived clients for login account.

Sorting can be applied to any of the column. Provide sort column and direction for it.

To get list of particular size, paging can be applied. For example to get first 50 clients, pass limit as 50 and start as 0. Paging details are given below with the parameters.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

outputColumns

query

Provide comma separated list of output columns.

Eg=> name,code,numActiveProjects,numArchivedProjects

Refer to List of output columns.

No

string

sortColumn

query

Provide sort column from your output columns.

No

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page. If not provided default 5 records will be returned.

No

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema` : List of archived clients. { Client }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful

Schema : List of archived clients.

{ Client }

Failure

Unexpected error

Schema : Result

/client.do?cmd=AddClient

GET /client.do?cmd=AddClient

Client

Summary

Add client

Description

Add new client to the account

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

name

query

Provide client name

Yes

Object

type:"string"

string

currencyId

query

Provide currency ID for client.

No

Object

type:"integer"

integer

description

query

Provide description for client

No

Object

type:"string"

string

code

query

Provide a code for the client

No

Object

type:"string"

string

cwClientId

query

Provide cloud wall client Id.

No

Object

type:"integer"

integer

campaignNumberFormat

query

Campaign Number Format pattern

No

Object

type:"string"

string

startCampaignNumber

query

Number from Campaign Number will start.

No

Object

type:"integer"

integer

resetCampaignNumberYearlyFlag

query

Reset Campaign Number yearly flag. Value 1/2

No

Object

type:"integer"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide client Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_client_success_clientAdd", "detailedMessage": "Client added successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "03E676981E4630D18C2662FD722F0332", "customParams": { "clientId": 38965 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide client Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_clientAdd",
  "detailedMessage": "Client added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630D18C2662FD722F0332",
  "customParams": {
    "clientId": 38965
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=UpdateClient

GET /client.do?cmd=UpdateClient

Client

Summary

Update client

Description

Update client

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

currencyId

query

Provide currencyId client.

Yes

Object

type:"integer"

integer

clientId

query

Provide client Id to update.

Yes

Object

type:"integer"

integer

name

query

Provide client name

Yes

Object

type:"string"

string

description

query

Provide description for client

No

Object

type:"string"

string

code

query

Provide a code for the client

No

Object

type:"string"

string

removeLogo

query

Provide a code for the client

No

Object

type:"string"

boolean

cwClientId

query

Provide cloud wall client Id.

No

Object

type:"integer"

integer

campaignNumberFormat

query

Campaign Number Format pattern

No

Object

type:"string"

string

startCampaignNumber

query

Number from Campaign Number will start.

No

Object

type:"integer"

integer

resetCampaignNumberYearlyFlag

query

Reset Campaign Number yearly flag. Value 1/2

No

Object

type:"integer"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It has updated client's Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_client_success_clientUpdate", "detailedMessage": "Client updated successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "03E676981E4630D18C2662FD722F0332", "customParams": { "clientId": 38922 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It has updated client's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_clientUpdate",
  "detailedMessage": "Client updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630D18C2662FD722F0332",
  "customParams": {
    "clientId": 38922
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=GetClient

GET /client.do?cmd=GetClient
Client

Summary

Get client
Description
Get client details

Access
- Project Manager +
Parameters

Name Located in Description Required Schema

clientId query
Provide client Id to get its details.
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Retrieval successfully

Schema : Client

Failure
Unexpected error

Schema : Result

/client.do?cmd=DeleteClients

GET /client.do?cmd=DeleteClients

Client

Summary

Delete clients

Description

Delete clients

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientIds

query

Provide comma separated client Id's to delete.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide deleted client Id's.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_clientDelete",
  "detailedMessage": "Client(s) deleted successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630D18C2662FD722F0332",
  "customParams": {
    "clientIds": [
      38922
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=UndoClientDelete

GET /client.do?cmd=UndoClientDelete

Client

Summary

Undelete Clients

Description

Undelete Clients - Activated deleted clients

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientIds

query

Provide comma separated client Id's.

Yes

type: "string"

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide activated client Id's.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_clientActivate",
  "detailedMessage": "Client(s) activated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630D18C2662FD722F0332",
  "customParams": {
    "clientIds": [
      389,
      35
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=ArchiveClients

GET /client.do?cmd=ArchiveClients

Client

Summary

Archive clients

Description

Archive clients

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientIds

query

Provide comma separated client Id's to archive.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide archived client Id's.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_clientArchived",
  "detailedMessage": "Client(s) archived successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630D18C2662FD722F0332",
  "customParams": {
    "clientIds": [
      89545,
      48987
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=ActivateClients

GET /client.do?cmd=ActivateClients

Client

Summary

Activate clients

Description

Activate clients

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientIds

query

Provide comma separated client Ids to activate.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide activated client Id's.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_clientActivate",
  "detailedMessage": "Client(s) activated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630D18C2662FD722F0332",
  "customParams": {
    "clientIds": [
      3531,
      38922
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=ExportList

GET /client.do?cmd=ExportList

Client

Summary

Export Active/Archive client list.

Description

Export Active/Archive client list.

Sorting can be applied to any of the column. Provide sort column and direction for it.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientState

query

Provide state to get active or archived client list

Active(1)
Archive(3)

Yes

integer

outputColumns

query

Provide comma separated list of output columns.

Eg=> name,code,numActiveProjects,numArchivedProjects

Refer to List of output columns.

No

string

outputColumnMap

query

[{
"name": "Output Column Name", //eg. "name": "name"
"value": "Field Display Name" // eg. "value": "CLIENT NAME"
},
.......Similar for other fields]

Yes

string

sortColumn

query

Provide sort column from your output columns.

No

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

Responses

Response Type Description

Success

Client list exported successfully.

Failure

Unexpected error

Schema : Result

/client.do?cmd=ListClientRoles

GET /client.do?cmd=ListClientRoles

Client

Summary

Get client role list.

Description

Get client role list.

Access

Project Manager +

Parameters

Name

Located in

Description

Required

Schema

clientIds

query

Provide comma separated client Ids to get client roles.

Yes

string

userId

query

Provide user id.

No

integer

sortColumn

query

Provide sort column from your output columns.

No

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page.

No

integer

Responses

Response Type Description

Success

Retrieval successfully

Schema : TaskRole

Failure

Unexpected error

Schema : Result

/client.do?cmd=GetClientRoleRateDetails

GET /client.do?cmd=GetClientRoleRateDetails
Client

Summary

Get client role rate details.
Description
Get client role rate details

Access
- Account Admin +
Parameters

Name Located in Description Required Schema

clientRoleId query
Provide client role id.
Yes

Object
type:"string"

integer

Responses

Response Type Description

Success
Retrieval successfully

Schema : UserTaskRoleRate

Failure
Unexpected error

Schema : Result

/client.do?cmd=AddClientRole

GET /client.do?cmd=AddClientRole

Client

Summary

Add client role.

Description

Add client role.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client id to add role to client.

Yes

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide client role Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_addClientRole",
  "detailedMessage": "Client role added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "159FD831197F6C619438F091BE00060001",
  "customParams": {
    "clientRoleId": 42721
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=AddClientRoleRate

GET /client.do?cmd=AddClientRoleRate

Client

Summary

Add client role rate.

Description

Add client role rate.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client id to add role to client.

Yes

integer

clientRoleId

query

Provide client role id.

Yes

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide role rate Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_addTaskRoleRate",
  "detailedMessage": "Client role rate added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "159FD831197F6C619438F091BE0006B7-0001",
  "customParams": {
    "clientRoleRateId": 1971
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=DeleteClientRoleRate

GET /client.do?cmd=DeleteClientRoleRate

Client

Summary

Delete client role rate.

Description

Delete client role rate.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientRoleRateId

query

Provide client role rate id.

Yes

integer

clientId

query

Provide client id.

Yes

type: "string"

integer

Responses

Response Type Description

Success

Client role rate deleted successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/client.do?cmd=DeleteClientRole

GET /client.do?cmd=DeleteClientRole
Client

Summary

Delete client role.
Description
Delete client role.

Access
- Account Admin
Parameters

Name Located in Description Required Schema

clientRoleId query
Provide client role id.
Yes

Object
type:"string"

integer

Responses

Response Type Description

Success
Client role deleted successfully.

Schema : Result

Failure
Unexpected error

Schema : Result

/client.do?cmd=UpdateClientRole

GET /client.do?cmd=UpdateClientRole

Client

Summary

Update client role.

Description

Update client role.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client id to add role to client.

Yes

integer

clientRoleId

query

Provide client role id.

Yes

integer

displayValue

query

Provide task role display value.

Yes

type: "string"

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide updated client role's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_updateClientRole",
  "detailedMessage": "Client role updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "159FD831197F6C6194F091BE0006B7-0001",
  "customParams": {
    "clientRoleId": 32723
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=UpdateClientRolePriorityOrder

GET /client.do?cmd=UpdateClientRolePriorityOrder

Client

Summary

Update client role priority order.

Description

Update client role priority order.

Access

All authenticated users

Parameters

Name

Located in

Description

Required

Schema

clientIds

query

Provide comma separated client id's.

Yes

string

clientRoleId

query

Provide client role id.

Yes

integer

Responses

Response Type Description

Success

Client role sorted successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/client.do?cmd=GetClientNonProjectTaskList

GET /client.do?cmd=GetClientNonProjectTaskList

Client

Summary

List Client Non Project Tasks.

Description

List Client Non Project Tasks.

Access

Contact+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client id to list non project task.

Yes

integer

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page.

No

integer

Responses

Response Type Description

Success

Retrieval successfully

Schema : NonProjectTask

Failure

Unexpected error

Schema : Result

/client.do?cmd=AddClientNonProjectTask

GET /client.do?cmd=AddClientNonProjectTask

Client

Summary

Add a non project task.

Description

Add a non project task.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client id to add task.

Yes

integer

clientTaskRoleId

query

Provide client task role id.

Yes

integer

displayValue

query

Provide display value for task.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide added non project task Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_addClientNonProjectTask",
  "detailedMessage": "Client non project task added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630D18C2662FD722F0332",
  "customParams": {
    "nonProjectTaskId": 32658
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=UpdateClientNonProjectTask

GET /client.do?cmd=UpdateClientNonProjectTask

Client

Summary

Update a client non project task.

Description

Update a client non project task.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client id to add task.

Yes

integer

nonProjectTaskId

query

Provide non project task id.

Yes

integer

displayValue

query

Provide display value for task.

Yes

string

clientRoleId

query

Provide client role id.

Yes

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide updated non project task's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_updateClientNonProjectTask",
  "detailedMessage": "Client non project task updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "159FD831197F6C619438F091BE0006B7-0001",
  "customParams": {
    "nonProjectTaskId": 31837
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=DeleteClientNonProjectTask

GET /client.do?cmd=DeleteClientNonProjectTask

Client

Summary

Delete client non project task.

Description

Delete client non project task.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

nonProjectTaskId

query

Provide non project task id to delete a task.

Yes

integer

Responses

Response Type Description

Success

Client non project task deleted successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/client.do?cmd=UpdateClientNonProjectTaskPriorityOrder

GET /client.do?cmd=UpdateClientNonProjectTaskPriorityOrder

Client

Summary

Update Client Non Project Task Priority Order.

Description

Update Client Non Project Task Priority Order.

Access

All authenticated users

Parameters

Name

Located in

Description

Required

Schema

nonProjectTaskIds

query

Provide comma separated non project task id's to update task priority order.

Yes

string

clientId

query

Provide client id.

Yes

integer

Responses

Response Type Description

Success

Client non project task sorted successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/client.do?cmd=ListClientExpenseFieldOptions

GET /client.do?cmd=ListClientExpenseFieldOptions

Client

Summary

Get list of expense field options.

Description

Get list of expense field options.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide clientId to get expense list.

Yes

integer

listType

query

Provide list type id.

Yes

integer

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page.

No

integer

Responses

Response Type Description

Success

Retrieval successfully

Schema : ExpenseFieldOptions

Failure

Unexpected error

Schema : Result

/client.do?cmd=AddClientExpenseFieldOptions

GET /client.do?cmd=AddClientExpenseFieldOptions

Client

Summary

Add expense field option.

Description

Add expense field option.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide clientId to get expense list.

Yes

integer

displayValue

query

Provide display value expense field.

Yes

integer

listType

query

Provide list type id.

Yes

integer

value

query

Provide value.

Yes

integer

sortOrder

query

Provide sort order.

No

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide added expense field option Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_addexpenseFieldOption",
  "detailedMessage": "Expense field option added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "159FD831197F6C619438F091BE0006B7-0001",
  "customParams": {
    "clientExpenseFieldOptionId": 34179
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=UpdateClientExpenseFieldOptions

GET /client.do?cmd=UpdateClientExpenseFieldOptions

Client

Summary

Update Client Expense Field Option.

Description

Update Client Expense Field Option.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id to update expense field.

Yes

integer

expenseFieldOptionId

query

Provide expense field option Id to update expense field.

Yes

integer

displayValue

query

Provide display value expense field.

Yes

integer

listType

query

Provide list type Id.

Yes

integer

value

query

Provide value.

Yes

integer

sortOrder

query

Provide sort order.

Yes

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide updated expense field option's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_client_success_updateExpenseFieldOption",
  "detailedMessage": "Expense field option updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "03E676981E4630C2662FD722F0332",
  "customParams": {
    "expenseFieldOptionId": 5365
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/client.do?cmd=DeleteClientExpenseFieldOptions

GET /client.do?cmd=DeleteClientExpenseFieldOptions

Client

Summary

Delete Expense Field Options.

Description

Delete Expense Field Options.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id to delete expense field.

Yes

integer

expenseFieldOptionId

query

Provide expense field option Id to delete expense field.

Yes

integer

Responses

Response Type Description

Success

Expense field option deleted successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/client.do?cmd=UpdateClientExpenseFieldOptionsOrder

GET /client.do?cmd=UpdateClientExpenseFieldOptionsOrder

Client

Summary

Update Client Expense Field Options Order.

Description

Update Client Expense Field Options Order.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id to get expense list.

Yes

integer

listType

query

Provide list type Id.

Yes

integer

expenseFieldOptionIds

query

Provide expense field option Id's to reorder expense field.

Yes

integer

Responses

Response Type Description

Success

Expense field options reordered successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/client.do?cmd=ActivateClientExpenseFieldOptions

GET /client.do?cmd=ActivateClientExpenseFieldOptions

Client

Summary

Update expense field option state.

Description

Update expense field option state.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id.

Yes

integer

expenseFieldOptionIds

query

Provide expense field option Id to activte it.

Yes

integer

Responses

Response Type Description

Success

Expense field option activated successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/client.do?cmd=GenerateObjectLink

GET /client.do?cmd=GenerateObjectLink

Client

Summary

Get client object link.

Description

Get client object link.

Access

All authenticated users

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id to generate link for client.

Yes