Skip to main content

Maintaining billing accounts via the API

Updated over 9 months ago

Customers who are maintaining their billing accounts in another solution, can via the Planner API, ensure that billing accounts in Planner are aligned.
​

!! For an introduction on how to access and use the API - please see API for Pronestor Planner

The steps below describe the steps recommended, through the API, for reflecting the billing accounts in Planner from a 3rd party data repository.

Step 1:

javascript GET / Api.mvc / v1 / GetBillingAccounts;

Get all billing accounts in Planner, including deleted billing accounts.

Step 2:

Compare the list of billing accounts to the new truth.

Step 2.1:

javascript POST / Api.mvc / v1 / DeleteBillingAccounts;

Delete all billing accounts, that must be removed. The request takes an array of billing account IDs. So deletion is a bulk process. The request is idempotent.

Step 2.2:

javascript POST / Api.mvc / v1 / CreateBillingAccount;

Create all new billing accounts. Be sure to include all the departments they will be available in. A list of departments can be fetched with the API call GET /Api.mvc/v1/GetDepartments.

Step 2.3:

javascript POST / Api.mvc / v1 / UpdateBillingAccount;

Update all changed billing accounts. Be sure to assign the correct departments.

Step 3:

If you need to list all billing accounts linked to a department, use this endpoint.

javascript GET /Api.mvc/v1/GetBillingAccountsByDepartment?departmentId=2&hideDeleted=False

Did this answer your question?