Jump to

• Request
• Response
• Examples

Update an external transaction

patch

/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}

Request

Path Parameters

• ExternalTransactionId(required): integer(int64)
  The unique identifier of the external transaction.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"UNR"
        },
        "OffsetAccountCombination":{
            "type":"string",
            "description":"The offset general ledger account code combination of the external transaction.",
            "nullable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Description":{
            "maxLength":360,
            "type":"string",
            "description":"The description of the external transaction.",
            "nullable":true
        },
        "BankConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The accounting conversion rate type used to convert the external transaction amount from the bank account currency to the ledger currency.",
            "nullable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource manages documents that are attached by the user to the external transaction.",
            "items":{
                "$ref":"#/components/schemas/cashExternalTransactions-attachments-item-patch-request"
            }
        },
        "Amount":{
            "type":"number",
            "description":"The transaction amount of the external transaction.",
            "nullable":false
        },
        "AccountingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The option that indicates whether the accounting event is raised when the external transaction is reconciled.",
            "nullable":false,
            "default":true
        },
        "AssetAccountCombination":{
            "type":"string",
            "description":"The cash general ledger account code combination of the external transaction.",
            "nullable":true
        },
        "BankConversionRate":{
            "type":"number",
            "description":"The accounting conversion rate used to convert the external transaction amount from the bank account currency to the ledger currency.",
            "nullable":true
        },
        "Source":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the external transaction. The default value is Imported.",
            "nullable":false,
            "default":"MANUAL"
        },
        "cashExternalTransactionDFF":{
            "title":"Descriptive Flexfields",
            "type":"array",
            "description":"The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.",
            "items":{
                "$ref":"#/components/schemas/cashExternalTransactions-cashExternalTransactionDFF-item-patch-request"
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the external transaction.",
            "nullable":false
        },
        "BankAccountName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the bank account associated to the external transaction.",
            "nullable":true
        },
        "ClearedDate":{
            "type":"string",
            "description":"The date when the external transaction is cleared.",
            "format":"date",
            "nullable":true
        },
        "ReferenceText":{
            "maxLength":50,
            "type":"string",
            "description":"The reconciliation reference of the external transaction.",
            "nullable":true
        },
        "LegalEntityName":{
            "type":"string",
            "description":"The name of the legal entity associated to the external transaction.",
            "nullable":true
        },
        "ExternalTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the external transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ValueDate":{
            "type":"string",
            "description":"The actual value date of the external transaction.",
            "format":"date",
            "nullable":true
        },
        "TransferId":{
            "type":"integer",
            "description":"The unique identifier of the bank account transfer or the ad hoc payment that created the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessUnitName":{
            "type":"string",
            "description":"The name of the business unit associated to the external transaction.",
            "nullable":true
        },
        "TransactionDate":{
            "type":"string",
            "description":"The date when the external transaction is created.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource manages documents that are attached by the user to the external transaction.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource manages documents that are attached by the user to the external transaction.",
    "items":{
        "$ref":"#/components/schemas/cashExternalTransactions-attachments-item-patch-request"
    }
}

Nested Schema : Descriptive Flexfields

Type: array

Title: Descriptive Flexfields

The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.

Show Source

• Array of: object schema

{
    "title":"Descriptive Flexfields",
    "type":"array",
    "description":"The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.",
    "items":{
        "$ref":"#/components/schemas/cashExternalTransactions-cashExternalTransactionDFF-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  The option to indicate whether the attachment is shared.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"The option to indicate whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "ExternalTransactionId":{
            "type":"integer",
            "description":"The unique external transaction identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The descriptive flexfield context display value for external transactions.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"The descriptive flexfield context name for external transactions.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.

Body ()

Root Schema : cashExternalTransactions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the external transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OffsetAccountCombination":{
            "type":"string",
            "description":"The offset general ledger account code combination of the external transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":360,
            "type":"string",
            "description":"The description of the external transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource manages documents that are attached by the user to the external transaction.",
            "items":{
                "$ref":"#/components/schemas/cashExternalTransactions-attachments-item-response"
            }
        },
        "AddendaTxt":{
            "title":"Additional Entry Information",
            "maxLength":1000,
            "type":"string",
            "description":"Additional information about the entry details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReconReference":{
            "title":"Reconciliation Reference",
            "maxLength":50,
            "type":"string",
            "description":"The reference to the underlying transaction information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The option that indicates whether the accounting event is raised when the external transaction is reconciled.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "AssetAccountCombination":{
            "type":"string",
            "description":"The cash general ledger account code combination of the external transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "BankConversionRate":{
            "type":"number",
            "description":"The accounting conversion rate used to convert the external transaction amount from the bank account currency to the ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "Source":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the external transaction. The default value is Imported.",
            "nullable":false,
            "default":"MANUAL",
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the external transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "ClearingSystemReference":{
            "title":"Clearing System Reference",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier assigned by the clearing system to a payment instruction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityName":{
            "type":"string",
            "description":"The name of the legal entity associated to the external transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the external transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValueDate":{
            "type":"string",
            "description":"The actual value date of the external transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransferId":{
            "type":"integer",
            "description":"The unique identifier of the bank account transfer or the ad hoc payment that created the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "type":"string",
            "description":"The name of the business unit associated to the external transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "type":"string",
            "description":"The date when the external transaction is created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the external transaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"UNR",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the external transaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BankConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The accounting conversion rate type used to convert the external transaction amount from the bank account currency to the ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "InstructionIdentification":{
            "title":"Instruction ID",
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"The transaction amount of the external transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "CheckNumber":{
            "title":"Check Number",
            "maxLength":40,
            "type":"string",
            "description":"The check number of the underlying transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "cashExternalTransactionDFF":{
            "title":"Descriptive Flexfields",
            "type":"array",
            "description":"The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.",
            "items":{
                "$ref":"#/components/schemas/cashExternalTransactions-cashExternalTransactionDFF-item-response"
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"The sequence number transaction identifier of the external transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerReference":{
            "title":"Customer Reference",
            "maxLength":30,
            "type":"string",
            "description":"The customer reference used by BAI format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BankAccountName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the bank account associated to the external transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ClearedDate":{
            "type":"string",
            "description":"The date when the external transaction is cleared.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceText":{
            "maxLength":50,
            "type":"string",
            "description":"The reconciliation reference of the external transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "StructuredPaymentReference":{
            "maxLength":256,
            "type":"string",
            "description":"The structured payment reference or receipt reference on the bank statement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccntServicerReference":{
            "title":"Account Servicer Reference",
            "maxLength":50,
            "type":"string",
            "description":"The reference number assigned by the account servicing institution for the underlying payment, receipt, external transaction, or payroll payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndToEndId":{
            "title":"End to End ID",
            "maxLength":100,
            "type":"string",
            "description":"The unique identification assigned by the initiating party to the transaction. It's passed on unchanged throughout the entire end to end chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the external transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the external transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BankTransactionId":{
            "maxLength":20,
            "type":"string",
            "description":"Unique identifier of the bank transaction on the statement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource manages documents that are attached by the user to the external transaction.

Show Source

• Array of: object cashExternalTransactions-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource manages documents that are attached by the user to the external transaction.",
    "items":{
        "$ref":"#/components/schemas/cashExternalTransactions-attachments-item-response"
    }
}

Nested Schema : Descriptive Flexfields

Type: array

Title: Descriptive Flexfields

The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.

Show Source

• Array of: object cashExternalTransactions-cashExternalTransactionDFF-item-response

{
    "title":"Descriptive Flexfields",
    "type":"array",
    "description":"The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.",
    "items":{
        "$ref":"#/components/schemas/cashExternalTransactions-cashExternalTransactionDFF-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : cashExternalTransactions-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  The option to indicate whether the attachment is shared.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"The option to indicate whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : cashExternalTransactions-cashExternalTransactionDFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "ExternalTransactionId":{
            "type":"integer",
            "description":"The unique external transaction identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The descriptive flexfield context display value for external transactions.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"The descriptive flexfield context name for external transactions.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

attachments

Operation: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments

Parameters:

• ExternalTransactionId: $request.path.ExternalTransactionId

The attachments resource manages documents that are attached by the user to the external transaction.

cashExternalTransactionDFF

Operation: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/cashExternalTransactionDFF

Parameters:

• ExternalTransactionId: $request.path.ExternalTransactionId

The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.

Back to Top

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"
 },
 ... 
 ]
}

Back to Top