GetReceivableCharges (beta)

get

https://api.sherweb.com/service-provider/v1/billing/receivable-charges

Returns your charges for a specific billing period. Three types of charges are included: recurring, usage, and setup.

For the time being, you cannot use the Service Provider API rebilling feature (GetReceivableCharges endpoint) while having a PSA integration enabled.

Query Params

customerId

uuid

required

Represents a specific customer under your account.

date

Format - date (as full-date in RFC3339). Specify any date Format: yyyy-MM-dd (UTC).

The date will return the charges of either

(a) the associated (and invoiced) billing period within which the specified date falls, or 

(b) the most recent invoiced charges for the last billing period.

See the periodFrom and periodTo in your results to verify which billing period you have queried.

Headers

Ocp-Apim-Subscription-Key

string

required

Subscription Key generated in the Partner Portal.

Accept-Language

string

Specify language (and culture) following [RFC 7231, section 5.3.5: Accept-Language]. Accepted Values: en, fr

Response

200OK