Corrigo: Retrieve several entities

← Batch operations · Get started

Operation corrigo.batch_get

Provider route: POST /v1/batch/Get. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/corrigo with npm, or alter-sdk-corrigo with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { CorrigoIntegration } from "@alter-ai/corrigo";

async function execute(input: Parameters<CorrigoIntegration["batch"]["get"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new CorrigoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.batch.get(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_corrigo import CorrigoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = CorrigoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.batch.get(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	array	Required within parent
body[]	Model	Each item	Expand Retrieve several entities — request body — body item

Referenced models: Retrieve several entities — request body — body item

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root

Schemas

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

Policy, approvals and errors

SDK function policy ID: corrigo.batch_get. Catalog operation: batch.get. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source