Query Regarding Technician Notes / Work Completed Field in Schedule API

Posts about the simPRO API. Help/support/how-to etc.
Forum rules
  • Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
  • No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
  • Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
  • Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
  • Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
  • Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
  • Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
  • Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
Post Reply
sathish
Posts: 53
Joined: Wed Apr 17, 2019 7:24 am

Query Regarding Technician Notes / Work Completed Field in Schedule API

Post by sathish » Thu May 07, 2026 6:23 am

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 } ] }'
SimproAPITeam
Posts: 831
Joined: Wed May 01, 2024 2:31 am

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

Post by SimproAPITeam » Mon Jun 01, 2026 1:36 am

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,
Simpro API Team | Simpro Software Group
Post Reply