Corrigo: Proposal schemas
1 Corrigo schema with complete fields and constraints.
← Proposal operations · All schemas
Create proposal — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
amount | JSON | Optional | |
amount (anyOf 1) | object | Alternative | A Corrigo MoneyValue. |
amount (anyOf 2) | null | Alternative | |
approval | JSON | Optional | |
approval (anyOf 1) | object | Alternative | A Corrigo ApprovalTemplate. |
approval (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
documents | JSON | Optional | |
documents (anyOf 1) | array | Alternative | |
documents (anyOf 1)[] | JSON | Each item | |
documents (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo Document. |
documents (anyOf 1)[] (anyOf 2) | null | Alternative | |
documents (anyOf 2) | null | Alternative | |
status | string | Optional | One of: Unknown, Draft, Pending, Approved, Rejected, Insufficient, DraftWaiting, SubmittedWaiting, RejectedByCustomer, RejectedByServiceProvider Format: int32 |
type | string | Optional | One of: Standard, Estimate, Quote, ApInvoice, Nte, Purchase, Other, WorkOrder, ProcedureTemplate, IncidentStart, IncidentCompletion, IncidentCompletionExtended, RoundsSchedule, FoundWork, ConsumptionRequest Format: int32 |
utcSubmitted | JSON | Optional | |
utcSubmitted (anyOf 1) | string | Alternative | Format: date-time |
utcSubmitted (anyOf 2) | null | Alternative | |
workOrder | JSON | Optional | |
workOrder (anyOf 1) | object | Alternative | A Corrigo WorkOrder. |
workOrder (anyOf 2) | null | Alternative | |
workZone | JSON | Optional | |
workZone (anyOf 1) | object | Alternative | A Corrigo WorkZone. |
workZone (anyOf 2) | null | Alternative |