Raw schema
{
"type": "object",
"properties": {
"store_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The store the job is served from."
},
"state": {
"description": "0 = Enquiry, 1 = Draft, 2 = Quotation. Converting to an Order is left to Current RMS.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
},
"subject": {
"description": "The opportunity's subject (title).",
"type": "string"
},
"description": {
"description": "Internal description.",
"type": "string"
},
"external_description": {
"description": "Description shown on customer documents.",
"type": "string"
},
"member_id": {
"description": "The customer (Organisation/Contact member) id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"billing_address_id": {
"description": "The member's address id used for billing.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"venue_id": {
"description": "The Venue member id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"project_id": {
"description": "The project this opportunity belongs to.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"starts_at": {
"description": "Overall start / delivery date-time (UTC).",
"type": "string"
},
"ends_at": {
"description": "Overall end / collection date-time (UTC).",
"type": "string"
},
"charge_starts_at": {
"description": "Charging period start (UTC).",
"type": "string"
},
"charge_ends_at": {
"description": "Charging period end (UTC).",
"type": "string"
},
"reference": {
"description": "Customer reference, e.g. their PO number.",
"type": "string"
},
"owned_by": {
"description": "User member id of the owner.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"delivery_instructions": {
"description": "Delivery instructions.",
"type": "string"
},
"collection_instructions": {
"description": "Collection instructions.",
"type": "string"
},
"customer_collecting": {
"description": "The customer collects the goods themselves.",
"type": "boolean"
},
"customer_returning": {
"description": "The customer returns the goods themselves.",
"type": "boolean"
},
"rating": {
"description": "Rating, 0-5.",
"type": "integer",
"minimum": 0,
"maximum": 5
},
"tag_list": {
"description": "Tags.",
"type": "array",
"items": {
"type": "string"
}
},
"custom_fields": {
"description": "Custom field values by field name.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"store_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}