Retrieve Client Profitability Summaries

Time	Status	User Agent
Retrieving recent requests…

FromAccountingYearCode

string

Required. Select only transactions from accounting year code

FromAccountingMonthCode

string

Required. Select only transactions from accounting month code

ToAccountingYearCode

string

Required. Select only transactions to accounting year code

ToAccountingMonthCode

string

Required. Select only transactions to accounting month code

OfficeIds

array of int32s

Select only transactions which belong to these offices, you can only choose either office or entity.

OfficeIds

EntityIds

array of int32s

Select only transactions which belong to these entities, you can only choose either office or entity.

EntityIds

ClientIds

array of int32s

Select only transactions which belong to these clients.

ClientIds

GroupByClient

boolean

Set to false to group by master client. By default group by client.

ClientDisplay

string

Set the client display when group by client. By default it's Client.

GLAccountIds

array of int32s

Select only transactions which belong to these accounts.

GLAccountIds

DepartmentIds

array of int32s

Select only transactions which belong to these departments.

DepartmentIds

CostRateType

enum

Select the cost rate type. By default Use Time entry cost rates.

Allowed:

SeparateOffices

boolean

Separate report for each office. By default it's true.

ReportCurrencyType

enum

Select the report currency type. By default Use Office Home Currencies.

Allowed:

ReportCurrencyCode

string

Required when converted to selected currency.

ExchangeRateType

enum

Required when converted to selected currency. By default use Current Exchange Rates.

Allowed:

CalAllocationOnRevenue

boolean

Set to true to calculate Overhead Allocation based on Client % of Revenue. By default based on Client % of Direct Labour.

CalAllocationMonthly

boolean

Set to false to calculate Indirect Overheads base on Month Range. By default it's Monthly.

CapMonthlyHours

boolean

Set to true to cap the monthly hours. By default it's false.

ShowProductCampaignJobDetails

boolean

Set to true to show Product, Campaign & Job Detail. By default it's false.

200OK

400Bad Request

401Unauthorized

403Forbidden