Update an external transaction
/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}
Request
-
ExternalTransactionId(required): integer(int64)
The unique identifier of the external transaction.
-
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.
- application/json
object
-
AccountingFlag: boolean
Maximum Length:
1
Default Value:true
The option that indicates whether the accounting event is raised when the external transaction is reconciled. -
Amount: number
The transaction amount of the external transaction.
-
AssetAccountCombination: string
The cash general ledger account code combination of the external transaction.
-
attachments: array
Attachments
Title:
Attachments
The attachments resource manages documents that are attached by the user to the external transaction. -
BankAccountName: string
Maximum Length:
360
The name of the bank account associated to the external transaction. -
BankConversionRate: number
The accounting conversion rate used to convert the external transaction amount from the bank account currency to the ledger currency.
-
BankConversionRateType: string
Maximum Length:
30
The accounting conversion rate type used to convert the external transaction amount from the bank account currency to the ledger currency. -
BusinessUnitName: string
The name of the business unit associated to the external transaction.
-
cashExternalTransactionDFF: array
Descriptive Flexfields
Title:
Descriptive Flexfields
The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction. -
ClearedDate: string
(date)
The date when the external transaction is cleared.
-
CurrencyCode: string
Maximum Length:
15
The currency code of the external transaction. -
Description: string
Maximum Length:
360
The description of the external transaction. -
ExternalTransactionId: integer
(int64)
The unique identifier of the external transaction.
-
LegalEntityName: string
The name of the legal entity associated to the external transaction.
-
OffsetAccountCombination: string
The offset general ledger account code combination of the external transaction.
-
ReferenceText: string
Maximum Length:
50
The reconciliation reference of the external transaction. -
Source: string
Maximum Length:
30
Default Value:MANUAL
The source of the external transaction. The default value is Imported. -
Status: string
Maximum Length:
30
Default Value:UNR
The status of the external transaction. The default value is UNR for Unreconciled. Unreconciled external transactions can be rendered as void by updating this attribute to VOID. -
TransactionDate: string
(date)
The date when the external transaction is created.
-
TransactionType: string
Maximum Length:
30
The transaction type of the external transaction. Examples include Bank adjustment, Fee, Check, Electronic funds transfer, Interest, Zero balancing, Lockbox, Miscellaneous, and Automated clearing house. A list of accepted values is defined in the lookup type CE_TRX_TYPE. -
TransferId: integer
(int64)
The unique identifier of the bank account transfer or the ad hoc payment that created the external transaction.
-
ValueDate: string
(date)
The actual value date of the external transaction.
array
Attachments
array
Descriptive Flexfields
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description for 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 expiration date of the contents in the attachment. -
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. -
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.
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
The descriptive flexfield context name for external transactions. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for external transactions. -
ExternalTransactionId: integer
(int64)
The unique external transaction identifier.
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
-
AccntServicerReference: string
Title:
Account Servicer Reference
Read Only:true
Maximum Length:50
The reference number assigned by the account servicing institution for the underlying payment, receipt, external transaction, or payroll payment. -
AccountingFlag: boolean
Maximum Length:
1
Default Value:true
The option that indicates whether the accounting event is raised when the external transaction is reconciled. -
AddendaTxt: string
Title:
Additional Entry Information
Read Only:true
Maximum Length:1000
Additional information about the entry details. -
Amount: number
The transaction amount of the external transaction.
-
AssetAccountCombination: string
The cash general ledger account code combination of the external transaction.
-
attachments: array
Attachments
Title:
Attachments
The attachments resource manages documents that are attached by the user to the external transaction. -
BankAccountName: string
Maximum Length:
360
The name of the bank account associated to the external transaction. -
BankConversionRate: number
The accounting conversion rate used to convert the external transaction amount from the bank account currency to the ledger currency.
-
BankConversionRateType: string
Maximum Length:
30
The accounting conversion rate type used to convert the external transaction amount from the bank account currency to the ledger currency. -
BankTransactionId: string
Read Only:
true
Maximum Length:20
Unique identifier of the bank transaction on the statement line. -
BusinessUnitName: string
The name of the business unit associated to the external transaction.
-
cashExternalTransactionDFF: array
Descriptive Flexfields
Title:
Descriptive Flexfields
The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction. -
CheckNumber: string
Title:
Check Number
Read Only:true
Maximum Length:40
The check number of the underlying transaction. -
ClearedDate: string
(date)
The date when the external transaction is cleared.
-
ClearingSystemReference: string
Title:
Clearing System Reference
Read Only:true
Maximum Length:50
The unique identifier assigned by the clearing system to a payment instruction. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the external transaction. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the external transaction was created. -
CurrencyCode: string
Maximum Length:
15
The currency code of the external transaction. -
CustomerReference: string
Title:
Customer Reference
Read Only:true
Maximum Length:30
The customer reference used by BAI format. -
Description: string
Maximum Length:
360
The description of the external transaction. -
EndToEndId: string
Title:
End to End ID
Read Only:true
Maximum Length:100
The unique identification assigned by the initiating party to the transaction. It's passed on unchanged throughout the entire end to end chain. -
ExternalTransactionId: integer
(int64)
The unique identifier of the external transaction.
-
InstructionIdentification: string
Title:
Instruction ID
Read Only:true
Maximum Length:100
The unique identification which is a point to point reference used between the instructing party and the instructed party to refer to an individual instruction. It's assigned by the instructing party to the instructed party and can be included in several messages related to the instruction. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the external transaction was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the external transaction. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the external transaction. -
LegalEntityName: string
The name of the legal entity associated to the external transaction.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OffsetAccountCombination: string
The offset general ledger account code combination of the external transaction.
-
ReconReference: string
Title:
Reconciliation Reference
Read Only:true
Maximum Length:50
The reference to the underlying transaction information. -
ReferenceText: string
Maximum Length:
50
The reconciliation reference of the external transaction. -
Source: string
Maximum Length:
30
Default Value:MANUAL
The source of the external transaction. The default value is Imported. -
Status: string
Maximum Length:
30
Default Value:UNR
The status of the external transaction. The default value is UNR for Unreconciled. Unreconciled external transactions can be rendered as void by updating this attribute to VOID. -
StructuredPaymentReference: string
Read Only:
true
Maximum Length:256
The structured payment reference or receipt reference on the bank statement line. -
TransactionDate: string
(date)
The date when the external transaction is created.
-
TransactionId: integer
(int64)
The sequence number transaction identifier of the external transaction.
-
TransactionType: string
Maximum Length:
30
The transaction type of the external transaction. Examples include Bank adjustment, Fee, Check, Electronic funds transfer, Interest, Zero balancing, Lockbox, Miscellaneous, and Automated clearing house. A list of accepted values is defined in the lookup type CE_TRX_TYPE. -
TransferId: integer
(int64)
The unique identifier of the bank account transfer or the ad hoc payment that created the external transaction.
-
ValueDate: string
(date)
The actual value date of the external transaction.
array
Attachments
array
Descriptive Flexfields
array
Links
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 and time when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description for 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 expiration date of the contents in the attachment. -
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 user who created the attachment.
array
Links
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
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
The descriptive flexfield context name for external transactions. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for external transactions. -
ExternalTransactionId: integer
(int64)
The unique external transaction identifier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
- attachments
-
Parameters:
- ExternalTransactionId:
$request.path.ExternalTransactionId
The attachments resource manages documents that are attached by the user to the external transaction. - ExternalTransactionId:
- cashExternalTransactionDFF
-
Parameters:
- ExternalTransactionId:
$request.path.ExternalTransactionId
The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction. - ExternalTransactionId:
Examples
The following example shows how to update an external transaction by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100188229669
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "Amount": 145, "Description": "CE_REST_External_Transaction_Updated", "AccountingFlag" : true }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AccountingFlag" : true, "Amount" : 145, "Description" : "CE_REST_External_Transaction_Updated", "ExternalTransactionId" : 300100188229669, ... "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100188229669", "name" : "cashExternalTransactions", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "child", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100188229669/child/attachments", "name" : "attachments", "kind" : "collection" }, ... ] }
An external transaction can be made void by updating it's status attribute.
The following example shows how to update an external transaction, to make it void, by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100188229669
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "Status" : "VOID" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AccountingFlag" : true, "Amount" : 145, "ClearedDate" : null, "Status" : "VOID", ... "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100188229669", "name" : "cashExternalTransactions", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "child", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100188229669/child/attachments", "name" : "attachments", "kind" : "collection" }, ... ] }