AMCS Group Job API
The Job API from AMCS Group — 8 operation(s) for job.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amcs-group-job-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Core AccessGroup Job API
version: core
servers:
- url: https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Job
paths:
/jobsystem/jobs/changes:
get:
tags:
- Job
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
- name: links
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges_ApiJobResource'
/jobsystem/jobs/template:
get:
tags:
- Job
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResult_ApiJobResource'
/jobsystem/jobs/{id}:
get:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: links
in: query
schema:
type: string
- name: include
in: query
schema:
type: string
- name: expand
in: query
schema:
type: string
- name: udf
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity_ApiJobResource'
put:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
delete:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResource'
/jobsystem/jobs/{id}/blob/{blobMemberName}:
get:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: blobMemberName
in: path
required: true
schema:
type: string
- name: fileName
in: query
schema:
type: string
- name: contentType
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
format: binary
/jobsystem/jobs:
get:
tags:
- Job
parameters:
- name: filter
in: query
schema:
type: string
- name: search
in: query
schema:
type: string
- name: order
in: query
schema:
type: string
- name: max
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: includeCount
in: query
schema:
type: string
- name: includeDeleted
in: query
schema:
type: string
- name: links
in: query
schema:
type: string
- name: udf
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection_ApiJobResource'
post:
tags:
- Job
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/transport/jobs/changes:
get:
tags:
- Job
summary: Retrieve changes
description: "| Property| Description|\n| ---------------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| GUID| The GUID associated to the job.|\n| DeleteRouteAssignmentsOnCompletion| Whether to delete route assignments on completion of the job.|\n| InProgress| Is the job in progress?|\n| IsAdhoc| Is the job ad hoc?|\n| IsCompleted| Is the job completed?Filterable.|\n| CompletedDate| The completed date of the job|\n| IsConfirmed| Is the job confirmed?|\n| IsExternalTransport| Is the job using external transport?|\n| IsFinanciallyConfirmed| Is the job financially confirmed?|\n| IsHazardousPaperworkComplete| Is the hazardous paperwork complete?|\n| IsScheduledTransfer| Is the job a scheduled transfer?|\n| IsWarranty| Is the job a warranty?|\n| IsDeleted| Whether to delete the job|\n| DeleteReasonGuid| The GUID of delete reason|\n| RelatedPONumberGuid| The GUID of related PONumber associated to the job. Filterable.|\n| RelatedRouteVisitGuid| The GUID of related routeVisit associated to the job. Filterable.|\n| RelatedScheduleGuid| The GUID of related schedule associated to the job. Filterable.|\n| RelatedSiteOrderGuid| The GUID of related siteorder associated to the job. Filterable.|\n| RelatedSiteOrderItemGuid| The GUID of related siteorder item associated to the job. Filterable.|\n| RelatedSupplierSiteTransportGuid| The GUID of related supplier site transport associated to the job. Filterable.|\n| RelatedExternalVehicleGuid| The GUID of related external vehicle associated to the job. Filterable.|\n| ActionListItem| The GUID and description of the action associated to the job.| \n| CancelledReasonListItem| The GUID and description of the cancellation reason associated to the job. |\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the job. |\n| ContainerTypeListItem| The GUID and description of the container type associated to the job. |\n| DepartmentListItem| The GUID and description of the department associated to the job. |\n| MaterialListItem| The GUID and description of the material associated to the job. |\n| PaymentTypeListItem| The GUID and description of the payment type associated to the job. |\n| RepairReasonListItem| The GUID and description of the repair reason associated to the job. |\n| Access[]| The array of job access time associated to the job.|\n| Access[0].Contact| The contact associated to the job access time.|\n| Access[0].StartTime| The start time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\n| Access[0].EndTime| The end time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\n| Access[0].Notes| The notes time associated to the job access time.|\n| Access[0].DayOfWeekId | The day of the week associated to the job access time.|\n| Access[0].GUID| The Guid associated to the job access time.|\n| ContainerDetails| The container details object associated to the job.|\n| ContainerDetails.Delivered| The container delivered to the job.|\n| ContainerDetails.Delivered.RelatedContainerGuid| The GUID of the container delivered to the job.|\n| ContainerDetails.Delivered.ContainerTypeListItem| The GUID and description of the container type delivered to the job.|\n| ContainerDetails.Delivered.Notes| The delivered container notes.|\n| ContainerDetails.Delivered.SerialNo| The delivered container serial number.|\n| ContainerDetails.Delivered.Tag| The delivered container tag.|\n| ContainerDetails.Removed| The container removed from the job.|\n| ContainerDetails.Removed.RelatedContainerGuid| The GUID of the container removed from the job.|\n| ContainerDetails.Removed.ContainerTypeListItem| The GUID and description of the container type removed from to the job.|\n| ContainerDetails.Removed.Notes| The removed container notes.|\n| ContainerDetails.Removed.SerialNo| The removed container serial number.|\n| ContainerDetails.Removed.Tag| The removed container tag.|\n| VisitDetails| The visit details object associated to the job.|\n| VisitDetails.DriverNotes| The driver notes on the visit associated to the job.|\n| VisitDetails.TimeInCustomerSite| The time in on the visit associated to the job.|\n| VisitDetails.TimeOutCustomerSite| The time out on the visit associated to the job.|\n| VisitDetails.HoursChargable| The hours chargeable on the visit associated to the job.|\n| VisitDetails.HoursNotChargable| The hours not chargeable on the visit associated to the job.|\n| CustomerOrderNo| The customer order number associated to the job. Filterable.|\n| DateRequired| The date the job is required.|\n| HazardousLoadReference| The hazardous load reference associated to the job. Filterable.|\n| ManualTicketNo| The manual ticket number associated to the job. Filterable. |\n| Notes| The notes associated to the job. Filterable.|\n| PONumber| The PO number associated to the job.|\n| Quantity| The quantity associated to the job.|\n| ReleaseNumber| The release number associated to the job.|\n| TicketNo| The ticket number associated to the job. Filterable. |\n| RejectedReasonListItem| The GUID and description of the job rejection reason. |\n| RelatedLocationDestinationGuid| Used to filter the related destination location guid associated to the job. Filterable.|\n| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the job.|\n| RelatedPictureBlobHashes[0].Description| The description of the blob.|\n| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\n| RelatedPictureBlobHashes[0].PictureSourceListItem| The GUID and description of the Picture Source associated to the job.|\n| RelatedPictureBlobHashes[0].PictureTypeListItem| The GUID and description of the Picture Type associated to the job.|\n| PriceOverrides| The array of price overrides associated to the job.|\n| PriceOverrides[0].RelatedPriceGuid| The GUID of the price associated to the job price override.|\n| PriceOverrides[0].OverrideRate| The override rate associated to the job price override.|\n| PriceOverrides[0].Guid| The GUID associated to the job price override.|\n| PriceOverrides[0].IsSelected| The price isselected associated to the job price override.|\n| PriceOverrides[0].Breakdowns| The array of price breakdowns associated to the job price.|\n| PriceOverrides[0].Breakdowns[0].Guid| The GUID associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].IsDeleted| Whether the price breakdown is deleted.|\n| PriceOverrides[0].Breakdowns[0].FillLevel| The fill level associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].Quantity| The quantity associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].IsReceived| Whether the price breakdown is received.|\n| PriceOverrides[0].Breakdowns[0].Barcode| The BarCode associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].JobPriceBreakdownTypeEnum| The Job Price Breakdown Type associated to the price breakdown.|\n| RelatedPriceGuidFilter| Used to filter on the related price GUID.|\n| RelatedBlobJobDocketPdfHashes| The array of related job docket blob hashes.|\n| RelatedBlobJobDocketPdfHashes[0].Hash| The hash of the job docket blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\n| RelatedWTNBlobHashes| The array of related waste transfer note blob hashes.|\n| RelatedWTNBlobHashes[0].Guid| The guid of the job waste transfer note blob.|\n| RelatedWTNBlobHashes[0].Hash| The hash of the job waste transfer note blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\n| VATIntendedListItem| The GUID and description (code + rate) of the VAT associated to the job.|\n| RequiredStartTime| The start time at which the job is required.|\n| RequiredEndTime| The end time at which the job is required.|\n| ServiceListItem| The GUID and description of the Service associated to the job.|\n| LastChangeReasonListItem| The GUID and description of the last change reason associated to the job. |\n| LinkedJobs| The array of linked jobs associated to the job.|\n| LinkedJobs[0].Guid| The guid of the linked job associated to the job.|\n| LinkedJobs[0].IsDeleted| Whether the linked job is deleted.|\n| LinkedJobs[0].RelatedJobGuid| The job guid of the linked job associated to the job.|\n| Position| The position associated to the job.|\n| RelatedCreatedByUserGuid| The created by sys user guid associated to the job. Filterable.|\n| LinkedJobGuidFilter| Used to filter on linked job guid.|\n| RelatedJobGuidFilter| Used to filer on the job guid of the linked job.|\n| MaterialSaleSlots| The array of material sale slots associated to the job.|\n| MaterialSaleSlots[0].SlotNumber| The slot number associated to the jobmaterial sale slot.|\n| MaterialSaleSlots[0].SlotDate| The slot date associated to the job material sale slot.|\n| MaterialSaleSlots[0].SlotTime| The slot time associated to the job material sale slot.|\n| MaterialSaleSlots[0].CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the material sale slot. |\n| MaterialSaleSlots[0].MaterialListItem| The GUID and description of the Material associated to the material sale slot.|\n| MaterialSaleSlots[0].Notes| The notes associated to the job.|\n| MaterialSaleSlots[0].RelatedBookingSlotGuid| The guid of booking slot associated to the material sale slot.|\n| MaterialSaleSlots[0].RelatedCustomerGuid| The guid of customer associated to the material sale slot.|\n| MaterialSaleSlots[0].IsSchedule| The Schedule of material sale slots associated to the job.|\n| MaterialSaleSlots[0].IsManuallyAssigned| The IsManuallyAssigned of material sale slots associated to the job.|\n| MaterialSaleSlots[0].IsDeleted| Whether the material sale slot is deleted.|\n| MaterialSaleSlots[0].Guid| The GUID associated to the material sale slot.|\n| MaterialSaleSlotSlotNumberFilter| Used to filter on the material sale slot slot number.|\n| MaterialSaleSlotGuidFilter| Used to filter on the material sale slot guid.|\n| MaterialSaleSlotRelatedBookingSlotGuidFilter| Used to filter on the material sale slot related booking slot guid.|\n| MaterialSaleSlotRelatedCustomerGuidFilter| Used to filter on the material sale slot related customer guid.|\n| PriorityListItem| The GUID and description of the priority associated to the job. |\n| DriverFeedback| The driver feedback associated to the job. |"
operationId: Job_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges_ApiIntegratorJobResource'
/transport/jobs/{guid}:
get:
tags:
- Job
summary: Find with GUID
description: "| Property| Description|\n| ---------------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| GUID| The GUID associated to the job.|\n| DeleteRouteAssignmentsOnCompletion| Whether to delete route assignments on completion of the job.|\n| InProgress| Is the job in progress?|\n| IsAdhoc| Is the job ad hoc?|\n| IsCompleted| Is the job completed?Filterable.|\n| CompletedDate| The completed date of the job|\n| IsConfirmed| Is the job confirmed?|\n| IsExternalTransport| Is the job using external transport?|\n| IsFinanciallyConfirmed| Is the job financially confirmed?|\n| IsHazardousPaperworkComplete| Is the hazardous paperwork complete?|\n| IsScheduledTransfer| Is the job a scheduled transfer?|\n| IsWarranty| Is the job a warranty?|\n| IsDeleted| Whether to delete the job|\n| DeleteReasonGuid| The GUID of delete reason|\n| RelatedPONumberGuid| The GUID of related PONumber associated to the job. Filterable.|\n| RelatedRouteVisitGuid| The GUID of related routeVisit associated to the job. Filterable.|\n| RelatedScheduleGuid| The GUID of related schedule associated to the job. Filterable.|\n| RelatedSiteOrderGuid| The GUID of related siteorder associated to the job. Filterable.|\n| RelatedSiteOrderItemGuid| The GUID of related siteorder item associated to the job. Filterable.|\n| RelatedSupplierSiteTransportGuid| The GUID of related supplier site transport associated to the job. Filterable.|\n| RelatedExternalVehicleGuid| The GUID of related external vehicle associated to the job. Filterable.|\n| ActionListItem| The GUID and description of the action associated to the job.| \n| CancelledReasonListItem| The GUID and description of the cancellation reason associated to the job. |\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the job. |\n| ContainerTypeListItem| The GUID and description of the container type associated to the job. |\n| DepartmentListItem| The GUID and description of the department associated to the job. |\n| MaterialListItem| The GUID and description of the material associated to the job. |\n| PaymentTypeListItem| The GUID and description of the payment type associated to the job. |\n| RepairReasonListItem| The GUID and description of the repair reason associated to the job. |\n| Access[]| The array of job access time associated to the job.|\n| Access[0].Contact| The contact associated to the job access time.|\n| Access[0].StartTime| The start time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\n| Access[0].EndTime| The end time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\n| Access[0].Notes| The notes time associated to the job access time.|\n| Access[0].DayOfWeekId | The day of the week associated to the job access time.|\n| Access[0].GUID| The Guid associated to the job access time.|\n| ContainerDetails| The container details object associated to the job.|\n| ContainerDetails.Delivered| The container delivered to the job.|\n| ContainerDetails.Delivered.RelatedContainerGuid| The GUID of the container delivered to the job.|\n| ContainerDetails.Delivered.ContainerTypeListItem| The GUID and description of the container type delivered to the job.|\n| ContainerDetails.Delivered.Notes| The delivered container notes.|\n| ContainerDetails.Delivered.SerialNo| The delivered container serial number.|\n| ContainerDetails.Delivered.Tag| The delivered container tag.|\n| ContainerDetails.Removed| The container removed from the job.|\n| ContainerDetails.Removed.RelatedContainerGuid| The GUID of the container removed from the job.|\n| ContainerDetails.Removed.ContainerTypeListItem| The GUID and description of the container type removed from to the job.|\n| ContainerDetails.Removed.Notes| The removed container notes.|\n| ContainerDetails.Removed.SerialNo| The removed container serial number.|\n| ContainerDetails.Removed.Tag| The removed container tag.|\n| VisitDetails| The visit details object associated to the job.|\n| VisitDetails.DriverNotes| The driver notes on the visit associated to the job.|\n| VisitDetails.TimeInCustomerSite| The time in on the visit associated to the job.|\n| VisitDetails.TimeOutCustomerSite| The time out on the visit associated to the job.|\n| VisitDetails.HoursChargable| The hours chargeable on the visit associated to the job.|\n| VisitDetails.HoursNotChargable| The hours not chargeable on the visit associated to the job.|\n| CustomerOrderNo| The customer order number associated to the job. Filterable.|\n| DateRequired| The date the job is required.|\n| HazardousLoadReference| The hazardous load reference associated to the job. Filterable.|\n| ManualTicketNo| The manual ticket number associated to the job. Filterable. |\n| Notes| The notes associated to the job. Filterable.|\n| PONumber| The PO number associated to the job.|\n| Quantity| The quantity associated to the job.|\n| ReleaseNumber| The release number associated to the job.|\n| TicketNo| The ticket number associated to the job. Filterable. |\n| RejectedReasonListItem| The GUID and description of the job rejection reason. |\n| RelatedLocationDestinationGuid| Used to filter the related destination location guid associated to the job. Filterable.|\n| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the job.|\n| RelatedPictureBlobHashes[0].Description| The description of the blob.|\n| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\n| RelatedPictureBlobHashes[0].PictureSourceListItem| The GUID and description of the Picture Source associated to the job.|\n| RelatedPictureBlobHashes[0].PictureTypeListItem| The GUID and description of the Picture Type associated to the job.|\n| PriceOverrides| The array of price overrides associated to the job.|\n| PriceOverrides[0].RelatedPriceGuid| The GUID of the price associated to the job price override.|\n| PriceOverrides[0].OverrideRate| The override rate associated to the job price override.|\n| PriceOverrides[0].Guid| The GUID associated to the job price override.|\n| PriceOverrides[0].IsSelected| The price isselected associated to the job price override.|\n| PriceOverrides[0].Breakdowns| The array of price breakdowns associated to the job price.|\n| PriceOverrides[0].Breakdowns[0].Guid| The GUID associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].IsDeleted| Whether the price breakdown is deleted.|\n| PriceOverrides[0].Breakdowns[0].FillLevel| The fill level associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].Quantity| The quantity associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].IsReceived| Whether the price breakdown is received.|\n| PriceOverrides[0].Breakdowns[0].Barcode| The BarCode associated to the price breakdown.|\n| PriceOverrides[0].Breakdowns[0].JobPriceBreakdownTypeEnum| The Job Price Breakdown Type associated to the price breakdown.|\n| RelatedPriceGuidFilter| Used to filter on the related price GUID.|\n| RelatedBlobJobDocketPdfHashes| The array of related job docket blob hashes.|\n| RelatedBlobJobDocketPdfHashes[0].Hash| The hash of the job docket blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\n| RelatedWTNBlobHashes| The array of related waste transfer note blob hashes.|\n| RelatedWTNBlobHashes[0].Guid| The guid of the job waste transfer note blob.|\n| RelatedWTNBlobHashes[0].Hash| The hash of the job waste transfer note blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\n| VATIntendedListItem| The GUID and description (code + rate) of the VAT associated to the job.|\n| RequiredStartTime| The start time at which the job is required.|\n| RequiredEndTime| The end time at which the job is required.|\n| ServiceListItem| The GUID and description of the Service associated to the job.|\n| LastChangeReasonListItem| The GUID and description of the last change reason associated to the job. |\n| LinkedJobs| The array of linked jobs associated to the job.|\n| LinkedJobs[0].Guid| The guid of the linked job associated to the job.|\n| LinkedJobs[0].IsDeleted| Whether the linked job is deleted.|\n| LinkedJobs[0].RelatedJobGuid| The job guid of the linked job associated to the job.|\n| Position| The position associated to the job.|\n| RelatedCreatedByUserGuid| The created by sys user guid associated to the job. Filterable.|\n| LinkedJobGuidFilter| Used to filter on linked job guid.|\n| RelatedJobGuidFilter| Used to filer on the job guid of the linked job.|\n| MaterialSaleSlots| The array of material sale slots associated to the job.|\n| MaterialSaleSlots[0].SlotNumber| The slot number associated to the jobmaterial sale slot.|\n| MaterialSaleSlots[0].SlotDate| The slot date associated to the job material sale slot.|\n| MaterialSaleSlots[0].SlotTime| The slot time associated to the job material sale slot.|\n| MaterialSaleSlots[0].CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the material sale slot. |\n| MaterialSaleSlots[0].MaterialListItem| The GUID and description of the Material associated to the material sale slot.|\n| MaterialSaleSlots[0].Notes| The notes associated to the job.|\n| MaterialSaleSlots[0].RelatedBookingSlotGuid| The guid of booking slot associated to the material sale slot.|\n| MaterialSaleSlots[0].RelatedCustomerGuid| The guid of customer associated to the material sale slot.|\n| MaterialSaleSlots[0].IsSchedule| The Schedule of material sale slots associated to the job.|\n| MaterialSaleSlots[0].IsManuallyAssigned| The IsManuallyAssigned of material sale slots associated to the job.|\n| MaterialSaleSlots[0].IsDeleted| Whether the material sale slot is deleted.|\n| MaterialSaleSlots[0].Guid| The GUID associated to the material sale slot.|\n| MaterialSaleSlotSlotNumberFilter| Used to filter on the material sale slot slot number.|\n| MaterialSaleSlotGuidFilter| Used to filter on the material sale slot guid.|\n| MaterialSaleSlotRelatedBookingSlotGuidFilter| Used to filter on the material sale slot related booking slot guid.|\n| MaterialSaleSlotRelatedCustomerGuidFilter| Used to filter on the material sale slot related customer guid.|\n| PriorityListItem| The GUID and description of the priority associated to the job. |\n| DriverFeedback| The driver feedback associated to the job. |"
operationId: Job_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity_ApiIntegratorJobResource'
put:
tags:
- Job
summary: Partial update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID | The GUID associated to the job.| Yes |
| DeleteRouteAssignmentsOnCompletion| Whether to delete route assignments on completion of the job.| Yes |
| InProgress| Is the job in progress?| Yes |
| IsAdhoc| Is the job ad hoc?| Yes |
| IsCompleted| Is the job completed?| Yes |
| CompletedDate| The completed date of the job| No |
| IsConfirmed| Is the job confirmed?| Yes |
| IsExternalTransport| Is the job using external transport?| Yes |
| IsFinanciallyConfirmed| Is the job financially confirmed?| Yes |
| IsHazardousPaperworkComplete| Is the hazardous paperwork complete?| Yes |
| IsScheduledTransfer| Is the job a scheduled transfer?| Yes |
| IsWarranty| Is the job a warranty?| Yes |
| IsDeleted| Whether to delete the job| No |
| DeleteReasonGuid| The GUID of delete reason| No (Required only if IsDeleted=true) |
| RelatedPONumberGuid| The GUID of related PONumber associated to the job. | No |
| RelatedRouteVisitGuid| The GUID of related routeVisit associated to the job. | No |
| RelatedScheduleGuid| The GUID of related schedule associated to the job. Set to null to un-assign the job. | No |
| RelatedSiteOrderGuid| The GUID of related siteorder associated to the job. | Yes (Not required for Transfer out weighingType)|
| RelatedSiteOrderItemGuid| The GUID of related siteorder item associated to the job. | No (Required Only for Container Jobs(Except Start of cycle)) |
| RelatedSupplierSiteTransportGuid| The GUID of related supplier site transport associated to the job. | No |
| RelatedExternalVehicleGuid | The GUID of related external vehicle associated to the job. | No |
| ActionListItem| The GUID and description of the action associated to the job.| Yes |
| CancelledReasonListItem| The GUID and description of the cancellation reason associated to the job. | No |
| CompanyOutletListItem| The GUID and description of the company outlet associated to the job. | Yes |
| ContainerTypeListItem| The GUID and description of the container type associated to the job. | Yes (Only for Container & Collection Jobs) |
| DepartmentListItem| The GUID and description of the department associated to the job. | No |
| MaterialListItem| The GUID and description of the material associated to the job. | Yes (Only for Container & Collection Jobs)|
| PaymentTypeListItem| The GUID and description of the payment type associated to the job. | No |
| RepairReasonListItem| The GUID and description of the repair reason associated to the job. | No |
| Access[]| The array of job access time associated to the job.| No |
| Access[0].Contact| The contact associated to the job access time.| No |
| Access[0].StartTime| The start time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).| Yes |
| Access[0].EndTime| The end time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).| Yes |
| Access[0].Notes| The notes time associated to the job access time.| No |
| Access[0].DayOfWeekId | The day of the week associated to the job access time.| Yes |
| Access[0].GUID| The Guid associated to the job access time.| Yes |
| ContainerDetails| The container details object associated to the job.| No |
| ContainerDetails.Delivered| The container delivered to the job.| No |
| ContainerDetails.Delivered.RelatedContainerGuid | The GUID of the container delivered to the job.| No |
| ContainerDetails.Delivered.ContainerTypeListItem | The GUID and description of the container type delivered to the job. | No |
| ContainerDetails.Delivered.Notes| The delivered container notes.| No |
| ContainerDetails.Delivered.SerialNo| The delivered container serial number.| Yes |
| ContainerDetails.Delivered.Tag| The delivered container tag.| Yes |
| ContainerDetails.Removed| The container removed from the job.| No |
| ContainerDetails.Removed.RelatedContainerGuid| The GUID of the container removed from the job.| No |
| ContainerDetails.Removed.ContainerTypeListItem | The GUID and description of the container type removed from to the job. | No |
| ContainerDetails.Removed.Notes| The removed container notes.| No |
| ContainerDetails.Removed.SerialNo| The removed container serial number.| Yes |
| ContainerDetails.Removed.Tag| The removed container tag.| Yes |
| VisitDetails| The visit details object associated to the job.| No |
| VisitDetails.DriverNotes| The driver notes on the visit associated to the job.| No |
| VisitDetails.TimeInCustomerSite| The time in on the visit associated to the job.| No |
| VisitDetails.TimeOutCustomerSite| The time out on the visit associated to the job.| No |
| VisitDetails.HoursChargeable| The hours chargeable on the visit associated to the job.| No |
| VisitDetails.HoursNotChargeable| The hours not chargeable on the visit associated to the job.| No |
| CustomerOrderNo| The customer order number associated to the job.| No |
| DateRequired| The date the job is required.| Yes |
# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-job-api-openapi.yml