GET /sales/sell-orders/{sellOrderId}

Get a Sell Order (Sale)

This endpoint allows you to get a specific Sell Order (Sale).

Operation ID: getSellOrder

lock This endpoint requires a Bearer token in the Authorization header.

Path Parameters

Name	Type	Description
`sellOrderId` required path	string	The Sell Order (Sale) ID

Query Parameters

Name	Type	Description
`expanded` query	string	This parameter allows to expand the resulting Sell Orders (Sales) relationships in the response. `entity` `createdBy` `cancelledBy` `completedBy` `startedBy` `client` `contacts` `failure` `files` `quote` `scheduledWork` `confirmedBy`

Responses

data object

Sell Order (Sale) Resource structure details.

id string read-only

ID for the Sell Order (Sale) in Infraspeak.

Example: 123

type string read-only

Resource type

sell_order

Example: sell_order

attributes object

client_id integer

ID of the client associated with the Sell Order (Sale). **This field is required if `related_to_type` and `related_to_id` are not filled.**

Example: 123

code integer read-only

Code used to identify the Sell Order (Sale) in Infraspeak.

Example: 123

sell_order_uuid string (uuid) read-only

Universally Unique Identifier (UUID) for the Sell Order (Sale).

Example: 3ac7648a-d628-47d8-b9a5-bf6c5edfe176

state string

Current State for the Sell Order (Sale). Possible states for a Sell Order (Sale) in Infraspeak are: - `DRAFT` - `CANCELLED` - `RUNNING` - `COMPLETED` - `COMPLETED_CONFIRMED`

DRAFT CANCELLED RUNNING COMPLETED COMPLETED_CONFIRMED

Example: DRAFT

entity_id integer read-only

ID for the Entity this Sell Order (Sale) belongs to in Infraspeak.

Example: 123

created_at string (date-time) read-only

Creation date of the Sell Order (Sale).

Example: 2020-08-28 08:48:00

created_by integer

ID for the Operator who created the Sell Order (Sale).

Example: 123

started_at string (date-time) | null read-only

Date indicating when the Sell Order (Sale) was Started (state 'RUNNING').

Example: 2020-08-28T08:48:00.000Z

started_by integer | null

ID for the Operator who started the Sell Order (Sale).

Example: 123

completed_at string (date-time) | null read-only

Date indicating when the Sell Order (Sale) was Completed (state 'COMPLETED').

Example: 2020-08-28T08:48:00.000Z

completed_by integer | null

ID for the Operator who completed the Sell Order (Sale).

Example: 123

cancelled_at string (date-time) | null read-only

Date indicating when the Sell Order (Sale) was Cancelled (state 'CANCELED').

Example: 2020-08-28T08:48:00.000Z

cancelled_by integer | null

ID for the Operator that cancelled the Sell Order (Sale).

Example: 123

description string | null

Observations or notes for the Sell Order (Sale). This field is a free text input that holds any information regarding the Sell Order (Sale), filled by the user.

Example: Some information regarding the sell Order (Sale)

internal_sale_id string | null

Internal ID of the Sell Order (Sale).

Example: 123

external_sale_id string | null

External ID of the associated Sell Order (Sale). Usually used to identify the Sell Order (Sale) with an unique identifier from a third-party application.

Example: 1e29e166-c6b8-4686-8856-2090d8dc12e1

related_to_type string | null

Type of the Infraspeak Object related to the Sell Order (Sale). **This is required when the field `related_to_id` is filled.** Allowed values for this field are: - `FAILURE` (Work Order) - `SCHEDULED_WORK` (Planned Job Order)

FAILURE SCHEDULED_WORK

Example: FAILURE

related_to_id integer | null

ID for the Infraspeak Object related to the Sell Order (Sale). **This is required when the field `related_to_type` is filled.** Possible related objects to a Sell Order (Sale) are: - `FAILURE` (Work Order) - `SCHEDULED_WORK` (Planned Job Order)

Example: 123

quote_id integer | null

ID of the Quote that originated the Sell Order (Sale).

Example: 123

base_total number

Total Base Price for the Sell Order (Sale). **This does not include Taxes or Discounts.**

Example: 11.22

discount_total number

