Corrigo: Create payment item

Corrigo paymentItem.create: arguments, response, policy and SDK examples.

Operation corrigo.base_paymentitem_create

Provider route: POST /v1/base/PaymentItem. 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["paymentItem"]["create"]>[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.paymentItem.create(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.payment_item.create(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`body`	object	Required within parent	Additional keys: not allowed
`body.requestId`	JSON	Optional
`body.requestId (anyOf 1)`	string	Alternative
`body.requestId (anyOf 2)`	null	Alternative
`body.properties`	JSON	Optional
`body.properties (anyOf 1)`	array	Alternative
`body.properties (anyOf 1)[]`	string	Each item
`body.properties (anyOf 2)`	null	Alternative
`body.entity`	Model	Required within parent	Expand Create payment item — request body — body entity

Referenced models: Create payment item — request body — body entity

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

Create payment item — 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
`amtBalance`	JSON	Optional
`amtBalance (anyOf 1)`	object	Alternative	A Corrigo MoneyValue.
`amtBalance (anyOf 2)`	null	Alternative
`amtUsed`	JSON	Optional
`amtUsed (anyOf 1)`	object	Alternative	A Corrigo MoneyValue.
`amtUsed (anyOf 2)`	null	Alternative
`currencyTypeId`	Model	Optional	Expand Create rcs action — request body — body entity money Id
`isCredit`	boolean	Optional
`objectId`	integer	Optional	Format: int32
`objectTypeId`	Model	Optional	Expand Create actor — request body — body entity type Id
`refInvoice`	JSON	Optional
`refInvoice (anyOf 1)`	object	Alternative	A Corrigo Invoice.
`refInvoice (anyOf 2)`	null	Alternative
`refPayment`	JSON	Optional
`refPayment (anyOf 1)`	object	Alternative	A Corrigo Payment.
`refPayment (anyOf 2)`	null	Alternative

Referenced models: Create actor — request body — body entity type Id, Create rcs action — request body — body entity money Id

Create actor — request body — body entity type Id

Field	Type	Presence	Description and constraints
`$`	string	Root	One of: Unknown, Employee, Occupancy, CorrigoNet, Resident, CommLease, CommLeaseSpace, Property, Portfolio, LeaseGroup, LeaseUser, Supplier, Asset, WO, Org, Warranty, WOPrintout, Team, CompanyProp, Landmark, Provider, ReportTimeSet, TenantCoi, Model, Theme, CustomerInvoice, Payment, MhLocation, MhProduct, PmRmTemplate, Document, WoProxy, Proposal, PlWoItem, Insurance, InvTemplate, ReportSubscription, Requestor, ProcTemplateStep, Procedure, MhOrder, AssetSystem, WorkTemplate, WtWoProxy, Incident, Visit, DutyType, Estimate, Quote, WoActionLog, ProcedureTemplate, WoRequiredDoc, WoSchedule, Rounds, RoundsSchedule, RoundsStep, Specialty, ReceiptStorageRecord, MhTransaction, MhConsumptionRequest, AlertSend Format: int32

Create rcs action — request body — body entity money Id

Field	Type	Presence	Description and constraints
`$`	string	Root	One of: Unknown, SAR, BGN, TWD, CZK, DKK, EUR, USD, ILS, HUF, JPY, KRW, PLN, BRL, RON, RUB, HRK, SEK, THB, TRY, PKR, IDR, VND, AMD, MKD, ZAR, INR, MYR, KZT, KES, KHR, MMK, LKR, PHP, NGN, CNY, CHF, GBP, MXN, NOK, BND, BDT, EGP, HKD, AUD, SGD, CAD, DZD, MOP, NZD, CRC, BAM, MAD, TND, OMR, VES, COP, PEN, JOD, ARS, LBP, KWD, CLP, AED, UYU, BHD, QAR, RSD, AZN, UZS, VUV, FJD, PGK, TOP, CFP, SBD, WST, MUR, BMD Format: int32

Policy, approvals and errors

SDK function policy ID: corrigo.base_paymentitem_create. Catalog operation: base.PaymentItem.create. 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

Report an issue with this page