Searches for billing runs using predefined parameters

Request

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

The fields that you want to retrieve; if omitted, the entire object is returned

Bodyapplication/jsonrequired

The billing run that you would like to be saved.

activate_applicationsArray of booleans(Activate Applications)

application_expiration_optionsArray of booleans(Application Expiration Options)

bill_training_providersArray of booleans(Bill Training Providers)

idsArray of strings(Ids)

IDs to search

namestring(Name)

perform_dropsArray of booleans(Perform Drops)

run_dateArray of strings, = 2 items(Run Date)

scheduled_run_dateArray of strings, = 2 items(Scheduled Run Date)

send_application_remindersArray of booleans(Send Application Reminders)

send_renewal_remindersArray of booleans(Send Renewal Reminders)

statusArray of strings(Status)

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "activate_applications": [
      true
    ],
    "application_expiration_options": [
      true
    ],
    "bill_training_providers": [
      true
    ],
    "ids": [
      "string"
    ],
    "name": "string",
    "perform_drops": [
      true
    ],
    "run_date": [
      "string",
      "string"
    ],
    "scheduled_run_date": [
      "string",
      "string"
    ],
    "send_application_reminders": [
      true
    ],
    "send_renewal_reminders": [
      true
    ],
    "status": [
      "string"
    ]
  }'

Responses

The billing run search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(BillingRunSearchResults)

LastEvaluatedKeystring

Response

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}