Discount total for the Sell Order (Sale).

Example: 0.22

vat_total number

Taxes total for the Sell Order (Sale).

Example: 1

total number

Total Price for the Sell Order (Sale) including Taxes and Discounts.

Example: 12

updated_at string (date-time) read-only

Date for the last change in the Sell Order (Sale).

Example: 2020-08-28T13:05:00.000Z

confirmed_by integer | null

ID for the Operator that confirmed the Sell Order (Sale).

Example: 123

confirmed_at string (date-time)

Date indicating when the Operator confirmed the Sell Order (Sale).

Example: 2024-08-28T16:05:00.000Z

meta object

custom_fields object | null

included array<union>

List of expanded relationships for the Sell Order (Sale). Items available in this list will vary depending on the value supplied in `expanded` query parameter.

id string read-only

ID of the Supplier

Example: 1

type string read-only

Model type

entity

attributes object

entity_id integer

name string

email string

site string

phone string

cellphone string

address string

nib string

nif string

report_email string

language string

currency string

license string

ASSISTANCE CHURNED COMPLEX CSENTITY DISTRIBUTED HOTEL NONE PARTNER PLACECHECKUP

profile_picture string

entity_uuid string

vat_rate number

colour string

id string read-only

ID of the Operator

type string read-only

Model type

operator

attributes object

operator_id integer read-only

ID of the Operator

operator_uuid string (uuid) read-only

Uuid of the Operator

full_name string

email string (email)

phone string | null

cellphone string | null

account string

Type of account which determines the access permission level.

admin manager technician operator reporter

language string

ar ca da_dk en es fr_fr pl_pl pt_br pt_pt ko zh_cn nl_nl de_de

cost_per_hour number

Example: 10

warehouse_id integer

ID of the warehouse associated to the Operator by default.

entity_id integer read-only

timezone string

Valid PHP timezone identifier. See the full list here: https://www.php.net/manual/en/timezones.php.

Example: Europe/Lisbon

is_from_network boolean

created_at string (date-time)

phone_country_code string

Example: US

is_first_web_login boolean | null read-only

status string

WORKING AVAILABLE OFFLINE

Example: WORKING

meta object

custom_fields object | null

id string read-only

ID of the Operator

type string read-only

Model type

operator

attributes object

operator_id integer read-only

ID of the Operator

operator_uuid string (uuid) read-only

Uuid of the Operator

full_name string

email string (email)

phone string | null

cellphone string | null

account string

Type of account which determines the access permission level.

admin manager technician operator reporter

language string

ar ca da_dk en es fr_fr pl_pl pt_br pt_pt ko zh_cn nl_nl de_de

cost_per_hour number

Example: 10

warehouse_id integer

ID of the warehouse associated to the Operator by default.

entity_id integer read-only

timezone string

Valid PHP timezone identifier. See the full list here: https://www.php.net/manual/en/timezones.php.

Example: Europe/Lisbon

is_from_network boolean

created_at string (date-time)

phone_country_code string

Example: US

is_first_web_login boolean | null read-only

status string

WORKING AVAILABLE OFFLINE

Example: WORKING

meta object

custom_fields object | null

id string read-only

ID of the Operator

type string read-only

Model type

operator

attributes object

operator_id integer read-only

ID of the Operator

operator_uuid string (uuid) read-only

Uuid of the Operator

full_name string

email string (email)

phone string | null

cellphone string | null

account string

Type of account which determines the access permission level.

admin manager technician operator reporter

language string

ar ca da_dk en es fr_fr pl_pl pt_br pt_pt ko zh_cn nl_nl de_de

cost_per_hour number

Example: 10

warehouse_id integer

ID of the warehouse associated to the Operator by default.

entity_id integer read-only

timezone string

Valid PHP timezone identifier. See the full list here: https://www.php.net/manual/en/timezones.php.

Example: Europe/Lisbon

is_from_network boolean

created_at string (date-time)

phone_country_code string

Example: US

is_first_web_login boolean | null read-only

status string

WORKING AVAILABLE OFFLINE

Example: WORKING

meta object

custom_fields object | null

id string read-only

ID of the Operator

type string read-only

Model type

operator

