RfqSummary response model

All models · Download OpenAPI

Nullable fields represent unknown values; they do not imply zero cost or a completed action.

Field	Type	Required	Details
id	string	Yes	Format: uuid
projectId	string	Yes	Format: uuid
projectName	string	Yes
title	string	Yes
status	string	Yes	One of: draft, sent, closed
anonymised	boolean	Yes	The buyer is anonymised to the supplier in the managed request
scope	string	Yes
sourcingModel	string	Yes
runKind	string	Yes
priority	string	Yes
drawingsStatus	string	Yes
toolOwnershipRequired	boolean	Yes
bomId	string or null	Yes
lineIds	string[]	Yes
fileIds	string[]	Yes
requested	object	Yes
requested.quantities	integer[]	If parent supplied
requested.targetUnitPrice	string or null	If parent supplied
requested.currency	string	If parent supplied	Stored currency
requested.currencyAtColumnDefault	boolean	If parent supplied	True only when the stored value is indistinguishable from the USD column default: the RFQ was created in the Maglev workspace, whose form cannot tell a chosen USD from an unstated one, and still stores USD. False on an RFQ published through POST /actions/{id}/publication, which requires the currency in the reviewed selection and hashes it into reviewSha256, so a chosen USD is a declared currency there.
requested.incoterm	string	If parent supplied	Stored Incoterm
requested.incotermAtColumnDefault	boolean	If parent supplied	True only when the stored value is indistinguishable from the EXW column default: a workspace-created RFQ still storing EXW. False on an RFQ published through POST /actions/{id}/publication, which requires the Incoterm in the reviewed selection and hashes it into reviewSha256.
requested.namedPlace	string or null	If parent supplied
requested.deliverTo	string or null	If parent supplied
requested.quoteBy	string or null	If parent supplied
createdAt	string	Yes
updatedAt	string	Yes

Full JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "projectId": {
      "type": "string",
      "format": "uuid"
    },
    "projectName": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "sent",
        "closed"
      ]
    },
    "anonymised": {
      "type": "boolean",
      "description": "The buyer is anonymised to the supplier in the managed request"
    },
    "scope": {
      "type": "string"
    },
    "sourcingModel": {
      "type": "string"
    },
    "runKind": {
      "type": "string"
    },
    "priority": {
      "type": "string"
    },
    "drawingsStatus": {
      "type": "string"
    },
    "toolOwnershipRequired": {
      "type": "boolean"
    },
    "bomId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "lineIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "fileIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "requested": {
      "type": "object",
      "properties": {
        "quantities": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "targetUnitPrice": {
          "anyOf": [
            {
              "type": "string",
              "description": "Decimal string; null when the buyer set no target"
            },
            {
              "type": "null"
            }
          ]
        },
        "currency": {
          "type": "string",
          "description": "Stored currency"
        },
        "currencyAtColumnDefault": {
          "type": "boolean",
          "description": "True only when the stored value is indistinguishable from the USD column default: the RFQ was created in the Maglev workspace, whose form cannot tell a chosen USD from an unstated one, and still stores USD. False on an RFQ published through POST /actions/{id}/publication, which requires the currency in the reviewed selection and hashes it into reviewSha256, so a chosen USD is a declared currency there."
        },
        "incoterm": {
          "type": "string",
          "description": "Stored Incoterm"
        },
        "incotermAtColumnDefault": {
          "type": "boolean",
          "description": "True only when the stored value is indistinguishable from the EXW column default: a workspace-created RFQ still storing EXW. False on an RFQ published through POST /actions/{id}/publication, which requires the Incoterm in the reviewed selection and hashes it into reviewSha256."
        },
        "namedPlace": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "deliverTo": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "quoteBy": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO date; null when no deadline was recorded"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "quantities",
        "targetUnitPrice",
        "currency",
        "currencyAtColumnDefault",
        "incoterm",
        "incotermAtColumnDefault",
        "namedPlace",
        "deliverTo",
        "quoteBy"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "projectId",
    "projectName",
    "title",
    "status",
    "anonymised",
    "scope",
    "sourcingModel",
    "runKind",
    "priority",
    "drawingsStatus",
    "toolOwnershipRequired",
    "bomId",
    "lineIds",
    "fileIds",
    "requested",
    "createdAt",
    "updatedAt"
  ]
}