Funds Disbursement Extract

Extract Structure Overview

The disbursement payment instruction
extract has a 4 level structure. Each level except the last containing
one or more sub-levels.

The top level is the payment
instruction level. One disbursement extract will have one and only
payment instruction to be delivered to the payment system. The second
level is the payment. It is called OutboundPayment to distinguish
with funds capture payment orders. One payment must have one or more
document payables. The third level is document payable. Each document
payable contains multiple document lines, located at the forth level
and equivalent to a line item of an invoice.

Element Definition Table Legend

The
table below is an example of an element definition table entitled
BankAccount.

BankAccount

<XML Tags>

Cardinality

Datatype

Description

<BankAccountID>

0..1

<Identifier>

Bank account identifier.

<BankAccountNumber>

0..n

String

Bank account number.

Each
table includes the following columns:

<XML Tags>

If indicated in boldface, it denotes the element is a complex
aggregate; otherwise it is in a normal font.

Cardinality

blank = cardinality of 1

? = cardinality of 0..1

* = cardinality of 0..n

+ = cardinality of 1..n

n = cardinality of n

Datatype

Aggregate: Complex type
consisting of child elements.

Type:
Element conforms to a custom-defined type described in its own table.
Elements that share a type have identical child elements.

Scalar:
This can be String, Integer, Real, Date, or Boolean and are the same
as equivalent SQL types.

Description

Describes
the technical or business purpose of the element.

Payment Instruction Level Elements

OutboundPaymentInstruction

OutboundPaymentInstruction

<XML Tags>

Cardinality

Datatype

Description

<PaymentInstructionInfo>

1

Aggregate

Information about the payment
instruction.

<PaymentProcessProfile>

1

Aggregate

Payment process profile used
to create this payment instruction.

<PaymentFormat>

1

Aggregate

Format of the payment instruction.

<CheckFormatInfo>

0..1

Aggregate

Check format specific information
such as paper document name and paper stock type.

<InstructionTotals>

1

Aggregate

Totals for the payment instruction,
such as the payment count.

<InstructionGrouping>

1

Aggregate

Criteria by which payments were
grouped to form the instruction; the presence of an element within
this structure indicates all payments in the instruction meet the
criterion.

<FederalInstructionInfo>

0..1

Aggregate

US Federal payment fields at
the instruction level.

<OutboundPayment>

1..n

Aggregate

Payment.

<Extend>

0..n

Aggregate

Extensibility element; to be
filled with custom user data.

PaymentInstructionInfo

PaymentInstructionInfo

<XML Tags>

Cardinality

Datatype

Description

<InstructionReferenceNumber>

1

Integer

Primary key of the payment instruction;
exposed as instruction reference number in disbursement dashboard
User Interface.

<FormatProgramRequestID>

1

Integer

Concurrent program request ID.

<InstructionCreationDate>

1

Date

Date of the payment instruction's
creation.

<MultiOrgAccessControl>

0..1

Aggregate

Multiple organizations access
control information.

<InstructionStatus>

1

<Lookup>

Current status of the instruction.

<ProcessingType>

1

String

How the payment instruction will
be processed. Possible values are: PRINTED and ELECTRONIC.

<ProcessType>

1

String

Lookup IBY_PROCESS_TYPES include
STANDARD, IMMEDIATE, and MANUAL.

<UserAssignedRefCode>

0..1

String

User (payment admin) - assigned
reference code. In case of some US Federal formats this reference
code is generated by the Federal Financials module and used as the
payment schedule number in the formats.

<BankAssignedRefCode>

0..1

String

Bank-assigned reference code.

<PaymentSequence>

Minimum 0, maximum 3

Aggregate

Store the last used payment sequence
numbers. Used to support sequential numbering of payment records across
payment files in some EFT formats.

The payment system account to
be used to send the payment instruction if applicable.

<Notes>

0..1

String

User entered notes.

<DescriptiveFlexField>

0..1

<Descriptive Flexfield>

Descriptive flexfield for the
payment instruction.

MultiOrgAccessControl

MultiOrgAccessControl

<XML Tags>

Cardinality

Datatype

Description

