iotoms Docs

Mark a quotation as converted to an order

PATCH
/api/v1/sales/quotations/{id}/convert

Links an accepted quotation to the order it became. Create the order through the normal transaction endpoints first, then pass its transactionId here. This call creates no order and posts nothing.

How to use it

  1. Mark the quotation accepted first with Mark a quotation as accepted.
  2. Create the order through the normal sales path, e.g. Create a transaction from a cart, and keep its transaction ID.
  3. Send that transactionId here; the quotation shows CONVERTED and can only be converted once.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

X-TenantID*string

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

Request Body

application/json
  1. body
transactionId*string

ID of the order (transaction) created for this quotation, e.g. by Create a transaction from a cart. Must exist. Required.

Formatuuid

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?

The quotation with its lines and current status.

Example Request
curl -X PATCH 'https://beta.iotoms.com/api/v1/sales/quotations/497f6eca-6276-4993-bfeb-53cbbbba6f08/convert' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "quoteNumber": "string",    "customerNumber": "string",    "customerName": "string",    "customerContact": "string",    "storeId": 0,    "storeName": "string",    "status": "string",    "effectiveStatus": "string",    "quoteDate": "2019-08-24",    "validUntil": "2019-08-24",    "daysUntilExpiry": 0,    "currency": "string",    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "grandTotal": 0,    "notes": "string",    "terms": "string",    "lostReason": "string",    "sentAt": "2019-08-24T14:15:22Z",    "acceptedAt": "2019-08-24T14:15:22Z",    "convertedAt": "2019-08-24T14:15:22Z",    "convertedTransactionId": "ffec8c36-02ff-4068-8a67-e53c0a6dd346",    "items": [      {        "id": 0,        "itemId": "string",        "itemName": "string",        "description": "string",        "quantity": 0,        "unitPrice": 0,        "discountAmount": 0,        "taxRate1": 0,        "taxRate2": 0,        "taxAmount": 0,        "lineTotal": 0,        "uomId": "4df47f00-a69d-4ff2-b50d-4a7649a4b70c",        "priceSource": "string",        "sortOrder": 0      }    ],    "createdBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}