Get all intercompany transaction source documents
get
/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds intercompany transaction source document with the specified primary key.
Finder Variables- IntercompanyTrxSourceDocumentId; integer; The unique identifier of the intercompany transaction source document.
- PrimaryKey Finds intercompany transaction source document with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ApprovalRequiredFlag; boolean; Indicates whether the intercompany transaction approval is required.
- BusinessUnit; string; Business unit for the source document.
- CreatedBy; string; The user who created the source document.
- CreationDate; string; The date and time when the source document was created.
- DocumentAccountDistribution; string; Account code combination for the source document.
- DocumentAction; string; Action type of the source document. Valid values are New Transaction and Reversal Transaction.
- DocumentAmount; number; Transaction amount for the source document.
- DocumentAmountType; string; Amount type for the source document.
- DocumentChartOfAccount; integer; Chart of account of the intercompany transaction source document.
- DocumentCurrencyCode; string; The currency code for the source document.
- DocumentDate; string; Document date for the source document.
- DocumentDescription; string; A brief description about the source document.
- DocumentDistributionNumber; integer; Distribution number of the source document.
- DocumentFirstReferenceId; integer; First reference identifier of the source document.
- DocumentLegalEntityId; integer; The unique identifier of the legal entity associated with the source document.
- DocumentLineNumber; integer; Document line number of the source document.
- DocumentNumber; string; Document number of the source document.
- DocumentType; string; Document type of the source document.
- ErrorMessage; string; Intercompany transaction processing error details.
- IntercompanyAgreementNumber; string; Agreement number associated with the source document.
- IntercompanyTrxSourceDocumentId; integer; The unique identifier of the intercompany transaction source document.
- IntercompanyTrxSourceNumber; integer; The unique number assigned to intercompany transaction source document.
- LastUpdateDate; string; The date when the intercompany transaction source document was last updated.
- LastUpdatedBy; string; The user who last updated the intercompany transaction source document.
- LedgerName; string; Name of the ledger associated with the intercompany transaction source document.
- LegalEntity; string; Name of the legal entity associated with the intercompany transaction source document.
- Notes; string; A brief note or description that's added to the transfer authorization.
- ProcessingStatus; string; Processing status of the intercompany transaction.
- ProcessingStatusCode; string; Processing status code of the intercompany transaction source document.
- ProviderIntercompanyOrgName; string; Provider organization of the intercompany transaction.
- ReceiverIntercompanyOrgName; string; Receiver or beneficiary organization of the intercompany transaction.
- SourceApplication; string; Source application where the source document is originated from.
- SupplierName; string; The supplier name on the source document.
- SupplierNumber; string; The unique supplier number of the source document.
- SupplierSite; string; The supplier location on the source document.
- TransferAuthorizationAmount; number; Transaction amount for the transfer authorization.
- TransferAuthorizationAmountType; string; Amount type for the transfer authorization.
- TransferAuthorizationDescription; string; A brief description about the transfer authorization.
- TransferAuthorizationGroupId; integer; The unique identifier of the transfer authorization group.
- TransferAuthorizationNumber; string; The unique number of the transfer authorization.
- TransferAuthorizationReference; string; Reference number for the transfer authorization.
- TransferAuthorizationStatus; string; Transfer authorization status.
- TransferAuthorizationTrxDate; string; Transaction date for the transfer authorization.
- TrxProviderAccountDistribution; string; Provider account code combination of the intercompany transaction.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : intercompanyTransactionSourceDocuments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intercompanyTransactionSourceDocuments-item-response
Type:
Show Source
object
-
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.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intercompanyTransactionSourceDocuments-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- createTransferAuthorization
-
Creates a transfer authorization for the specified intercompany agreement associated with the intercompany transaction source document.
Examples
The following example shows how to get all intercompany document preparation records by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "CreatedBy": "FUSION_APPS_FIN_ODI_ESS_APPID", "CreationDate": "2025-01-06T09:51:15.767+00:00", "DocumentAmount": "50", "DocumentCurrencyCode": "USD", "DocumentDate": "2025-01-06", "DocumentDescription": null, "DocumentDistributionNumber": "1", "DocumentLegalEntityId": "300100563232034", "DocumentLineNumber": "2", "DocumentNumber": "VISION_US_INV1", "DocumentFirstReferenceId": "300100626324599", "ErrorMessage": null, "IntercompanyTrxSourceDocumentId": "100106219509672", "IntercompanyTrxSourceNumber": "2", "LastUpdateDate": "2025-01-06T14:06:03.247+00:00", "LastUpdatedBy": "FINUSER1", "ProcessingStatusCode": "ORA_COMPLETED", "TransferAuthorizationAmount": "50", "TransferAuthorizationDescription": null, "TransferAuthorizationNumber": "AP2", "TransferAuthorizationReference": "AP2", "TransferAuthorizationTrxDate": "2025-01-06", "DocumentChartOfAccount": "86583", "TrxProviderAccountDistribution": "", "DocumentAccountDistribution": "10-000-11015-0000-10-10", "SupplierNumber": "1488256855", "SupplierName": "FusionOne Supplier", "SupplierSite": "FusionOne Supplier addr1", "ApprovalRequiredFlag": true, "IntercompanyAgreementNumber": " IA-PC1R-SUS1-VISIONK-SUS2-01", "BusinessUnit": "3211 FusionOne BU", "ProviderIntercompanyOrgName": "3211 FusionOne Canada", "ReceiverIntercompanyOrgName": "VISION US ORG2", "LegalEntity": "3211 FusionOne LE", "DocumentAmountType": "Item", "LedgerName": "FusionOne US", "TransferAuthorizationStatus": "Sent to Receivables", "DocumentAction": "New transaction", "DocumentType": "Standard", "SourceApplication": "Payables", "TransferAuthorizationAmountType": "Cross charge", "ProcessingStatus": "Complete", "@context": { "key": "100106219509672", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578" }, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106219509672", "name": "intercompanyTransactionSourceDocuments", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106219509672", "name": "intercompanyTransactionSourceDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106219509672/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/100106219509672/child/intercompanyTransactionSourceDocumentDFF", "name": "intercompanyTransactionSourceDocumentDFF", "kind": "collection" } ] } }, ... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments", "name": "intercompanyTransactionSourceDocuments", "kind": "collection" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments/action/createTransferAuthorization", "name": "createTransferAuthorization", "kind": "other" } ] }