<HasBlockedData>

1

String

Y or N flag indicating whether
the payment instruction has payments that are not accessible (viewable)
for the user who submitted the format program. This flag is used in
the seeded Payment Instruction Register format to display a warning
(some transactions are blocked) if the flag is Y. Similar usage in
the seeded Payment Process Request Status Report.

PaymentSequence

PaymentSequence

<XML Tags>

Cardinality

Datatype

Description

<SequenceName>

1

String

Name of the periodic sequence.

<LastValue>

1

Integer

Last value of the periodic sequence.
Stored on the account payment profile.

PaymentSystemAccount

PaymentSystemAccount

<XML Tags>

Cardinality

Datatype

Description

<AccountName>

1

String

Name of the payment system account.

<AccountSettings>

0..n

Aggregate

Name value pairs of account settings.
Bank assigned identifiers are exposed through this structure.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
payment system account.

AccountSettings

AccountSettings

<XML Tags>

Cardinality

Datatype

Description

<Name>

1

String

Name of account setting.

<Value>

1

String

Value of account setting.

PaymentProcessProfile

PaymentProcessProfile

<XML Tags>

Cardinality

Datatype

Description

<PaymentProcessProfileInternalID>

1

String

Account payment process profile
ID.

<PaymentProcessProfileName>

1

String

Name of the payment process profile.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
payment process profile.

PaymentFormat

PaymentFormat

<XML Tags>

Cardinality

Datatype

Description

<PaymentFormatInternalID>

1

String

User entered code for the payment
format.

<PaymentFormatName>

1

String

Name of the payment process profile.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
payment process profile.

CheckFormatInfo

CheckFormatInfo

<XML Tags>

Cardinality

Datatype

Description

<PaymentDocumentName>

1

String

Paper document name. Derived
from the payment_document_id of the instructions table.

<PaperStockType>

0..1

<Lookup>

Paper stock type: blank or pre-numbered.

InstructionTotals

InstructionTotals

<XML Tags>

Cardinality

Datatype

Description

<PaymentCount>

1

Integer

Total number of payments in the
instruction.

<TotalPaymentAmount>

0..1

<Amount>

Total payment amount value if
the instruction is created with group by currency (single currency).

InstructionGrouping

InstructionGrouping

<XML Tags>

Cardinality

Datatype

Description

<Payment Date>

0..1

Date

Payment date for all payments
in the instruction.

<PaymentCurrency>

0..1

<Currency>

Currency of all payments in the
instruction.

<PaymentServiceRequestID>

0..1

String

Service request id for all payments
in the instruction.

<Payer>

0..1

Aggregate

First party payer for all payments
in the instruction.

<PayerOrganization>

0..1

Aggregate

First party payer organization
for all payments in the instruction.

<BankAccount>

0..1

Aggregate

Internal bank account for all
payments in the instruction.

<PaymentReason>

0..1

<Lookup with Format Value>

Payment reason for all payments
in the instruction.

<PaymentReasonComments>

0..1

String

Payment reason comments for all
payments in the instruction.

<FederalRFCIdentifier>

0..1

String

US Federal RFC Identifier applicable
to all payments in the instruction. Associated with the payer bank
branch party.

The bank account number. Formatted
for electronic transmission. In case the account number for transmission
is the same as user entered, the same value will be saved to the two
columns and extracted.

<UserEnteredBankAccountNumber>

1

String

The bank account number as user
entered. This field should be used for formats that are intended for
human read, such as checks.

<SwiftCode>

0..1

String

SWIFT code of the bank account.
Stored in HZ_CONTACT_POINTS associated with bank branch.

<IBANNumber>

0..1

String

IBAN of the bank account.

<CheckDigits>

0..1

String

Check digits of the bank account
number.

<BankAccountType>

0..1

<Lookup>

The account type.

<BankAccountCurrency>

0..1

<Currency>

Currency by which accounts funds
are denominated.

<BankAddress>

0..1

<Address>

Primary address of the bank branch.

<BankContact>

0..1

<ContactInfo>

Contact at the bank.

<PrimaryOwner>

1

Aggregate

Primary owner of bank account
in case of single/joint owned; payment factor party in case of factor
bank account.

<FactorAccount>

0..1

<Lookup>

Y or N flag indicating if the
bank account is a factor account.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
bank account.

<BranchDescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
bank branch. From the HZ party of the bank branch.

PrimaryOwner

PrimaryOwner

<XML Tags>

Cardinality

Datatype

Description

<Name>

1

String

Party name of the primary owner
or payment factor.

Beneficiary

Beneficiary

<XML Tags>

Cardinality

Datatype

Description

<Name>

1

String

Party name of the actual beneficiary
or payee.

Payer

Payer

<XML Tags>

Cardinality

Datatype

Description

<PartyInternalID>

1

Integer

The party that is linked to the
legal entity.

<PartyNumber>

1

String

Party number.

<Name>

1

String

Full name of the party.

<TaxRegistrationNumber>

0..1

String

Tax registration number.

Use this element if the data
was previously stored in FINANCIALS_SYSTEM_PARAMETERS_ALL.VAT_REGISTRATION_NUM
in 11i.

<LegalEntityRegistrationNumber>

0..1

String

Legal entity registration number.
Use this element if the data was previously stored in AP_REPORTING_ENTITIES_ALL.TAX_IDENTIFICATION_NUM
in 11i.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
party record.

<LegalEntityInternalID>

1

Integer

Legal entity stamped on the payments.
Owner of the transactions.

<LegalEntityName>

1

String

Legal entity name.

<Address>

1

<Address>

Legal entity address.

<ContactInfo>

0..1

<ContactInfo>

Contact at the first party.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
legal entity record.

BankAccount

BankAccount

<XML Tags>

Cardinality

Datatype

Description

<BankAccountInternalID>

1

Integer

Primary key of the CE (internal)
bank account table.

<BankName>

0..1

String

Bank name.

<BankNumber>

0..1

String

Bank number. From the HZ organization
profile linked to the bank party.

<BranchInternalID>

1

Integer

Party id of the bank branch party.

<BranchName>

0..1

String

Name of the bank branch.

<AlternateBranchName>

0..1

String

Alternate name of the bank branch.

<BranchNumber>

0..1

String

Number of the bank branch. From
the HZ organization profile linked to the bank branch party.

<BankAccountName>

1

String

Name of the bank account.

<AlternateBankAccountName>

0..1

String

Alternate name of the bank account.

<BankAccountNumber>

1

String

The bank account number. Formatted
for electronic transmission. In case the account number for transmission
is the same as user entered, the same value will be saved to the two
columns and extracted.

<UserEnteredBankAccountNumber>

1

String

The bank account number as user
entered. This field should be used for formats that are intended for
human read, such as checks.

<SwiftCode>

0..1

String

SWIFT code of the bank account.
Stored in HZ_CONTACT_POINTS associated with bank branch.

<IBANNumber>

0..1

String

IBAN of the bank account.

<CheckDigits>

0..1

String

Check digits of the bank account
number.

<BankAccountType>

1

<Lookup>

The account type.

<BankAccountCurrency>

1

<Currency>

Currency by which accounts funds
are denominated.

<BankAddress>

1

<Address>

Primary address of the bank branch.

<BankContact>

0..1

<ContactInfo>

Contact at the bank.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
bank account.

<BranchDescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
bank branch. From the HZ party of the bank branch.

<FederalBankAccountInfo>

0..1

Aggregate

Additional information for use
by US Federal customers.

<EFTUserNumber>

0..1

Aggregate

EFT numbers assigned by the bank
to the user.

FederalBankAccountInfo

FederalBankAccountInfo

<XML Tags>

Cardinality

Datatype

Description

<FederalRFCIdentifier>

1

String

Identifier of the US Treasury
Regional Finance Center (RFC) from which the disbursement should originate
for federal agencies. Stored in HZ_CODE_ASSIGNMENTS with CLASS_CATEGORY
as RFC_IDENTIFIER, associated with the bank branch party.

<FederalAgencyLocationCode>

1

String

US Federal Agency Location Code
used by federal agency.

<FederalAbbreviatedAgencyCode>

1

String

US Federal Abbreviated Agency
Code.

<FederalEmployerIdentificationNumber>

1

String

US Federal Employer ID.

EFTUserNumber

EFTUserNumber

<XML Tags>

Cardinality

Datatype

Description

<AccountLevelEFTNumber>

1

String

Account-level EFT user number.

<BranchLevelEFTNumber>

1

String

Branch-level EFT user number.

PaymentMethod

PaymentMethod

<XML Tags>

Cardinality

Datatype

Description

<PaymentMethodInternalID>

1

String

Internal id of the payment method.

<PaymentMethodName>

1

String

Describes the payment method.

<PaymentMethodFormatValue>

1

String

This field is currently mapped
to the same DB column as PaymentMethodInternalID, pending the change
to add it's own column.

<DescriptiveFlexField>

0..1

<Descriptive Flex Field>

Descriptive flexfield for the
payment method.

DiscountTaken

DiscountTaken

<XML Tags>

Cardinality

Datatype

Description

<Amount>

1

<Amount>

Amount of discount taken. In
payment currency.

<DiscountDate>

1

Date

Discount date. Available at document
payable level only.

BankCharges

BankCharges

<XML Tags>

Cardinality

Datatype

Description

<BankChargeBearer>

1

<Lookup>

Bank charge bearer lookup.

<Amount>

0..1

<Amount>

Bank charge amount in payment
currency. The amount is only available at the payment level.

UniqueRemittanceIdentifier

UniqueRemittanceIdentifier

<XML Tags>

Cardinality

Datatype

Description

<Number>

1

String

Unique remittance identifier.

<CheckDigit>

0..1

String

Check digit.

RegulatoryReporting

RegulatoryReporting

<XML Tags>

Cardinality

Datatype

Description

<DeclarationFlag>

1

String

Y or N flag indicating whether
this payment needs to be reported to the central bank.

<Amount>

1

<Amount>

Declared payment amount in the
declaration currency.

FederalPaymentInfo

FederalPaymentInfo

<XML Tags>

Cardinality

Datatype

Description

<FederalAllotmentCode>

1

String

US Federal Allotment code.

<FederalOffsetEligibilityFlag>

1

String

Y or N flag indicating if the
payment can be used for US Treasury offset.

Code for the document type. The
document type is a concatenation of the calling product doc types,
such as STANDARD, CREDIT, DEBIT, INTEREST, PREPAYMENT, MIXED, or AWT
for Oracle Payables and BAT for Cash Management Bank Account Transfer.

<DocumentDescription>

0..1

String

Free text description of the
document payable.

<ExpenseReportCreditCardNumber>

0..1

String

Credit card number for expense
report with Oracle iExpense.

<EmployeePaymentFlag>

0..1

String

Y or N flag indicating if the
payment is for an employee, that is, the payee is an employee. This
is a hard-coded grouping rule for creating payments, where the documents
of a payment must all have the same Employee Payment Flag value –
either Y or N.

<TotalDocumentAmount>

0..1

<Amount>

Total amount specified on the
document in the document currency.

<PaymentAmount>

1

<Amount>

Payment amount in payment currency.

<PayAloneFlag>

0..1

String

Y or N flag indicating if the
document should be paid by its own payment.

Pre-formatted concatenated address.
Address fields are concatenated with the space as separator. Address
fields are ordered according to country address format styles. This
version of per-formatted address can be used in EFT formats.

<PreFormattedMailingAddress>

1

String

Pre-formatted mailing address
with embedded line breaks. Generated by TCA with the Postal Address
TCA style. Address fields are ordered according to country address
format conventions.

<AddressName>

1

String

HR location code for payer; vendor
site name or party site name for payee.

<AlternateAddressName>

0..1

String

For payee address only. Alternate
vendor site code.

Bank Account Address

Internal and external bank account
addresses come from the HZ locations table. The internal (payer) bank
account address is obtained based on the int_bank_branch_location_id
column in the payments table; while the external (payee) bank account
address is based on ext_bank_branch_location_id.

The elements are similar to those
of payer/payee addresses, except they do not have the AddressName
and AlternateAddressName elements.