Payment Batches
paymentBatches Based on latest (2026.09)
Create and look up Payment Batches, with payment transactions and paysheets.
- Operations
- GET (list)GET (one)POST (create)
- Record key
PayrunId- Required on create
PayGroupIdPayPeriodIdPayrunName- At a glance
- 19 fields1 finders3 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/paymentBatches?fields=CreatedBy,CreationDate,EarningsCalculatedBy,IncentiveTypeCode,LastUpdateDate&limit=25&onlyData=true
{
"items": [
{
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"EarningsCalculatedBy": "ALL",
"IncentiveTypeCode": "ALL",
"LastUpdateDate": "2026-01-31T09:00:00+00:00"
}
],
"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 latest (2026.09) REST specification.
Fields 19
| Attribute | Type | Use |
|---|---|---|
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EarningsCalculatedBy | text · max 30 · default ALL | Optional on createSearchable |
IncentiveTypeCode | text · max 30 · default ALL | Optional on createSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
OrgId | number | Optional on createSearchable |
OrgName | text · max 960 | Read-onlySearchable |
PayGroupId | number | Required on createSearchable |
PayGroupName | text · max 80 | Read-onlySearchable |
PayPeriodId | number | Required on createSearchable |
PaymentDate | date | Optional on createSearchable |
PayrunId | number | Optional on createSearchable |
PayrunName | text · max 80 | Required on createSearchable |
PeriodName | text · max 30 | Read-onlySearchable |
ReportGroup | text · max 30 | Optional on createSearchable |
RequestId | number | Optional on createSearchable |
Status | text · max 30 · default UNPAID | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
FindPaymentBatches·businessUnitpayGroupNamepayPeriodpayrunNamestatus
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 3
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/<name>. Add them to a GET with expand.
paymentTransactionsGET · POST · PATCH · DELETE Payment Transactions · 42 fields · 1 findersAdjustCommentsCommAmountCalculationCurrencyCommissionValueCreatedByCreationDateCreditFactorCreditTypeIdCreditedParticipantIdEarningFactorEarningHIdEarningIdEarningTypeEligibleCatIdHoldFlagHomeCurrencyCodeIncentiveTypeCodeLastUpdateDateLastUpdateLoginLastUpdatedByManualAdjustmentReasonCodeObjectStatusOrgIdParticipantIdParticipantNameParticipantPayIdPayAmountFuncCurrencyPayAmountHomeCurrencyPayAmountPayCurrencyPayCurrencyCodePayPeriodIdPaymentTransactionDeleteFlagPaymentTransactionUpdateFlagPayrunIdPayrunNamePersonNumberPlanComponentIdPrimaryWorkerNumberRecoverableFlagSourceEarningIdSourceEventDateSourceTrxNumberSrpPlanAssignIdpaysheetsGET · PATCH Paysheets · 39 fields · 2 findersBeginningBalanceAmountCalculatedEarningsChequeNumberEarningDifferenceLastUpdateDateLastUpdateLoginLastUpdatedByNonRecEarningAdjustmentOrgIdOrgNameParticipantIdParticipantNamePartyIdPartyNumberPayCurrencyCodePayGroupIdPayGroupNamePayPeriodIdPaymentAdjustmentAmountPaymentDatePaymentMethodPaymentTotalAmountPayrunIdPayrunNamePaysheetDeleteFlagPaysheetIdPaysheetStatusPaysheetUpdateFlagPeriodIdPeriodNamePersonNumberPlanComponentIdPlanComponentNamePmtAmountRecoveryPrimaryWorkerNumberRecEarningAdjustmentSrpCompensationPlanIdTotalAmountHomeCurrencyTotalAmountPayToHomeCnvrtpaymentTransactionsGET · POST · PATCH · DELETE Payment Transactions · 42 fields · 1 findersAdjustCommentsCommAmountCalculationCurrencyCommissionValueCreatedByCreationDateCreditFactorCreditTypeIdCreditedParticipantIdEarningFactorEarningHIdEarningIdEarningTypeEligibleCatIdHoldFlagHomeCurrencyCodeIncentiveTypeCodeLastUpdateDateLastUpdateLoginLastUpdatedByManualAdjustmentReasonCodeObjectStatusOrgIdParticipantIdParticipantNameParticipantPayIdPayAmountFuncCurrencyPayAmountHomeCurrencyPayAmountPayCurrencyPayCurrencyCodePayPeriodIdPaymentTransactionDeleteFlagPaymentTransactionUpdateFlagPayrunIdPayrunNamePersonNumberPlanComponentIdPrimaryWorkerNumberRecoverableFlagSourceEarningIdSourceEventDateSourceTrxNumberSrpPlanAssignId
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/paymentBatchesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
FindPaymentBatchesfor 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:EarningsCalculatedBy, notearningscalculatedby. - 9 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- 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.