Collections Service

Swagger documentation: https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Collections%20API%201.6.8

Overview

The BT Collections API provides programmatic access to collections data on your Collections platform tenant. Use it to synchronize companies, debtors (accounts), documents (invoices/credit notes/payments), collector activity notes, payment plans, and related entities into your own systems.

This documentation covers the external surface only (v1 publish). Internal service-to-service endpoints are omitted.

Base URL

https://{your-collections-platform-host}/api/v1

Replace {your-collections-platform-host} with the hostname of your BT Collections tenant (the same host collectors use in the browser).

Collections is not served from arc-aegis.billtrust.com. Each customer platform has its own host.

Authentication

Collections uses Bearer tokens created inside the product (Settings → API Tokens). This is different from Billtrust Platform API Keys (X-Billtrust-Api-Key).

See Authentication.

Batching and filters

Most list endpoints return at most 100 rows per request and support incremental sync via cursors. See Batching and filters.

API version

Current documented API version: 1.6.8

GET /version returns the live version string for your platform.

Endpoints in this section

Section	Endpoints	Description
Meta	GET /version, GET /is-active	API version and platform active flag
Companies	GET /companies	Legal entities / company groups of debtors
Debtors	GET /debtors	Accounts / debtors
Debtor Contacts	GET /debtor-contacts	Contact people on debtors
Debtor Custom Fields	GET /debtor-custom-fields, POST /debtor-custom-fields-bulk-update	Custom field read/update
Debtor Exports	GET /debtor-export-templates, GET /debtor-export	Export templates and file download
Documents	GET /documents, document sets/links/custom fields	Invoices, credit notes, payments, related data
General Log Entries	GET /general-log-entries, attachment download	Collector actions and free-text notes
Payment Plans	GET /payment-plans, GET /payment-plan-instalments	Payment plans and instalments
Running Procedures	GET /running-procedures	Active procedure state
Sent Document Overviews	GET /sent-document-overviews	Sent document metadata
Users and User Tasks	GET /users, GET /user-tasks	Platform users and tasks
External Workspace Items	GET / PATCH /external-workspace-items	Offloaded procedure actions for external processors

Interactive reference

Full filtered OpenAPI is available in Swagger UI under Collections API.

When using Swagger UI:

1. Select Collections API 1.6.8 from the definition dropdown.
2. Set the platform-host server variable to your Collections hostname.
3. Click Authorize and paste a Bearer token from Settings → API Tokens.

Try it out limitations

Browser Try it out from swagger-ui.aws-prod.billtrust.com against your tenant host often fails CORS and is not the supported integration path. Prefer the curl examples in these docs (or a server-side client) with a token stored securely outside the browser. Do not paste production tokens into shared/public Swagger UI sessions.