Create an intercompany agreement

post

/fscmRestApi/resources/11.13.18.05/intercompanyAgreements

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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 : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
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 : schema
Type: object
Show Source
Nested Schema : schema
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 : schema
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-item-post-request
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-post-request
Type: object
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-providerDistributionLines-item-post-request
Type: object
Show Source
  • Maximum Length: 30
    Currency conversion rate type to convert settlement currency to the provider ledger currency that's posted to provider general ledger.
  • Maximum Length: 250
    A brief description of the provider distribution line.
  • The unique identifier of the intercompany transaction distribution line.
  • The unique number assigned to identify a distribution line in the transaction.
  • Maximum Length: 1
    Default Value: L
    Indicates whether the distribution line is user created or clearing line. Valid values are L, R, and P.
  • Maximum Length: 1
    Default Value: I
    Indicates whether the distribution is for a provider or receiver. Valid values are P and R.
  • Distribution account code combination of the provider distribution line.
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-receiverDistributionLines-item-post-request
Type: object
Show Source
  • Maximum Length: 30
    Currency conversion rate type to convert the settlement currency to the receiver ledger currency that's posted to transaction receiver general ledger.
  • Maximum Length: 250
    A brief description of the receiver distribution line.
  • The unique identifier of the intercompany transaction distribution line.
  • The unique number assigned to identify a distribution line in the transaction.
  • Maximum Length: 1
    Default Value: L
    Indicates whether the distribution line is user created or clearing line. Valid values are L, R, and P.
  • Maximum Length: 1
    Default Value: R
    Indicates whether the distribution is for a provider or receiver. Valid values are P and R.
  • Distribution account code combination of the receiver distribution line.
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
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-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
Back to Top

Examples

The following example shows how to create an intercompany agreement using POST request on the REST resource using cURL.

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

Example Request Payload

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

{
    "CurrencyCode": "USD",
    "TransactionTypeName": "Non Invoicing Agreement",
    "IntercompanyAgreementNumber": "Test Fund Transfer-Feb01-01",
    "ProviderIntercompanyOrgName": "3211 FusionOne Canada",
    "CurrencyConversionType": "Corporate",
    "Status": "Draft",
    "SettlementCurrencyBasis": "Transaction Currency",
    "Description": "test fund transfer",
    "FirstClearingOrgName": "3111 FusionOne US Corp",
    "ControlAmount": 10000,
    "transferAuthorizationGroups": [
        {
            "AmountType": "Expense Amount",
            "transferAuthorizations": [
                {
                    "AllocationPercentage": "100",
                    "ReceiverIntercompanyOrgName": "3311 FusionOne SGP Finance"
                }
            ]
        }
    ]
}

Example of Response Body

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

{
    "AllowInvoicingFlag": false,
    "CreatedBy": "FIN_USER1",
    "CreationDate": "2024-02-01T06:19:02+00:00",
    "CurrencyCode": "USD",
    "Description": "test fund transfer",
    "LastUpdateDate": "2024-02-01T06:19:02.896+00:00",
    "LastUpdatedBy": "FIN_USER1",
    "IntercompanyAgreementId": 300100581686169,
    "IntercompanyAgreementNumber": "Test Fund Transfer-Feb01-01",
    "ProviderIntercompanyOrgName": "3211 FusionOne Canada",
    "CurrencyConversionType": "Corporate",
    "TransactionTypeName": "Non Invoicing Agreement",
    "FirstClearingOrgName": "3111 FusionOne US Corp",
    "SecondClearingOrgName": null,
    "SettlementCurrencyBasis": "Transaction Currency",
    "Status": "Draft",
    "ActivationDate": null,
    "ClosureDate": null,
    "ControlAmount": 10000.00,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686169",
            "name": "intercompanyAgreements",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        ...
    ]
}
Back to Top