Get all intercompany transaction source documents

get

/fscmRestApi/resources/11.13.18.05/intercompanyTransactionSourceDocuments

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : intercompanyTransactionSourceDocuments-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : intercompanyTransactionSourceDocumentDFF
Type: array
Show Source
Nested Schema : intercompanyTransactionSourceDocuments-attachments-item-response
Type: object
Show Source
Nested Schema : intercompanyTransactionSourceDocuments-intercompanyTransactionSourceDocumentDFF-item-response
Type: object
Show Source
Back to Top

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"
        }
    ]
}
Back to Top