General and Configuration APIs
Use General and Configuration APIs to complete Account Configuration including the ability to create, read, update, and delete labor categories, organizations, and code table records, as well as perform other miscellaneous setup.
The example HTTP requests are illustrative of the available endpoints. For a listing of available API endpoints, see the interactive visualization.
API | Example HTTP Request | Description |
---|---|---|
Accounting Codes | GET /api/accountConfiguration/laborCode/{code} | Create, read, update, and delete labor categories. You can also use this API to create
labor codes.
|
Organizations | GET /api/organization/{org} | Create, read, update, and delete
organizations,
only if you use
organizations with a variable structure. If you configured
DPS for the fixed
organization type, enter your
organizations in the browser application.
To get the metadata for an organization, you execute a GET on {{url}}/metadata/organization/. |
Code Tables | GET /api/codeTable/{codetable}
For example, when codetable resolves to BTLABORCATS, you retrieve the list of available labor categories in the labor configuration table. |
Create, read, update, and delete code table records. Code tables are lists of standard values for selected fields. Generally, these lists contain attributes that you want to assign to
employees, generic resources,
projects, or
opportunities.
To get the metadata for a code table, you execute a GET on {{url}}/metadata/codeTable/{codetable}. |