Get all charges for a circle

GET /api/v1/circles/{circle_uuid}/charges

Personal access token & OAuth2

Headers

Path parameters

circle_uuid integer Required

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [statement].
filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[client_uuids] string

Filter by a comma separated list of client UUIDs.
filter[circle_uuids] string

Filter by a comma separated list of circle UUIDs.
filter[plan_uuids] string

Filter by a comma separated list of plan UUIDs.
filter[provider_uuids] string

Filter by a comma separated list of provider UUIDs.
filter[policy_number] string

Filter by policy numbers.
filter[seller_uuids] string

Filter by a comma separated list of seller account UUIDs.
filter[payment_origin] string

Filter by comma separated list of payment origins.
filter[type] string

Filter by comma separated list of charge types.
filter[category] string

Filter by comma separated list of charge categories.
filter[recurring] boolean

Filter by recurring charges or not.
filter[frequency] string

Filter by comma separated list of frequencies.
filter[start_date_after] string

Filter by charge start dates after.
filter[start_date_before] string

Filter by charge start dates before.
filter[end_date_after] string

Filter by charge end dates after.
filter[end_date_before] string

Filter by charge end dates before.
filter[next_expectation_date_after] string

Filter by charge next expectation dates after.
filter[next_expectation_date_before] string

Filter by charge next expectation dates before.
filter[amount_from] integer

Filter by charge fixed amounts from in pennies.
filter[amount_to] integer

Filter by charge fixed amounts to in pennies.
filter[percentage_from] number

Filter by charge percentages from.
filter[percentage_to] number

Filter by charge percentages to.
filter[tax_exempt] boolean

Filter by tax exempt charges or not.
filter[exclude_from_rmar] boolean

Filter by charges excluded from RMAR or not.
filter[rmar_type] string

Filter by comma separated list of RMAR types.
filter[advice_type] string

Filter by comma separated list of advice types.
filter[service_type] string

Filter by comma separated list of service types.
sort string

Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC. Defaults to '-start_date'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

GET /api/v1/circles/{circle_uuid}/charges

curl \
 --request GET https://api.plannrcrm.com/api/v1/circles/circle_uuid/charges \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"