Payment
Represents vendor payment transactions, including payment method, currency totals, joint payee details, payment provider references, and associated summary information.
Columns
| Name | Type | ReadOnly | Description |
| action | String | False |
The action associated with this payment, such as submit or approve. |
| auditCreatedBy | String | True |
The user who created the payment. |
| auditCreatedDateTime | Datetime | True |
The date and time when the payment was created. |
| auditModifiedBy | String | True |
The user who last modified the payment. |
| auditModifiedDateTime | Datetime | True |
The date and time when the payment was last modified. |
| bankFile_Href | String | True |
The URL of the bank file associated with this payment. |
| bankFile_Id | String | True |
The Id of the bank file associated with this payment. |
| bankFile_Key | String | True |
The system-assigned key of the bank file associated with this payment. |
| baseCurrencyCurrency | String | False |
The base currency code for this payment. |
| baseCurrencyTotalAmount | Decimal | True |
The total payment amount in the base currency. |
| baseCurrencyTotalDue | Decimal | True |
The total amount due for this payment in the base currency. |
| baseCurrencyTotalPaid | Decimal | True |
The total amount paid for this payment in the base currency. |
| baseCurrencyTotalSelected | Decimal | True |
The total amount selected for payment in the base currency. |
| cleared | String | True |
The cleared status of this payment, such as cleared or uncleared. |
| clearedDate | Date | True |
The date on which this payment was cleared. |
| description | String | False |
The description of this payment. |
| documentId | String | False |
The document Id associated with this payment. |
| documentNumber | String | False |
The document number associated with this payment. |
| entity_Href | String | True |
The URL of the entity associated with this payment. |
| entity_Id | String | True |
The Id of the entity associated with this payment. |
| entity_Key | String | True |
The system-assigned key of the entity associated with this payment. |
| entity_Name | String | True |
The name of the entity associated with this payment. |
| exchangeRateDate | Date | False |
The date used to determine the exchange rate for this payment. |
| exchangeRateRate | String | True |
The exchange rate used to convert the transaction currency to the base currency for this payment. |
| exchangeRateTypeId | String | False |
The Id of the exchange rate type used for currency conversion on this payment. |
| financialEntity_Id | String | False |
The Id of the financial entity associated with this payment. |
| href | String | True |
The URL of the payment resource. |
| id | String | True |
The unique identifier of the payment record. |
| isInclusiveTax | Bool | True |
Indicates whether the tax amount is included in the total for this payment. |
| jointPayee_Href | String | True |
The URL of the joint payee associated with this payment. |
| jointPayee_Id | String | True |
The Id of the joint payee associated with this payment. |
| jointPayee_Key | String | True |
The system-assigned key of the joint payee associated with this payment. |
| jointPayee_Name | String | True |
The name of the joint payee associated with this payment. |
| jointPayee_PrintAs | String | True |
The print-as name of the joint payee associated with this payment. |
| key [KEY] | String | True |
The system-assigned key that uniquely identifies the payment record. |
| payTo_Href | String | True |
The URL of the pay-to vendor associated with this payment. |
| payTo_Id | String | True |
The Id of the pay-to vendor associated with this payment. |
| payTo_Key | String | True |
The system-assigned key of the pay-to vendor associated with this payment. |
| paymentFileType | String | True |
The file type used when generating the payment file for this payment. |
| paymentMethod | String | False |
The payment method used for this payment, such as check or EFT. |
| paymentProvider_Href | String | True |
The URL of the payment provider associated with this payment. |
| paymentProvider_Id | String | True |
The Id of the payment provider associated with this payment. |
| paymentProvider_Key | String | True |
The system-assigned key of the payment provider associated with this payment. |
| paymentRequestMethod | String | False |
The method used to request this payment, such as online or manual. |
| paymentSubmitter | String | True |
The user who submitted this payment for processing. |
| paymentSummary_Href | String | True |
The URL of the payment summary associated with this payment. |
| paymentSummary_Id | String | True |
The Id of the payment summary associated with this payment. |
| paymentSummary_Key | String | True |
The system-assigned key of the payment summary associated with this payment. |
| paymentSummary_Name | String | True |
The name of the payment summary associated with this payment. |
| paymentSummary_PostingDate | Date | True |
The posting date of the payment summary associated with this payment. |
| recordType | String | False |
The record type that identifies the category of this payment. |
| state | String | False |
The current state of the payment, such as draft, submitted, or posted. |
| systemGenerated | String | True |
Indicates whether this payment was generated automatically by the system. |
| taxSolution_Href | String | True |
The URL of the tax solution associated with this payment. |
| taxSolution_Id | String | True |
The Id of the tax solution associated with this payment. |
| taxSolution_Key | String | True |
The system-assigned key of the tax solution associated with this payment. |
| taxSolution_TaxCalculationMethod | String | True |
The tax calculation method used by the tax solution associated with this payment. |
| txnCurrencyCurrency | String | False |
The transaction currency code for this payment. |
| txnCurrencyTotalAmount | Decimal | True |
The total payment amount in the transaction currency. |
| txnCurrencyTotalDue | Decimal | True |
The total amount due for this payment in the transaction currency. |
| txnCurrencyTotalPaid | Decimal | True |
The total amount paid for this payment in the transaction currency. |
| txnCurrencyTotalSelected | Decimal | True |
The total amount selected for payment in the transaction currency. |
| txnDate | Date | True |
The date of the transaction for this payment. |
| txnPaidDate | Date | True |
The date on which this payment was made. |
| vendor_Entity | String | True |
The entity of the vendor associated with this payment. |
| vendor_Href | String | True |
The URL of the vendor associated with this payment. |
| vendor_Id | String | False |
The Id of the vendor associated with this payment. |
| vendor_Key | String | False |
The system-assigned key of the vendor associated with this payment. |
| vendor_Name | String | True |
The name of the vendor associated with this payment. |
| ListAggregate_Details | String | False |
The aggregate list of payment details associated with this payment. |
| ListAggregate_Lines | String | False |
The aggregate list of line items associated with this payment. |