Vendor APIs
The Vendor APIs enable external systems to retrieve and manage vendor data in Sparkrock Impact.
Use these APIs to synchronize vendor master data with external finance, accounts payable, purchasing, or reporting systems.
Vendor APIs support standard REST methods and require authentication using a Bearer token.
Retrieve a list of vendors
To retrieve a list of vendors, use:
GET https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/vendors
Authorization: Bearer {token}
You can use standard OData query options such as:
$select
$filter
$orderby
$top
$skip
Retrieve a specific vendor
To retrieve a specific vendor, use:
GET https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/vendors({id})
Authorization: Bearer {token}
Create a vendor
To create a vendor, use:
POST https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/vendors
Authorization: Bearer {token}
Include a valid vendor JSON object in the request body.
System-managed fields, such as id and lastModifiedDateTime, cannot be set manually.
Update a vendor
To update a vendor, use:
PATCH https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/vendors({id})
Authorization: Bearer {token}
Include only the fields you want to update in the request body. Read-only fields are not modified.
Delete a vendor
To delete a vendor, use:
DELETE https://api.businesscentral.dynamics.com/v2.0/{environmentname}/api/sparkrock/finance/v1.0/companies({companyId})/vendors({id})
Authorization: Bearer {token}
Related information
Create an API security token
Finance APIs
Feedback
To send feedback about this page, select the following link: