Get a standard receipt
get
/fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}
Request
Path Parameters
-
StandardReceiptId(required): integer(int64)
The unique identifier of the standard receipt.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : standardReceipts-item-response
Type:
Show Source
object
-
AccountedAmount: number
Title:
Accounted Amount
Read Only:true
The receipt amount in the functional currency. -
AccountingDate: string
(date)
Title:
Accounting Date
The date when the standard receipt is accounted. -
Amount: number
Title:
Receipt Amount
The amount of a standard receipt. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to add one or more attachments to a standard receipt. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:240
A 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 Holder
The first name of the credit card holder. -
CardHolderLastName: string
Title:
Last Name of the Credit Card Holder
The last name of the credit card holder. -
Comments: string
Title:
Comments
Maximum Length:2000
The comments about this receipt. -
ConversionDate: string
(date)
Title:
Conversion Date
The date when the standard receipt was converted. -
ConversionRate: number
Title:
Conversion Rate
The conversion rate between the standard receipt currency and the ledger currency. -
ConversionRateType: string
Title:
Conversion Rate Type
Maximum Length:30
The conversion rate type of a standard receipt. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreditCardAuthorizationRequestIdentifier: integer
Title:
Credit Card Authorization Request Identifier
The authorization request identifier received from the tokenization service provider to authorize the credit card number. -
CreditCardExpirationDate: string
Title:
Credit Card Expiration Date
The date when the credit card expires. -
CreditCardIssuerCode: string
Title:
Credit Card Issuer Code
The code for the credit card issuer, such as Visa or MasterCard. -
CreditCardTokenNumber: string
Title:
Credit Card Token Number
The token number issued by tokenization service provider corresponding to a credit card number. -
Currency: string
Title:
Currency
Maximum Length:15
The currency of a standard receipt. -
CustomerAccountNumber: string
Title:
Customer Account Number
Maximum Length:30
The customer account number of the customer on the standard receipt. -
CustomerBank: string
Title:
Customer Bank
Read Only:true
Maximum Length:360
The bank name of the customer on the standard receipt. -
CustomerBankAccountNumber: string
Title:
Customer Bank Account Number
The bank account number of the customer on the standard receipt. -
CustomerBankBranch: string
Title:
Customer Bank Branch
Read Only:true
Maximum Length:360
The bank branch name of the customer on the standard receipt. -
CustomerName: string
Title:
Customer Name
Maximum Length:360
The name of the customer on the standard receipt. -
CustomerSite: string
Title:
Customer Site
Maximum Length:150
The customer site of the customer on the standard receipt. -
DocumentNumber: integer
(int64)
Title:
Document Number
The document sequence number on the standard receipt. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaturityDate: string
(date)
Title:
Maturity Date
The date when the standard receipt is matured. -
PostmarkDate: string
(date)
Title:
Postmark Date
The date when the standard receipt is postmarked. -
ReceiptAtRisk: string
Title:
Receipt at Risk
Read Only:true
Maximum Length:1
Identifies whether the receipt is currently at risk with the remittance bank. -
ReceiptBatchDate: string
(date)
Title:
Receipt Batch Date
Read Only:true
The date of the receipt batch. -
ReceiptBatchName: string
Title:
Receipt Batch Name
Read Only:true
Maximum Length:20
The name of the receipt batch. -
ReceiptDate: string
(date)
Title:
Receipt Date
The date when the standard receipt was created. -
ReceiptMethod: string
Title:
Receipt Method
Maximum Length:30
The receipt method used on the standard receipt. -
ReceiptNumber: string
Title:
Receipt Number
Maximum Length:30
The receipt number of the standard receipt. -
ReceivablesSpecialist: string
Title:
Receivables Specialist
Read Only:true
Maximum Length:360
The Receivables specialist assigned to the standard receipt. -
RemittanceBankAccountNumber: string
Title:
Remittance Bank Account Number
Maximum Length:30
The remittance bank account number on the standard receipt. -
RemittanceBankAllowOverride: string
Title:
Remittance Bank Allow Override
Maximum Length:1
The options that allow the remittance selection process to override the remittance account on a standard receipt. -
RemittanceBankBranch: string
Title:
Remittance Bank Branch
Read Only:true
Maximum Length:360
The remittance bank branch name on the standard receipt. -
RemittanceBankDepositDate: string
(date)
Title:
Remittance Bank Deposit Date
The date when the standard receipt was deposited. -
RemittanceBankName: string
Title:
Remittance Bank Name
Read Only:true
Maximum Length:360
The remittance bank name on the standard receipt. -
remittanceReferences: array
Remittance References
Title:
Remittance References
The remittance references resource is used to add one or more remittance references to a standard receipt. -
ReversalCategory: string
Title:
Reversal Category
Read Only:true
Maximum Length:80
The category assigned to the receipt reversal. -
ReversalComments: string
Title:
Reversal Comments
Read Only:true
Maximum Length:240
The user-entered comments accompanying the receipt reversal. -
ReversalDate: string
(date)
Title:
Reversal Date
Read Only:true
The date when the receipt was reversed. -
ReversalReason: string
Title:
Reversal Reason
Read Only:true
Maximum Length:80
The reason code assigned to the receipt reversal. -
standardReceiptDFF: array
Standard Receipt Descriptive Flexfields
Title:
Standard Receipt Descriptive Flexfields
The 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 Flexfields
The 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 ID
The unique identifier of the standard receipt. -
State: string
Title:
State
Read Only:true
Maximum Length:255
The 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:
Status
Read Only:true
Maximum Length:255
The status of the entered payment. The valid values are CONFIRMED, CLEARED, APPROVED, and REMITTED. -
StructuredPaymentReference: string
Title:
Structured Payment Reference
Maximum Length:256
An 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 Number
Read Only:true
Maximum Length:20
The tax payer identification number of the customer on the standard receipt. -
UnappliedAmount: number
Title:
Unapplied Amount
Read Only:true
The receipt amount that is unapplied to any transaction in the receipt currency. -
VoiceAuthorizationCode: string
Title:
Credit Card Voice Authorization Code
The voice authorization code received from tokenization service provider for authorization.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to add one or more attachments to a standard receipt.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Remittance References
Type:
array
Title:
Remittance References
The 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:
array
Title:
Standard Receipt Descriptive Flexfields
The 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:
array
Title:
Standard Receipt Global Descriptive Flexfields
The 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 Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The value that indicates the data type code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
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 By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CustomerReason: string
Title:
Customer Reason
Maximum Length:30
Customer reason for Channel Revenue Management deductions and overpayments associated with an application. -
CustomerReference: string
Title:
Customer Reference
Maximum Length:100
Reference supplied by the customer for a Channel Revenue Management claim. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReceiptMatchBy: string
Title:
Receipt Match By
The document type used to match the standard receipt to a transaction. -
ReferenceAmount: number
Title:
Reference Amount
The receipt application amount. -
ReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The unique identifier of the selected document type. -
RemittanceReferenceId: integer
(int64)
Title:
Remittance Reference ID
The unique identifier of the remittance reference of the standard receipt.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __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
The following example shows how to retrieve a standard receipt by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169027
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "StandardReceiptId": 300100169169027, "ReceiptNumber": "SKR_Receipt_1010", "BusinessUnit": "Vision Operations", "ReceiptMethod": "Automatic Receipts", ... "links": [ { "rel": "self", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169027", "name": "standardReceipts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "child", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/standardReceipts/300100169169027/child/remittanceReferences", "name": "remittanceReferences", "kind": "collection" } ... ] }