BETA - Financial Batching API

See below for documentation on Beta Financial API. NOTE that this is only available for BETA customers for which it has been enabled, and batching will not be functional for orgs that are not in this group.

// --- Create a batch by date range ---
// POST /api/v1/financial/batch
// Request Body:
{
"startDate": "07/10/2019",
"endDate": "07/11/2019"
}
// Response Body:
{
"timestamp": 1585158568000,
"status": 201, // updated
"message": "Created", // updated
"item": {
"id": 10100
}
}
// --- Get paged journal details by batch id - sorted by apply date ---
// GET /api/v1/financial/journal-detail?batchId={batch-id}&pageNumber={page-number}&pageSize={page-size}
// Response Body:
{
"totalCount": 16,
"count": 6,
"pageNumber": 2,
"pageSize": 6,
"totalPageCount": 3,
"firstPageUrl": "https://chr.memberclicks.net/api/v1/financial/journal-detail?batchId=10100&pageNumber=1&pageSize=6", // updated
"previousPageUrl": "https://chr.memberclicks.net/api/v1/financial/journal-detail?batchId=10100&pageNumber=1&pageSize=6", // updated; will be set to null when does not apply
"nextPageUrl": "https://chr.memberclicks.net/api/v1/financial/journal-detail?batchId=10100&pageNumber=3&pageSize=6", // updated; will be set to null when does not apply
"lastPageUrl": "https://chr.memberclicks.net/api/v1/financial/journal-detail?batchId=10100&pageNumber=3&pageSize=6", // updated
"journalDetails": [
{
"id" : 10332,
"amount" : 10.34,
"accountId" : 9200,
"type" : "Credit",
"applyDate" : "2019-07-10T04:37:43Z" // updated
},
{
"id" : 10333,
"amount" : 10.34,
"accountId" : 9201,
"type" : "Debit",
"applyDate" : "2019-07-10T04:37:45Z" // updated
},
{
"id" : 10379,
"amount" : 5,
"accountId" : 9501,
"type" : "Credit",
"applyDate" : "2019-07-11T08:03:04Z" // updated
},
{
"id": 10380,
"amount": 5,
"accountId": 9502,
"type": "Debit",
"applyDate" : "2019-07-11T08:03:17Z" // updated
},
{
"id" : 10425,
"amount" : 5.34,
"accountId" : 9501,
"type" : "Credit",
"applyDate" : "2019-07-11T18:03:17Z" // updated
},
{
"id": 10426,
"amount": 5.34,
"accountId": 9502,
"type": "Debit",
"applyDate" : "2019-07-11T18:03:29Z" // updated
}
]
}
// --- Get accounts - sorted by account name ---
// GET /api/v1/financial/account
// Response Body:
{
"totalCount": 4,
"accounts": [
{
"id": 9200,
"name": "Sale Credit"
},
{
"id": 9201,
"name": "Sale Debit"
},
{
"id": 9501,
"name": "Payment Credit"
},
{
"id": 9502,
"name": "Payment Debit"
}
]
}