Field Name |
Description |
Field Type |
Required/Unique |
Possible Values |
Type |
Describes the type of row. Possible values are Payment, Payment Details or
Payment Detail Allocation |
|
No/No |
|
Payment ID |
The ID of the payment |
integer |
No/No |
|
Payment Batch ID |
The ID of the Payment Batch the payment belongs to |
integer |
No/No |
|
Payment Batch Type |
The type of Payment Batch the payment belongs to. It can be an Invoice Payment
Batch or Expense Payment Batch |
|
No/No |
|
Payment Batch Status |
The status of the Payment Batch the payment belongs to |
|
No/No |
|
Payment Status |
The status of the payment |
string(255) |
No/No |
|
Created At |
The date the payment was created on |
datetime |
No/No |
|
Updated At |
The date the payment was last updated on |
datetime |
No/No |
|
Exported |
A flag to check if the payment was already exported |
|
No/No |
|
Pay From Account Name |
The company payment account name used for the payment |
|
No/No |
|
Pay From Account Kind |
The company payment account type used for the payment |
|
No/No |
|
Pay From Account Currency |
The company payment account currency used for the payment |
|
No/No |
|
Pay From Account Total |
The total amount to be used for the payment from the company payment
account |
|
No/No |
|
Pay To Account Name |
The payee's payment account name |
|
No/No |
|
Pay To Account Kind |
The payee's payment account type |
|
No/No |
|
Pay to Account Currency |
The payee's payment account currency |
|
No/No |
|
Pay To Account Total |
The total amount the payee is to be paid in its account currency |
|
No/No |
|
Reporting Pay To Currency |
The reported currency for the payee |
|
No/No |
|
Reporting Pay To Total |
The reported total amount to be paid based on payee's currency |
decimal |
No/No |
|
Exchange Rate |
The exchange rate used for the payment |
decimal(30,9) |
No/No |
|
Payee ID |
A unique number identifing the payee. This is unique within each source
transaction type |
integer |
No/No |
|
Payee Name |
The name of the payee |
string(255) |
No/No |
|
Payee Display Name |
A commonly used name for the payee |
|
No/No |
|
Payee Login |
The login ID used for employees. This is blank for suppliers |
|
No/No |
|
Payee Email |
The email used by the payee to receive payment notifications |
|
No/No |
|
Payee Number |
A unique number identifing the payee. This is unique within each source
transaction type |
|
No/No |
|
Pay To Total |
The total amount to be paid |
decimal |
No/No |
|
Error Text |
Error text on completed with error payments |
text |
No/No |
|
Digital Check Number |
The digital check number when there is one attached to the payment |
|
No/No |
|
Estimated Pay From Total |
The estimated pay from total based on exchange rates loaded in the
system |
decimal |
No/No |
|
Source Name |
Source Name provided for payments loaded from external source |
string(255) |
No/No |
|
Source Reference |
Source Reference provided for payments in an external source |
string(255) |
No/No |
|
Payment Type |
The Payment Type |
|
No/No |
|
Description |
Description provided describing the payment |
string(255) |
No/No |
|
Payment Identifier |
Payment Identifier provided used to reference the payment |
string(255) |
No/No |
|
Legal Entity name |
Legal Entity name |
|
No/No |
|
Transfer Type |
Transfer Type is used by the Bank or Payment Partner and defines how a payment
will need to be processed (ACH, WIRE, Standard, Next Day, Same Day) |
string(255) |
No/No |
|
Requested Execution Date |
When sending payment instructions to a bank, the Requested Execution Date can
be used to request the bank to initiate a payment on a specific date |
datetime |
No/No |
|