TransactionMatchSeries
Retrieves a monthly series of transaction match reports which include details arrays and summaries
Retrieves a TransactionMatchSeries resource.
get/transaction_match_series
Query parameters
startstring date-time
YYYY-MM-DD
endstring date-time
YYYY-MM-DD
refreshstring
If refresh is set, data will be fetched from the source application even when cached data is available
Response
TransactionMatchSeries resource
Example response
{
"start": "2022-07-01",
"end": "2022-08-31",
"series": [
{
"start": "2022-07-01",
"end": "2022-07-31",
"summary": {
"bankMatchedCount": 0,
"bankTotalCount": 1,
"bankMatchedAmount": 0,
"bankTotalAmount": 446.99,
"accountingMatchedCount": 0,
"accountingTotalCount": 1,
"accountingMatchedAmount": 0,
"accountingTotalAmount": 276.01,
"overallMatchedCount": 0,
"overallTotalCount": 2,
"overallMatchedAmount": 0,
"overallTotalAmount": 723
},
"details": [
{
"type": "BANK",
"bank_transaction_id": "003dafbc-9d3a-4772-9a88-72c5d0786f83",
"bank_txn_type": "CREDIT",
"bank_total_amount": 446.99,
"bank_currency": "USD",
"bank_date": "2022-08-17",
"bank_merchant": null,
"bank_description": "Dolor sit amet",
"bank_category": null,
"accounting_table": null,
"accounting_table_id": null,
"accounting_txn_type": null,
"accounting_total_amount": null,
"accounting_currency": null,
"accounting_date": null,
"accounting_merchant": null,
"accounting_description": null,
"accounting_category": null,
"has_match": false
},
{
"type": "ACCOUNTING",
"bank_transaction_id": null,
"bank_txn_type": null,
"bank_total_amount": null,
"bank_currency": null,
"bank_date": null,
"bank_merchant": null,
"bank_description": null,
"bank_category": null,
"accounting_table": "expense",
"accounting_table_id": "c851a382-f5ef-4ca5-9d4c-fe5afc52ce81",
"accounting_txn_type": "DEBIT",
"accounting_total_amount": 276.01,
"accounting_currency": "USD",
"accounting_date": "2022-07-11 00:00:00",
"accounting_merchant": null,
"accounting_description": "Yippee ki yay",
"accounting_category": null,
"has_match": false
}
]
},
{
"start": "2022-08-01",
"end": "2022-08-31",
"summary": {
"bankMatchedCount": 1,
"bankTotalCount": 1,
"bankMatchedAmount": 316.85,
"bankTotalAmount": 316.85,
"accountingMatchedCount": 1,
"accountingTotalCount": 1,
"accountingMatchedAmount": 316.85,
"accountingTotalAmount": 316.85,
"overallMatchedCount": 2,
"overallTotalCount": 2,
"overallMatchedAmount": 633.7,
"overallTotalAmount": 633.7
},
"details": [
{
"type": "ACCOUNTING",
"bank_transaction_id": "0073ecc5-0158-48a9-b148-33cb082c156c",
"bank_txn_type": "DEBIT",
"bank_total_amount": 316.85,
"bank_currency": "USD",
"bank_date": "2022-03-22",
"bank_merchant": null,
"bank_description": "Lorem ipsum",
"bank_category": null,
"accounting_table": "expense",
"accounting_table_id": "f7c7dd07-dfcf-4a65-8a69-cf6a00b54194",
"accounting_txn_type": "DEBIT",
"accounting_total_amount": 316.85,
"accounting_currency": "USD",
"accounting_date": "2022-03-22 00:00:00",
"accounting_merchant": null,
"accounting_description": "Lorem ipsum",
"accounting_category": null,
"has_match": true
},
{
"type": "BANK",
"bank_transaction_id": "0073ecc5-0158-48a9-b148-33cb082c156c",
"bank_txn_type": "DEBIT",
"bank_total_amount": 316.85,
"bank_currency": "USD",
"bank_date": "2022-03-22",
"bank_merchant": null,
"bank_description": "Lorem ipsum",
"bank_category": null,
"accounting_table": "expense",
"accounting_table_id": "f7c7dd07-dfcf-4a65-8a69-cf6a00b54194",
"accounting_txn_type": "DEBIT",
"accounting_total_amount": 316.85,
"accounting_currency": "USD",
"accounting_date": "2022-03-22 00:00:00",
"accounting_merchant": null,
"accounting_description": "Lorem ipsum",
"accounting_category": null,
"has_match": true
}
]
}
]
}