Create a standard receipt
post
/fscmRestApi/resources/11.13.18.05/standardReceipts
Request
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.
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AccountingDate: string
(date)
Title:
Accounting DateThe date when the standard receipt is accounted. -
Amount(required): number
Title:
Receipt AmountThe amount of a standard receipt. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to add one or more attachments to a standard receipt. -
BusinessUnit(required): string
Title:
Business UnitMaximum Length:240A unit of an enterprise that performs one or more business functions that can be accumulated in a management hierarchy. -
CardHolderFirstName: string
Title:
First Name of the Credit Card HolderThe first name of the credit card holder. -
CardHolderLastName: string
Title:
Last Name of the Credit Card HolderThe last name of the credit card holder. -
Comments: string
Title:
CommentsMaximum Length:2000The comments about this receipt. -
ConversionDate: string
(date)
Title:
Conversion DateThe date when the standard receipt was converted. -
ConversionRate: number
Title:
Conversion RateThe conversion rate between the standard receipt currency and the ledger currency. -
ConversionRateType: string
Title:
Conversion Rate TypeMaximum Length:30The conversion rate type of a standard receipt. -
CreditCardAuthorizationRequestIdentifier: integer
Title:
Credit Card Authorization Request IdentifierThe authorization request identifier received from the tokenization service provider to authorize the credit card number. -
CreditCardExpirationDate: string
Title:
Credit Card Expiration DateThe date when the credit card expires. -
CreditCardIssuerCode: string
Title:
Credit Card Issuer CodeThe code for the credit card issuer, such as Visa or MasterCard. -
CreditCardTokenNumber: string
Title:
Credit Card Token NumberThe token number issued by tokenization service provider corresponding to a credit card number. -
Currency(required): string
Title:
CurrencyMaximum Length:15The currency of a standard receipt. -
CustomerAccountNumber: string
Title:
Customer Account NumberMaximum Length:30The customer account number of the customer on the standard receipt. -
CustomerBankAccountNumber: string
Title:
Customer Bank Account NumberThe bank account number of the customer on the standard receipt. -
CustomerName: string
Title:
Customer NameMaximum Length:360The name of the customer on the standard receipt. -
CustomerSite: string
Title:
Customer SiteMaximum Length:150The customer site of the customer on the standard receipt. -
DocumentNumber: integer
(int64)
Title:
Document NumberThe document sequence number on the standard receipt. -
MaturityDate: string
(date)
Title:
Maturity DateThe date when the standard receipt is matured. -
PostmarkDate: string
(date)
Title:
Postmark DateThe date when the standard receipt is postmarked. -
ReceiptDate(required): string
(date)
Title:
Receipt DateThe date when the standard receipt was created. -
ReceiptMethod(required): string
Title:
Receipt MethodMaximum Length:30The receipt method used on the standard receipt. -
ReceiptNumber: string
Title:
Receipt NumberMaximum Length:30The receipt number of the standard receipt. -
RemittanceBankAccountNumber: string
Title:
Remittance Bank Account NumberMaximum Length:30The remittance bank account number on the standard receipt. -
RemittanceBankAllowOverride: string
Title:
Remittance Bank Allow OverrideMaximum Length:1The options that allow the remittance selection process to override the remittance account on a standard receipt. -
RemittanceBankDepositDate: string
(date)
Title:
Remittance Bank Deposit DateThe date when the standard receipt was deposited. -
remittanceReferences: array
Remittance References
Title:
Remittance ReferencesThe remittance references resource is used to add one or more remittance references to a standard receipt. -
standardReceiptDFF: array
Standard Receipt Descriptive Flexfields
Title:
Standard Receipt Descriptive FlexfieldsThe standard receipts DFF resource is used to add one or more descriptive flexfield values to a standard receipt. -
standardReceiptGdf: array
Standard Receipt Global Descriptive Flexfields
Title:
Standard Receipt Global Descriptive FlexfieldsThe standard receipts GDF resource is used to add one or more global descriptive flexfield values to a standard receipt. -
StandardReceiptId: integer
(int64)
Title:
Standard Receipt IDThe unique identifier of the standard receipt. -
StructuredPaymentReference: string
Title:
Structured Payment ReferenceMaximum Length:256An industry standard reference on Receivables transactions composed of letters, check digits, and transaction information, used to identify the transaction and its payments to the customer and bank. -
VoiceAuthorizationCode: string
Title:
Credit Card Voice Authorization CodeThe voice authorization code received from tokenization service provider for authorization.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to add one or more attachments to a standard receipt.
Show Source
Nested Schema : Remittance References
Type:
arrayTitle:
Remittance ReferencesThe remittance references resource is used to add one or more remittance references to a standard receipt.
Show Source
Nested Schema : Standard Receipt Descriptive Flexfields
Type:
arrayTitle:
Standard Receipt Descriptive FlexfieldsThe standard receipts DFF resource is used to add one or more descriptive flexfield values to a standard receipt.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "ORA_ZENGIN_CASH_RECEIPTS":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptDff_view_StandardReceiptFLEXORA__5FZENGIN__5FCASH__5FRECEIPTSVO-item-post-request" } }
Nested Schema : Standard Receipt Global Descriptive Flexfields
Type:
arrayTitle:
Standard Receipt Global Descriptive FlexfieldsThe standard receipts GDF resource is used to add one or more global descriptive flexfield values to a standard receipt.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "FVxUSARCashReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfFVxUSARCashReceiptsVO-item-post-request", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request", "JAxJPReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxJPReceiptsVO-item-post-request", "JAxTWReceiptInformation":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxTWReceiptInformationVO-item-post-request", "JExFRReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExFRReceiptsVO-item-post-request", "JExILReceiptInformation":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExILReceiptInformationVO-item-post-request", "JExPTAdditionalInfo":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExPTAdditionalInfoVO-item-post-request", "JLxARReceiptInformation":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxARReceiptInformationVO-item-post-request", "JLxMXReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxMXReceiptsVO-item-post-request" } }
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe value that indicates the data type code of the attachment. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attachment file. -
UploadedText: string
Title:
Uploaded TextThe text of the attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of the attachment.
Nested Schema : schema
Type:
Show Source
object-
CustomerReason: string
Title:
Customer ReasonMaximum Length:30Customer reason for Channel Revenue Management deductions and overpayments associated with an application. -
CustomerReference: string
Title:
Customer ReferenceMaximum Length:100Reference supplied by the customer for a Channel Revenue Management claim. -
ReceiptMatchBy: string
Title:
Receipt Match ByThe document type used to match the standard receipt to a transaction. -
ReferenceAmount: number
Title:
Reference AmountThe receipt application amount. -
ReferenceNumber: string
Title:
Reference NumberMaximum Length:50The unique identifier of the selected document type. -
RemittanceReferenceId: integer
(int64)
Title:
Remittance Reference IDThe unique identifier of the remittance reference of the standard receipt.
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
- FVxUSARCashReceipts
- JA_CN_REMIT_BILL_NUM
- JAxJPReceipts
- JAxTWReceiptInformation
- JExFRReceipts
- JExILReceiptInformation
- JExPTAdditionalInfo
- JLxARReceiptInformation
- JLxMXReceipts
Match One Schema
Show Source
- FVxUSARCashReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfFVxUSARCashReceiptsVO-item-post-request
- JA_CN_REMIT_BILL_NUM - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request
- JAxJPReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxJPReceiptsVO-item-post-request
- JAxTWReceiptInformation - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxTWReceiptInformationVO-item-post-request
- JExFRReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExFRReceiptsVO-item-post-request
- JExILReceiptInformation - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExILReceiptInformationVO-item-post-request
- JExPTAdditionalInfo - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExPTAdditionalInfoVO-item-post-request
- JLxARReceiptInformation - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxARReceiptInformationVO-item-post-request
- JLxMXReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxMXReceiptsVO-item-post-request
Response
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 : standardReceipts-item-response
Type:
Show Source
object-
AccountedAmount: number
Title:
Accounted AmountRead Only:trueThe receipt amount in the functional currency. -
AccountingDate: string
(date)
Title:
Accounting DateThe date when the standard receipt is accounted. -
Amount: number
Title:
Receipt AmountThe amount of a standard receipt. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to add one or more attachments to a standard receipt. -
BusinessUnit: string
Title:
Business UnitMaximum Length:240A unit of an enterprise that performs one or more business functions that can be accumulated in a management hierarchy. -
CardHolderFirstName: string
Title:
First Name of the Credit Card HolderThe first name of the credit card holder. -
CardHolderLastName: string
Title:
Last Name of the Credit Card HolderThe last name of the credit card holder. -
Comments: string
Title:
CommentsMaximum Length:2000The comments about this receipt. -
ConversionDate: string
(date)
Title:
Conversion DateThe date when the standard receipt was converted. -
ConversionRate: number
Title:
Conversion RateThe conversion rate between the standard receipt currency and the ledger currency. -
ConversionRateType: string
Title:
Conversion Rate TypeMaximum Length:30The conversion rate type of a standard receipt. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreditCardAuthorizationRequestIdentifier: integer
Title:
Credit Card Authorization Request IdentifierThe authorization request identifier received from the tokenization service provider to authorize the credit card number. -
CreditCardExpirationDate: string
Title:
Credit Card Expiration DateThe date when the credit card expires. -
CreditCardIssuerCode: string
Title:
Credit Card Issuer CodeThe code for the credit card issuer, such as Visa or MasterCard. -
CreditCardTokenNumber: string
Title:
Credit Card Token NumberThe token number issued by tokenization service provider corresponding to a credit card number. -
Currency: string
Title:
CurrencyMaximum Length:15The currency of a standard receipt. -
CustomerAccountNumber: string
Title:
Customer Account NumberMaximum Length:30The customer account number of the customer on the standard receipt. -
CustomerBank: string
Title:
Customer BankRead Only:trueMaximum Length:360The bank name of the customer on the standard receipt. -
CustomerBankAccountNumber: string
Title:
Customer Bank Account NumberThe bank account number of the customer on the standard receipt. -
CustomerBankBranch: string
Title:
Customer Bank BranchRead Only:trueMaximum Length:360The bank branch name of the customer on the standard receipt. -
CustomerName: string
Title:
Customer NameMaximum Length:360The name of the customer on the standard receipt. -
CustomerSite: string
Title:
Customer SiteMaximum Length:150The customer site of the customer on the standard receipt. -
DocumentNumber: integer
(int64)
Title:
Document NumberThe document sequence number on the standard receipt. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaturityDate: string
(date)
Title:
Maturity DateThe date when the standard receipt is matured. -
PostmarkDate: string
(date)
Title:
Postmark DateThe date when the standard receipt is postmarked. -
ReceiptAtRisk: string
Title:
Receipt at RiskRead Only:trueMaximum Length:1Identifies whether the receipt is currently at risk with the remittance bank. -
ReceiptBatchDate: string
(date)
Title:
Receipt Batch DateRead Only:trueThe date of the receipt batch. -
ReceiptBatchName: string
Title:
Receipt Batch NameRead Only:trueMaximum Length:20The name of the receipt batch. -
ReceiptDate: string
(date)
Title:
Receipt DateThe date when the standard receipt was created. -
ReceiptMethod: string
Title:
Receipt MethodMaximum Length:30The receipt method used on the standard receipt. -
ReceiptNumber: string
Title:
Receipt NumberMaximum Length:30The receipt number of the standard receipt. -
ReceivablesSpecialist: string
Title:
Receivables SpecialistRead Only:trueMaximum Length:360The Receivables specialist assigned to the standard receipt. -
RemittanceBankAccountNumber: string
Title:
Remittance Bank Account NumberMaximum Length:30The remittance bank account number on the standard receipt. -
RemittanceBankAllowOverride: string
Title:
Remittance Bank Allow OverrideMaximum Length:1The options that allow the remittance selection process to override the remittance account on a standard receipt. -
RemittanceBankBranch: string
Title:
Remittance Bank BranchRead Only:trueMaximum Length:360The remittance bank branch name on the standard receipt. -
RemittanceBankDepositDate: string
(date)
Title:
Remittance Bank Deposit DateThe date when the standard receipt was deposited. -
RemittanceBankName: string
Title:
Remittance Bank NameRead Only:trueMaximum Length:360The remittance bank name on the standard receipt. -
remittanceReferences: array
Remittance References
Title:
Remittance ReferencesThe remittance references resource is used to add one or more remittance references to a standard receipt. -
ReversalCategory: string
Title:
Reversal CategoryRead Only:trueMaximum Length:80The category assigned to the receipt reversal. -
ReversalComments: string
Title:
Reversal CommentsRead Only:trueMaximum Length:240The user-entered comments accompanying the receipt reversal. -
ReversalDate: string
(date)
Title:
Reversal DateRead Only:trueThe date when the receipt was reversed. -
ReversalReason: string
Title:
Reversal ReasonRead Only:trueMaximum Length:80The reason code assigned to the receipt reversal. -
standardReceiptDFF: array
Standard Receipt Descriptive Flexfields
Title:
Standard Receipt Descriptive FlexfieldsThe standard receipts DFF resource is used to add one or more descriptive flexfield values to a standard receipt. -
standardReceiptGdf: array
Standard Receipt Global Descriptive Flexfields
Title:
Standard Receipt Global Descriptive FlexfieldsThe standard receipts GDF resource is used to add one or more global descriptive flexfield values to a standard receipt. -
StandardReceiptId: integer
(int64)
Title:
Standard Receipt IDThe unique identifier of the standard receipt. -
State: string
Title:
StateRead Only:trueMaximum Length:255The state of the current payment entry progress in the standard receipt. The valid values are APPLIED, UNAPPLIED, UNIDENTIFIED, INSUFFICIENT FUNDS, REVERSE PAYMENT, and STOP PAYMENT. -
Status: string
Title:
StatusRead Only:trueMaximum Length:255The status of the entered payment. The valid values are CONFIRMED, CLEARED, APPROVED, and REMITTED. -
StructuredPaymentReference: string
Title:
Structured Payment ReferenceMaximum Length:256An industry standard reference on Receivables transactions composed of letters, check digits, and transaction information, used to identify the transaction and its payments to the customer and bank. -
TaxpayerIdentificationNumber: string
Title:
Taxpayer Identification NumberRead Only:trueMaximum Length:20The tax payer identification number of the customer on the standard receipt. -
UnappliedAmount: number
Title:
Unapplied AmountRead Only:trueThe receipt amount that is unapplied to any transaction in the receipt currency. -
VoiceAuthorizationCode: string
Title:
Credit Card Voice Authorization CodeThe voice authorization code received from tokenization service provider for authorization.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to add one or more attachments to a standard receipt.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Remittance References
Type:
arrayTitle:
Remittance ReferencesThe remittance references resource is used to add one or more remittance references to a standard receipt.
Show Source
Nested Schema : Standard Receipt Descriptive Flexfields
Type:
arrayTitle:
Standard Receipt Descriptive FlexfieldsThe standard receipts DFF resource is used to add one or more descriptive flexfield values to a standard receipt.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "ORA_ZENGIN_CASH_RECEIPTS":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptDff_view_StandardReceiptFLEXORA__5FZENGIN__5FCASH__5FRECEIPTSVO-item-response" } }
Nested Schema : Standard Receipt Global Descriptive Flexfields
Type:
arrayTitle:
Standard Receipt Global Descriptive FlexfieldsThe standard receipts GDF resource is used to add one or more global descriptive flexfield values to a standard receipt.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "FVxUSARCashReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfFVxUSARCashReceiptsVO-item-response", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response", "JAxJPReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxJPReceiptsVO-item-response", "JAxTWReceiptInformation":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxTWReceiptInformationVO-item-response", "JExFRReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExFRReceiptsVO-item-response", "JExILReceiptInformation":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExILReceiptInformationVO-item-response", "JExPTAdditionalInfo":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExPTAdditionalInfoVO-item-response", "JLxARReceiptInformation":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxARReceiptInformationVO-item-response", "JLxMXReceipts":"#/components/schemas/oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxMXReceiptsVO-item-response" } }
Nested Schema : standardReceipts-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe value that indicates the data type code of the attachment. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attachment file. -
UploadedText: string
Title:
Uploaded TextThe text of the attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login associated with the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
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 : standardReceipts-remittanceReferences-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CustomerReason: string
Title:
Customer ReasonMaximum Length:30Customer reason for Channel Revenue Management deductions and overpayments associated with an application. -
CustomerReference: string
Title:
Customer ReferenceMaximum Length:100Reference supplied by the customer for a Channel Revenue Management claim. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReceiptMatchBy: string
Title:
Receipt Match ByThe document type used to match the standard receipt to a transaction. -
ReferenceAmount: number
Title:
Reference AmountThe receipt application amount. -
ReferenceNumber: string
Title:
Reference NumberMaximum Length:50The unique identifier of the selected document type. -
RemittanceReferenceId: integer
(int64)
Title:
Remittance Reference IDThe unique identifier of the remittance reference of the standard receipt.
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
Match One Schema
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
- FVxUSARCashReceipts
- JA_CN_REMIT_BILL_NUM
- JAxJPReceipts
- JAxTWReceiptInformation
- JExFRReceipts
- JExILReceiptInformation
- JExPTAdditionalInfo
- JLxARReceiptInformation
- JLxMXReceipts
Match One Schema
Show Source
- FVxUSARCashReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfFVxUSARCashReceiptsVO-item-response
- JA_CN_REMIT_BILL_NUM - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response
- JAxJPReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxJPReceiptsVO-item-response
- JAxTWReceiptInformation - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJAxTWReceiptInformationVO-item-response
- JExFRReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExFRReceiptsVO-item-response
- JExILReceiptInformation - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExILReceiptInformationVO-item-response
- JExPTAdditionalInfo - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJExPTAdditionalInfoVO-item-response
- JLxARReceiptInformation - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxARReceiptInformationVO-item-response
- JLxMXReceipts - object oracle_apps_flex_financials_receivables_receipts_shared_restModel_StandardReceiptGdf_view_StandardReceiptGdfJLxMXReceiptsVO-item-response
Links
- attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachmentsParameters:
- StandardReceiptId:
$request.path.StandardReceiptId
The attachments resource is used to add one or more attachments to a standard receipt. - StandardReceiptId:
- remittanceReferences
-
Operation: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/remittanceReferencesParameters:
- StandardReceiptId:
$request.path.StandardReceiptId
The remittance references resource is used to add one or more remittance references to a standard receipt. - StandardReceiptId:
- standardReceiptDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptDFFParameters:
- StandardReceiptId:
$request.path.StandardReceiptId
The standard receipts DFF resource is used to add one or more descriptive flexfield values to a standard receipt. - StandardReceiptId:
- standardReceiptGdf
-
Operation: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptGdfParameters:
- StandardReceiptId:
$request.path.StandardReceiptId
The standard receipts GDF resource is used to add one or more global descriptive flexfield values to a standard receipt. - StandardReceiptId:
Examples
Example 1
The following example shows how to create a standard receipt 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/standardReceipts
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"ReceiptNumber":"SKR_Receipt_1009",
"ReceiptMethod":"Manual",
"BusinessUnit":"Vision Operations",
"CustomerAccountNumber":"1004",
"CustomerSite":"Tulsa (OPS)",
"Amount":451.2343,
"Currency":"USD",
"RemittanceBankAccountNumber":"10271-17621-619"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"ReceiptNumber":"SKR_Receipt_1009",
"ReceiptMethod":"Manual",
"BusinessUnit":"Vision Operations",
"CustomerAccountNumber":"1004",
"CustomerSite":"Tulsa (OPS)",
"Amount":451.2343,
"Currency":"USD",
"RemittanceBankAccountNumber":"10271-17621-619,
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169023",
"name": "standardReceipts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169023/child/remittanceReferences",
"name": "remittanceReferences",
"kind": "collection"
},
...
]
}
Example 2
The following example shows how to create a standard receipt with remittance references 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/standardReceipts
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"ReceiptNumber":"SKR_Receipt_1011",
"ReceiptMethod":"Manual",
"BusinessUnit":"Vision Operations",
"CustomerAccountNumber":"1004",
...
"remittanceReferences":
[
{
"ReceiptMatchBy":"Purchase Order",
"ReferenceNumber":"SK_PO_1012",
"ReferenceAmount":"8774.45"
},
{
"ReceiptMatchBy":"Transaction Number",
"ReferenceNumber":"SK_TRX_1013",
"ReferenceAmount":"6895.63"
}
]
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"StandardReceiptId": 300100169169033,
"ReceiptNumber": "SKR_Receipt_1011",
"BusinessUnit": "Vision Operations",
"ReceiptMethod": "Manual",
...
"remittanceReferences": [
{
"RemittanceReferenceId": 300100169169034,
"ReceiptMatchBy": "Purchase Order",
"ReferenceNumber": "SK_PO_1012",
"ReferenceAmount": 8774.45,
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169033/child/remittanceReferences/300100169169034",
"name": "remittanceReferences",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169033/child/remittanceReferences/300100169169034",
"name": "remittanceReferences",
"kind": "item"
},
...
]
},
{
"RemittanceReferenceId": 300100169169035,
"ReceiptMatchBy": "Transaction Number",
"ReferenceNumber": "SK_TRX_1013",
"ReferenceAmount": 6895.63,
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169033/child/remittanceReferences/300100169169035",
"name": "remittanceReferences",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169033/child/remittanceReferences/300100169169035",
"name": "remittanceReferences",
"kind": "item"
},
...
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169033",
"name": "standardReceipts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169033/child/remittanceReferences",
"name": "remittanceReferences",
"kind": "collection"
},
...
]
}