attributes object

operator_id integer read-only

ID of the Operator

operator_uuid string (uuid) read-only

Uuid of the Operator

full_name string

email string (email)

phone string | null

cellphone string | null

account string

Type of account which determines the access permission level.

admin manager technician operator reporter

language string

ar ca da_dk en es fr_fr pl_pl pt_br pt_pt ko zh_cn nl_nl de_de

cost_per_hour number

Example: 10

warehouse_id integer

ID of the warehouse associated to the Operator by default.

entity_id integer read-only

timezone string

Valid PHP timezone identifier. See the full list here: https://www.php.net/manual/en/timezones.php.

Example: Europe/Lisbon

is_from_network boolean

created_at string (date-time)

phone_country_code string

Example: US

is_first_web_login boolean | null read-only

status string

WORKING AVAILABLE OFFLINE

Example: WORKING

meta object

custom_fields object | null

id string read-only

ID of the Operator

type string read-only

Model type

operator

attributes object

operator_id integer read-only

ID of the Operator

operator_uuid string (uuid) read-only

Uuid of the Operator

full_name string

email string (email)

phone string | null

cellphone string | null

account string

Type of account which determines the access permission level.

admin manager technician operator reporter

language string

ar ca da_dk en es fr_fr pl_pl pt_br pt_pt ko zh_cn nl_nl de_de

cost_per_hour number

Example: 10

warehouse_id integer

ID of the warehouse associated to the Operator by default.

entity_id integer read-only

timezone string

Valid PHP timezone identifier. See the full list here: https://www.php.net/manual/en/timezones.php.

Example: Europe/Lisbon

is_from_network boolean

created_at string (date-time)

phone_country_code string

Example: US

is_first_web_login boolean | null read-only

status string

WORKING AVAILABLE OFFLINE

Example: WORKING

meta object

custom_fields object | null

id string required read-only

ID of the Client

Example: 123

type string required read-only

Model type

client

Example: client

attributes object required

client_id integer

ID of the Client

Example: 123

client_uuid string (uuid)

UUID of the Client

Example: e632afe8-a1bf-4702-b5bd-b1163861ba51

name string

Client Name

Example: John Doe

code string | null

Client Code

Example: JD

nif string | null

NIF/ VAT Number of the Client

Example: 1234566789

postal_code string | null

Postal Code of the Client

Example: 1234-567

city string | null

City of the Client

Example: Lisbon

observations string | null

Additional information

Example: abc

address string | null

Address of the Client

Example: abc

country string | null

Country of the Client

Example: PT

created_at string (date-time) read-only

The datetime of the creation of the Client

Example: 2020-12-03T12:45:00

updated_at string (date-time) read-only

The datetime of the last update of the Client

Example: 2020-12-03T12:45:00

has_handshake boolean

Indicates if this Client is "connected" to work on Infraspeak Network.

Example: 1

my_company boolean

Indicates whether it is the entity's default client

Example: 1

relationships object

The relationships of the Client (Only present when expanded in the request)

buildings object

The Buildings associated to the Client

contacts object

The Contacts associated to the Client

files object

The Files associated to the Client

profilePicture object

The profile picture of the the Client

operators object

The Operators associated to the Client

handshake object

The Handshake associated to the Client

id string required read-only

ID of the Contact

Example: 123

type string required read-only

Model type

contact

Example: contact

attributes object required

contact_id integer read-only

ID of the Contact

Example: 123

entity_id integer read-only

ID of the Entity

Example: 123

cellphone string

The cellphone number of the Contact

Example: 123456789

language string

The language of the Contact

Example: pt_br

email string | null

The email of the Contact

Example: foo@bar.com

full_name string

The full name of the Contact

Example: Jose Pinhal

phone string

The phone number of the Contact

Example: 123456789

is_direct_user boolean

Indicates whether the contact is a Direct user

Example:

has_access union

Indicates whether the contact has access to Direct

Example:

relationships object

The relationships of the Contact

suppliers object

The Suppliers associated to the Contact

clients object

The Clients associated to the Contact

extensionsPermissions object

The Extensions Permissions associated to the Contact

locals object

The Locations associated to the Contact

profilePicture object

