SimPROInstall

Summary

Call SimPRO API endpoints by specifying the desired resource and operation.

Inputs

• baseUrl — Your SimPRO instance URL. Leave blank to use the default from the OpenAPI spec.
• tag (required) — The SimPRO resource type to work with. Choose from the list, or specify an ID using an expression.
• companyID — Company ID (use 0 for single-company builds, or the specific company ID for multi-company builds).
• customerID — The ID of the customer (only fill if required by the operation).
• jobID — The ID of the job (only fill if required by the operation).
• siteID — The ID of the site (only fill if required by the operation).
• quoteID — The ID of the quote (only fill if required by the operation).
• invoiceID — The ID of the invoice (only fill if required by the operation).
• sectionID — The ID of the section (only fill if required by the operation).
• otherPathParams — Any additional path parameters not listed above, in JSON format.
• queryParams — Query string parameters for filtering, sorting, and pagination. Common options: search, page, pageSize, columns, display.
• body — The request body for POST, PUT, PATCH operations.

Output shape

A JSON object containing the response data from the API call.

Response shape depends on the specific API endpoint called. Ensure to handle any required parameters accordingly.