ClientFeeAPI

integer

outputColumns

query

Provide comma separated string of output columns.

Eg=> typeOfFee,startDate,lastBillDate,nextBillDate,status, endDate,description,amount,recurring,billDate,resource,poNumber,createdOn

Yes

string

selectedClientFeeIds

query

Provide comma separated string of selected client fee Id's

Yes

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 all records will be returned.

No

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful. `Schema` : List Client Fees { ClientFee }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful.

Schema : List Client Fees

{ ClientFee }

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=ListExpiredClientFees

GET /clientFee.do?cmd=ListExpiredClientFees

Client Fee

Summary

Retrieve list of all expired client fees.

Description

Retrieve list of all expired client fees.

Access

Account Admin
Client Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id to get it's fees

Yes

integer

outputColumns

query

Provide comma separated string of output columns.

Eg=> typeOfFee,startDate,lastBillDate,nextBillDate,status, endDate,description,amount,recurring,billDate,resource,poNumber,createdOn

Yes

string

selectedClientFeeIds

query

Provide comma separated string of selected client fee Id's

No

type: "string"

format: "date"

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 all records will be returned.

No

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful. `Schema` : List Client Fees { ClientFee }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful.

Schema : List Client Fees

{ ClientFee }

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=GetClientFee

GET /clientFee.do?cmd=GetClientFee

Client Fee

Summary

Get Client fee details.

Description

Get Client fee details.

Access

Account Admin
Client Admin

Parameters

Name

Located in

Description

Required

Schema

clientFeeId

query

Provide client fee Id to get fee details.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Client fee retrieved successfully. `Schema` : ClientFee
Failure	Unexpected error `Schema` : Result

Success

Client fee retrieved successfully.

Schema : ClientFee

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=ExportClientFeeHistory

GET /clientFee.do?cmd=ExportClientFeeHistory

Client Fee

Summary

Export list of client fee history.

Description

Export list of client fee history.

Access

Account Admin
Client Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id to export client fee history.

Yes

integer

outputColumns

query

Provide comma separated string of output columns.

Eg=> billDate,amount,status

Yes

string

outputColumnMap

query

[{
"name": "billDate",
"value": "DATE"
},{
"name": "amount",
"value": "AMOUNT"
},{
"name": "status",
"value": "STATUS"
}]

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Client fee history exported successfully.
Failure	Unexpected error `Schema` : Result

Success

Client fee history exported successfully.

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=UpdateClientFee

GET /clientFee.do?cmd=UpdateClientFee

Client Fee

Summary

Update client fee.

Description

Update client fee.

Access

Account Admin
Client Admin(Associated client)

Parameters

Name

Located in

Description

Required

Schema

clientFeeId

query

Provide client fee Id to update client fee.

Yes

integer

clientId

query

Provide client Id to update client fee.

Yes

integer

recurring

query

Provide 1 for recurring fee and 2 for non-recurring fees.

No

integer

feeType

query

Provide fee type for updating client fee

1)Service Fee- 540 2)Fixed Resource Type-541 3) Pre-pay- 542

No

integer

amount

query

Provide amount for client fee

Yes

integer

description

query

Provide description for client fee.

Yes

string

billDate

query

Provide bill date for client fee.

Yes

string (date)

poId

query

Provide purchase order Id for fees.

No

integer

resource

query

Provide resource Id.

No

integer

frequency

query

Provide frequency for client fee

1)Weekly - 545 2)Monthly - 546 3)Annually - 547

Yes(If fee is recurring)

integer

repeatInterval

query

Provide repeat interval for client fee.

Default=1, Max=12

Yes(If fee is recurring)

integer

ends

query

Provide ends for fees.

Value is one of following.

1)Never - 551 2)After - 552 3)On - 553

if selected option is "After" then provide number occurences

if selected option is "On" then provide date

Yes(If fee is recurring)

integer

feeProjects

query

Provide if fee type is pre-bill

