Sage 300 People v2

Sage 300 People is a payroll and human-resources platform used to manage employee and organizational records.

The Flowgear Sage 300 People Node exposes a curated Early Access set of public API operations for reading and maintaining People records.

Revision History

0.0.0.4 - Initial release.
0.0.0.11 - Added a separate token endpoint and session-cookie authentication; improved Connection testing.

Connection

Use the Sage 300 People Connection for all methods. The Node authenticates at the configured token endpoint and retains the returned access token and session cookies. API calls use the session cookies rather than a bearer Authorization header. If Sage 300 People rejects a request as unauthorized, the Node acquires a new token and session cookies and retries the request once.

Property Type Description
Base URL String Absolute tenant API base URL, for example, https://people.example.com:9000/.
Token URL String Optional absolute token endpoint, including /token, when authentication uses a different host. Leave empty to use /token on Base URL.
API Key Masked API key configured in Sage 300 People.
Username String Sage 300 People username used when Authenticate Using API Key Only is false.
Password Masked Sage 300 People password used when Authenticate Using API Key Only is false.
Authenticate Using API Key Only Boolean When true, token acquisition uses only the API Key.
Timeout (seconds) Integer Timeout applied to token and API requests.
Access Token Masked Token acquired automatically with the authenticated session.
Session Cookie Masked Session cookies acquired automatically with the token. Treat this value as a credential.

Setup Notes

  • Enter Base URL as an absolute URL, including the required protocol and port for your tenant.
  • Configure an API Key in Sage 300 People before testing the Connection.
  • If Authenticate Using API Key Only is false, also provide Username and Password.
  • Ensure the Sage 300 People account used by the Connection has permission to access the records and actions required by the selected template.
  • Set Token URL when token acquisition is hosted separately from the API.
  • The Connection test requests fresh authentication and verifies that both the token and session cookies are present. It does not query Job Titles or prove access to a specific data operation.

Methods

Use templates to select the supported Sage 300 People operation for each method family.

Query

Reads data from the curated Sage 300 People API surface. Supported templates include Job Titles, Job Grades, Hierarchy, Entity, Employee, and Generic Get.

Parameter Type Description
Connection Connection Sage 300 People connection profile.
OperationId String Identifier for the selected query template.
Options Object Template-specific lookup or route values, for example, employee, entity, hierarchy, or Generic Get identifiers.
Items Array Optional request body used by templates that require structured JSON input, such as Generic Get.
Return Type Description
Response Array Provider-shaped response rows. Query templates usually return one row per matching record. Generic Get returns tenant-defined columns based on the configured query.

Create

Creates records in Sage 300 People. Supported templates include Create Entity, Create Employee, Create Job Title, Create Job Grade, Create Hierarchy Header, and Create Hierarchy Items.

Parameter Type Description
Connection Connection Sage 300 People connection profile.
OperationId String Identifier for the selected create template.
Options Object Additional route values required by the selected create operation.
Items Array One structured request body per record to create. The selected template defines the available fields.
Return Type Description
Response Array At least one response row per submitted item, or one row per returned record when Sage 300 People returns a result array. Each row includes a Flowgear object with IsSuccess and Message, plus any provider fields returned by Sage 300 People.

Update

Updates records in Sage 300 People. Supported templates include Update Entity, Update Employee, Update Job Title, Update Job Grade, Update Hierarchy Header, and Update Hierarchy Item.

Parameter Type Description
Connection Connection Sage 300 People connection profile.
OperationId String Identifier for the selected update template.
Options Object Additional route values required by the selected update operation.
Items Array One structured request body per record to update. The selected template defines the available fields.
Return Type Description
Response Array At least one response row per submitted item, or one row per returned record when Sage 300 People returns a result array. Each row includes a Flowgear object with IsSuccess and Message, plus any provider fields returned by Sage 300 People.

Usage Notes

  • This Node currently exposes only the curated Query, Create, and Update operation families.
  • Generic Get uses the GenericGetCode value from Options and can also accept an Items body containing the QueryParameterList required by the target Sage 300 People query.
  • Mutation methods emit at least one Response row per input item, and one row per returned record when Sage 300 People returns multiple results for an item. Check Flowgear.IsSuccess and Flowgear.Message to confirm whether each item succeeded.
  • Query failures are raised as Node errors. Create and Update surface handled per-item failures inside the returned Response rows.

Known Issues

  • This Node is in Early Access and does not yet expose the broader Sage 300 People delete, process, position, document, or payroll-batch API surfaces.