Get a payment
get
/fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}
Request
Path Parameters
-
CheckId(required): integer(int64)
The unique identifier assigned to every payment made.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : payablesPayments-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Read Only:
trueThe date when the payment is to be accounted. -
AccountingStatus: string
Read Only:
trueMaximum Length:255The accounting status of the payment. -
AddressLine1: string
Title:
Address Line 1Maximum Length:240The first address line of the party to whom the payment is made. -
AddressLine2: string
Title:
Address Line 2Maximum Length:240The second address line of the party to whom the payment is made. -
AddressLine3: string
Title:
Address Line 3Maximum Length:240The third address line of party to whom the payment is made. -
AddressLine4: string
Title:
Address Line 4Maximum Length:240The fourth address line of the party to whom the payment is made. -
AnticipatedValueDate: string
(date)
Title:
Anticipated Value DateRead Only:trueThe date when the funds are anticipated to be disbursed by the bank. -
BankChargeAmount: number
Read Only:
trueThe bank charge amount in the payment currency. -
BusinessUnit: string
Title:
Business UnitMaximum Length:240The business unit name for the payment. -
CheckId: integer
(int64)
Read Only:
trueThe unique identifier assigned to every payment made. -
City: string
Title:
CityMaximum Length:60The city name of the party to whom the payment is made. -
ClearingAmount: number
Read Only:
trueThe payment amount cleared against payment in cash management. -
ClearingConversionDate: string
(date)
Read Only:
trueThe date when the clearing conversion rate is effective, which is usually the accounting date of a transaction. -
ClearingConversionRate: number
Read Only:
trueThe conversion rate at which the payment is cleared. The resource is only used for foreign currency payments. -
ClearingConversionRateType: string
Title:
Conversion Rate TypeRead Only:trueMaximum Length:30The conversion rate type at which the payment is cleared. This attribute is only used for foreign currency payments. -
ClearingDate: string
(date)
Read Only:
trueThe date when the payment is cleared in cash management. -
ClearingLedgerAmount: number
Read Only:
trueThe payment cleared amount in functional currency. -
ClearingValueDate: string
(date)
Read Only:
trueThe date when the bank disburses funds. -
ConversionDate: string
(date)
Title:
Conversion DateRead Only:trueThe date when the conversion rate was used to convert foreign currency payments. -
ConversionRate: number
Title:
Conversion RateThe conversion rate used to convert foreign currency payments. -
ConversionRateType: string
Title:
Conversion Rate TypeMaximum Length:30The type of conversion rate used to convert foreign currency payments. -
Country: string
Title:
CountryMaximum Length:60The country name of the party to whom the payment is made. -
County: string
Title:
CountyMaximum Length:150The county name of the party to whom the payment is made. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
CrossCurrencyRateType: string
Title:
Conversion Rate TypeMaximum Length:30The conversion rate type used to convert the invoice currency to payment currency. -
DisbursementBankAccountName: string
Maximum Length:
255The name of the internal bank account from where the payment is made. -
DisbursementBankAccountNumber: string
Read Only:
trueMaximum Length:255The bank account number of the internal bank from where the payment is made. -
DocumentCategory: string
Title:
Document Sequence Category NameRead Only:trueMaximum Length:80The sequential numbering document category name. -
DocumentSequence: string
Title:
Document Sequence NameRead Only:trueMaximum Length:30The sequence number when document sequential numbering is enabled. -
EmployeeAddress: string
Maximum Length:
255The address of the employee. -
ExternalBankAccountId: integer
(int64)
Title:
Remit-to AccountThe unique identifier for the supplier bank account. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. If both Remit-to Account Number and External Bank Account ID is provided in the payload then the value for the External Bank Account ID is given preference and the value provided for Remit-to Account Number is ignored. -
IbyPaymentStatus: string
Read Only:
trueMaximum Length:255The status of the payment. A list of accepted values are defined in the lookup type IBY_PAYMENT_STATUSES lookup. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The session login associated to the user who last updated the record. -
LegalEntity: string
Title:
Legal Entity NameRead Only:trueMaximum Length:240The legal entity name for the payment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaturityConversionDate: string
(date)
Read Only:
trueThe date when the maturity conversion rate is effective, which is usually the maturity date for the payment. -
MaturityConversionRate: number
Title:
Maturity Conversion RateRead Only:trueThe conversion rate type at a future dated payment maturity time. This attribute is only used for foreign currency payments. -
MaturityConversionRateType: string
Title:
Conversion Rate TypeRead Only:trueMaximum Length:30The conversion rate at a future dated payment maturity time. This attribute is only used for foreign currency payments. -
MaturityDate: string
(date)
Title:
Maturity DateRead Only:trueThe date when the future dated payment matures and the payment status can get changed from Issued to Negotiable. -
PaperDocumentNumber: integer
(int64)
Title:
Document NumberRead Only:trueThe payment document number of a printed payment. -
PartyId: integer
(int64)
Title:
PayeeThe unique identifier of the party that a payment is made to. It also helps to uniquely identify the payee associated with the party. -
Payee: string
Title:
Payee PayeeMaximum Length:240The party name to whom payment is made. -
PayeeSite: string
Title:
SiteMaximum Length:240The supplier site name to whom payment is made. -
PaymentAmount: number
Read Only:
trueThe payment amount in payment currency. -
PaymentBaseAmount: number
Title:
Payment Base AmountRead Only:trueThe payment amount in functional currency. -
PaymentBaseCurrency: string
Read Only:
trueMaximum Length:15The functional or ledger currency. -
PaymentCurrency: string
Title:
Payment CurrencyMaximum Length:15The currency in which payment is made. -
PaymentDate: string
(date)
Title:
Payment DateThe date when the payment is made and mentioned on the payment document. -
PaymentDescription: string
Title:
Payment DescriptionMaximum Length:240The user description for a payment. -
paymentDff: array
Payments Descriptive Flexfields
Title:
Payments Descriptive FlexfieldsThe payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment. -
PaymentDocument: string
Title:
Payment DocumentMaximum Length:100The name of the payment document. -
PaymentFileReference: integer
(int64)
Read Only:
trueThe identifier of payment file generated for given payment. -
PaymentFunction: string
The business function that the payment serves. Examples include Employee expenses and Payables disbursements. The value can either be provided while creating payment or populated by default to Payables disbursements.
-
paymentGdf: array
Payments Global Descriptive Flexfields
Title:
Payments Global Descriptive FlexfieldsThe payables payments global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for a payment. -
PaymentId: integer
(int64)
Title:
Payment IDRead Only:trueThe Payments application payment identifier associated with the row. -
PaymentMethod: string
Title:
NameMaximum Length:100The option to indicate how the first party payer has made the payment. -
PaymentMethodCode: string
Title:
Payment MethodMaximum Length:30The user-entered payment method code that helps to uniquely identify a payment method. -
PaymentNumber: integer
(int64)
Title:
Payment NumberThe check number printed on physical check. -
PaymentProcessProfile: string
Title:
Configuration ProfileMaximum Length:100The payment process profile name. -
PaymentProcessProfileCode: string
Read Only:
trueMaximum Length:100The code that uniquely identifies a payment process profile. If multiple profiles exist under the same name, the user can provide both payment process profile name and payment process profile code to identify the correct profile. -
PaymentProcessRequest: string
Title:
Payment Process RequestRead Only:trueMaximum Length:255The name of payment batch or quick payment identifier. -
PaymentReference: integer
(int64)
Title:
Payment ReferenceRead Only:trueThe user and bank facing number that identifies the payment. -
PaymentStatus: string
Read Only:
trueMaximum Length:80The status of the payment. Examples include Negotiable, Set Up, and Spoiled. -
PaymentType: string
Maximum Length:
255The type of payment such as Manual, Quick, Refund, and Payment Process Request. Note: Currently you can only create manual payments only. Other payment types are not supported. -
ProcurementBU: string
The procurement business unit that is associated to the supplier site and helps to uniquely identify a supplier site.
-
Province: string
Title:
ProvinceMaximum Length:150The province of the party to whom the payment is made. -
ReconciledFlag: boolean
Read Only:
trueMaximum Length:1The option to indicate whether the payment is reconciled. The values are Y and N. - relatedInvoices: array Related Invoices
-
RemitToAccountNumber: string
Maximum Length:
30The supplier's bank account number for electronic payment purposes. -
SeparateRemittanceAdviceCreated: string
Read Only:
trueMaximum Length:1The option to indicate if the separate remittance advice has been printed or delivered for this payment. The values are Y and N. -
State: string
Title:
StateMaximum Length:150The state name of the party to whom the payment is made. -
StopDate: string
(date)
Read Only:
trueThe date and time when the user recorded the stop payment. -
StopReason: string
Read Only:
trueMaximum Length:240Reason for placing the stop request on the payment. -
StopReference: string
Read Only:
trueMaximum Length:100Payment system reference code for the stop request on the payment. -
SupplierNumber: string
Title:
Supplier NumberRead Only:trueMaximum Length:30The unique number to identify the supplier. -
ThirdPartyAddressName: string
Title:
Third-Party Address NameMaximum Length:240The third-party payment related remit-to address where the payment is sent. -
ThirdPartySupplier: string
Title:
Third-Party SupplierMaximum Length:240The third-party payment related remit-to supplier where the payment is sent. -
VoidAccountingDate: string
(date)
Title:
Void Accounting DateThe date when the voided payment is accounted. -
VoidDate: string
(date)
Title:
Void DateThe date when the payment is voided. -
VoucherNumber: integer
Title:
Voucher NumberRead Only:trueThe manual voucher number for the payment when document sequential numbering is not used. -
WithheldAmount: number
Read Only:
trueThe amount withheld for the payment. -
Zip: string
Title:
Postal CodeMaximum Length:60The postal code or zip code of the party to whom the payment is made.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Payments Descriptive Flexfields
Type:
arrayTitle:
Payments Descriptive FlexfieldsThe payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "Context1":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response", "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response" } }
Nested Schema : Payments Global Descriptive Flexfields
Type:
arrayTitle:
Payments Global Descriptive FlexfieldsThe payables payments global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for a payment.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "FVxUSAPCHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response", "JAxINChallanInfo":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response", "JAxTHPayments":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response", "JE_IL_PAYMENT_CHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response", "JLxMXPaymentChecks":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response" } }
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:150Default Value:Context1The descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
ContextThe descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:150Default Value:Context2The descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
ContextThe descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
- FVxUSAPCHECKS
- JA_CN_REMIT_BILL_NUM
- JAxINChallanInfo
- JAxTHPayments
- JE_IL_PAYMENT_CHECKS
- JLxMXPaymentChecks
Match One Schema
Show Source
-
FVxUSAPCHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response
-
JA_CN_REMIT_BILL_NUM -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response
-
JAxINChallanInfo -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response
-
JAxTHPayments -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response
-
JE_IL_PAYMENT_CHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response
-
JLxMXPaymentChecks -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:FVxUSAPCHECKSThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
VoidedPaymentID: number
Title:
Voided Payment -
VoidedPaymentID_Display: string
Title:
Voided Payment
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JA_CN_REMIT_BILL_NUMThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
_Remittance__Bill__Number: string
Title:
Remittance Bill NumberMaximum Length:150 -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JAxINChallanInfoThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
BankName: string
Title:
Bank NameMaximum Length:150 -
BSRCode: string
Title:
BSR CodeMaximum Length:150 -
ChallanSerialNumber: string
Title:
Challan Serial NumberMaximum Length:150 -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
DateOfDeposit: string
(date)
Title:
Date of Deposit -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JAxTHPaymentsThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
ExchangeRateDocumentNumber: string
Title:
Exchange Rate Document NumberMaximum Length:150 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PaymentCondition: string
Title:
Payment ConditionMaximum Length:150 -
PaymentCondition_Display: string
Title:
Payment Condition
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JE_IL_PAYMENT_CHECKSThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
_Withholding__Amount__Paid__by__Ban: number
Title:
Withholding Amount Paid by Bank -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JLxMXPaymentChecksThe global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
digitalTaxReceiptUsingInternet: string
Title:
Digital Tax Receipt using Internet Unique IDMaximum Length:150 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
paymentMethod: string
Title:
Payment MethodMaximum Length:150 -
paymentMethod_Display: string
Title:
Payment Method
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_invoicePaymentsGdf_view_InvoicePaymentRestGdfJExESOnlineVatReportingVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:150Default Value:JExESOnlineVatReportingThe global descriptive flexfield context name for the invoice payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationThe global descriptive flexfield context display value for the invoice payment. -
DateLastUpdated: string
(date)
Title:
Date Last Updated -
InvoicePaymentId: integer
(int64)
The unique identifier of the invoice payment.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageCode: string
Title:
Message CodeMaximum Length:150 -
MessageDescription: string
Title:
Message DescriptionMaximum Length:150 -
RegisterType: string
Title:
Register TypeMaximum Length:150 -
RegisterType_Display: string
Title:
Register Type -
TaxAuthorityStatus: string
Title:
Tax Authority StatusMaximum Length:150 -
TaxAuthorityStatus_Display: string
Title:
Tax Authority Status -
TransactionStatus: string
Title:
Transaction StatusMaximum Length:150 -
TransactionStatus_Display: string
Title:
Transaction Status
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- paymentDff
-
Parameters:
- CheckId:
$request.path.CheckId
The payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment. - CheckId:
- paymentGdf
-
Parameters:
- CheckId:
$request.path.CheckId
The payables payments global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for a payment. - CheckId:
- relatedInvoices
-
Parameters:
- CheckId:
$request.path.CheckId
The related invoices resource is used to manage details of invoices related to a payment. - CheckId:
Examples
The following example shows how to retrieve a payment by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"CheckId": 300100170746039,
"PaymentId": 103709,
"PaymentReference": 1878,
"PaperDocumentNumber": 1005,
"PaymentNumber": 1005,
"PaymentFileReference": null,
"PaymentProcessRequest": "300100170746039",
"PaymentAmount": 92.5,
"PaymentDate": "2018-11-07",
"AccountingDate": "2018-11-07",
"PaymentDescription": "Manual_Payment",
"ConversionRate": null,
"ConversionDate": null,
"ConversionRateType": null,
"ClearingDate": null,
"ClearingAmount": null,
"ClearingLedgerAmount": null,
"ClearingConversionRate": null,
"ClearingConversionDate": null,
"ClearingConversionRateType": null,
"CrossCurrencyRateType": "Corporate",
"MaturityDate": null,
"MaturityConversionRateType": null,
"MaturityConversionDate": null,
"MaturityConversionRate": 1,
"AnticipatedValueDate": null,
"ClearingValueDate": null,
"StopDate": null,
"VoidDate": null,
"VoidAccountingDate": null,
"PaymentStatus": "Negotiable",
"SeparateRemittanceAdviceCreated": null,
"AccountingStatus": "Unaccounted",
"ReconciledFlag": false,
"PaymentType": "Manual",
"PaymentCurrency": "USD",
"WithheldAmount": null,
"BankChargeAmount": null,
"LegalEntity": "Vision Operations",
"BusinessUnit": "Vision Operations",
"PaymentFunction": null,
"Payee": "Advanced Network Devices",
"ProcurementBU": null,
"PayeeSite": "FRESNO",
"EmployeeAddress": null,
"SupplierNumber": "1013",
"ThirdPartySupplier": null,
"ThirdPartyAddressName": null,
"ExternalBankAccountId": null,
"RemitToAccountNumber": null,
"DisbursementBankAccountNumber": "10271-17621-619",
"DisbursementBankAccountName": "BofA-204",
"PaymentMethodCode": "CHECK",
"PaymentMethod": "Check",
"PaymentDocument": "AP Standard Check Format 2",
"PaymentProcessProfile": "Standard Check",
"DocumentCategory": null,
"DocumentSequence": null,
"VoucherNumber": null,
"PaymentBaseAmount": null,
"PaymentBaseCurrency": "USD",
"AddressLine1": "5600 Independence Ave",
"AddressLine2": null,
"AddressLine3": null,
"AddressLine4": null,
"City": "Fresno",
"County": null,
"Province": null,
"State": "CA",
"Country": "US",
"Zip": "95602",
"CreatedBy": "AP_SUPV_OPERATIONS",
"CreationDate": "2018-11-25T19:11:34.001+00:00",
"LastUpdatedBy": "AP_SUPV_OPERATIONS",
"LastUpdateDate": "2018-11-25T19:11:34.260+00:00",
"LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039",
"name": "payablesPayments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039",
"name": "payablesPayments",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/BankAccountPaymentDocumentNoBuPVO",
"name": "BankAccountPaymentDocumentNoBuPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/DisbursementBankAccountVVO",
"name": "DisbursementBankAccountVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/SupplierSiteVVO",
"name": "SupplierSiteVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/PaymentFunctionPVO",
"name": "PaymentFunctionPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/ProcurementBusinessUnitVVO",
"name": "ProcurementBusinessUnitVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/EmployeeAddressTypeVVO",
"name": "EmployeeAddressTypeVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/ApplicablePaymentProfilePVO",
"name": "ApplicablePaymentProfilePVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/PaymentBusinessUnitPVO",
"name": "PaymentBusinessUnitPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/RemitToSupplierPVO",
"name": "RemitToSupplierPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/TradingPartnerVVO",
"name": "TradingPartnerVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/PaymentTypeVVO",
"name": "PaymentTypeVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/PaymentMethodPVO",
"name": "PaymentMethodPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/DailyConversionTypePVO",
"name": "DailyConversionTypePVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/lov/RemitToAddressPVO",
"name": "RemitToAddressPVO",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices",
"name": "relatedInvoices",
"kind": "collection"
}
]
}