ExpenseAPI

integer

expenseTypeId

query

Provide expense Type Id to add budgeted expense. To get account expense list give call to ListAvailableBudgetedExpenses of expense module and pass account Id and project Id to it.

Yes

integer

description

query

Provide description for budgeted expense

No

string

budgetedAmount

query

Provide budgeted amount for the expense

Yes

number (double)

Responses

Response Type Description

Response Type	Description
Success	Budgeted expense added successfully. `Schema` : Result Response contain customParams, It provide budgeted expense Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_expense_success_addBudgetedExpense", "detailedMessage": "Budgeted expense added successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "B71412444C7A20992A1212EA6", "customParams": { "budgetedExpenseId": 86585 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Budgeted expense added successfully.

Schema : Result

Response contain customParams, It provide budgeted expense Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_expense_success_addBudgetedExpense",
  "detailedMessage": "Budgeted expense added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "B71412444C7A20992A1212EA6",
  "customParams": {
    "budgetedExpenseId": 86585
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/expense.do?cmd=UpdateBudgetedExpense

GET /expense.do?cmd=UpdateBudgetedExpense

Expense

Summary

Update Budgeted Expense

Description

Update budgeted expense

Access

Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as Manage
Project Manager with Manage All EP or Manage permission to Project or having Contribute permission to project with account expense contribute setting as Manage
Account Admin

Parameters

Name

Located in

Description

Required

Schema

budgetedExpenseId

query

Provide budgeted expense Id to update

Yes

integer

projectId

query

Provide budgeted expense project Id

Yes

integer

expenseTypeId

query

Provide budgeted expense expense type Id

Yes

integer

description

query

Provide description

No

string

budgetedAmount

query

Provide budgeted amount

Yes

number (double)

Responses

Response Type Description

Response Type	Description
Success	Budgeted expense updated successfully. `Schema` : Result
Failure	Unexpected error `Schema` : Result

Success

Budgeted expense updated successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/expense.do?cmd=DeleteBudgetedExpense

GET /expense.do?cmd=DeleteBudgetedExpense
Expense

Summary

Delete Budgeted Expense
Description
Delete budgeted expense

Access
- Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as Manage
- Project Manager with Manage All EP or Manage permission to Project or having Contribute permission to project with account expense contribute setting as Manage
- Account Admin
Parameters

Name Located in Description Required Schema

budgetedExpenseId query
Provide budgeted Expense Id to delete.
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Budgeted expense deleted successfully.

Schema : Result

Failure
Unexpected error

Schema : Result

Response Type	Description
Success	Budgeted expense deleted successfully. `Schema` : Result
Failure	Unexpected error `Schema` : Result

/expense.do?cmd=ListBudgetedExpenses

GET /expense.do?cmd=ListBudgetedExpenses
Expense

Summary

List Budgeted Expense
Description
Get list of budgeted expense for particular project

Access
- Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as Manage
- Project Manager with Manage All EP or Manage permission to Project or having Contribute permission to project with account expense contribute setting as Manage
- Account Admin
Parameters

Name Located in Description Required Schema

projectId query
Provide project Id
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Retrieval successfully

Schema : List of budgeted expense

{ BudgetedExpense }

Failure
Unexpected error

Schema : Result

Response Type	Description
Success	Retrieval successfully `Schema` : List of budgeted expense { BudgetedExpense }
Failure	Unexpected error `Schema` : Result

/expense.do?cmd=GetBudgetedExpense

GET /expense.do?cmd=GetBudgetedExpense
Expense

Summary

Get Budgeted Expense
Description
Get Budgeted Expense details

Access
- Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
- Project Manager with Manage All EP or Manage permission to Project having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
- Account Admin
Parameters

Name Located in Description Required Schema

budgetedExpenseId query
Provide budgeted expense Id
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Retrieval successfully

Schema : BudgetedExpense

Failure
Unexpected error

Schema : Result

<

Response Type	Description
Success	Retrieval successfully `Schema` : BudgetedExpense
Failure	Unexpected error `Schema` : Result

/expense.do?cmd=ListProjectExpenses

GET /expense.do?cmd=ListProjectExpenses

Expense

Summary

List Project Expenses

Description

Get list of project budgeted and actual expense

Access

Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
Project Manager with Manage All EP or Manage permission to Project having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
Account Admin

Parameters

Name

Located in

Description

Required

Schema

projectId

query

Provide project Id

Yes

integer

outputColumns

query

Provide comma separated output columns list form below,

expenseType,description,expenseDate,budgetedAmount,actualAmount,variance

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

No

integer

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

Response Type	Description
Success	Retrieval successfully `Schema` : List of budgeted expense with actual expense included. { BudgetedExpense }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successfully

Schema : List of budgeted expense with actual expense included.

{ BudgetedExpense }

Failure

Unexpected error

Schema : Result

/expense.do?cmd=ListActualExpensesForBudgetedExpense

GET /expense.do?cmd=ListActualExpensesForBudgetedExpense

Expense

Summary

List Actual Expenses For Budgeted Expense

Description

Get list of actual expense for a particular budgeted expense.

Access

Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
Project Manager with Manage All EP or Manage permission to Project having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
Account Admin

Parameters

Name

Located in

Description

Required

Schema

budgetedExpenseId

query

Provide budgeted expense Id

Yes

integer

projectId

query

Provide project Id

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successfully `Schema` : List of actual expense { ActualExpense }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successfully

Schema : List of actual expense

{ ActualExpense }

Failure

Unexpected error

Schema : Result

/expense.do?cmd=ListUnBudgetedExpenses

GET /expense.do?cmd=ListUnBudgetedExpenses
Expense

Summary

List UnBudgeted Expenses
Description
Get list of unbudgeted expense for particular project

Access
- Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
- Project Manager with Manage All EP or Manage permission to Project having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
- Account Admin
Parameters

Name Located in Description Required Schema

projectId query
Provide project Id
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Retrieval successfully

Schema : List of actual expense

{ ActualExpense }

Failure
Unexpected error

Schema : Result

Response Type	Description
Success	Retrieval successfully `Schema` : List of actual expense { ActualExpense }
Failure	Unexpected error `Schema` : Result

/expense.do?cmd=ListAvailableBudgetedExpenses

GET /expense.do?cmd=ListAvailableBudgetedExpenses

Expense

Summary

List Available Budgeted Expenses

Description

Get list of available budgeted expense that can be added to project

Access

Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View
Project Manager with Manage All EP or Manage permission to Project having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
Account Admin

Parameters

Name

Located in

Description

Required

Schema

projectId

query

Provide project Id

Yes

integer

clientId

query

Provide client Id

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successfully `Schema` : List of account list { ExpenseFieldOptions }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successfully

Schema : List of account list

{ ExpenseFieldOptions }

Failure

Unexpected error

Schema : Result

/expense.do?cmd=GetActualExpense

GET /expense.do?cmd=GetActualExpense
Expense

Summary

Get Actual Expense
Description
Get actual expense details

Access
- Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+ - Project Manager with Manage All EP or Manage permission to Project having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+ - Account Admin
Parameters

Name Located in Description Required Schema

actualExpenseId query
Provide actual Expense Id
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Retrieval successfully

ActualExpense

Failure
Unexpected error

Schema : Result

Response Type	Description
Success	Retrieval successfully ActualExpense
Failure	Unexpected error `Schema` : Result

/expense.do?cmd=AddActualExpense

GET /expense.do?cmd=AddActualExpense

Expense

Summary

Add Actual Expense

Description

Add actual expense under budgeted expense or add individual actual expense that will be considered under unbudgeted expense.

Access

Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as Manage
Project Manager with Manage All EP or Manage permission to Project or having Contribute permission to project with account expense contribute setting as Manage
Account Admin

Parameters

Name

Located in

Description

Required

Schema

projectId

query

Provide project Id

Yes

integer

expenseTypeId

query

Provide expense type Id. To get account expense list give call to ListAvailableBudgetedExpenses of expense module and pass account Id and project Id to it.

Yes

integer

budgetedExpenseId

query

Provide budgeted Expense Id, if want to add actual expense under budgeted expense. To get budgeted expense list give call to ListBudgetedExpenses of expense module and pass project Id to it.

No

integer

supplierId

query

Provide supplier Id. To get list of suppliers give call to ListForListType of account module and provide listType = 2

No

integer

expenseDate

query

Provide expense date

Yes

format:"date"

string (date)

actualAmount

query

Provide actual amount

Yes

number (double)

description

query

Provide description

No

string

invoiceNumber

query

Provide invoice number

No

integer

resourceId

query

Provide resource Id If Cloudwall module enabled

No

integer

markupPercentage

query

Provide markupPercentage If Billing module enabled

No

integer

billAmount

query

Provide billAmount If Billing module enabled

No

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide actual expense Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_expense_success_addActualExpense",
  "detailedMessage": "Actual expense added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "4B0032E768A34C249F9F18C-0001",
  "customParams": {
    "actualExpenseId": 80184
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/expense.do?cmd=UpdateActualExpense

GET /expense.do?cmd=UpdateActualExpense

Expense

Summary

Update Actual Expense

Description

Update actual expense

Access

Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as Manage
Project Manager with Manage All EP or Manage permission to Project or having Contribute permission to project with account expense contribute setting as Manage
Account Admin

Parameters

Name

Located in

Description

Required

Schema

projectId

query

Provide project Id

Yes

integer

actualExpenseId

query

Provide actual expense Id to update

Yes

integer

expenseTypeId

query

Provide expense Type Id

Yes

integer

budgetedExpenseId

query

Provide budgeted expense Id if present or want to associate new one.

No

integer

supplierId

query

Provide supplier Id if present or want to add new one. To get list of suppliers give call to ListForListType of account module and provide listType = 2

No

integer

expenseDate

query

Provide expense date

Yes

format:"date"

string (date)

actualAmount

query

Provide actual amount

Yes

number (double)

description

query

Provide description

No

string

invoiceNumber

query

Provide invoice number

No

integer

resourceId

query

Provide resource Id If Cloudwall module enabled

No

integer

markupPercentage

query

Provide markupPercentage If Billing module enabled

No

integer

billAmount

query

Provide billAmount If Billing module enabled

No

integer

Responses

Response Type Description

Success

Actual expense updated successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/expense.do?cmd=DeleteActualExpense

GET /expense.do?cmd=DeleteActualExpense
Expense

Summary

Delete Actual Expense
Description
Delete actual expense

Access
- Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as Manage
- Project Manager with Manage All EP or Manage permission to Project or having Contribute permission to project with account expense contribute setting as Manage
- Account Admin
Parameters

Name Located in Description Required Schema

actualExpenseId query
Provide actual expense Id
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Actual expense deleted successfully.

Schema : Result

Failure
Unexpected error

Schema : Result

/expense.do?cmd=ExportList

GET /expense.do?cmd=ExportList

Expense

Summary

Export List

Description

Export expense list for a project

Access

Project Member having Manage permission to Project or having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
Project Manager with Manage All EP or Manage permission to Project having Contribute permission to Project with account expense contribute setting as View+ or having View permission to Project with account expense view setting as View+
Account Admin

Parameters

Name

Located in

Description

Required

Schema

projectId

query

Provide project Id

Yes

integer

outputColumns

query

Provide comma separated list of columns from below list

expenseType,description,expenseDate,budgetedAmount,actualAmount,variance

Yes

string

outputColumnMap

query

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

Yes