Page 1 of 1

Query Regarding Technician Notes / Work Completed Field in Schedule API

Posted: Thu May 07, 2026 6:23 am
by sathish
Hi Team,

We are currently exporting timesheet notes to the Schedule Notes field via the Schedules API endpoint. However, the customer has advised that this is not very useful for invoicing purposes.

Instead, they would prefer the notes to be mapped to either:
  • Technician Notes
  • Work Completed
We reviewed the API documentation but could not find any fields related to these sections in the Schedule API request.
Could you please confirm:
1.Whether Technician Notes or Work Completed fields are available via API?
2.If available, which endpoint and field names should be used?
3.If not currently supported, is there any recommended alternative approach?

Below is the current API request payload we are using:
curl --location 'https://xxxxx.simprosuite.com/api/v1.0/ ... schedules/' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \ --data '{ "Notes": "working on construction", "IsLocked": false, "Staff": 12, "Date": "2026-04-23", "Blocks": [ { "StartTime": "03:00", "EndTime": "04:00", "ScheduleRate": 1 } ] }'

Re: Query Regarding Technician Notes / Work Completed Field in Schedule API

Posted: Mon Jun 01, 2026 1:36 am
by SimproAPITeam
Hi,

Thanks for reaching out — happy to clarify this for you.

The Notes field on the Schedules endpoint is a scheduling-level field intended for internal scheduling context. Technician Notes and Work Completed are separate fields that live on the Job Card (Work Order) record, not the
Schedule, which is why they don't appear in the Schedules API documentation.

To answer your questions directly:

1. Are these fields available via API?
Yes — both fields are available via the REST API v1.0:

Work Completed to DescriptionNotes
Technician Notes to MaterialNotes

2. Which endpoint and field names should be used?

GET /api/v1.0/jobs/{jobId}/sections/{sectionId}/costcenters/{costCenterId}/workorders
PATCH /api/v1.0/jobs/{jobId}/sections/{sectionId}/costcenters/{costCenterId}/workorders/{workOrderId}

Both DescriptionNotes and MaterialNotes are supported for read and write on this endpoint.

3. Recommended approach

Rather than writing to the Schedules endpoint, we recommend updating your workflow to write to the Work Orders endpoint instead. The general flow would be:

1. Create/update your Schedule as you currently do
2. Retrieve the associated Job Card / Work Order using the job, section, and cost center IDs
3. PATCH the Work Order with your notes using DescriptionNotes and/or MaterialNotes

This will ensure the notes appear correctly in the Technician Notes and Work Completed sections within simPRO, which are the fields used for invoicing and job reporting purposes.

Please let us know if you need further assistance or example payloads for the Work Orders endpoint.

Kind regards,