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.
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/
https://collect.api.rhythmsoftware.com/
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}
https://collect.api.rhythmsoftware.com/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "batch_id": "string", "errors": 0.1, "success": 0.1, "total": 0.1 }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/invoices/{tenantId}/renderEmail/{id}
https://collect.api.rhythmsoftware.com/invoices/{tenantId}/renderEmail/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/invoices/{tenantId}/renderEmail/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{}
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/invoices/{tenantId}/search
https://collect.api.rhythmsoftware.com/invoices/{tenantId}/search
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/invoices/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount_paid": [
0.1,
0.1
],
"balance_due": [
0.1,
0.1
],
"batch_id": [
"string"
],
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_to_type": "string",
"business_unit_id": "string",
"date": [
"string",
"string"
],
"date_due": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"id": [
"string"
],
"number": [
0.1,
0.1
],
"purchase_order_number": [
"string"
],
"total": [
0.1,
0.1
],
"total_in_base_currency": [
0.1,
0.1
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }