Wednesday, April 9, 2025

External Bank Account Creation using Rest API for Employee and Supplier

 

Process to add Bank Account to Worker/Employee when same bank account is already assigned to a Supplier.

The existing bank accounts belongs employees we can use the REST service to add join owners/Assignments.

If the you would like to use REST then it is a three step process
1. Payee Creation
2. Joint owner creation
3. Bank Account Assignment creation.

Here is the APIs list that we can use for External Bank Account. External Bank Account REST APIs

The sample payloads are below:

Step1 : Creation of Payee for employee in Payroll


/fscmRestApi/resources/latest/paymentsExternalPayees

Payload :
{
"PayeePartyIdentifier": <>,  --
PartyId from hz_parties for Employee record. Employee record can be identified from HZ_PARTY_USG_ASSIGNMENTS table
"PaymentFunctionCode": "EMPLOYEE_EXP",
"PersonId": <>, -- PERSON_ID from PER_ALL_PEOPLE_F
"Intent": "Person"
}

 

Eg: {

    "PayeePartyIdentifier"300000007944164,

    "PaymentFunctionCode""EMPLOYEE_EXP",

    "PersonId"100000077680253,

    "Intent""Person"

}



Step2: Creation of account owners

fscmRestApi/resources/latest/externalBankAccounts/{externalBankAccountId}/child/accountOwners

{
"AccountOwnerPartyIdentifier": <>, --
PartyId from hz_parties for Employee record. Employee record can be identified from HZ_PARTY_USG_ASSIGNMENTS table
"PersonId": <>, -- PERSON_ID from PER_ALL_PEOPLE_F
"Intent": "Person"
}

Eg:
{
"AccountOwnerPartyIdentifier"300000007944164,
"PersonId"100000077680253,
"Intent""Person"
}

Step3: Account assignment

/fscmRestApi/resources/latest/instrumentAssignments
{
"PaymentPartyId": -- EXT_PAYEE_ID from IBY_EXTERNAL_PAYEES_ALL table. (PAYMENT_FUNCTION = ‘HR_EMPLOYEE’)
"PaymentInstrumentId": 123456 – EXT_BANK_ACCOUNT_ID from IBY_EXT_BANK_ACCOUNTS
"PaymentFlow": "DISBURSEMENTS",
"PaymentInstrumentType": "BANKACCOUNT",
"Intent": "Person",
"PersonId": -- PERSON_ID from PER_ALL_PEOPLE_F

}

Eg; {
"PaymentPartyId":300000009400363,
"PaymentInstrumentId"43436,
"PaymentFlow""DISBURSEMENTS,
"PaymentInstrumentType""BANKACCOUNT",
"Intent""Person",
"PersonId"100000077680253
}

 

Process to add Bank Account to Supplier when same bank account is already assigned to a Worker/Employee.

 If the you would like to use REST then it is a three step process

1. Payee Creation
2. Joint owner creation
3. Bank Account Assignment creation.

The sample payloads are below:

Step1 : Creation of Payee for Supplier in Accounts Payables (This is not needed because the External Payee is created by default when the Supplier and Supplier Site  is created.)

/fscmRestApi/resources/latest/paymentsExternalPayees
{

"PayeePartyIdentifier":300000007058375, -- PartyId from hz_parties for Supplier record. Supplier record can be identified from HZ_PARTY_USG_ASSIGNMENTS table

"PayeePartySiteIdentifier": 300000007344362,  -- PARTY_SITE_ID from hz_party_sites

"SupplierSiteIdentifier": 300000007344390, - Supplier_Site_Id from poz_supplier_sites_v

"PaymentFunctionCode": "PAYABLES_DISB",

"Intent": "Supplier"

}

Step2: Creation of account owners
fscmRestApi/resources/latest/externalBankAccounts/{externalBankAccountId}/child/accountOwners

{
"AccountOwnerPartyIdentifier":
300000007058375, -- PartyId from hz_parties for Supplier record. Supplier record can be identified from HZ_PARTY_USG_ASSIGNMENTS table
"Intent": "Supplier"
}


Step3: Account assignment
/fscmRestApi/resources/latest/instrumentAssignments
{
"PaymentPartyId":
300000007470139, -- EXT_PAYEE_ID from IBY_EXTERNAL_PAYEES_ALL table. (PAYMENT_FUNCTION = ‘PAYABLES_DISB’) (EXT_PAYEE_ID at site level.)
"PaymentInstrumentId": 52001, – EXT_BANK_ACCOUNT_ID from IBY_EXT_BANK_ACCOUNTS
"PaymentFlow": "DISBURSEMENTS",
"PaymentInstrumentType": "BANKACCOUNT",
"Intent": "
Supplier"
}
 

No comments:

Post a Comment