iotoms Docs

List quotations

GET
/api/v1/sales/quotations

Returns a paginated list of quotations (0-based page, default size 20). Filter by status (DRAFT, SENT, ACCEPTED, EXPIRED, LOST or CONVERTED), customerNumber, storeId, a validUntilFrom/validUntilTo range, or free text q matching quote number, customer name or customer number.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

status?string

DRAFT | SENT | ACCEPTED | EXPIRED | LOST | CONVERTED

customerNumber?string

Only quotations for this customer number.

storeId?integer

Only quotations from this merchant store ID.

Formatint64
validUntilFrom?string

Only quotations valid until this date or later (YYYY-MM-DD).

Formatdate
validUntilTo?string

Only quotations valid until this date or earlier (YYYY-MM-DD).

Formatdate
q?string

Matches quote number, customer name or customer number

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was processed; otherwise an error status.

message*string

Short human-readable message describing the outcome, e.g. which record was saved or why the call failed.

data?

One page of quotation summaries, newest first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/sales/quotations' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "quoteNumber": "string",        "customerNumber": "string",        "customerName": "string",        "storeId": 0,        "storeName": "string",        "status": "string",        "effectiveStatus": "string",        "quoteDate": "2019-08-24",        "validUntil": "2019-08-24",        "daysUntilExpiry": 0,        "grandTotal": 0,        "lineCount": 0,        "convertedTransactionId": "ffec8c36-02ff-4068-8a67-e53c0a6dd346",        "createdBy": "string",        "createdAt": "2019-08-24T14:15:22Z"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0  }}