Collect (Finance & Billing) (v1-2025-04-18)

The Finance, or Collect, API provides all the accounts receivable capabilities in Rhythm. This includes all aspects of Invoices, Credits, Payments, Credit Memos, and Debit Memos. Additionally, this API manages Batches and Fiscal Periods and can be used to download batches for import into your accounting package.

Like most of the other Rhythm apps, the Collect API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
Languages
Servers
Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/

https://collect.api.rhythmsoftware.com/

Accounting Projects

Accounting Projects

Operations

Bank Accounts

Bank Accounts

Operations

Batch Assignment Settings

Batch Assignment Settings

Operations

Batch Downloading

Batch Downloading

Operations

Batch Posting

Batch Posting

Operations

Batch Templates

Batch Templates

Operations

Batches

Batches

Operations

Billing Notices

Billing Notices

Operations

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

Billing Templates

Billing Templates

Operations

Business Units

Business Units

Operations

Check Request Processes

Check Request Processes

Operations

Check Request Templates

Check Request Templates

Operations

Check Requests

Check Requests

Operations

Cogs Entries

Cogs Entries

Operations

Credit Memos

Credit Memos

Operations

Credits

Credits

Operations

Currency Mapping Policies

Currency Mapping Policies

Operations

Debit Memos

Debit Memos

Operations

Departments

Departments

Operations

Donation Products

Donation Products

Operations

Exchange Rates

Exchange Rates

Operations

External Payments

External Payments

Operations

Fiscal Years

Fiscal Years

Operations

Gateway Entities

Gateway Entities

Operations

Gateway Entries

Gateway Entries

Operations

Gateway Fees

Gateway Fees

Operations

Gl Accounts

Gl Accounts

Operations

Installment Plans

Installment Plans

Operations

Installment Schedules

Installment Schedules

Operations

Invoice Payment Terms

Invoice Payment Terms

Operations

Invoice Templates

Invoice Templates

Operations

Invoice Types

Invoice Types

Operations

Invoices

Invoices

Operations

Late Fee Rules

Late Fee Rules

Operations

Late Fees

Late Fees

Operations

Legacy Import Products

Legacy Import Products

Operations

Merchant Accounts

Merchant Accounts

Operations

Miscellaneous Products

Miscellaneous Products

Operations

Payment Receipt Templates

Payment Receipt Templates

Operations

Payments

Payments

Operations

Product Financial Configs

Product Financial Configs

Operations

Query Definitions

Query Definitions

Operations

Returns a list of records

Request

Returns a list of records

Path
tenantIdstringrequired

The tenant

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/queryDefinitions/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
categorystring(Category)
definitionobject(Definition)
idstring(ID)
namestring(Name)
]
Response
application/json
[ { "category": "string", "definition": {}, "id": "string", "name": "string" } ]

Recurring Batches

Recurring Batches

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Refund Receipt Templates

Refund Receipt Templates

Operations

Refunds

Refunds

Operations

Revenue Recognition Schedules

Revenue Recognition Schedules

Operations

Settings

Settings

Operations

Statement Templates

Statement Templates

Operations

Statements

Statements

Operations

Statistics

Statistics

Operations

Stored Payment Methods

Stored Payment Methods

Operations

Subledger Entries

Subledger Entries

Operations

Write Offs

Write Offs

Operations