v1

latestOpenAPI 3.0.42026-08-045381279.6 KB
Cases

List collection cases

Returns a paginated list of collection cases for your account.

Pagination:

  • page (default: 1) - Page number, starting from 1
  • pageSize (default: 10, max: 100) - Number of results per page

Filters:

  • statuses - Filter by case lifecycle status (comma-separated list) Valid values: PendingContractSigning, PendingVerificationInternal, PendingVerification, NeedsAdditionalDetails, Leads, LeadsQuoteGiven, Active, Paused, Closed, Merged (case-insensitive; both name and description forms accepted)
  • divisionIds - Filter by creditor division IDs (comma-separated GUIDs, for multi-division creditors)
  • debtorIds - Filter by specific debtor IDs (comma-separated GUIDs)
  • ids - Filter by specific case IDs (comma-separated GUIDs)

Sorting:

  • sort - Sort field and direction (format: 'field:direction') Valid sort fields: DateCreated, DateUpdated, DateFinished, DateCollectionStarted, DueDate, Date, GrossAmount, Remainder, InterestFees, CollectionFees, ReminderFees, Lifecycle, CloseCode Examples: 'DateCreated:desc', 'DueDate:asc', 'GrossAmount:desc' Unknown fields are silently ignored.

Response:

  • Returns InvoiceListApiDTO with page metadata and cases array
  • Page metadata includes: totalResults, currentPage, skipped, pageSize
get/cases

Query parameters

Pageinteger
PageSizeinteger
DebtorIdsstring[]
Idsstring[]
Statusesstring[]

Filter by case lifecycle status. Valid values: PendingContractSigning, PendingVerificationInternal, PendingVerification, NeedsAdditionalDetails, Leads, LeadsQuoteGiven, Active, Paused, Closed, Merged (case-insensitive; both name and description forms accepted).

DivisionIdsstring[]

Optional list of division IDs to filter by

Sortstring

Optional sorting string "Field[:asc|desc][,Field2[:asc|desc]]…". Valid sort fields: DateCreated, DateUpdated, DateFinished, DateCollectionStarted, DueDate, Date, GrossAmount, Remainder, InterestFees, CollectionFees, ReminderFees, Lifecycle, CloseCode. Examples: 'DateCreated:desc', 'DueDate:asc'. Unknown fields are silently ignored.

Response

List returned

Example response

{
  "cases": [
    {
      "debtor": {
        "type": "Company",
        "name": "Pacific Trading LLC",
        "contactPerson": "John Smith",
        "companyRegistrationNumber": "47-1234567",
        "address": "123 Market Street, Suite 400",
        "zipCode": "94105",
        "city": "San Francisco",
        "state": "California",
        "stateAlpha2": "CA",
        "countryAlpha2": "US",
        "country": "United States",
        "email": "accounts@pacifictrading.com",
        "phone": "+1 415 555 0123"
      }
    }
  ]
}