GET /sales/quotes/{id}

Get a Quote

This endpoint allows you to get a specific Quote.

Operation ID: getQuote

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

Path Parameters

Name	Type	Description
`id` required path	string	The Quote ID

Responses

data object

Quote model structure details

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

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

403

message string

Example: Action unauthorized

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

filter_alt Filters

Pagination

GET https://api.sandbox.infraspeak.com/v3/sales/quotes/{id}

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/sales/quotes/{id}' \
  -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/quotes/{id}', {
  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/quotes/{id}');

import requests

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

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "string",
        "type": "quote",
        "attributes": {
            "quote_id": 0,
            "quote_uuid": "string",
            "code": 0,
            "client_id": 0,
            "state": "DRAFT",
            "entity_id": 0,
            "created_at": "2021-07-21 18:38:00",
            "created_by": 0,
            "started_at": "2021-07-21 18:38:00",
            "started_by": 0,
            "ready_at": "2021-07-21 18:38:00",
            "ready_by_id": 0,
            "ready_by_type": "OPERATOR",
            "accepted_at": "2021-07-21 18:38:00",
            "accepted_by_id": 0,
            "accepted_by_type": "OPERATOR",
            "declined_at": "2021-07-21 18:38:00",
            "declined_by_id": 0,
            "declined_by_type": "OPERATOR",
            "cancelled_by": 0,
            "cancelled_at": "2021-07-21 18:38:00",
            "last_sent_at": "2021-07-21 18:38:00",
            "last_sent_by": 0,
            "last_share_at": "2021-07-21 18:38:00",
            "last_share_by": 0,
            "converted_by": 0,
            "converted_at": "2021-07-21 18:38:00",
            "description": "string",
            "internal_quote_id": "FS-123",
            "external_quote_id": "FS-123",
            "related_to_type": "FAILURE",
            "related_to_id": 0,
            "base_total": 0,
            "discount_total": 0,
            "vat_total": 0,
            "total": 0,
            "sell_order_id": 0,
            "updated_at": "2021-07-21 18:38:00",
            "deleted_at": "2021-07-21 18:38:00",
            "quote_request_id": 0,
            "received_quote_request_id": 0,
            "is_from_network": true,
            "client_answer": {
                "clientUserName": "string",
                "clientName": "string",
                "answer": "string"
            }
        },
        "meta": {
            "custom_fields": {}
        }
    }
}

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"
    }
}

403 Forbidden. The action can not be fulfilled.

{
    "status": "error",
    "error": {
        "http_code": 403,
        "message": "Action unauthorized",
        "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"
    }
}