The profile picture of the Contact

user object

The user associated to the Contact

meta object

custom_fields object | null

id string required read-only

ID of the Failure

type string required read-only

Model type

failure

attributes object required

failure_id integer read-only

ID of the Failure

Example: 1

uuid string (uuid) read-only

Universally Unique Identifier for the Failure

problem_id integer

ID of the associated problem

status string read-only

WAITING_APPROVAL WAITING_RESOLUTION IN_RESOLUTION PAUSED COMPLETED ARCHIVED

start_date string (date-time) read-only

Example: 2020-08-28T08:48:00.000Z

completed_date string (date-time) | null read-only

Example: 2020-08-28T17:12:00.000Z

approved_date string (date-time) | null read-only

Example: 2020-08-28T09:30:00.000Z

paused_date string (date-time) | null read-only

Example: 2020-08-28T13:05:00.000Z

description string

Example: Needs replacement

last_status_description string

Example: Completed

observations string | null

Example: Needs a new part

code string

Example: WO2022

fts_vector string

Denormalized data of a Failure

priority integer

Failure priority number being 1 the lowest priority and 4 the highest priority.

1 2 3 4

client_id integer read-only

ID of the associated client defined according to the respective `local_id`.

entity_id integer read-only

ID of the Entity of the Failure

metering_registry_id integer | null read-only

ID of a possible associated metering registry

local_id integer

ID of the location associated to the Failure

paused_reason_id integer

ID of the paused reason associated to the Failure

external_id string | null

External ID to be associated to the Failure

report_name string

Name of who reported the Failure

solved boolean read-only

Indicates whether the Failure was closed successfully or not

confirmed boolean read-only

Indicates whether the Failure is confirmed or not

started boolean read-only

Indicates whether the Failure is started or not

paused boolean read-only

Indicates whether the Failure is paused or not

completed boolean read-only

Indicates whether the Failure is completed or not

archived boolean read-only

Indicates whether the Failure is archived or not

approved boolean read-only

Indicates whether the Failure is approved or not

next_schedule string (date-time) | null read-only

Example: 2020-08-29T10:30:00.000Z

message_count integer

Example: 3

time_statistics object

approved_date string (date-time) | null read-only

Example: 2020-08-28T09:30:00.000Z

last_completed_date string (date-time) | null read-only

Example: 2020-08-28T17:12:00.000Z

last_paused_date string (date-time) | null read-only

Example: 2020-08-28T13:05:00.000Z

started_date string (date-time) | null read-only

Example: 2020-08-28T09:45:00.000Z

time_to_approve string | null read-only

Duration it took to approve the Failure since reported in `ISO8601` format.

Example: P0Y0M0DT0H42M0S

time_to_complete string | null read-only

Duration it took to complete the Failure since reported in `ISO8601` format.

Example: P0Y0M0DT8H24M0S

time_to_complete_after_started string | null read-only

Duration it took to complete the Failure since the resolution started in `ISO8601` format.

Example: P0Y0M0DT7H27M0S

time_to_start string | null read-only

Duration it took to start the Failure's resolution since reported in `ISO8601` format.

Example: P0Y0M0DT0H57M0S

time_to_start_after_approved string | null read-only

Duration it took to start the Failure's resolution since approved in `ISO8601` format.

Example: P0Y0M0DT0H15M0S

real_duration string | null read-only

Real duration of the Failure's resolution time in `ISO8601` format.

Example: P0Y0M0DT7H27M0S

supplier_id integer

ID of the supplier associated to the Failure

signature_status string

Indicates whether the Failure is signed or not

SIGNED NOT_SIGNED

last_status_change_date string (date-time) read-only

Example: 2020-08-28T09:30:00.000Z

approved_by_id integer | null read-only

ID of the operator who approved the Failure.

completed_by_id integer | null read-only

ID of the operator who completed the Failure.

started_by_id integer | null read-only

ID of the operator who started the Failure's resolution.

paused_by_id integer | null read-only

ID of the operator who paused the Failure's resolution.

approved_by string | null read-only

Name of the operator who approved the Failure.

completed_by string | null read-only

Name of the operator who completed the Failure.

started_by string | null read-only

