Delete Company (by id)
DELETE {{base_url}}/company/v2/companies/:companyId
The ‘Delete company’ endpoint will let you delete a company when the company id has passed as a parameter.
Deleting the company will also delete all the data that has been associated with the company. The data includes bank accounts, bank transactions, forecasts etc.
Path variables
Field | Type | Description |
---|---|---|
companyId | string | Unique identifier for the company |
Success
202 Accepted
Error messages
Condition | Response Status | Response Body |
---|---|---|
Without company id | 403 Forbidden | {“error”: “Invalid request”, “hint”: “Unsupported method or endpoint”} |
Invalid company id | 404 Not Found |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
X-Api-Key | string | ||
X-Partner-Id | string | ||
Authorization | string |