...
Info |
---|
The information in this document is currently in BETA and subject to change. |
The Rates resource represents a collection of rates that have been setup in Actionstep for the accessing organization. While the Rates resources forms a foundation of rates that may be applied to charges, there are numerous overrides and exceptions that may be applied to determine rates in different circumstances.
Resource Properties
Scope Parameter | rates |
---|---|
Location | /rates |
Methods | GET |
Default Page Size | 50 |
Max Page Size | 200 |
Default Includes | None |
...
Resource Attributes
Field | Description | Format | Required | Field Type | Notes | ||
---|---|---|---|---|---|---|---|
id | Unique identifier | integer | true | default | |||
name | The name given to the rate. | string | true | default | |||
rate | The actual rate. | number | true | default | |||
includesTax | If the rate includes tax or not. | boolean | true | default | |||
costRate | A comparison rate of the cost of the service. | number | false | default | Only used for reporting. | ||
isActive | If the rate is active. | boolean | true | default | |||
isFixedFee | If the rate is a fixed fee. | boolean | true | default | unitOfMeasure | ||
isCustomRate | If the rate is a custom rate. | boolean | true | default | |||
unit | The unit of measure for the rate. | string | true | link | |||
incomeAccount | The income account associated to the matter. | string | false | link | Not Yet Implemented. | ||
expenseAccount | The expense account associated to the matter. | string | false | link | Not Yet Implemented. | ||
taxCode | The income tax code associated to the matter. | string | false | link | Not Yet Implemented. | ||
expenseTaxCode | The expense code associated to the matter. | string | false | link | Not Yet Implemented. |
Link Templates
Identifier | Resource | Location Template |
---|---|---|
rates.unitOfMeasureunit | unitofmeasureunits | /unitofmeasure/{rates.unitOfMeasureunit} |
rates.incomeAccount | accounts | /accounts/{rates.incomeAccount} |
rates.expenseAccount | accounts | /accounts/{rates.expenseAccount} |
rates.taxCode | taxcodes | /taxcodes/{rates.taxCode} |
rates.expenseTaxCode | taxcodes | /taxcodes/{rates.expenseTaxCode} |
...