Name of the operator who started the Failure's resolution.

paused_by string | null read-only

Name of the operator who paused the Failure's resolution.

reported_by string | null read-only

Name of the operator who reported the Failure.

manpower_duration string | null read-only

Duration of the Failure's manpower time in `ISO8601` format.

Example: P0Y0M0DT7H27M0S

cost_center_id integer | null

ID of the cost center associated to the Failure

network_failure_id integer read-only

ID of the Network Failure

Example: 1

created_at string (date-time) read-only

updated_at string (date-time) read-only

date_deleted string (date-time) read-only

relationships object

approvedBy object

data object

type string read-only

operator

id string read-only

completedBy object

data object

type string read-only

operator

id string read-only

createdBy object

data object

type string read-only

operator

id string read-only

files object

data array<object>

type string read-only

file

id string read-only

location object

data object

type string read-only

location

id string read-only

operator object

data object

type string read-only

operator

id string read-only

id string required read-only

ID of the File

type string required read-only

Model type

file

attributes object required

file_id integer read-only

File Id

file_uuid string read-only

File UUID

related_to string

Object which the File is related to

BUILDING CATEGORY CLIENT ELEMENT ELEMENT_REGISTRY FAILURE METERING_REGISTRY OPERATOR ORDER QUOTE QUOTE_REQUEST RECEIVED_QUOTE RECEIVED_QUOTE_REQUEST REQUEST SELL_ORDER SUPPLIER SCHEDULE_WORK WORK SCHEDULED_WORK PURCHASE PURCHASE_MATERIAL_LINE PURCHASE_SERVICE_LINE SALE

related_to_id integer

Relations Id

related_type string read-only

Object which the File is related to

file_label_id integer | null

File Label Id

name string

File name

Example: my_example_file

thumb string | null read-only

URL to the thumbnail, in case the File is an image.

file_url string (uri) read-only

URL to the File

description string | null

expire_date string (date-time) | null read-only

Example: 2020-08-28T17:12:00.000Z

has_reminder boolean read-only

file_type string read-only

Internal type of the file

cad compressed file image office other pdf signature video

permission_to_technician boolean

permission_to_manager boolean

permission_to_direct boolean

extension string read-only

3gp 3gpp bin bmp cad csv doc docx gif jpeg jpg kmz mov mp4 odf odp pdf png ppt pptx qt rar txt xls xlsx zip

network_status string

Show the network status of the file.

SHARED RECEIVED NOT_SHARED

shared_with_supplier boolean

Show if the file is currently in a shared status with the supplier.

shared_with_client boolean

Show if the file is currently in a shared status with the client.

file_size integer read-only

created_at string | null read-only

Example: 2021-07-21 18:38:00

id string read-only

ID of the Quote.

type string read-only

Model type

quote

attributes object

quote_id integer read-only

ID of the Quote.

quote_uuid string (uuid) | null read-only

UUID of the Quote.

code integer read-only

Code of the Quote. Visible on Infraspeak platform.

client_id integer | null read-only

ID of the Client associated to the quote.

state string

State of the Quote.

DRAFT READY ACCEPTED DECLINED CANCELLED CONVERTED_TO_SALE

Example: DRAFT

entity_id integer read-only

created_at string | null read-only

Creation date of the Quote

Example: 2021-07-21 18:38:00

created_by integer read-only

ID of the operator that created the Quote.

started_at string | null read-only

Date when Quote has started.

Example: 2021-07-21 18:38:00

started_by integer | null read-only

ready_at string | null read-only

Date Quote is marked as Awaiting.

Example: 2021-07-21 18:38:00

ready_by_id integer | null read-only

ID of the user who marked the quote as Awaiting.

ready_by_type string | null

Type of user who marked the Quote as Awaiting.

OPERATOR CONTACT

accepted_at string | null read-only

Date Quote is accepted.

Example: 2021-07-21 18:38:00

accepted_by_id integer | null read-only

ID of the user who accepted the Quote.

accepted_by_type string | null

Type of user who accepted the Quote.

OPERATOR CONTACT

declined_at string | null read-only

Date Quote was declined.

Example: 2021-07-21 18:38:00

declined_by_id integer | null read-only

