Journal APIs
The Journal APIs enable external systems to retrieve and manage journal batches in Sparkrock Impact.
Use these APIs to create, update, or remove journal batches before posting.
Journal APIs require authentication using a Bearer token.
Retrieve a list of journals
To retrieve a list of journals, use:
GET https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/journals
Authorization: Bearer {token}
You can use standard OData query options such as:
$select
$filter
$orderby
$top
$skip
Retrieve a specific journal
To retrieve a specific journal, use:
GET https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/journals({id})
Authorization: Bearer {token}
Create a journal
To create a journal, use:
POST https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/journals
Authorization: Bearer {token}
Include a valid journal JSON object in the request body.
Update a journal
To update an existing journal, use:
PATCH https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/journals({id})
Authorization: Bearer {token}
Include only the fields you want to update in the request body. Read-only fields are not modified.
Delete a journal
To delete a journal, use:
DELETE https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/journals({id})
Authorization: Bearer {token}
Related information
Create an API security token
Journal line APIs
Finance APIs
Feedback
To send feedback about this page, select the following link: