Query Parameters
The API uses a variety of query parameters. Each API provides more information on parameters required for specific types of requests. The following table describes sample query parameters.
Name | Description | Type/Format | Required | Example | API | Request |
---|---|---|---|---|---|---|
orgShortName | The organization identifier | String | Yes | "tfoinc" | Configuration API | GET {basePath}/menus/summary |
rvcRef | The revenue center identifier | Integer | Yes | 42 | Configuration API | GET {basePath}/serviceCharges/collection |
checkNumbers | Only checks with these numbers are returned. It is possible to get more than one check with the same check number. | Integer | No | 976 | Checks API | GET {basePath}/checks |