API Clarification: Field Naming 'Revised' vs. 'Revized' and Other Inconsistencies

[mlt]

Hi Simpro Developers,

I hope you're having a great week.

While working with the Simpro API, I've noticed a few inconsistencies in the responses from the Job and Quote endpoints. I was hoping to get some clarification to ensure my integration is robust.

Any help would be greatly appreciated!

1. Duplicate Keys: 'Revised' and 'Revized' in Totals Object
The most significant issue is that in the Totals object for both jobs and quotes, the API is returning two fields for what appears to be the same value: Revised (spelled correctly) and Revized (spelled with a 'z'). Both keys are present in the same object, often with the same value.

This occurs in multiple endpoints, including /api/.../jobs/{JobID} and /api/.../quotes/{QuoteID}.

Example Snippet from a Job's Totals Object:

Code: Select all

"GrossProfitLoss": {
    "Actual": 108.37,
    "Estimate": 125,
    "Revised": 0,
    "Revized": 0  // <-- Typo/duplicate key
},
"NettMargin": {
    "Actual": 75.83,
    "Estimate": 85.19,
    "Revised": 0,
    "Revized": 0  // <-- Typo/duplicate key
}

My Question: Could you confirm which key is the correct one to use moving forward? Is Revized deprecated, and can it be removed from the API response in the future to avoid confusion?

2. Inconsistent Object Structures Between Endpoints
I've also noticed that the structure of some nested objects can differ between jobs and quotes, even when they represent the same data.

For example, the Totals.ResourcesCost.PlantAndEquipmentHours object in the job response contains an Actual field, but the same object in the quote response does not.

Example from /jobs/{JobID}:

Code: Select all

"PlantAndEquipmentHours": {
    "Actual": 0,
    "Estimate": 0,
    "Revised": 0,
    "Revized": 0
}

Example from /quotes/{QuoteID}:

Code: Select all

"PlantAndEquipmentHours": {
    "Estimate": 0,
    "Revised": 0,
    "Revized": 0
}

My Question: Is this structural difference intentional?

3. Potential Invalid Routes (404 Errors)
My logs show that several API calls to what seem like standard sub-endpoints for a job are returning a 404 - Invalid route. error.

The routes that are failing are:

/api/.../jobs/{JobID}/costs/

/api/.../jobs/{JobID}/schedules/blocks/

/api/.../jobs/{JobID}/activities/

/api/.../jobs/{JobID}/billable/

My Question: Are these endpoints deprecated, or is there a different URL structure we should be using to access this information?

Thanks in advance for your time and for the great work you do on the API!

Best regards,

Gary (My Local Trades)

[SimproAPITeam]

For the first question, yes they are both the same, as per documentation Revised is Depricated.

As for the second question, yes they are structurally different because not everything on job is applicable on quotes.
https://helpguide.simprogroup.com/Conte ... ual%20cost

Finally, for the third question, please have a look at our documentation on all the available endpoints for jobs here:
https://developer.simprogroup.com/apido ... 36d5dec226#