Jump to

• Request
• Response
• Examples

Update an intercompany transaction source document

patch

/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/{IntercompanyTrxSourceDocumentId}

Request

Path Parameters

• IntercompanyTrxSourceDocumentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• ApprovalRequiredFlag: boolean
  Maximum Length: 1

  Indicates whether the intercompany transaction approval is required.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ErrorMessage: string
  Maximum Length: 2000

  Intercompany transaction processing error details.
• IntercompanyAgreementNumber: string
  Maximum Length: 60

  Agreement number associated with the source document.
• intercompanyTransactionSourceDocumentDFF: array intercompanyTransactionSourceDocumentDFF
• Notes: string
  Maximum Length: 240

  A brief note or description that's added to the transfer authorization.
• ProcessingStatus: string
  Title: Meaning

  Maximum Length: 80

  Processing status of the intercompany transaction.
• ProcessingStatusCode: string
  Maximum Length: 30

  Processing status code of the intercompany transaction source document.
• TransferAuthorizationAmount: number
  Transaction amount for the transfer authorization.
• TransferAuthorizationAmountType: string
  Maximum Length: 80

  Amount type for the transfer authorization.
• TransferAuthorizationDescription: string
  Maximum Length: 240

  A brief description about the transfer authorization.
• TransferAuthorizationNumber: string
  Maximum Length: 50

  The unique number of the transfer authorization.
• TransferAuthorizationReference: string
  Maximum Length: 30

  Reference number for the transfer authorization.
• TransferAuthorizationTrxDate: string (date)
  Transaction date for the transfer authorization.
• TrxProviderAccountDistribution: string
  Provider account code combination of the intercompany transaction.

{
    "type":"object",
    "properties":{
        "intercompanyTransactionSourceDocumentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-attachments-item-patch-request"
            }
        },
        "TransferAuthorizationTrxDate":{
            "type":"string",
            "description":"Transaction date for the transfer authorization.",
            "format":"date",
            "nullable":true
        },
        "TrxProviderAccountDistribution":{
            "type":"string",
            "description":"Provider account code combination of the intercompany transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.commonModules.intercompanyTransactions.restModel.view.DocumentPreparationVO#TrxProviderAccountDistributionDetails",
                "FND_ACFF_ResourceName":"intercompanyTransactionSourceDocuments",
                "ojStructureInstanceNumber":"TrxProviderChartOfAccount"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "IntercompanyAgreementNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Agreement number associated with the source document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransferAuthorizationReference":{
            "maxLength":30,
            "type":"string",
            "description":"Reference number for the transfer authorization.",
            "nullable":true
        },
        "TransferAuthorizationNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The unique number of the transfer authorization.",
            "nullable":true
        },
        "TransferAuthorizationDescription":{
            "maxLength":240,
            "type":"string",
            "description":"A brief description about the transfer authorization.",
            "nullable":true
        },
        "ApprovalRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the intercompany transaction approval is required.",
            "nullable":true
        },
        "TransferAuthorizationAmountType":{
            "maxLength":80,
            "type":"string",
            "description":"Amount type for the transfer authorization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ErrorMessage":{
            "maxLength":2000,
            "type":"string",
            "description":"Intercompany transaction processing error details.",
            "nullable":true
        },
        "TransferAuthorizationAmount":{
            "type":"number",
            "description":"Transaction amount for the transfer authorization.",
            "nullable":true
        },
        "ProcessingStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Processing status of the intercompany transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcessingStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Processing status code of the intercompany transaction source document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Notes":{
            "maxLength":240,
            "type":"string",
            "description":"A brief note or description that's added to the transfer authorization.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object intercompanyTransactionSourceDocuments-attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-attachments-item-patch-request"
    }
}

Nested Schema : intercompanyTransactionSourceDocumentDFF

Type: array

Show Source

• Array of: object intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : intercompanyTransactionSourceDocuments-attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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 URI of the file.
• 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 size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type 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 of 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":"A value that indicates the data type.",
            "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"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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 a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates 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 from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text 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 size 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 document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "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:
  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.

Body ()

