GET api/revenueassurance/GetBillingServiceCharges?BillingPeriodId={BillingPeriodId}&PageSize={PageSize}&StartRow={StartRow}&BuyPriceOption={BuyPriceOption}&CompanyId={CompanyId}&SiteId={SiteId}&Account={Account}&BillingId={BillingId}&BillRunId={BillRunId}&Carrier={Carrier}&InvoiceId={InvoiceId}&Nominal={Nominal}&Frequency={Frequency}&ServiceChargeTypeId={ServiceChargeTypeId}
This method returns details for the sales check
Notes:
Profit and Margin Calculation Options
- 0 - Buy Price
- 1 - Calculated Buy Price
- 2 - Baseline Price
Frequency
- 1 - Annual
- 2 - Monthly
- 3 - One Off
- 4 - Quarterly
- 5 - Bimonthly
Error messages
- 403/Forbidden - Billing period is required
- 403/Forbidden - Page size must be between 1 and 1000
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
BillingPeriodId | The id for the billing period | integer |
Required |
PageSize | The number of records to return. Defaults to 200 | integer |
Range: inclusive between 1 and 1000 |
StartRow | The start row for the data returned. Defaults to 0 | integer |
None. |
BuyPriceOption | Profit and Margin Calculation Option. Defaults to 0 | integer |
None. |
CompanyId | The id for the company | integer |
None. |
SiteId | The id for the site | integer |
None. |
Account | The name of the account | string |
None. |
BillingId | The CLI for the record | string |
None. |
BillRunId | The id for the bill run | integer |
None. |
Carrier | The name of the carrier | string |
None. |
InvoiceId | The id for the invoice | integer |
None. |
Nominal | string |
None. |
|
Frequency | The value for the frequency option | integer |
None. |
ServiceChargeTypeId | The id for the service charge type | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
The sales check result
SalesCheckResultName | Description | Type | Additional information |
---|---|---|---|
TotalRecords | Total count of records found that match filter | integer |
None. |
ReturnData | List of records for the sales | Collection of SalesCheck |
None. |