ID of the user who declined the quote.

declined_by_type string | null

Type of user who declined the Quote.

OPERATOR CONTACT

cancelled_by integer | null read-only

ID of the user who cancelled the quote.

cancelled_at string | null read-only

Date Quote was cancelled.

Example: 2021-07-21 18:38:00

last_sent_at string | null read-only

Date Quote was last sent.

Example: 2021-07-21 18:38:00

last_sent_by integer | null read-only

last_share_at string | null read-only

Date Quote was last shared.

Example: 2021-07-21 18:38:00

last_share_by integer | null read-only

converted_by integer | null read-only

converted_at string | null read-only

Date Quote was converted.

Example: 2021-07-21 18:38:00

description string | null

Quote observations.

internal_quote_id string | null read-only

Internal ID of the Quote.

Example: FS-123

external_quote_id string | null read-only

External ID of the Quote.

Example: FS-123

related_to_type string | null

Type of object related to the quote.

FAILURE SCHEDULED_WORK

Example: FAILURE

related_to_id integer | null

ID of the object (failure or scheduled work) related to the quote.

base_total integer | null read-only

Total Base value of the Quote, without VAT and discount.

discount_total integer | null read-only

Total value of the discount applied to the Quote items.

vat_total integer | null read-only

Total value of the VAT applied to the Quote items.

total integer read-only

Total value of the Quote, considering the discount and VAT applied.

sell_order_id integer | null read-only

ID of the Sale associated to the Quote, after converted.

updated_at string | null read-only

Date Quote was updated.

Example: 2021-07-21 18:38:00

deleted_at string | null read-only

Date Quote was deleted.

Example: 2021-07-21 18:38:00

quote_request_id integer | null read-only

received_quote_request_id integer | null read-only

is_from_network boolean read-only

client_answer object

clientUserName string

clientName string

answer string

meta object

custom_fields object | null

id string required read-only

ID of the Scheduled Order

Example: 123

type string required read-only

Model type

scheduled_work

Example: scheduled_work

attributes object required

entity_id integer

The ID of the Entity where the Scheduled Work belongs.

Example: 123

complete_date string (date-time) | null

The datetime when the Scheduled Work was completed

Example: 2014-09-01 02:22:00

cost_center_name string | null

The name of the Cost Center associated with the Scheduled Work.

Example: abc

completed_by_id integer | null

The ID of the Operator that completed the Scheduled Work.

Example: 123

completed_percentage integer

The percentage of the Scheduled Work that is completed.

Example: 45

completed_date string (date-time) | null

The datetime when the Scheduled Work was completed

Example: 2014-09-01 02:22:00

confirmed boolean

Indicates if the Scheduled Work is confirmed.

Example: 1

failure_id integer | null

The ID of the Failure / Work Order associated with the Scheduled Work (Only if the Scheduled work originated from a Failure / Work Order)

last_status_change_date string (date-time) | null

The datetime when the Scheduled Work status changed for the last time

Example: 2014-09-01 02:22:00

last_status_change_operator string | null

The name of the Operator that changed the Scheduled Work status for the last time

Example: John

manpower_duration string | null

The total manpower duration of the Scheduled work in ISO-8601 duration format.

Example: P0Y0M0DT0H1M19S

manpower_cost number | null

The total manpower cost of the Scheduled work in the currency of the logged in user.

Example: 12.5

observation string | null

Observations added to the Scheduled Work.

Example: abc

real_start_date string (date-time) | null

The datetime when the Scheduled Work was actually started (not to confuse with the datetime when the Scheduled work planned to start)

Example: 2014-09-01 02:22:00

running boolean

Indicates if the Scheduled Work is currently in a running status

Example: 1

schedule_work_id integer

The ID of the Scheduled Work

Example: 123

signature_status string

Indicates if the Scheduled Work is signed by a responsible.

NOT_SIGNED SIGNED

Example: NOT_SIGNED

start_date string | null

The datetime when the Scheduled Work is/was planned to start

Example: 2021-07-21 18:38:00

started_by_id integer | null

The ID of the Operator that started the Scheduled Work.

Example: 123

state string

The current state of the Scheduled Work.