Root Schema : intercompanyTransactionSourceDocuments-item-response

Type: object

Show Source

• ApprovalRequiredFlag: boolean
  Maximum Length: 1

  Indicates whether the intercompany transaction approval is required.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BusinessUnit: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Business unit for the source document.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the source document.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the source document was created.
• DocumentAccountDistribution: string
  Account code combination for the source document.
• DocumentAction: string
  Read Only: true

  Maximum Length: 80

  Action type of the source document. Valid values are New Transaction and Reversal Transaction.
• DocumentAmount: number
  Transaction amount for the source document.
• DocumentAmountType: string
  Maximum Length: 80

  Amount type for the source document.
• DocumentChartOfAccount: integer
  Chart of account of the intercompany transaction source document.
• DocumentCurrencyCode: string
  Maximum Length: 15

  The currency code for the source document.
• DocumentDate: string (date)
  Document date for the source document.
• DocumentDescription: string
  Maximum Length: 240

  A brief description about the source document.
• DocumentDistributionNumber: integer (int64)
  Distribution number of the source document.
• DocumentFirstReferenceId: integer (int64)
  First reference identifier of the source document.
• DocumentLegalEntityId: integer (int64)
  The unique identifier of the legal entity associated with the source document.
• DocumentLineNumber: integer (int64)
  Document line number of the source document.
• DocumentNumber: string
  Maximum Length: 250

  Document number of the source document.
• DocumentType: string
  Read Only: true

  Maximum Length: 80

  Document type of the source document.
• ErrorMessage: string
  Maximum Length: 2000

  Intercompany transaction processing error details.
• IntercompanyAgreementNumber: string
  Maximum Length: 60

  Agreement number associated with the source document.
• intercompanyTransactionSourceDocumentDFF: array intercompanyTransactionSourceDocumentDFF
• IntercompanyTrxSourceDocumentId: integer (int64)
  The unique identifier of the intercompany transaction source document.
• IntercompanyTrxSourceNumber: integer (int64)
  The unique number assigned to intercompany transaction source document.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the intercompany transaction source document was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the intercompany transaction source document.
• LedgerName: string
  Title: Name

  Read Only: true

  Maximum Length: 30

  Name of the ledger associated with the intercompany transaction source document.
• LegalEntity: string
  Title: Legal Entity Name

  Read Only: true

  Maximum Length: 240

  Name of the legal entity associated with the intercompany transaction source document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: string
  Maximum Length: 240

  A brief note or description that's added to the transfer authorization.
• ProcessingStatus: string
  Title: Meaning

  Maximum Length: 80

  Processing status of the intercompany transaction.
• ProcessingStatusCode: string
  Maximum Length: 30

  Processing status code of the intercompany transaction source document.
• ProviderIntercompanyOrgName: string
  Read Only: true

  Maximum Length: 360

  Provider organization of the intercompany transaction.
• ReceiverIntercompanyOrgName: string
  Read Only: true

  Maximum Length: 360

  Receiver or beneficiary organization of the intercompany transaction.
• SourceApplication: string
  Read Only: true

  Maximum Length: 80

  Source application where the source document is originated from.
• SupplierName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The supplier name on the source document.
• SupplierNumber: string
  Title: Supplier Number

  Read Only: true

  Maximum Length: 30

  The unique supplier number of the source document.
• SupplierSite: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  The supplier location on the source document.
• TransferAuthorizationAmount: number
  Transaction amount for the transfer authorization.
• TransferAuthorizationAmountType: string
  Maximum Length: 80

  Amount type for the transfer authorization.
• TransferAuthorizationDescription: string
  Maximum Length: 240

  A brief description about the transfer authorization.
• TransferAuthorizationGroupId: integer (int64)
  Read Only: true

  The unique identifier of the transfer authorization group.
• TransferAuthorizationNumber: string
  Maximum Length: 50

  The unique number of the transfer authorization.
• TransferAuthorizationReference: string
  Maximum Length: 30

  Reference number for the transfer authorization.
• TransferAuthorizationStatus: string
  Read Only: true

  Maximum Length: 80

  Transfer authorization status.
