Corrigo: Batch schemas
4 Corrigo schemas with complete fields and constraints.
← Batch operations · All schemas
Create several entities, of any type — request body — body item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
requestId | JSON | Optional | |
requestId (anyOf 1) | string | Alternative | |
requestId (anyOf 2) | null | Alternative | |
entity | JSON | Optional | |
entity (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
entity (anyOf 1).* | JSON | Additional keys | |
entity (anyOf 2) | null | Alternative | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | string | Each item | |
properties (anyOf 2) | null | Alternative | |
entityType | Model | Optional | Expand Retrieve several entities — request body — body item entity Type |
Referenced models: Retrieve several entities — request body — body item entity Type
Execute several commands, of any kind — request body — body item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
requestId | JSON | Optional | |
requestId (anyOf 1) | string | Alternative | |
requestId (anyOf 2) | null | Alternative | |
command | JSON | Optional | |
command (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
command (anyOf 1).* | JSON | Additional keys | |
command (anyOf 2) | null | Alternative | |
commandName | JSON | Optional | |
commandName (anyOf 1) | string | Alternative | |
commandName (anyOf 2) | null | Alternative |
Retrieve several entities — request body — body item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
requestId | JSON | Optional | |
requestId (anyOf 1) | string | Alternative | |
requestId (anyOf 2) | null | Alternative | |
entityType | Model | Optional | Expand Retrieve several entities — request body — body item entity Type |
id | JSON | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | string | Each item | |
properties (anyOf 2) | null | Alternative |
Referenced models: Retrieve several entities — request body — body item entity Type
Retrieve several entities — request body — body item entity Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One of: TaxCode, InvoiceDictionaryItem, BillingAccount, WorkOrder, Location, Address, Customer, Invoice, InvoiceLine, CorporateEntity, GLAccount, Payment, PaymentItem, Employee, WorkZone, Space, Task, Disposition, WoItem, CustomFieldDescriptor, CustomField, Organization, Contact, TimePeriod, Specialty, WorkOrderType, CustomerNoteType, RepairCode, AttributeDescriptor, WoActionReasonLookup, WoPriority, WoLastAction, WoNote, Actor, ContactAddress, Address2, ContactInfo, CustomField2, Note, WorkOrderCost, WoAssignment, WoOnSite, WoActionLog, WoVerification, WoActionLogProp, FinancialItem, WoQuote, WoEquipment, Blob, DocumentType, Document, Product, LaborCode, WpTree, WoEstimate, ToDoItem, LinkCustomerAndGroup, LinkContactAndGroup, AssetInfo, PmSchedule, PmItem, Contract, TaxRegion, TaxRegionItem, PriceList, PriceListItem, ChargeCodeLookup, CustomFieldOption, Model, LinkUserAndSpecialty, LinkUserAndCustomerGroup, LinkUserAndWorkZone, LinkUserAndPortfolio, LinkUserAndTeam, UserPayRate, UserCertification, LinkUserAndStockLocation, LinkProviderPriceList, LinkProviderAndService, Role, AlertScope, AlertSubscription, AssetTree, AttributeOption, Team, LinkTeamAndWorkZone, LinkPortfolioAndWorkZone, BusinessHours, Holiday, SpecDispatchRule, EscalationRule, OnCallRule, Responsibility, Warranty, AssetAttribute, SpecialtyMoneyValues, ContactMoneyValues, TaskMoneyValues, UserPayRateMoneyValues, RoleMoneyValues, Portfolio, AssetTemplate, AssetSystem, ProductCategory, LinkProductAndSupplier, ProductMoneyValues, ApInvoiceStatus, TimeCardWeek, TimeCard, TimeCardItem, ProviderCoi, ResponsibilityType, ToDoType, ApprovalTemplateStep, ApprovalTemplate, ProcedureTemplateStep, ProcedureFlagReason, ProcedureTemplate, WoProcedureStep, WoProcedure, StockLocation, ReplenishmentOrder, ReplenishmentOrderItem, ApprovalScope, CustomFieldAutocompleteOption, TimeOff, SlaValuesOverride, Turn, LinkModelAndAttribute, BillToOption, PrintoutTemplate, InvoiceLog, QuoteOrEstimateItem, MaterialTransaction, MaterialTransactionItem, StockLocationInventoryDetails, InternalCostStatus, WoFlag, ProcedureCategory, LinkProcedureCategoryAndTemplate, LinkProductAndQtyAttribute, RequiredDocCategory, WorkTemplate, Proposal, WorkOrderCostCategory, WoSchedule, RcsCircuit, RcsAction, RcsCylinder, LinkCommunityAndRcsCylinder, LinkEmployeeAndRcsCylinder, RcsLeakRateLog, RcsCircuitMonitorMapping, BlackoutDay, ShiftHours, WoVisit, WoVisitCfg, WoVisitSvc, LirOutstandingInvoiceWorkOrder Format: int32 |