You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
You are viewing the article in preview mode. It is not live at the moment.
Home > Citywide > Citywide Budgeting - Cloud > CWBC System Administration > CWBC - System Administration - API Documentation
CWBC - System Administration - API Documentation
print icon

API Documentation
The API Documentation provides technical details required to configure and maintain integration between the Citywide Budgeting system and external applications (e.g., ERP). 

This documentation is presented in the Swagger documentation format that should be familiar to the party responsible for setting up your integration.

This documentation is intended for IT administrators, technical consultants, and/or integration partners responsible for creating the API connections used in integration.   


The documentation includes:

•    A list of available endpoints, including their purpose (e.g., import actuals, export budgets, retrieve account structures).
•    Authentication Details - instructions for generating and managing API tokens
•    Required Fields & Data Formats
•    Field-level specifications for each endpoint
•    Error Codes & Troubleshooting

 

Before you begin, ensure the following prerequisites are met:
•    API access has been enabled for your organization
•    A secure API token has been generated
•    Your Chart of Accounts segments and required field specifications (e.g., Fund, Cost Centre, Object, Activity) are configured and aligned with your external application

 

scroll to top icon