1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Intercompany Agreements

Get all intercompany agreements

get

/fscmRestApi/resources/11.13.18.05/intercompanyAgreements

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 the intercompany agreement with the specified primary key.
      Finder Variables
      • IntercompanyAgreementId; integer; The unique identifier of the intercompany agreement.
  • 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:
    • ActivationDate; string; The date when the intercompany agreement status is set to active.
    • AllowInvoicingFlag; boolean; Indicates whether the intercompany agreement follows the invoicing flow or general ledger flow. This information is derived from the transaction type.
    • AmountType; string; The abbreviated name that uniquely identifies the amount type. For examples, Principal, Interest, and Expense. These values are used for reporting.
    • ClosureDate; string; The date when the intercompany agreement is closed.
    • ControlAmount; number; The control amount of the intercompany agreement.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • CurrencyCode; string; The code representing the currency of the multitier intercompany transaction. The transaction is initiated in the this currency.
    • CurrencyConversionType; string; Conversion rate type for currency conversion defined in the intercompany agreement.
    • Description; string; A brief description of the intercompany agreement.
    • FirstClearingOrgName; string; Name of the first clearing organization.
    • IntercompanyAgreementId; integer; The unique identifier of the intercompany agreement.
    • IntercompanyAgreementNumber; string; The unique number assigned to the intercompany agreement.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • NumberOfTransferAuthorizations; integer; The total number of transfer authorizations created for an intercompany agreement.
    • ProviderIntercompanyOrgName; string; Name of the provider intercompany organization.
    • ReceiverIntercompanyOrgName; string; Name of the receiver intercompany organization.
    • RunningTotalAmount; number; The running total amount of the valid transfer authorizations created for an intercompany agreement.
    • SecondClearingOrgName; string; Name of the second clearing organization.
    • SettlementCurrencyBasis; string; Basis for currency conversion from transaction currency to settlement currency that's defined for the intercompany agreement.
    • Status; string; Status of the intercompany agreement.
    • TransactionDate; string; Transaction date of the intercompany transaction.
    • TransactionTypeCode; string; Transaction type of the intercompany agreement. All transactions in a intercompany agreement must have the same transaction type.
    • TransactionTypeName; string; Transaction type of the intercompany agreement. All transactions in a intercompany agreement must have the same transaction type.
  • 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 : intercompanyAgreements
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : intercompanyAgreements-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 : intercompanyAgreementDFF
Type: array
Show Source
Nested Schema : Transfer Authorization Groups
Type: array
Title: Transfer Authorization Groups
The transfer authorization group represents the receivers organizations definition information.
Show Source
Nested Schema : intercompanyAgreements-attachments-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-intercompanyAgreementDFF-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-item-response
Type: object
Show Source
Nested Schema : transferAuthorizationGroupDFF
Type: array
Show Source
Nested Schema : Transfer Authorizations
Type: array
Title: Transfer Authorizations
The transfer authorization represents the receivers organizations definition information.
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizationGroupDFF-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-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 : Agreement Based Intercompany Transactions
Type: array
Title: Agreement Based Intercompany Transactions
The transactions represents intercompany transaction information that's generated from a transfer authorization.
Show Source
Nested Schema : transferAuthorizationDFF
Type: array
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-attachments-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-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 : Provider Accounting Previews
Type: array
Title: Provider Accounting Previews
The provider accounting preview presents a detailed distribution view of the provider organization.
Show Source
Nested Schema : Receiver Accounting Previews
Type: array
Title: Receiver Accounting Previews
The receiver accounting preview presents a detailed distribution view of the receiver organization.
Show Source
Nested Schema : transactionDFF
Type: array
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-attachments-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-providerDistributionLines-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-receiverDistributionLines-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-transactionDFF-item-response
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transferAuthorizationDFF-item-response
Type: object
Show Source
Links
approveTransferAuthorizations
When approval is initiated, all transactions in the transfer authorization will be approved.
cancelTransferAuthorizationGrps
Transfer Authorizations can be canceled until the transfer authorization along with the transactions and accounting aren't approved. Once they're approved, a transfer authorization can't be canceled. All transfer authorizations in a group must be canceled together.
generateAccountingLines
Accounting lines provide a draft accounting view representing when these transactions will be transferred to receivables and payables as invoices or to general ledger as journals.
generateTransactions
Generates transactions for all the transfer authorizations created. Individual transactions are created for each leg of the route.
rejectTransferAuthorizations
When rejection is initiated, all transactions in the transfer authorization will be rejected.
reverseTransferAuthorizationGrp
Reverses a transfer authorization group. A new transfer authorization group is created with a reversed amount.
Back to Top

Examples

The following example shows how to get all intercompany agreements 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/intercompanyAgreements

Example Response Body

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

{
    "items": [
        {
            "AllowInvoicingFlag": false,
            "CreatedBy": "FIN_USER1",
            "CreationDate": "2024-01-21T06:56:36+00:00",
            "CurrencyCode": "USD",
            "Description": null,
            "LastUpdateDate": "2024-01-23T11:22:48.511+00:00",
            "LastUpdatedBy": "FIN_USER1",
            "IntercompanyAgreementId": 300100581735794,
            "IntercompanyAgreementNumber": "IAN-2101-01",
            "ProviderIntercompanyOrgName": "SAU US ORG1",
            "CurrencyConversionType": "Corporate",
            "TransactionTypeName": "Non Invoicing Agreement",
            "FirstClearingOrgName": "SAU CA ORG",
            "SecondClearingOrgName": null,
            "SettlementCurrencyBasis": "Transaction Currency",
            "Status": "Active",
            "ActivationDate": "2024-01-21",
            "ClosureDate": null,
            "ControlAmount": null
        },
        {
            "AllowInvoicingFlag": false,
            "CreatedBy": "FIN_USER1",
            "CreationDate": "2024-01-22T09:06:44+00:00",
            "CurrencyCode": "USD",
            "Description": null,
            "LastUpdateDate": "2024-01-22T09:07:19.060+00:00",
            "LastUpdatedBy": "FIN_USER1",
            "IntercompanyAgreementId": 300100581735973,
            "IntercompanyAgreementNumber": "IC22JAN241",
            "ProviderIntercompanyOrgName": "SAU CA ORG",
            "CurrencyConversionType": "Corporate",
            "TransactionTypeName": "Non Invoicing Agreement",
            "FirstClearingOrgName": null,
            "SecondClearingOrgName": null,
            "SettlementCurrencyBasis": "Transaction Currency",
            "Status": "Active",
            "ActivationDate": "2024-01-22",
            "ClosureDate": null,
            "ControlAmount": null
        },
        ...      
    ],
    "count": 16,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements",
            "name": "intercompanyAgreements",
            "kind": "collection"
        },
        ...
    ]
}
Back to Top