Yes(If fee type is pre-bill)

integer

Responses

Response Type Description

Success

Schema : Result

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

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_clientFee_success_api_updateClientFee",
  "detailedMessage": "Client fee updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "EA2E5ADEA92315ACE",
  "customParams": {
    "clientFeeId": 394
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=ExportOpenClientFees

GET /clientFee.do?cmd=ExportOpenClientFees

Client Fee

Summary

Export list of all open client fees.

Description

Export list of all open client fees.

Access

Account Admin
Client Admin (Associated client)

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id

Yes

integer

selectedClientFeeIds

query

Provide comma separated string of selected client fee Id's

No

string

outputColumns

query

Provide comma separated string of output columns.

Eg=> typeOfFee,startDate,lastBillDate,nextBillDate,status,endDate,description,amount,

recurring,billDate,resource,poNumber,createdOn

Yes

string

outputColumnMap

query

[{
"name": "typeOfFee",
"value": "TYPE OF FEE"
},{
"name": "startDate",
"value": "START DATE"
},{
"name": "lastBillDate",
"value": "LAST BILLED DATE"
},
.......Similar for other fields]

Yes

string

sortColumn

query

Provide sort column from output columns.

Yes

string

sortDirection

query

Provide sort direction. ASC or DESC

Yes

string

Responses

Response Type Description

Success

Open client fees exported successfully.

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=ExportExpiredClientFees

GET /clientFee.do?cmd=ExportExpiredClientFees

Client Fee

Summary

Retrieve and export list of all expired client fees.

Description

Retrieve and export list of all expired client fees.

Access

Account Admin
Client Admin (Associated client)

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id

Yes

integer

selectedClientFeeIds

query

Provide comma separated string of selected client fee Id's

No

string

outputColumns

query

Provide comma separated string of output columns.

Eg=> typeOfFee,startDate,lastBillDate,nextBillDate,status,endDate,description,amount,

recurring,billDate,resource,poNumber,createdOn

Yes

string

outputColumnMap

query

[{
"name": "typeOfFee",
"value": "TYPE OF FEE"
},{
"name": "startDate",
"value": "START DATE"
},{
"name": "lastBillDate",
"value": "LAST BILLED DATE"
},
.......Similar for other fields]

Yes

string

sortColumn

query

Provide sort column from output columns.

Yes

string

sortDirection

query

Provide sort direction. ASC or DESC

Yes

string

Responses

Response Type Description

Success

Expired client fees exported successfully.

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=DeleteClientFee

GET /clientFee.do?cmd=DeleteClientFee

Client Fee

Summary

Delete client fee.

Description

Delete client fee.

Access

Account Admin
Client Admin(Associated client)

Parameters

Name

Located in

Description

Required

Schema

clientFeeIds

query

Provide client fee Ids to delete fees.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide deleted client fee Id list.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_clientFee_success_api_deleteClientFee",
  "detailedMessage": "Client fee deleted successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "EA2E5ADEA9871042315ACE",
  "customParams": {
    "clientFeeIds": [
      52
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=UndeleteClientFee

GET /clientFee.do?cmd=UndeleteClientFee

Client Fee

Summary

Undelete client fee.

Description

Undelete client fee.

Access

Account Admin
Client Admin(Associated client)

Parameters

Name

Located in

Description

Required

Schema

clientFeeIds

query

Provide client fee Ids to delete fees.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide undeleted client fee Id list.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_clientFee_success_api_undeleteClientFee",
  "detailedMessage": "Client fee undeleted successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "EA2E5DGET9E254EBA57F871042315ACE",
  "customParams": {
    "clientFeeIds": [
      46,
      43
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=DeleteClientFeeHistory

GET /clientFee.do?cmd=DeleteClientFeeHistory

Client Fee

Summary

Delete client fee history.

Description

Delete client fee history.

Access

Account Admin
Client Admin(Associated client)

Parameters

Name

Located in

Description

Required

Schema

clientFeeHistoryIds

query

Provide client fee history Id's.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide deleted client fee history Id list.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_clientFee_success_deleteFeeHistory",
  "detailedMessage": "Client Fee history deleted successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "EA2E5ADEA1B54E1457F871042315ACE",
  "customParams": {
    "clientFeeHistoryIds": [
      68
    ]
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=UndeleteClientFeeHistory

GET /clientFee.do?cmd=UndeleteClientFeeHistory

Client Fee

Summary

Undelete client fee history.

Description

Undelete client fee history.

Access

Account Admin
Client Admin(Associated client)

Parameters

Name

Located in

Description

Required

Schema

clientFeeHistoryIds

query

Provide client fee history Id's to undelete client fee history.

Yes

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide undeleted client fee history Id list.

Sample JSON


Response Sample :
{
 "returnCode": 0,
 "messageKey": "msg_clientFee_success_api_undeleteFeeHistory",
  "detailedMessage": "Client fee history undeleted successfully.",
 "exception": null,
 "browser": "Mozilla 5.0 (Windows)",
 "sessionId": "EA2E5ADEA9E254A5357F871042315ABE",
 "customParams": {
   "clientFeeHistoryIds": [
     89
   ]
 },
 "errorMessages": null,
 "success": true
}

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=GetClientFeeHistory

GET /clientFee.do?cmd=GetClientFeeHistory

Client Fee

Summary

Get client fee history.

Description

Get client fee history for provided client fee history Id.

Access

Application Admin, Account Admin and Client Admins (associated with that client)

Parameters

Name

Located in

Description

Required

Schema

clientFeeHistoryId

query

Provide client fee history Id to get client fee history.

Yes

integer

Responses

Response Type Description

Success

Schema : Result

Response contain client fee history Id, amount, bill date, description, client fee object...

Sample JSON


Response Sample :
{
      "id":308,
      "clientFee":{  
      "id":102,
      "user":null,
      "globalListByFrequency":null,
      "account":null,
      "client":null,
      "globalListByStatusId":null,
      "purchaseOrder":null,
      "globalListByEnds":null,
      "globalListByFeeTypeId":null,
      "createdBy":0,
      "createdOn":null,
      "modifiedBy":null,
      "modifiedOn":null,
      "billDate":null,
      "amount":null,
      "description":null,
      "state":null,
      "recurring":null,
      "repeatInterval":0,
      "numOccurences":null,
      "lastBillDate":null,
      "nextBillDate":null,
      "startDate":null,
      "endDate":null,
      "isCwSynced":null,
      "isTaxable":null,
      "cwSyncedDate":null,
      "clientFeeProjects":[  

      ],
      "clientFeeHistories":[  

      ],
      "isClientFeeOpen":null
   },
   "user":{  },
   "account":{  },
   "client":{  },
   "globalListByStatusId":{  },
   "purchaseOrder":{  },
   "globalListByFeeTypeId":{  },
   "createdBy":0,
   "createdOn":"09/28/2018 06:22 AM  US/Eastern",
   "modifiedBy":null,
   "modifiedOn":null,
   "billDate":"09/28/2018 12:00 AM  US/Eastern",
   "amount":100.00,
   "description":"ab",
   "isCwSynced":1,
   "state":1,
   "invoiceId":null,
   "invoiceNumber":null,
   "isTaxable":2,
   "cwSyncedDate":null
}

Failure

Unexpected error

Schema : Result

/clientFee.do?cmd=UpdateClientFeeHistory

GET /clientFee.do?cmd=UpdateClientFeeHistory

Client Fee

Summary

Update client fee history.

Description

Update client fee history for provided client fee history Id.

Access

Application Admin, Account Admin and Client Admins (associated with that client)

Parameters

Name

Located in

Description

Required

Schema

clientFeeHistoryId

query

Provide client fee history Id to get client fee history.

Yes

integer

PO Id

query

Provide PO Id if available

No