|
BillingRule
Represents a BillingRule object. It's a child of a billinggrade object. The Billing Rules page allows you to set up complex rules for how BlueCamroo should bill the time users log into BlueCamroo.
Supported API Calls: List | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID for the BillingRule. When adding a new BillingRule object the value must be 0. |
|
GradeId |
integer |
The ID of the parent billinggrade. |
|
GradeName |
string (100) |
The name of the billinggrade. |
|
ProductId |
integer |
The ID of the product object the rule should bill for. |
|
EqualTime |
float |
The amount of time associated to one unit of Product. |
|
EqualTimeUnit |
string (100) |
In what unit the time should be assessed. Values are: hour and minute. |
|
TotalEach |
string (100) |
Sets how to total multiple time records. Values are: entry and day. |
|
Rounding |
string (100) |
How to round time totals. Values are: up, down, nearest. |
|
RoundTo |
double |
Rounding to multiplier |
|
RoundToTimeUnit |
string (100) |
Sets how time units are rounded. Values are hour, minute. |
|
MaxTimeInSecond |
float |
The Maximum time that can be billed for each Grade. Value entered is calculated based on EqualTimeUnit. This value is optional. |
|
ExcessTime |
string (100) |
Excess Time sets the rule for how to handle time that is not billed because it is rounded away, or in excess of the Max time for the 'Total Each' period. Values are: accumulate, discard, overtime. |
|
OverTimeProductId |
integer |
The Product Code ID used for time that exceeds the Max value. This value is optional. |
List
Description
Returns a list of Accounting Setup Billing Rules.
URL
https://{company}.bluecamroo.com/api/BillingRule/list
HTTP Method
GET
Data Return
Returns a list of BillingRule objects in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Add
Description
Adds a Billing Rule object.
URL
https://{company}.bluecamroo.com/api/BillingRule/add
HTTP Method
POST
Parameters
A BillingRule object
Data Return
Returns the BillingRule object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Pass a billing rule object to replace the specified Billing Rule.
URL
https://{company}.bluecamroo.com/api/BillingRule/update
HTTP Method
PUT
Parameters
A BillingRule object
Data Return
Returns the BillingRule object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified Billing Rule.
URL
https://{company}.bluecamroo.com/api/BillingRule/delete/{id}
HTTP Method
Parameters
None
Parameters
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|