SCHEDULED RUNNING PAUSED COMPLETED CANCELED ARCHIVED COMPLETED_CANCELED

Example: COMPLETED

time_running string | null

The current running duration of the Scheduled work in ISO-8601 duration format.

Example: P0Y0M0DT0H1M19S

visit integer | null

Indicates the position/step of the Scheduled work in the parent Work / Planned Job that is originates from (e.g. can be the first Scheduled Work of the Work / Planned Job, the second, and so on)

Example: 1

work_id integer

The ID of the parent Work / Planned Job

Example: 123

next_sla_date string (date-time) | null

The datetime of the closest SLA that is still ongoing in the Scheduled Work (This field includes only SLAs that have not finished yet and are still ongoing, and will be null if there's none)

Example: 2014-09-01 02:22:00

next_sla_percentage number | null

The percentage of the Scheduled Work tasks that are completed in the closest SLA that is still ongoing (This field includes only SLAs that have not finished yet and are still ongoing, and will be null if there's none)

Example: 75.5

next_scheduled_work_sla_id integer | null

The ID of the next SLA (This field includes the next SLA, despite his current status being already finished or paused)

Example: 123

next_scheduled_work_sla_date string (date-time) | null

The datetime of the next SLA (This field includes the next SLA, despite his current status being already finished or paused)

Example: 2014-09-01 02:22:00

next_scheduled_work_sla_status_order integer | null

The status order of the next SLA (0 if status is 'RUNNING', 1 if status is 'PAUSED', 2 if status is 'FINISHED', otherwise 3) (This field includes the next SLA, despite his current status being already finished or paused)

Example: 0

rescheduled_by_user boolean

Indicates if the Scheduled Work was manually rescheduled by an User

Example:

network_id integer | null

ID used to reference a shared Planned Job Order

Example: 123

updated_at string | null

The datetime of the last update in the Scheduled Work

Example: 2021-07-21 18:38:00

display_start_date string | null

The start datetime to display in the Scheduled Work

Example: 2021-07-21 18:38:00

display_complete_date string | null

The complete datetime to display in the Scheduled Work

Example: 2021-07-21 18:38:00

estimated_duration_absolute_deviation integer | null

The absolute deviation between the actual manpower duration and the estimated task time in the Scheduled Work, representing the total difference regardless of whether the estimate was over or under

Example: 150

estimated_duration_relative_deviation integer | null

The relative deviation between the actual manpower duration and the estimated task time in the Scheduled Work. A negative value indicates the estimate was too low, while a positive value indicates it was too high

Example: -150

pause_reason_id integer | null

The ID of the Pause Reason associated with the Scheduled Work

Example: 123

last_status_description string | null

A description provided when the last status change occurred on the Scheduled Work

Example: Waiting for spare parts delivery

relationships object

The relationships of the Scheduled Work (Only present when expanded in the request)

auditStats object

data array<object>

type string read-only

audit_stats

id string read-only

buyOrders object

data array<object>

type string read-only

buy_order

id string read-only

client object

data object

type string read-only

client

id string read-only

completedBy object

data object

type string read-only

operator

id string read-only

elementRegistries object

data array<object>

type string read-only

element_registry

id string read-only

entity object

data object

type string read-only

entity

id string read-only

events object

data array<object>

type string read-only

event

id string read-only

eventsPlanned object

data array<object>

type string read-only

event

id string read-only

files object

data array<object>

type string read-only

file

id string read-only

gatekeeperAnswerRegistries object

data array<object>

type string read-only

gatekeeper_answer_registry

id string read-only

networkStatus object

data array<object>

type string read-only

If RECEIVER the Scheduled Work was received on Network, if SENDER the Scheduled Work was sent to the Network.

SENDER RECEIVER

action string read-only

If UNSHARED, the Scheduled Work was unshared from Network, if null, no action was taken.

id string read-only

in_sync boolean read-only

If the Scheduled Work is in sync of execution with the Network.

network_entity_uuid string read-only

The UUID of the Network Entity related to the Scheduled Work network status.

network_relation_id integer read-only

The ID of the Network Relation related to the Scheduled Work network status. It can be from a Client or a Supplier.

network_relation_type string read-only

The type of Network Relation related to the Scheduled Work network status. It can be from a Client or a Supplier, used to identify the relation ID and the relation the Network Entity has to the Scheduled Work.

CLIENT SUPPLIER

shared boolean read-only

If the Scheduled Work is actively shared on Network.

otherCosts object

data array<object>

type string read-only

other-cost

id string read-only

participants object

data array<object>

type string read-only

operator

id string read-only

pausedBy object

data object

type string read-only

operator

id string read-only

reminderRules object

data array<object>

type string read-only

reminder_rules

id string read-only

reminders object

data array<object>

type string read-only

reminder

id string read-only

requests object

data array<object>

type string read-only

request

id string read-only

scheduledWorkSlas object

data array<object>

type string read-only

schedule_work_sla

id string read-only

startedBy object

data object

type string read-only

operator

id string read-only

stock object

data array<object>

type string read-only

stock

id string read-only

stockTasks object

data array<object>

type string read-only

stock

id string read-only

survey object

data object

type string read-only

survey

id string read-only

surveyFeedbacks object

data array<object>

type string read-only

survey_feedback

id string read-only

work object

data object

type string read-only

work

id string read-only

realStartDateEditedBy object

data object

type string read-only

operator

id string read-only

completeDateEditedBy object

data object

type string read-only

operator

id string read-only

failureScheduleMapping object

data array<object>

type string read-only

failure_schedule_mapping

id string read-only

pause_reason object

The Pause Reason associated with the Scheduled Work

data object | null

type string read-only

pause_reason

id string read-only

assignees object

The Operators and Teams assigned to the Scheduled Work

data array<object>

type string read-only

scheduled_work_assignee

id string read-only

meta object

Meta model structure details

cost_centers object

names array<string>

Example: ["Cost center","Cost center 2"]

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

404

message string

Example: Resource not found

more_info string | null

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

Path Parameters

sellOrderId

filter_alt Filters

Pagination

GET https://api.sandbox.infraspeak.com/v3/sales/sell-orders/{sellOrderId}

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/sales/sell-orders/{sellOrderId}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/sales/sell-orders/{sellOrderId}', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->get('https://api.sandbox.infraspeak.com/v3/sales/sell-orders/{sellOrderId}');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/sales/sell-orders/{sellOrderId}',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "123",
        "type": "sell_order",
        "attributes": {
            "client_id": 123,
            "code": 123,
            "sell_order_uuid": "3ac7648a-d628-47d8-b9a5-bf6c5edfe176",
            "state": "DRAFT",
            "entity_id": 123,
            "created_at": "2020-08-28 08:48:00",
            "created_by": 123,
            "started_at": "2020-08-28T08:48:00.000Z",
            "started_by": 123,
            "completed_at": "2020-08-28T08:48:00.000Z",
            "completed_by": 123,
            "cancelled_at": "2020-08-28T08:48:00.000Z",
            "cancelled_by": 123,
            "description": "Some information regarding the sell Order (Sale)",
            "internal_sale_id": "123",
            "external_sale_id": "1e29e166-c6b8-4686-8856-2090d8dc12e1",
            "related_to_type": "FAILURE",
            "related_to_id": 123,
            "quote_id": 123,
            "base_total": 11.22,
            "discount_total": 0.22,
            "vat_total": 1,
            "total": 12,
            "updated_at": "2020-08-28T13:05:00.000Z",
            "confirmed_by": 123,
            "confirmed_at": "2024-08-28T16:05:00.000Z"
        },
        "meta": {
            "custom_fields": {}
        }
    },
    "included": {
        "id": "1",
        "type": "entity",
        "attributes": {
            "entity_id": 0,
            "name": "string",
            "email": "string",
            "site": "string",
            "phone": "string",
            "cellphone": "string",
            "address": "string",
            "nib": "string",
            "nif": "string",
            "report_email": "string",
            "language": "string",
            "currency": "string",
            "license": "ASSISTANCE",
            "profile_picture": "string",
            "entity_uuid": "string",
            "vat_rate": 0,
            "colour": "string"
        }
    },
    "meta": {
        "cost_centers": {
            "names": [
                "Cost center",
                "Cost center 2"
            ]
        }
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}