curl '{backend_url}/admin/transaction-groups' \
-H 'Authorization: Bearer {jwt_token}'{
"limit": 123,
"offset": 123,
"count": 123,
"transaction_groups": [
{
"id": "<string>",
"code": "<string>",
"credits": 123,
"debits": 123,
"balance": 123,
"account": {},
"metadata": {}
}
],
"estimate_count": 123
}List Transaction Groups
Retrieve a list of transaction groups. The transaction groups can be filtered by fields such as id. The transaction groups can also be sorted or paginated.
curl '{backend_url}/admin/transaction-groups' \
-H 'Authorization: Bearer {jwt_token}'{
"limit": 123,
"offset": 123,
"count": 123,
"transaction_groups": [
{
"id": "<string>",
"code": "<string>",
"credits": 123,
"debits": 123,
"balance": 123,
"account": {},
"metadata": {}
}
],
"estimate_count": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by the transaction group's ID.
Filter by the transaction group's code.
Filter by a transaction group's creation date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Filter by a transaction group's update date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Limit the number of items returned in the list.
The number of items to skip when retrieving a list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Response
OK
The paginated list of transaction groups.
The maximum number of transaction groups to return.
The number of transaction groups to skip before retrieving the results.
The total number of transaction groups available.
The list of transaction groups.
Show child attributes
Show child attributes
The transaction group's ID.
The transaction group's code.
The transaction group's credits.
The transaction group's debits.
The transaction group's balance.
The transaction group's metadata, can hold custom key-value pairs.
The transaction group's estimate count.