REST API Attributes
This section provides additional details about the resources and supported attributes for the POST and PATCH actions.
Payables Payments
Payables Payments is the top-level resource that contains the information required to create and manage a payment. Here are some additional details:
Attribute Name | Supports POST | Supports PATCH |
---|---|---|
CheckId |
No |
No |
PaymentId |
No |
No |
PaymentReference |
No |
No |
PaperDocumentNumber |
No |
No |
PaymentNumber |
Yes |
No |
PaymentFileReference |
No |
No |
PaymentProcessRequest |
No |
No |
PaymentAmount |
No |
No |
PaymentDate |
Yes |
No |
AccountingDate |
No |
No |
PaymentDescription |
Yes |
No |
ConversionRate |
Yes |
No |
ConversionDate |
Yes |
No |
ConversionRateType |
Yes |
No |
ClearingDate |
No |
No |
ClearingAmount |
No |
No |
ClearingLedgerAmount |
No |
No |
ClearingConversionRate |
No |
No |
ClearingConversionDate |
No |
No |
ClearingConversionRateType |
No |
No |
CrossCurrencyRateType |
Yes |
No |
MaturityDate |
No |
No |
MaturityConversionRateType |
No |
No |
MaturityConversionDate |
No |
No |
MaturityConversionRate |
No |
No |
AnticipatedValueDate |
No |
No |
ClearingValueDate |
No |
No |
StopDate |
No |
No |
VoidDate |
No |
Yes |
VoidAccountingDate |
No |
Yes |
PaymentStatus |
No |
No |
SeparateRemittanceAdviceCreated |
No |
No |
AccountingStatus |
No |
No |
ReconciledFlag |
No |
No |
PaymentType |
Yes |
No |
PaymentCurrency |
Yes |
No |
WithheldAmount |
No |
No |
BankChargeAmount |
No |
No |
LegalEntity |
No |
No |
BusinessUnit |
Yes |
No |
PaymentFunction |
Transient |
No |
Payee |
Yes |
No |
ProcurementBU |
Transient |
No |
PayeeSite |
Yes |
No |
EmployeeAddress |
Yes |
No |
SupplierNumber |
No |
No |
ThirdPartySupplier |
Yes |
No |
ThirdPartyAddressName |
Yes |
No |
ExternalBankAccountId |
Yes |
No |
RemitToAccountNumber |
Yes |
No |
DisbursementBankAccountNumber |
No |
No |
DisbursementBankAccountName |
Yes |
No |
PaymentMethodCode |
Transient |
No |
PaymentMethod |
Yes |
No |
PaymentDocument |
Yes |
No |
PaymentProcessProfile |
Yes |
No |
DocumentCategory |
No |
No |
DocumentSequence |
No |
No |
VoucherNumber |
No |
No |
PaymentBaseAmount |
No |
No |
PaymentBaseCurrency |
No |
No |
AddressLine1 |
No |
No |
AddressLine2 |
No |
No |
AddressLine3 |
No |
No |
AddressLine4 |
No |
No |
City |
No |
No |
County |
No |
No |
Province |
No |
No |
State |
No |
No |
Country |
No |
No |
Zip |
No |
No |
CreatedBy |
No |
No |
CreationDate |
No |
No |
LastUpdatedBy |
No |
No |
LastUpdateDate |
No |
No |
LastUpdateLogin |
No |
No |
Payments Descriptive Flexfields
Payments Descriptive Flexfields is a child-level resource of Payables Payments REST API. This resource is used to manage details about the descriptive flexfield references for a payment.
Attribute Name | Supports POST | Supports PATCH |
---|---|---|
CheckId |
No |
No |
__FLEX_Context |
Yes |
Yes |
__FLEX_Context_DisplayValue |
No |
No |
Payments Global Descriptive Flexfields
Payments Global Descriptive Flexfields is a child-level resource of Payables Payments REST API. This resource is used to manage details about the global descriptive flexfield references for a payment.
Attribute Name | Supports POST | Supports PATCH |
---|---|---|
CheckId |
No |
No |
__FLEX_Context |
Yes |
Yes |
__FLEX_Context_DisplayValue |
No |
No |
Related Invoice
Related Invoices is a child-level resource of Payables Payments REST API. This resource is used to manage details of invoices related to a payment.
Attribute Name | Supports POST | Supports PATCH |
---|---|---|
InvoicePaymentId |
No |
No |
CheckId |
No |
No |
InvoiceId |
No |
No |
InvoiceBusinessUnit |
Yes |
No |
InvoiceNumber |
Yes |
No |
InstallmentNumber |
Yes |
No |
AmountPaidPaymentCurrency |
Yes |
No |
AmountPaidInvoiceCurrency |
No |
No |
DiscountLost |
No |
No |
DiscountTaken |
Yes |
No |
InvoiceBaseAmount |
No |
No |
PaymentBaseAmount |
No |
No |
InvoiceCurrency CrossCurrencyRate |
Yes |
No |
LastUpdatedBy |
Yes |
No |
LastUpdateDate |
No |
No |
CreatedBy |
No |
No |
CreationDate |
No |
No |
LastUpdateLogin |
No |
No |
Related Invoice Global Descriptive Flexfields
Related Invoice Global Descriptive Flexfields is a child-level resource of Related Invoices REST API. This resource is used to manage details about the descriptive flexfield references for an invoice payment.
Attribute Name | Supports POST | Supports PATCH |
---|---|---|
InvoicePaymentId |
No |
No |
__FLEX_Context |
Yes |
Yes |
__FLEX_Context_DisplayValue |
No |
No |