• TransferAuthorizationTrxDate: string (date)
  Transaction date for the transfer authorization.
• TrxProviderAccountDistribution: string
  Provider account code combination of the intercompany transaction.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the source document was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntity":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the legal entity associated with the intercompany transaction source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "intercompanyTransactionSourceDocumentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-attachments-item-response"
            }
        },
        "ProviderIntercompanyOrgName":{
            "maxLength":360,
            "type":"string",
            "description":"Provider organization of the intercompany transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrxProviderAccountDistribution":{
            "type":"string",
            "description":"Provider account code combination of the intercompany transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.commonModules.intercompanyTransactions.restModel.view.DocumentPreparationVO#TrxProviderAccountDistributionDetails",
                "FND_ACFF_ResourceName":"intercompanyTransactionSourceDocuments",
                "ojStructureInstanceNumber":"TrxProviderChartOfAccount"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "DocumentCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code for the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "IntercompanyTrxSourceDocumentId":{
            "type":"integer",
            "description":"The unique identifier of the intercompany transaction source document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IntercompanyAgreementNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Agreement number associated with the source document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransferAuthorizationStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Transfer authorization status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentAction":{
            "maxLength":80,
            "type":"string",
            "description":"Action type of the source document. Valid values are New Transaction and Reversal Transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentDistributionNumber":{
            "type":"integer",
            "description":"Distribution number of the source document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransferAuthorizationNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The unique number of the transfer authorization.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the intercompany transaction approval is required.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentFirstReferenceId":{
            "type":"integer",
            "description":"First reference identifier of the source document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentAmount":{
            "type":"number",
            "description":"Transaction amount for the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "type":"integer",
            "description":"Document line number of the source document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransferAuthorizationAmount":{
            "type":"number",
            "description":"Transaction amount for the transfer authorization.",
            "nullable":true,
            "x-queryable":true
        },
        "LedgerName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the ledger associated with the intercompany transaction source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Processing status of the intercompany transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessingStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Processing status code of the intercompany transaction source document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Notes":{
            "maxLength":240,
            "type":"string",
            "description":"A brief note or description that's added to the transfer authorization.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentAmountType":{
            "maxLength":80,
            "type":"string",
            "description":"Amount type for the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the intercompany transaction source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiverIntercompanyOrgName":{
            "maxLength":360,
            "type":"string",
            "description":"Receiver or beneficiary organization of the intercompany transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferAuthorizationTrxDate":{
            "type":"string",
            "description":"Transaction date for the transfer authorization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"Document type of the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferAuthorizationReference":{
            "maxLength":30,
            "type":"string",
            "description":"Reference number for the transfer authorization.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique supplier number of the source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "maxLength":250,
            "type":"string",
            "description":"Document number of the source document.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentChartOfAccount":{
            "type":"integer",
            "description":"Chart of account of the intercompany transaction source document.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_StructureID":"DocumentAccountDistributionDetails"
            },
            "x-queryable":true
        },
        "DocumentAccountDistribution":{
            "type":"string",
            "description":"Account code combination for the source document.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.commonModules.intercompanyTransactions.restModel.view.DocumentPreparationVO#DocumentAccountDistributionDetails",
                "FND_ACFF_ResourceName":"intercompanyTransactionSourceDocuments",
                "ojStructureInstanceNumber":"DocumentChartOfAccount"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "TransferAuthorizationGroupId":{
            "type":"integer",
            "description":"The unique identifier of the transfer authorization group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransferAuthorizationDescription":{
            "maxLength":240,
            "type":"string",
            "description":"A brief description about the transfer authorization.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentDescription":{
            "maxLength":240,
            "type":"string",
            "description":"A brief description about the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The supplier name on the source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Business unit for the source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"The supplier location on the source document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntercompanyTrxSourceNumber":{
            "type":"integer",
            "description":"The unique number assigned to intercompany transaction source document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceApplication":{
            "maxLength":80,
            "type":"string",
            "description":"Source application where the source document is originated from.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentLegalEntityId":{
            "type":"integer",
            "description":"The unique identifier of the legal entity associated with the source document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransferAuthorizationAmountType":{
            "maxLength":80,
            "type":"string",
            "description":"Amount type for the transfer authorization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":2000,
            "type":"string",
            "description":"Intercompany transaction processing error details.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentDate":{
            "type":"string",
            "description":"Document date for the source document.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the intercompany transaction source document was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-attachments-item-response"
    }
}

Nested Schema : intercompanyTransactionSourceDocumentDFF

Type: array

Show Source

• Array of: object intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : intercompanyTransactionSourceDocuments-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

  Indicates 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 name 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

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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 URI of the file.
• 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 name 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 size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date 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 of 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 a Topology Manager type 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 a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "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 name 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 size 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 document version number from which the attachment is created.",
            "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 login credentials of 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":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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 name 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 to assign to a new 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 URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates 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 from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text 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 : intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• IntercompanyTrxSourceDocumentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "IntercompanyTrxSourceDocumentId":{
            "type":"integer",
            "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 Segment",
            "type":"string",
            "description":"Context Segment",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "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/intercompanyTransactionSourceDocuments/{IntercompanyTrxSourceDocumentId}/child/attachments

Parameters:

• IntercompanyTrxSourceDocumentId: $request.path.IntercompanyTrxSourceDocumentId

The attachments resource is used to view, create, and update attachments.

intercompanyTransactionSourceDocumentDFF

Operation: /fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/{IntercompanyTrxSourceDocumentId}/child/intercompanyTransactionSourceDocumentDFF

Parameters:

• IntercompanyTrxSourceDocumentId: $request.path.IntercompanyTrxSourceDocumentId

Back to Top

Examples

Example 1 - Update Beneficiary Information on Document Preparation record

The following example shows how to update an intercompany document preparation record by submitting a PATCH request on the REST resource using cURL.

curl -H 'Content-Type: application/json' -i -u "<username>:<password>" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076

Example Request Body

The following example shows the contents of the request body in JSON format:

{
  "IntercompanyAgreementNumber": "Fund Transfer Treasury",
  "TransferAuthorizationDescription": null,
  "TransferAuthorizationAmountType": "Cross charge",
  "TransferAuthorizationReference": "AP77",
  "TransferAuthorizationTrxDate": "2024-12-01",
  "TransferAuthorizationAmount": "174",
  "TransferAuthorizationNumber": "AP77"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "CreatedBy": "FINUSER1",
    "CreationDate": "2025-01-06T13:32:34.293+00:00",
    "DocumentAmount": "174",
    "DocumentCurrencyCode": "USD",
    "DocumentDate": "2024-12-01",
    "DocumentDescription": null,
    "DocumentDistributionNumber": "1",
    "DocumentLegalEntityId": "300100563232034",
    "DocumentLineNumber": "1",
    "DocumentNumber": "a-vision-us-75",
    "DocumentFirstReferenceId": "445436",
    "ErrorMessage": null,
    "IntercompanyTrxSourceDocumentId": "100106220212076",
    "IntercompanyTrxSourceNumber": "77",
    "LastUpdateDate": "2025-02-28T09:16:22+00:00",
    "LastUpdatedBy": "FINUSER1",
    "ProcessingStatusCode": "ORA_NOT_STARTED",
    "TransferAuthorizationAmount": "174",
    "TransferAuthorizationDescription": null,
    "TransferAuthorizationNumber": "AP77",
    "TransferAuthorizationReference": "AP77",
    "TransferAuthorizationTrxDate": "2024-12-01",
    "DocumentChartOfAccount": "86583",
    "TrxProviderAccountDistribution": "",
    "DocumentAccountDistribution": "10-000-11010-0000-10-10",
    "SupplierNumber": "1488256855",
    "SupplierName": "FusionOne Supplier",
    "SupplierSite": "FusionOne Supplier addr1",
    "ApprovalRequiredFlag": true,
    "IntercompanyAgreementNumber": "Fund Transfer Treasury",
    "BusinessUnit": "3211 FusionOne BU",
    "ProviderIntercompanyOrgName": "3211 FusionOne Canada",
    "ReceiverIntercompanyOrgName": "3111 FusionOne US Corp",
    "LegalEntity": "3211 FusionOne LE",
    "DocumentAmountType": "Item",
    "LedgerName": "FusionOne US",
    "TransferAuthorizationStatus": null,
    "DocumentAction": "New transaction",
    "DocumentType": "Standard",
    "SourceApplication": "Payables",
    "TransferAuthorizationAmountType": "Cross charge",
    "ProcessingStatus": "Not started",
    "@context": {
        "key": "100106220212076",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076",
                "name": "intercompanyTransactionSourceDocuments",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076",
                "name": "intercompanyTransactionSourceDocuments",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076/child/attachments",
                "name": "attachments",
                "kind": "collection"
            },
            {
                "rel": "child",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076/child/intercompanyTransactionSourceDocumentDFF",
                "name": "intercompanyTransactionSourceDocumentDFF",
                "kind": "collection"
            }
        ]
    }
}

Example 2 - Mark Document Preparation Record as Ready

The following example shows how to mark a document preparation record as Ready by submitting a PATCH request on the REST resource using cURL.

curl -H 'Content-Type: application/json' -i -u "<username>:<password>" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076

Example Request Body

The following example shows the contents of the request body in JSON format:

{
  "ProcessingStatus": "Ready"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "CreatedBy": "FINUSER1",
    "CreationDate": "2025-01-06T13:32:34.293+00:00",
    "DocumentAmount": "174",
    "DocumentCurrencyCode": "USD",
    "DocumentDate": "2024-12-01",
    "DocumentDescription": null,
    "DocumentDistributionNumber": "1",
    "DocumentLegalEntityId": "300100563232034",
    "DocumentLineNumber": "1",
    "DocumentNumber": "a-vision-us-75",
    "DocumentFirstReferenceId": "445436",
    "ErrorMessage": null,
    "IntercompanyTrxSourceDocumentId": "100106220212076",
    "IntercompanyTrxSourceNumber": "77",
    "LastUpdateDate": "2025-02-28T09:34:56+00:00",
    "LastUpdatedBy": "FINUSER1",
    "ProcessingStatusCode": "ORA_READY",
    "TransferAuthorizationAmount": "174",
    "TransferAuthorizationDescription": null,
    "TransferAuthorizationNumber": "AP77",
    "TransferAuthorizationReference": "AP77",
    "TransferAuthorizationTrxDate": "2024-12-01",
    "DocumentChartOfAccount": "86583",
    "TrxProviderAccountDistribution": "",
    "DocumentAccountDistribution": "10-000-11010-0000-10-10",
    "SupplierNumber": "1488256855",
    "SupplierName": "FusionOne Supplier",
    "SupplierSite": "FusionOne Supplier addr1",
    "ApprovalRequiredFlag": true,
    "IntercompanyAgreementNumber": "Fund Transfer Treasury",
    "BusinessUnit": "3211 FusionOne BU",
    "ProviderIntercompanyOrgName": "3211 FusionOne Canada",
    "ReceiverIntercompanyOrgName": "3111 FusionOne US Corp",
    "LegalEntity": "3211 FusionOne LE",
    "DocumentAmountType": "Item",
    "LedgerName": "FusionOne US",
    "TransferAuthorizationStatus": null,
    "DocumentAction": "New transaction",
    "DocumentType": "Standard",
    "SourceApplication": "Payables",
    "TransferAuthorizationAmountType": "Cross charge",
    "ProcessingStatus": "Ready",
    "@context": {
        "key": "100106220212076",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076",
                "name": "intercompanyTransactionSourceDocuments",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076",
                "name": "intercompanyTransactionSourceDocuments",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076/child/attachments",
                "name": "attachments",
                "kind": "collection"
            },
            {
                "rel": "child",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106220212076/child/intercompanyTransactionSourceDocumentDFF",
                "name": "intercompanyTransactionSourceDocumentDFF",
                "kind": "collection"
            }
        ]
    }
}

Back to Top