Create a payment
/fscmRestApi/resources/11.13.18.05/payablesPayments
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first address line of the party to whom the payment is made. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second address line of the party to whom the payment is made. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third address line of party to whom the payment is made. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of the party to whom the payment is made. -
BusinessUnit(required): string
Title:
Business Unit
Maximum Length:240
The business unit name for the payment. -
City: string
Title:
City
Maximum Length:60
The city name of the party to whom the payment is made. -
ConversionRate: number
Title:
Conversion Rate
The conversion rate used to convert foreign currency payments. -
ConversionRateType: string
Title:
Conversion Rate Type
Maximum Length:30
The type of conversion rate used to convert foreign currency payments. -
Country: string
Title:
Country
Maximum Length:60
The country name of the party to whom the payment is made. -
County: string
Title:
County
Maximum Length:150
The county name of the party to whom the payment is made. -
CrossCurrencyRateType: string
Title:
Conversion Rate Type
Maximum Length:30
The conversion rate type used to convert the invoice currency to payment currency. -
DisbursementBankAccountName: string
Maximum Length:
255
The name of the internal bank account from where the payment is made. -
EmployeeAddress: string
Maximum Length:
255
The address of the employee. -
ExternalBankAccountId: integer
(int64)
Title:
Remit-to Account
The 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. -
PartyId: integer
(int64)
Title:
Payee
The 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 Payee
Maximum Length:240
The party name to whom payment is made. -
PayeeSite: string
Title:
Site
Maximum Length:240
The supplier site name to whom payment is made. -
PaymentCurrency(required): string
Title:
Payment Currency
Maximum Length:15
The currency in which payment is made. -
PaymentDate(required): string
(date)
Title:
Payment Date
The date when the payment is made and mentioned on the payment document. -
PaymentDescription: string
Title:
Payment Description
Maximum Length:240
The user description for a payment. -
paymentDff: array
Payments Descriptive Flexfields
Title:
Payments Descriptive Flexfields
The payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment. -
PaymentDocument: string
Title:
Payment Document
Maximum Length:100
The name of the payment document. -
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 Flexfields
The payables payments global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for a payment. -
PaymentMethod: string
Title:
Name
Maximum Length:100
The option to indicate how the first party payer has made the payment. -
PaymentMethodCode(required): string
Title:
Payment Method
Maximum Length:30
The user-entered payment method code that helps to uniquely identify a payment method. -
PaymentNumber(required): integer
(int64)
Title:
Payment Number
The check number printed on physical check. -
PaymentProcessProfile: string
Title:
Configuration Profile
Maximum Length:100
The payment process profile name. -
PaymentType: string
Maximum Length:
255
The 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:
Province
Maximum Length:150
The province of the party to whom the payment is made. - relatedInvoices: array Related Invoices
-
RemitToAccountNumber: string
Maximum Length:
30
The supplier's bank account number for electronic payment purposes. -
State: string
Title:
State
Maximum Length:150
The state name of the party to whom the payment is made. -
ThirdPartyAddressName: string
Title:
Third-Party Address Name
Maximum Length:240
The third-party payment related remit-to address where the payment is sent. -
ThirdPartySupplier: string
Title:
Third-Party Supplier
Maximum Length:240
The third-party payment related remit-to supplier where the payment is sent. -
VoidAccountingDate: string
(date)
Title:
Void Accounting Date
The date when the voided payment is accounted. -
VoidDate: string
(date)
Title:
Void Date
The date when the payment is voided. -
Zip: string
Title:
Postal Code
Maximum Length:60
The postal code or zip code of the party to whom the payment is made.
array
Payments Descriptive Flexfields
-
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-post-request", "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-post-request" } }
array
Payments Global Descriptive Flexfields
-
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-post-request", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request", "JAxINChallanInfo":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-post-request", "JAxTHPayments":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-post-request", "JE_IL_PAYMENT_CHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-post-request", "JLxMXPaymentChecks":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-post-request" } }
object
Discriminator Values
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
Default Value:Context1
The descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Context
The descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
Default Value:Context2
The descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Context
The descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
object
Discriminator Values
- FVxUSAPCHECKS
- JA_CN_REMIT_BILL_NUM
- JAxINChallanInfo
- JAxTHPayments
- JE_IL_PAYMENT_CHECKS
- JLxMXPaymentChecks
-
FVxUSAPCHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-post-request
-
JA_CN_REMIT_BILL_NUM -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request
-
JAxINChallanInfo -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-post-request
-
JAxTHPayments -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-post-request
-
JE_IL_PAYMENT_CHECKS -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-post-request
-
JLxMXPaymentChecks -
object
oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-post-request
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:FVxUSAPCHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
VoidedPaymentID: number
Title:
Voided Payment
-
VoidedPaymentID_Display: string
Title:
Voided Payment
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JA_CN_REMIT_BILL_NUM
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
_Remittance__Bill__Number: string
Title:
Remittance Bill Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JAxINChallanInfo
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
BankName: string
Title:
Bank Name
Maximum Length:150
-
BSRCode: string
Title:
BSR Code
Maximum Length:150
-
ChallanSerialNumber: string
Title:
Challan Serial Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
DateOfDeposit: string
(date)
Title:
Date of Deposit
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JAxTHPayments
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 Number
Maximum Length:150
-
PaymentCondition: string
Title:
Payment Condition
Maximum Length:150
-
PaymentCondition_Display: string
Title:
Payment Condition
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JE_IL_PAYMENT_CHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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.
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxMXPaymentChecks
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 ID
Maximum Length:150
-
paymentMethod: string
Title:
Payment Method
Maximum Length:150
-
paymentMethod_Display: string
Title:
Payment Method
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JExESOnlineVatReporting
The global descriptive flexfield context name for the invoice payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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.
-
MessageCode: string
Title:
Message Code
Maximum Length:150
-
MessageDescription: string
Title:
Message Description
Maximum Length:150
-
RegisterType: string
Title:
Register Type
Maximum Length:150
-
RegisterType_Display: string
Title:
Register Type
-
TaxAuthorityStatus: string
Title:
Tax Authority Status
Maximum Length:150
-
TaxAuthorityStatus_Display: string
Title:
Tax Authority Status
-
TransactionStatus: string
Title:
Transaction Status
Maximum Length:150
-
TransactionStatus_Display: string
Title:
Transaction Status
Response
- application/json
Default Response
-
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.
object
-
AccountingDate: string
(date)
Read Only:
true
The date when the payment is to be accounted. -
AccountingStatus: string
Read Only:
true
Maximum Length:255
The accounting status of the payment. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first address line of the party to whom the payment is made. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second address line of the party to whom the payment is made. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third address line of party to whom the payment is made. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of the party to whom the payment is made. -
AnticipatedValueDate: string
(date)
Title:
Anticipated Value Date
Read Only:true
The date when the funds are anticipated to be disbursed by the bank. -
BankChargeAmount: number
Read Only:
true
The bank charge amount in the payment currency. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:240
The business unit name for the payment. -
CheckId: integer
(int64)
Read Only:
true
The unique identifier assigned to every payment made. -
City: string
Title:
City
Maximum Length:60
The city name of the party to whom the payment is made. -
ClearingAmount: number
Read Only:
true
The payment amount cleared against payment in cash management. -
ClearingConversionDate: string
(date)
Read Only:
true
The date when the clearing conversion rate is effective, which is usually the accounting date of a transaction. -
ClearingConversionRate: number
Read Only:
true
The conversion rate at which the payment is cleared. The resource is only used for foreign currency payments. -
ClearingConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The conversion rate type at which the payment is cleared. This attribute is only used for foreign currency payments. -
ClearingDate: string
(date)
Read Only:
true
The date when the payment is cleared in cash management. -
ClearingLedgerAmount: number
Read Only:
true
The payment cleared amount in functional currency. -
ClearingValueDate: string
(date)
Read Only:
true
The date when the bank disburses funds. -
ConversionDate: string
(date)
Title:
Conversion Date
Read Only:true
The date when the conversion rate was used to convert foreign currency payments. -
ConversionRate: number
Title:
Conversion Rate
The conversion rate used to convert foreign currency payments. -
ConversionRateType: string
Title:
Conversion Rate Type
Maximum Length:30
The type of conversion rate used to convert foreign currency payments. -
Country: string
Title:
Country
Maximum Length:60
The country name of the party to whom the payment is made. -
County: string
Title:
County
Maximum Length:150
The county name of the party to whom the payment is made. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CrossCurrencyRateType: string
Title:
Conversion Rate Type
Maximum Length:30
The conversion rate type used to convert the invoice currency to payment currency. -
DisbursementBankAccountName: string
Maximum Length:
255
The name of the internal bank account from where the payment is made. -
DisbursementBankAccountNumber: string
Read Only:
true
Maximum Length:255
The bank account number of the internal bank from where the payment is made. -
DocumentCategory: string
Title:
Document Sequence Category Name
Read Only:true
Maximum Length:80
The sequential numbering document category name. -
DocumentSequence: string
Title:
Document Sequence Name
Read Only:true
Maximum Length:30
The sequence number when document sequential numbering is enabled. -
EmployeeAddress: string
Maximum Length:
255
The address of the employee. -
ExternalBankAccountId: integer
(int64)
Title:
Remit-to Account
The 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. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
LegalEntity: string
Title:
Legal Entity Name
Read Only:true
Maximum Length:240
The legal entity name for the payment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaturityConversionDate: string
(date)
Read Only:
true
The date when the maturity conversion rate is effective, which is usually the maturity date for the payment. -
MaturityConversionRate: number
Title:
Maturity Conversion Rate
Read Only:true
The conversion rate type at a future dated payment maturity time. This attribute is only used for foreign currency payments. -
MaturityConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The conversion rate at a future dated payment maturity time. This attribute is only used for foreign currency payments. -
MaturityDate: string
(date)
Title:
Maturity Date
Read Only:true
The date when the future dated payment matures and the payment status can get changed from Issued to Negotiable. -
PaperDocumentNumber: integer
(int64)
Title:
Document Number
Read Only:true
The payment document number of a printed payment. -
PartyId: integer
(int64)
Title:
Payee
The 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 Payee
Maximum Length:240
The party name to whom payment is made. -
PayeeSite: string
Title:
Site
Maximum Length:240
The supplier site name to whom payment is made. -
PaymentAmount: number
Read Only:
true
The payment amount in payment currency. -
PaymentBaseAmount: number
Title:
Payment Base Amount
Read Only:true
The payment amount in functional currency. -
PaymentBaseCurrency: string
Read Only:
true
Maximum Length:15
The functional or ledger currency. -
PaymentCurrency: string
Title:
Payment Currency
Maximum Length:15
The currency in which payment is made. -
PaymentDate: string
(date)
Title:
Payment Date
The date when the payment is made and mentioned on the payment document. -
PaymentDescription: string
Title:
Payment Description
Maximum Length:240
The user description for a payment. -
paymentDff: array
Payments Descriptive Flexfields
Title:
Payments Descriptive Flexfields
The payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment. -
PaymentDocument: string
Title:
Payment Document
Maximum Length:100
The name of the payment document. -
PaymentFileReference: integer
(int64)
Read Only:
true
The 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 Flexfields
The 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 ID
Read Only:true
The Payments application payment identifier associated with the row. -
PaymentMethod: string
Title:
Name
Maximum Length:100
The option to indicate how the first party payer has made the payment. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The user-entered payment method code that helps to uniquely identify a payment method. -
PaymentNumber: integer
(int64)
Title:
Payment Number
The check number printed on physical check. -
PaymentProcessProfile: string
Title:
Configuration Profile
Maximum Length:100
The payment process profile name. -
PaymentProcessProfileCode: string
Read Only:
true
Maximum Length:100
The 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 Request
Read Only:true
Maximum Length:255
The name of payment batch or quick payment identifier. -
PaymentReference: integer
(int64)
Title:
Payment Reference
Read Only:true
The user and bank facing number that identifies the payment. -
PaymentStatus: string
Read Only:
true
Maximum Length:80
The status of the payment. Examples include Negotiable, Set Up, and Spoiled. -
PaymentType: string
Maximum Length:
255
The 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:
Province
Maximum Length:150
The province of the party to whom the payment is made. -
ReconciledFlag: boolean
Read Only:
true
Maximum Length:1
The option to indicate whether the payment is reconciled. The values are Y and N. - relatedInvoices: array Related Invoices
-
RemitToAccountNumber: string
Maximum Length:
30
The supplier's bank account number for electronic payment purposes. -
SeparateRemittanceAdviceCreated: string
Read Only:
true
Maximum Length:1
The 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:
State
Maximum Length:150
The state name of the party to whom the payment is made. -
StopDate: string
(date)
Read Only:
true
The date and time when the user recorded the stop payment. -
StopReason: string
Read Only:
true
Maximum Length:240
Reason for placing the stop request on the payment. -
StopReference: string
Read Only:
true
Maximum Length:100
Payment system reference code for the stop request on the payment. -
SupplierNumber: string
Title:
Supplier Number
Read Only:true
Maximum Length:30
The unique number to identify the supplier. -
ThirdPartyAddressName: string
Title:
Third-Party Address Name
Maximum Length:240
The third-party payment related remit-to address where the payment is sent. -
ThirdPartySupplier: string
Title:
Third-Party Supplier
Maximum Length:240
The third-party payment related remit-to supplier where the payment is sent. -
VoidAccountingDate: string
(date)
Title:
Void Accounting Date
The date when the voided payment is accounted. -
VoidDate: string
(date)
Title:
Void Date
The date when the payment is voided. -
VoucherNumber: integer
Title:
Voucher Number
Read Only:true
The manual voucher number for the payment when document sequential numbering is not used. -
WithheldAmount: number
Read Only:
true
The amount withheld for the payment. -
Zip: string
Title:
Postal Code
Maximum Length:60
The postal code or zip code of the party to whom the payment is made.
array
Links
array
Payments Descriptive Flexfields
-
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" } }
array
Payments Global Descriptive Flexfields
-
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" } }
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
Discriminator Values
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
Default Value:Context1
The descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Context
The descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
Default Value:Context2
The descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Context
The descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
array
Links
object
Discriminator Values
- FVxUSAPCHECKS
- JA_CN_REMIT_BILL_NUM
- JAxINChallanInfo
- JAxTHPayments
- JE_IL_PAYMENT_CHECKS
- JLxMXPaymentChecks
-
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
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:FVxUSAPCHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VoidedPaymentID: number
Title:
Voided Payment
-
VoidedPaymentID_Display: string
Title:
Voided Payment
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JA_CN_REMIT_BILL_NUM
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
_Remittance__Bill__Number: string
Title:
Remittance Bill Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JAxINChallanInfo
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the payment. -
BankName: string
Title:
Bank Name
Maximum Length:150
-
BSRCode: string
Title:
BSR Code
Maximum Length:150
-
ChallanSerialNumber: string
Title:
Challan Serial Number
Maximum Length:150
-
CheckId: integer
(int64)
The unique identifier maintained for every payment made.
-
DateOfDeposit: string
(date)
Title:
Date of Deposit
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JAxTHPayments
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 Number
Maximum Length:150
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentCondition: string
Title:
Payment Condition
Maximum Length:150
-
PaymentCondition_Display: string
Title:
Payment Condition
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JE_IL_PAYMENT_CHECKS
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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:
Links
The link relations associated with the resource instance.
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxMXPaymentChecks
The global descriptive flexfield context name for the payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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 ID
Maximum Length:150
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
paymentMethod: string
Title:
Payment Method
Maximum Length:150
-
paymentMethod_Display: string
Title:
Payment Method
array
Links
array
Links
array
Links
array
Links
array
Links
array
Links
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JExESOnlineVatReporting
The global descriptive flexfield context name for the invoice payment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The 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:
Links
The link relations associated with the resource instance. -
MessageCode: string
Title:
Message Code
Maximum Length:150
-
MessageDescription: string
Title:
Message Description
Maximum Length:150
-
RegisterType: string
Title:
Register Type
Maximum Length:150
-
RegisterType_Display: string
Title:
Register Type
-
TaxAuthorityStatus: string
Title:
Tax Authority Status
Maximum Length:150
-
TaxAuthorityStatus_Display: string
Title:
Tax Authority Status
-
TransactionStatus: string
Title:
Transaction Status
Maximum Length:150
-
TransactionStatus_Display: string
Title:
Transaction Status
array
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
Example 1
The following example shows how to create a manual payment for a supplier invoice by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PaymentNumber": 1005, "PaymentDate": "2018-11-07", "PaymentDescription": "Manual_Payment", "PaymentType": "Manual", "PaymentCurrency": "USD", "BusinessUnit": "Vision Operations", "Payee": "Advanced Network Devices", "PayeeSite": "FRESNO", "DisbursementBankAccountName": "BofA-204", "PaymentMethod": "Check", "PaymentProcessProfile": "Standard Check", "PaymentDocument": "AP Standard Check Format 2", "relatedInvoices": [ { "InvoiceNumber": "Functional-Currency-Invoice", "InstallmentNumber": 1, "DiscountTaken": 10, "AmountPaidPaymentCurrency": 46.25 }, { "InvoiceNumber": "Functional-Currency-Invoice", "InstallmentNumber": 2, "DiscountTaken": 10, "AmountPaidPaymentCurrency": 46.25 } ] }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "CheckId": 300100170746039, "PaymentId": null, "PaymentReference": null, "PaperDocumentNumber": null, "PaymentNumber": 1005, "PaymentFileReference": null, "PaymentProcessRequest": "300100170746039", "PaymentAmount": 92.5, "PaymentDate": "2018-11-07", "AccountingDate": null, "PaymentDescription": "Manual_Payment", "ConversionRate": null, "ConversionDate": null, "ConversionRateType": null, "ClearingDate": null, "ClearingAmount": null, "ClearingLedgerAmount": null, "ClearingConversionRate": null, "ClearingConversionDate": null, "ClearingConversionRateType": null, "CrossCurrencyRateType": null, "MaturityDate": null, "MaturityConversionRateType": null, "MaturityConversionDate": null, "MaturityConversionRate": 1, "AnticipatedValueDate": null, "ClearingValueDate": null, "StopDate": null, "VoidDate": null, "VoidAccountingDate": null, "PaymentStatus": null, "SeparateRemittanceAdviceCreated": null, "AccountingStatus": null, "ReconciledFlag": null, "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": null, "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", "relatedInvoices": [ { "InvoicePaymentId": 300100170746040, "CheckId": 300100170746039, "InvoiceId": 300100170752632, "InvoiceBusinessUnit": "Vision Operations", "InvoiceNumber": "Functional-Currency-Invoice", "InstallmentNumber": 1, "AmountPaidPaymentCurrency": 46.25, "AmountPaidInvoiceCurrency": 46.25, "DiscountLost": -10, "DiscountTaken": 10, "InvoiceBaseAmount": null, "PaymentBaseAmount": null, "InvoiceCurrency": "USD", "CrossCurrencyRate": 1, "LastUpdatedBy": "AP_SUPV_OPERATIONS", "LastUpdateDate": "2018-11-25T19:11:34.317+00:00", "CreatedBy": "AP_SUPV_OPERATIONS", "CreationDate": "2018-11-25T19:11:34.154+00:00", "LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746040", "name": "relatedInvoices", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746040", "name": "relatedInvoices", "kind": "item" }, ... ] }, { "InvoicePaymentId": 300100170746041, "CheckId": 300100170746039, "InvoiceId": 300100170752632, "InvoiceBusinessUnit": "Vision Operations", "InvoiceNumber": "Functional-Currency-Invoice", "InstallmentNumber": 2, "AmountPaidPaymentCurrency": 46.25, "AmountPaidInvoiceCurrency": 46.25, "DiscountLost": -10, "DiscountTaken": 10, "InvoiceBaseAmount": null, "PaymentBaseAmount": null, "InvoiceCurrency": "USD", "CrossCurrencyRate": 1, "LastUpdatedBy": "AP_SUPV_OPERATIONS", "LastUpdateDate": "2018-11-25T19:11:34.328+00:00", "CreatedBy": "AP_SUPV_OPERATIONS", "CreationDate": "2018-11-25T19:11:34.183+00:00", "LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746041", "name": "relatedInvoices", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746041", "name": "relatedInvoices", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039", "name": "payablesPayments", "kind": "item" }, ... ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039", "name": "payablesPayments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039", "name": "payablesPayments", "kind": "item" }, ... ] }
Example 2
The following example shows how to create a manual payment for an employee expense payment request scenario by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PaymentNumber": 1012, "PaymentDate": "2018-11-01", "PaymentDescription": "Manual_Payment", "PaymentType": "Manual", "PaymentCurrency": "USD", "BusinessUnit": "Vision Operations", "PaymentFunction": "Employee expenses", "Payee": "James Taylor", "EmployeeAddress": "Home", "DisbursementBankAccountName": "BofA-204", "PaymentMethod": "Check", "PaymentProcessProfile": "Standard Check", "PaymentDocument": "AP Standard Check Format 2", "relatedInvoices": [ { "InvoiceNumber": "EXM0169907926", "InstallmentNumber": 1, "AmountPaidPaymentCurrency": 50 } ] }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "CheckId": 300100174803469, "PaymentId": null, "PaymentReference": null, "PaperDocumentNumber": null, "PaymentNumber": 1012, "PaymentFileReference": null, "PaymentProcessRequest": "300100174803469", "PaymentAmount": 50, "PaymentDate": "2018-11-01", "AccountingDate": null, "PaymentDescription": "Manual_Payment", "ConversionRate": null, "ConversionDate": null, "ConversionRateType": null, "ClearingDate": null, "ClearingAmount": null, "ClearingLedgerAmount": null, "ClearingConversionRate": null, "ClearingConversionDate": null, "ClearingConversionRateType": null, "CrossCurrencyRateType": null, "MaturityDate": null, "MaturityConversionRateType": null, "MaturityConversionDate": null, "MaturityConversionRate": 1, "AnticipatedValueDate": null, "ClearingValueDate": null, "StopDate": null, "VoidDate": null, "VoidAccountingDate": null, "PaymentStatus": null, "SeparateRemittanceAdviceCreated": null, "AccountingStatus": null, "ReconciledFlag": null, "PaymentType": "Manual", "PaymentCurrency": "USD", "WithheldAmount": null, "BankChargeAmount": null, "LegalEntity": "Vision Operations", "BusinessUnit": "Vision Operations", "PaymentFunction": "Employee expenses", "Payee": "James Taylor", "ProcurementBU": null, "PayeeSite": null, "EmployeeAddress": "Home", "SupplierNumber": null, "ThirdPartySupplier": null, "ThirdPartyAddressName": null, "ExternalBankAccountId": null, "RemitToAccountNumber": null, "DisbursementBankAccountNumber": null, "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": null, "AddressLine2": null, "AddressLine3": null, "AddressLine4": null, "City": null, "County": null, "Province": null, "State": null, "Country": null, "Zip": null, "CreatedBy": "AP_SUPV_OPERATIONS", "CreationDate": "2018-11-28T09:15:49.001+00:00", "LastUpdatedBy": "AP_SUPV_OPERATIONS", "LastUpdateDate": "2018-11-28T09:15:51.035+00:00", "LastUpdateLogin": "7B2737422803F39EE0533AFDF40A6863", "relatedInvoices": [ { "InvoicePaymentId": 300100174803470, "CheckId": 300100174803469, "InvoiceId": 355912, "InvoiceBusinessUnit": "Vision Operations", "InvoiceNumber": "EXM0169907926", "InstallmentNumber": 1, "AmountPaidPaymentCurrency": 50, "AmountPaidInvoiceCurrency": 50, "DiscountLost": 0, "DiscountTaken": 0, "InvoiceBaseAmount": null, "PaymentBaseAmount": null, "InvoiceCurrency": "USD", "CrossCurrencyRate": 1, "LastUpdatedBy": "AP_SUPV_OPERATIONS", "LastUpdateDate": "2018-11-28T09:15:51.118+00:00", "CreatedBy": "AP_SUPV_OPERATIONS", "CreationDate": "2018-11-28T09:15:49.290+00:00", "LastUpdateLogin": "7B2737422803F39EE0533AFDF40A6863", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469/child/relatedInvoices/300100174803470", "name": "relatedInvoices", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469/child/relatedInvoices/300100174803470", "name": "relatedInvoices", "kind": "item" }, ... ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469", "name": "payablesPayments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469", "name": "payablesPayments", "kind": "item" }, ... ] }
Example 3
The following example shows how to create a manual payment for a customer refund payment request scenario by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments
Example Request Body
The following example shows the contents of the response body in JSON format:
{ "PaymentNumber": 192, "PaymentDate": "2020-04-01", "PaymentDescription": "Manual_Payment", "PaymentType": "Manual", "PaymentCurrency": "USD", "BusinessUnit": "Vision Operations", "Payee": "B2CM_Customer", "DisbursementBankAccountName": "AP BofA - USD", "PaymentMethod": "Check", "PaymentProcessProfile": "AP Basic Printed for IL", "PaymentDocument": "IBY Prenum 3-2", "PaymentFunction": "Receivables customer refunds", "relatedInvoices": [ { "InvoiceNumber": "999995000469018", "InstallmentNumber": 1, "AmountPaidPaymentCurrency": 10 } ] }
Example response Body
The following example shows the contents of the response body in JSON format:
{ "CheckId": 300100261773606, "PaymentId": null, "PaymentReference": null, "PaperDocumentNumber": null, "PaymentNumber": 192, "PaymentFileReference": null, "PaymentProcessRequest": "300100261773606", "PaymentAmount": 10, "PaymentDate": "2020-04-01", "AccountingDate": null, "PaymentDescription": "Manual_Payment", "ConversionRate": null, "ConversionDate": null, "ConversionRateType": null, "ClearingDate": null, "ClearingAmount": null, "ClearingLedgerAmount": null, "ClearingConversionRate": null, "ClearingConversionDate": null, "ClearingConversionRateType": null, "CrossCurrencyRateType": null, "MaturityDate": null, "MaturityConversionRateType": null, "MaturityConversionDate": null, "MaturityConversionRate": 1, "AnticipatedValueDate": null, "ClearingValueDate": null, "StopDate": null, "VoidDate": null, "VoidAccountingDate": null, "PaymentStatus": null, "SeparateRemittanceAdviceCreated": null, "AccountingStatus": null, "ReconciledFlag": null, "PaymentType": "Manual", "PaymentCurrency": "USD", "WithheldAmount": null, "BankChargeAmount": null, "LegalEntity": "Vision Operations", "BusinessUnit": "Vision Operations", "PaymentFunction": "Receivables customer refunds", "Payee": "B2CM_Customer", "ProcurementBU": null, "PayeeSite": null, "EmployeeAddress": null, "SupplierNumber": null, "ThirdPartySupplier": null, "ThirdPartyAddressName": null, "ExternalBankAccountId": null, "RemitToAccountNumber": null, "DisbursementBankAccountNumber": null, "DisbursementBankAccountName": "AP BofA - USD", "PaymentMethodCode": "CHECK", "PaymentMethod": "Check", "PaymentDocument": "IBY Prenum 3-2", "PaymentProcessProfile": "AP Basic Printed for IL", "DocumentCategory": null, "DocumentSequence": null, "VoucherNumber": null, "PaymentBaseAmount": null, "PaymentBaseCurrency": "USD", "AddressLine1": null, "AddressLine2": null, "AddressLine3": null, "AddressLine4": null, "City": null, "County": null, "Province": null, "State": null, "Country": "US", "Zip": null, "CreatedBy": "FINUSER1", "CreationDate": "2020-04-20T08:49:45.001+00:00", "LastUpdatedBy": "FINUSER1", "LastUpdateDate": "2020-04-20T08:49:48.946+00:00", "LastUpdateLogin": "A3A4DE17E9CB5148E05322EAF40A6C6B", "relatedInvoices": [ { "InvoicePaymentId": 300100261773607, "CheckId": 300100261773606, "InvoiceId": 608945, "InvoiceBusinessUnit": "Vision Operations", "InvoiceNumber": "999995000469018", "InstallmentNumber": 1, "AmountPaidPaymentCurrency": 10, "AmountPaidInvoiceCurrency": 10, "DiscountLost": 0, "DiscountTaken": 0, "InvoiceBaseAmount": null, "PaymentBaseAmount": null, "InvoiceCurrency": "USD", "CrossCurrencyRate": 1, "LastUpdatedBy": "FINUSER1", "LastUpdateDate": "2020-04-20T08:49:49.016+00:00", "CreatedBy": "FINUSER1", "CreationDate": "2020-04-20T08:49:46.344+00:00", "LastUpdateLogin": "A3A4DE17E9CB5148E05322EAF40A6C6B", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606/child/relatedInvoices/300100261773607", "name": "relatedInvoices", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606/child/relatedInvoices/300100261773607", "name": "relatedInvoices", "kind": "item" }, ... ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606", "name": "payablesPayments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606", "name": "payablesPayments", "kind": "item" }, ... ] }