Index case files

get

https://{defaultHost}/api/v2/case_files

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Lists all case files that are part of the scope of the current user (e.g. case files that belong to this creditor). The list can be filtered by the state of the case file and the page number of the returned list.

Query Params

from

integer | null

Starting number of the returned case files, defaults to 0.

amount

integer | null

Open gross main claim amount (excl. additional fees) of respective claim.

merchant

string | null

The short name of the merchant to create the case file for. You will receive the merchant-name from our Integrations-Team.

status

string | null

Status of the case files to be returned, defaults to active, paused, stopped and excludes finished. It's not possible to view multiple statuses at once, unless using the empty default.

invoice_number

string | null

Invoice number associated with the transmitted claim.

customer_number

string | null

Customer number

contract_number

string | null

ID of the contract concluded with customer.

state

string | null

CF state. Possible values: check the states table in the Case Files section.

updated_from

string | null

Updated after this timestamp (we use the CF field updated_at)

updated_to

string | null

Updated before this timestamp (we use the CF field updated_at)

sort_type

string | null

The sort direction: ascending or descending. Possible values: asc | desc. Default: asc.

Response

200returns case files