Payables Interface Invoices
payablesInterfaceInvoices Based on 26C
Create, change, delete and look up Payables Interface Invoices, with interface invoice lines and interface invoice rejections. Actions include submit import invoices and interface rejections.
The record key payablesInterfaceInvoicesUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE4 actions
- Record key
payablesInterfaceInvoicesUniqID- Required on create
InvoiceAmountInvoiceNumber- At a glance
- 192 fields3 finders4 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/payablesInterfaceInvoices?fields=AcctsPayCodeCombinationId,AddTaxToInvoiceAmountFlag,AmountApplicableToDiscount,ApplicationId,ApplyAdvancesFlag&limit=25&onlyData=true
{
"items": [
{
"AcctsPayCodeCombinationId": 0,
"AddTaxToInvoiceAmountFlag": false,
"AmountApplicableToDiscount": 0,
"ApplicationId": 200,
"ApplyAdvancesFlag": false
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's 26C REST specification.
Fields 192
| Attribute | Type | Use |
|---|---|---|
AcctsPayCodeCombinationId | number | Optional on createUpdatableSearchable |
AddTaxToInvoiceAmountFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
AmountApplicableToDiscount | number | Optional on createUpdatableSearchable |
ApplicationId | number · default 200 | Optional on createUpdatableSearchable |
ApplyAdvancesFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
Attribute1 | text · max 150 | Optional on createUpdatableSearchable |
Attribute10 | text · max 150 | Optional on createUpdatableSearchable |
Attribute11 | text · max 150 | Optional on createUpdatableSearchable |
Attribute12 | text · max 150 | Optional on createUpdatableSearchable |
Attribute13 | text · max 150 | Optional on createUpdatableSearchable |
Attribute14 | text · max 150 | Optional on createUpdatableSearchable |
Attribute15 | text · max 1000 | Optional on createUpdatableSearchable |
Attribute2 | text · max 150 | Optional on createUpdatableSearchable |
Attribute3 | text · max 150 | Optional on createUpdatableSearchable |
Attribute4 | text · max 150 | Optional on createUpdatableSearchable |
Attribute5 | text · max 150 | Optional on createUpdatableSearchable |
Attribute6 | text · max 150 | Optional on createUpdatableSearchable |
Attribute7 | text · max 150 | Optional on createUpdatableSearchable |
Attribute8 | text · max 150 | Optional on createUpdatableSearchable |
Attribute9 | text · max 150 | Optional on createUpdatableSearchable |
AttributeCategory | text · max 150 | Optional on createUpdatableSearchable |
AttributeDate1 | date | Optional on createUpdatableSearchable |
AttributeDate2 | date | Optional on createUpdatableSearchable |
AttributeDate3 | date | Optional on createUpdatableSearchable |
AttributeDate4 | date | Optional on createUpdatableSearchable |
AttributeDate5 | date | Optional on createUpdatableSearchable |
AttributeNumber1 | number | Optional on createUpdatableSearchable |
AttributeNumber2 | number | Optional on createUpdatableSearchable |
AttributeNumber3 | number | Optional on createUpdatableSearchable |
AttributeNumber4 | number | Optional on createUpdatableSearchable |
AttributeNumber5 | number | Optional on createUpdatableSearchable |
AwtGroupId | number | Optional on createUpdatableSearchable |
AwtGroupName | text · max 50 | Optional on createUpdatableSearchable |
BankAccountNumber | text | Optional on createUpdatable |
BankChargeBearer | text · max 30 | Optional on createUpdatableSearchable |
BudgetDate | date | Optional on createUpdatableSearchable |
CalculateTaxDuringImportFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
ControlAmount | number | Optional on createUpdatableSearchable |
CorrectionPeriod | text · max 15 | Optional on createUpdatableSearchable |
CorrectionYear | number | Optional on createUpdatableSearchable |
CreationDate | date-time | Read-onlySearchable |
CustomerRegistrationCode | text · max 30 | Optional on createUpdatableSearchable |
CustomerRegistrationNumber | text · max 30 | Optional on createUpdatableSearchable |
DeliveryChannelCode | text · max 30 | Optional on createUpdatableSearchable |
Description | text · max 240 | Optional on createUpdatableSearchable |
DigitalPaymentAccountName | text · max 150 | Optional on createUpdatableSearchable |
DocumentCategoryCode | text · max 30 | Optional on createUpdatableSearchable |
DocumentSubType | text · max 150 | Optional on createUpdatableSearchable |
ExchangeDate | date | Optional on createUpdatableSearchable |
ExchangeRate | number | Optional on createUpdatableSearchable |
ExchangeRateType | text · max 30 | Optional on createUpdatableSearchable |
ExclusivePaymentFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ExternalBankAccountIBANNumber | text · max 50 | Optional on createUpdatableSearchable |
ExternalBankAccountId | number | Optional on createUpdatableSearchable |
ExternalDocumentReference | text · max 240 | Optional on createUpdatableSearchable |
FirstPartyRegistrationId | number | Optional on createUpdatableSearchable |
FirstPartyRegistrationNumber | text · max 60 | Optional on createUpdatableSearchable |
GlDate | date | Optional on createUpdatableSearchable |
GlobalAttribute1 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute10 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute11 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute12 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute13 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute14 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute15 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute16 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute17 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute18 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute19 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute2 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute20 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute3 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute4 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute5 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute6 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute7 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute8 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttribute9 | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttributeCategory | text · max 150 | Optional on createUpdatableSearchable |
GlobalAttributeDate1 | date | Optional on createUpdatableSearchable |
GlobalAttributeDate2 | date | Optional on createUpdatableSearchable |
GlobalAttributeDate3 | date | Optional on createUpdatableSearchable |
GlobalAttributeDate4 | date | Optional on createUpdatableSearchable |
GlobalAttributeDate5 | date | Optional on createUpdatableSearchable |
GlobalAttributeNumber1 | number | Optional on createUpdatableSearchable |
GlobalAttributeNumber2 | number | Optional on createUpdatableSearchable |
GlobalAttributeNumber3 | number | Optional on createUpdatableSearchable |
GlobalAttributeNumber4 | number | Optional on createUpdatableSearchable |
GlobalAttributeNumber5 | number | Optional on createUpdatableSearchable |
GoodsReceivedDate | date | Optional on createUpdatableSearchable |
GroupId | text · max 80 | Optional on createUpdatableSearchable |
ImageDocumentNumber | text · max 50 | Optional on createUpdatableSearchable |
ImageDocumentUri | text · max 4000 | Optional on createUpdatableSearchable |
ImportDocumentDate | date | Optional on createUpdatableSearchable |
ImportDocumentNumber | text · max 50 | Optional on createUpdatableSearchable |
ImportRequestId | number | Read-onlySearchable |
InitBusinessUnitTransient | number | Read-onlySearchable |
InitExceptionCategoryTransient | text | Read-onlySearchable |
InitOwnerTransient | text | Read-onlySearchable |
InitSourceTransient | text | Read-onlySearchable |
IntercompanyCrossChargeFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
InvoiceAmount | number | Required on createUpdatableSearchable |
InvoiceCurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
InvoiceDate | date | Optional on createUpdatableSearchable |
InvoiceId | number | Read-onlySearchable |
InvoiceIncludesPrepayFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
InvoiceNumber | text · max 50 | Required on createUpdatableSearchable |
InvoiceReceivedDate | date | Optional on createUpdatableSearchable |
InvoiceRecordNumber | text | Optional on createUpdatable |
InvoiceTypeLookupCode | text · max 25 · default STANDARD | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LegalEntityId | number | Optional on createUpdatableSearchable |
LegalEntityName | text · max 240 | Optional on createUpdatableSearchable |
LoadRequestId | number · default -1 | Read-onlySearchable |
LogicalDocumentId | number | Optional on createUpdatableSearchable |
NetOfRetainageFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
NoXrateBaseAmount | number | Optional on createUpdatableSearchable |
OperatingUnit | text · max 240 | Optional on createUpdatableSearchable |
OrgId | number | Optional on createUpdatableSearchable |
Owner | text · max 255 | Read-only |
PONumber | text · max 30 | Optional on createUpdatableSearchable |
PaidOnBehalfEmployeeId | number | Optional on createUpdatableSearchable |
PartyId | number | Optional on createUpdatableSearchable |
PartySiteId | number | Optional on createUpdatableSearchable |
PayGroupLookupCode | text · max 25 | Optional on createUpdatableSearchable |
PayProcTrxnTypeCode | text · max 30 | Optional on createUpdatableSearchable |
PaymentCrossRate | number · default 1 | Optional on createUpdatableSearchable |
PaymentCrossRateDate | date | Optional on createUpdatableSearchable |
PaymentCrossRateType | text · max 30 | Optional on createUpdatableSearchable |
PaymentCurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
PaymentFunction | text · max 30 | Optional on createUpdatableSearchable |
PaymentMethodCode | text · max 30 | Optional on createUpdatableSearchable |
PaymentMethodLookupCode | text · max 25 | Optional on createUpdatableSearchable |
PaymentPriority | number | Optional on createUpdatableSearchable |
PaymentReasonCode | text · max 30 | Optional on createUpdatableSearchable |
PaymentReasonComments | text · max 240 | Optional on createUpdatableSearchable |
PortOfEntryCode | text · max 30 | Optional on createUpdatableSearchable |
PrepayApplyAmount | number | Optional on createUpdatableSearchable |
PrepayGlDate | date | Optional on createUpdatableSearchable |
PrepayLineNumber | number | Optional on createUpdatableSearchable |
PrepayNumber | text · max 50 | Optional on createUpdatableSearchable |
ProductTable | text · max 30 | Optional on createUpdatableSearchable |
Queues | text · max 255 | Read-only |
Reference1 | text · max 30 | Optional on createUpdatableSearchable |
Reference2 | text · max 30 | Optional on createUpdatableSearchable |
ReferenceKey1 | text · max 4000 | Optional on createUpdatableSearchable |
ReferenceKey2 | text · max 150 | Optional on createUpdatableSearchable |
ReferenceKey3 | text · max 150 | Optional on createUpdatableSearchable |
ReferenceKey4 | text · max 150 | Optional on createUpdatableSearchable |
ReferenceKey5 | text · max 150 | Optional on createUpdatableSearchable |
RemitToAddressName | text · max 240 | Optional on createUpdatableSearchable |
RemitToSupplierName | text · max 240 | Optional on createUpdatableSearchable |
RemitToSupplierNumber | text · max 30 | Optional on createUpdatableSearchable |
RemittanceMessage1 | text · max 150 | Optional on createUpdatableSearchable |
RemittanceMessage2 | text · max 150 | Optional on createUpdatableSearchable |
RemittanceMessage3 | text · max 150 | Optional on createUpdatableSearchable |
RequesterEmailAddress | text · max 240 | Optional on createUpdatableSearchable |
RequesterEmployeeNumber | text · max 30 | Optional on createUpdatableSearchable |
RequesterFirstName | text · max 150 | Optional on createUpdatableSearchable |
RequesterId | number | Optional on createUpdatableSearchable |
RequesterLastName | text · max 150 | Optional on createUpdatableSearchable |
RoutingAttribute1 | text · max 270 | Optional on createUpdatableSearchable |
RoutingAttribute2 | text · max 270 | Optional on createUpdatableSearchable |
RoutingAttribute3 | text · max 270 | Optional on createUpdatableSearchable |
RoutingAttribute4 | text · max 270 | Optional on createUpdatableSearchable |
RoutingAttribute5 | text · max 270 | Optional on createUpdatableSearchable |
SettlementPriority | text · max 30 | Optional on createUpdatableSearchable |
ShipToLocation | text · max 40 | Optional on createUpdatableSearchable |
Source | text · max 80 · default INVOICE GATEWAY | Optional on createUpdatableSearchable |
Status | text · max 25 | Optional on createUpdatableSearchable |
SupplierTaxExchangeRate | number | Optional on createUpdatableSearchable |
SupplierTaxInvoiceDate | date | Optional on createUpdatableSearchable |
SupplierTaxInvoiceNumber | text · max 150 | Optional on createUpdatableSearchable |
TaxInvoiceInternalSequence | text · max 150 | Optional on createUpdatableSearchable |
TaxInvoiceRecordingDate | date | Optional on createUpdatableSearchable |
TaxRelatedInvoiceId | number | Optional on createUpdatableSearchable |
TaxationCountry | text · max 30 | Optional on createUpdatableSearchable |
TermsDate | date | Optional on createUpdatableSearchable |
TermsId | number | Optional on createUpdatableSearchable |
TermsName | text · max 50 | Optional on createUpdatableSearchable |
ThirdPartyRegistrationId | number | Optional on createUpdatableSearchable |
ThirdPartyRegistrationNumber | text · max 60 | Optional on createUpdatableSearchable |
TransientAccount | text | Optional on createUpdatableSearchable |
UniqueRemittanceIdentifier | text · max 256 | Optional on createUpdatableSearchable |
UriCheckDigit | text · max 2 | Optional on createUpdatableSearchable |
VendorEmailAddress | text · max 2000 | Optional on createUpdatableSearchable |
VendorId | number | Optional on createUpdatableSearchable |
VendorName | text · max 240 | Optional on createUpdatableSearchable |
VendorNumber | text · max 30 | Optional on createUpdatableSearchable |
VendorSiteCode | text · max 240 | Optional on createUpdatableSearchable |
VendorSiteId | number | Optional on createUpdatableSearchable |
VoucherNumber | text · max 50 | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByB2BInvoiceStatus·ChannelPartnerReferenceCreationDateFromCreationDateToImportRequestNumberImportSetSupplierNotifiedfindByProcessedStatus·ChannelPartnerReferenceCreationDateFromCreationDateToImportRequestNumberImportSetInvoiceSourcefindBySpreadsheetSearch·BusinessUnitBusinessUnitIdCreationDateFromCreationDateToExceptionCategoryHeadersOnlyImportErrorImportSetInvoiceNumberInvoiceSourceLedgerIdLineNumberFromLineNumberToNoOfInvoicesOwnerQueueShowOnlyErrorLinesSupplierSupplierIdSupplierSiteSupplierSiteIdTotalNoOfInvoiceLines
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 4
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/payablesInterfaceInvoices/{payablesInterfaceInvoicesUniqID}/child/<name>. Add them to a GET with expand.
attachmentsGET · POST · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameinterfaceInvoiceLinesGET · POST · PATCH · DELETE Interface Invoice Lines · 215 fields · 2 findersAccountSegmentAccountingDateAmountApplicationIdAssessableValueAssetBookTypeCodeAssetCategoryIdAssetsTrackingFlagAttribute1Attribute10Attribute11Attribute12Attribute13Attribute14Attribute15Attribute2Attribute3Attribute4Attribute5Attribute6Attribute7Attribute8Attribute9AttributeCategoryAwardIdAwtGroupIdAwtGroupNameBalancingSegmentBudgetDateConsumptionAdviceHeaderIdConsumptionAdviceLineIdConsumptionAdviceLineNumberConsumptionAdviceNumberControlAmountCostCenterSegmentCostFactorIdCreationDateCreditCardTrxIdDefAcctgAccrualCcidDefAcctgEndDateDefAcctgStartDateDefaultDistCcidDescriptionDistCodeCombinationIdDistCodeConcatenatedDistributionSetIdDistributionSetNameExpenditureItemDateExpenditureOrganizationIdExpenditureTypeExternalDocumentLineReferenceFinalDischargeLocationCodeFinalDischargeLocationIdFinalMatchFlagFiscalChargeTypeGlobalAttribute1GlobalAttribute10GlobalAttribute11GlobalAttribute12GlobalAttribute13GlobalAttribute14GlobalAttribute15GlobalAttribute16GlobalAttribute17GlobalAttribute18GlobalAttribute19GlobalAttribute2GlobalAttribute20GlobalAttribute3GlobalAttribute4GlobalAttribute5GlobalAttribute6GlobalAttribute7GlobalAttribute8GlobalAttribute9GlobalAttributeCategoryInclInTaxableLineFlagIncomeTaxRegionInventoryItemIdInvoiceIdInvoiceLineIdItemDescriptionLastUpdateDateLcmEnabledFlagLineGroupNumberLineNumberLineTypeLookupCodeLoadRequestIdManufacturerMatchOptionModelNumberOrgIdPJC_RESERVED_ATTRIBUTE1PJC_RESERVED_ATTRIBUTE10PJC_RESERVED_ATTRIBUTE2PJC_RESERVED_ATTRIBUTE3PJC_RESERVED_ATTRIBUTE4PJC_RESERVED_ATTRIBUTE5PJC_RESERVED_ATTRIBUTE6PJC_RESERVED_ATTRIBUTE7PJC_RESERVED_ATTRIBUTE8PJC_RESERVED_ATTRIBUTE9PJC_USER_DEF_ATTRIBUTE1PJC_USER_DEF_ATTRIBUTE10PJC_USER_DEF_ATTRIBUTE2PJC_USER_DEF_ATTRIBUTE3PJC_USER_DEF_ATTRIBUTE4PJC_USER_DEF_ATTRIBUTE5PJC_USER_DEF_ATTRIBUTE6PJC_USER_DEF_ATTRIBUTE7PJC_USER_DEF_ATTRIBUTE8PJC_USER_DEF_ATTRIBUTE9PODistributionIdPODistributionNumberPOHeaderIdPOLineIdPOLineLocationIdPOLineNumberPONumberPOReleaseIdPOShipmentNumberPaAdditionFlagPaCcArInvoiceIdPaCcArInvoiceLineNumberPaCcProcessedCodePaQuantityPackingSlipPjcBillableFlagPjcCapitalizableFlagPjcContextCategoryPjcContractIdPjcContractLineIdPjcContractNamePjcContractNumberPjcExpenditureItemDatePjcExpenditureTypeIdPjcExpenditureTypeNamePjcFundingAllocationIdPjcFundingSourceNamePjcFundingSourceNumberPjcOrganizationIdPjcOrganizationNamePjcProjectIdPjcProjectNamePjcProjectNumberPjcTaskIdPjcTaskNamePjcTaskNumberPjcWorkTypePjcWorkTypeIdPriceCorrectInvLineNumberPriceCorrectInvNumberPriceCorrectionFlagPrimaryIntendedUseProductCategoryProductFiscClassificationProductTableProductTypeProjectIdProrateAcrossFlagPurchasingCategoryPurchasingCategoryIdQuantityInvoicedQueuesRcvShipmentHeaderIdRcvTransactionIdReceiptLineNumberReceiptNumberReference1Reference2ReferenceKey1ReferenceKey2ReferenceKey3ReferenceKey4ReferenceKey5ReleaseNumberRequesterEmailAddressRequesterEmployeeNumberRequesterFirstNameRequesterIdRequesterLastNameSerialNumberShipFromLocationCodeShipFromLocationIdShipToLocationCodeShipToLocationIdSourceApplicationIdSourceEntityCodeSourceEventClassCodeSourceLineIdSourceTrxIdSourceTrxLevelTypeStatAmountTaskIdTaxTaxClassificationCodeTaxCodeTaxCodeIdTaxJurisdictionCodeTaxRateTaxRateCodeTaxRateIdTaxRegimeCodeTaxStatusCodeTaxableFlagTransientAccountTransientAccrualAccountTransientProjectDFFTrxBusinessCategoryType1099UnitOfMeasLookupCodeUnitPriceUserDefinedFiscClassVendorItemNumberWarrantyNumberinterfaceInvoiceLineRejectionsGET Interface Invoice Line Rejections · 21 fields · 1 findersRejectionDescriptionTokenNameEightTokenNameFiveTokenNameFourTokenNameNineTokenNameOneTokenNameSevenTokenNameSixTokenNameTenTokenNameThreeTokenNameTwoTokenValueEightTokenValueFiveTokenValueFourTokenValueNineTokenValueOneTokenValueSevenTokenValueSixTokenValueTenTokenValueThreeTokenValueTwointerfaceInvoiceRejectionsGET Interface Invoice Rejections · 21 fields · 1 findersRejectionDescriptionTokenNameEightTokenNameFiveTokenNameFourTokenNameNineTokenNameOneTokenNameSevenTokenNameSixTokenNameTenTokenNameThreeTokenNameTwoTokenValueEightTokenValueFiveTokenValueFourTokenValueNineTokenValueOneTokenValueSevenTokenValueSixTokenValueTenTokenValueThreeTokenValueTwo
Actions 4
POST …/action/submitImportInvoices·OrgIdSummarizeReportPurgeImportSetAccountingDateInvoiceGroupHoldSourceHoldReasonPOST …/{payablesInterfaceInvoicesUniqID}/action/interfaceRejectionsPOST …/{payablesInterfaceInvoicesUniqID}/child/interfaceInvoiceLines/action/submitImportInvoices·OrgIdSummarizeReportPurgeImportSetAccountingDateInvoiceGroupHoldSourceHoldReasonPOST …/{payablesInterfaceInvoicesUniqID}/child/interfaceInvoiceLines/{InvoiceLineId}/action/interfaceLineRejections
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/payablesInterfaceInvoicesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByB2BInvoiceStatusfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AcctsPayCodeCombinationId, notacctspaycodecombinationid. - 11 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.