Paysheets: Required Attributes and Path Parameters

This section lists the required attributes and path parameters for the request payloads of the Paysheets resource and its child resources.

The following table shows the relation between the parent resource and its child resources.

Parent Level	Paysheets
Child Resources	Payment Transactions

The following table lists the attributes required for the POST method for Paysheets child resources.

Resource	Attribute	Attribute Description
Paysheets > Payment Transactions Note: The paysheet status should be UNPAID to create a payment transaction. You can get all unpaid paysheets by querying on the paysheet status: /fscmRestApi/resources/11.13.18.10/paysheets?q=PaysheetStatus='UNPAID'	CreditedParticipantId	The unique identifier of the incentive compensation participant who received credit for the source transaction. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.
	PayAmountPayCurrency	The payment transaction amount in the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
	PayAmountFuncCurrency	The payment transaction amount in the operating currency.
	PayAmountHomeCurrency	The payment transaction amount in the participant home currency.
	HomeCurrencyCode	The participant home currency code that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.
	PayCurrencyCode	The processing currency code for the payment transaction amount. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
	PlanComponentId	The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.

The following table lists the path parameters required for the PATCH method for Paysheets resource.

Resource	Path	Path Parameters
Paysheets	/fscmRestApi/resources/11.13.18.10/paysheets/{paysheetId}	paysheetId

The following table lists the path parameters required for the PATCH method for Paysheets child resources.

Resource	Path	Path Parameters
Paysheets > Payment Transactions	/fscmRestApi/resources/11.13.18.10/paysheets/{paysheetId}/child/paymentTransactions/{ParticipantPayId}	paysheetId ParticipantPayId

Note:

You can hold or remove hold on a payment transaction by updating the Payment Hold and providing the Payment Transaction ID of the Payment Transactions resource. For example, to remove payment hold you must provide the Payment Transaction ID and set Payment Hold attribute to 'N'. To hold a payment you must provide the Payment Transaction ID and set Payment Hold attribute to 'Y'.