Get an intercompany agreement
get
/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/{IntercompanyAgreementId}
Request
Path Parameters
-
IntercompanyAgreementId(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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
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 : intercompanyAgreements-item-response
Type:
Show Source
object
-
ActivationDate: string
(date)
Read Only:
true
The date when the intercompany agreement status is set to active. -
AllowInvoicingFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the intercompany agreement follows the invoicing flow or general ledger flow. This information is derived from the transaction type. -
AmountType: string
Read Only:
true
Maximum Length:80
The abbreviated name that uniquely identifies the amount type. For examples, Principal, Interest, and Expense. These values are used for reporting. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
ClosureDate: string
(date)
Read Only:
true
The date when the intercompany agreement is closed. -
ControlAmount: number
The control amount of the intercompany agreement.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
CurrencyCode: string
Maximum Length:
15
The code representing the currency of the multitier intercompany transaction. The transaction is initiated in the this currency. -
CurrencyConversionType: string
Title:
Conversion Rate Type
Maximum Length:30
Conversion rate type for currency conversion defined in the intercompany agreement. -
Description: string
Maximum Length:
240
A brief description of the intercompany agreement. -
FirstClearingOrgName: string
Maximum Length:
255
Name of the first clearing organization. -
intercompanyAgreementDFF: array
intercompanyAgreementDFF
-
IntercompanyAgreementId: integer
(int64)
The unique identifier of the intercompany agreement.
-
IntercompanyAgreementNumber: string
Maximum Length:
60
The unique number assigned to the intercompany agreement. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfTransferAuthorizations: integer
Read Only:
true
The total number of transfer authorizations created for an intercompany agreement. -
ProviderIntercompanyOrgName: string
Title:
Intercompany Organization
Maximum Length:360
Name of the provider intercompany organization. -
ReceiverIntercompanyOrgName: string
Read Only:
true
Maximum Length:360
Name of the receiver intercompany organization. -
RunningTotalAmount: number
Read Only:
true
The running total amount of the valid transfer authorizations created for an intercompany agreement. -
SecondClearingOrgName: string
Maximum Length:
255
Name of the second clearing organization. -
SettlementCurrencyBasis: string
Maximum Length:
80
Basis for currency conversion from transaction currency to settlement currency that's defined for the intercompany agreement. -
Status: string
Maximum Length:
80
Status of the intercompany agreement. -
TransactionDate: string
Read Only:
true
Maximum Length:60
Transaction date of the intercompany transaction. -
TransactionTypeName: string
Maximum Length:
80
Transaction type of the intercompany agreement. All transactions in a intercompany agreement must have the same transaction type. -
transferAuthorizationGroups: array
Transfer Authorization Groups
Title:
Transfer Authorization Groups
The transfer authorization group represents the receivers organizations definition information. -
TransferAuthorizationNumber: string
Read Only:
true
Maximum Length:60
The unique number assigned to the transfer authorization.
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 : 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:
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 : intercompanyAgreements-intercompanyAgreementDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
IntercompanyAgreementId: 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
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-item-response
Type:
Show Source
object
-
AllocateEvenlyFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether the transaction amount should be distributed equally to all receivers or based on allocation percentage assigned to each receiver entered by the user. -
AmountType: string
Maximum Length:
80
The abbreviated name that uniquely identifies the amount type. For examples, Principal, Interest, and Expense. These values are used for reporting. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
CurrencyConversionType: string
Title:
Conversion Rate Type
Maximum Length:30
Conversion rate type for currency conversion defined in the intercompany agreement. -
Description: string
Maximum Length:
240
A brief description of the transfer authorization group. -
ExchangeRateDate: string
(date)
The date as of which a conversion rate is used to convert an amount.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettlementCurrencyBasis: string
Maximum Length:
80
Basis for currency conversion from transaction currency to settlement currency that's defined for the intercompany agreement. -
Status: string
Maximum Length:
80
Status of the transfer authorization group derived based on the status of transfer authorizations. -
TemplateFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the transfer authorization group is a template. This is used to distinguish the rows that hold receiver information from the transfer authorization data. -
TransferAuthGroupReference: string
Maximum Length:
30
Reference number assigned to a transfer authorization group. -
TransferAuthorizationGroupAmount: number
Total transaction amount of the transfer authorization group. This is the total amount that's transacted by the provider irrespective of the number of receiver organizations.
-
TransferAuthorizationGroupDate: string
(date)
The date when the transfer authorization group is processed. All the transfer authorizations will inherit the same date.
-
transferAuthorizationGroupDFF: array
transferAuthorizationGroupDFF
-
TransferAuthorizationGroupId: integer
(int64)
The unique identifier for the transfer authorization group.
-
TransferAuthorizationGroupNumber: string
Maximum Length:
50
The unique number assigned to the transfer authorization group. -
transferAuthorizations: array
Transfer Authorizations
Title:
Transfer Authorizations
The transfer authorization represents the receivers organizations definition information.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransferAuthorizationGroupId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-item-response
Type:
Show Source
object
-
AllocationPercentage: number
Allocation percentage of the total transaction amount for the receiver organization.
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
CurrencyConversionType: string
Title:
Conversion Rate Type
Maximum Length:30
Conversion rate type for currency conversion defined in the intercompany agreement. -
Description: string
Maximum Length:
240
A brief description of the transfer authorization. -
ExchangeRateDate: string
(date)
The date as of which a conversion rate is used to convert an amount.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalTransferAuthNumber: string
Maximum Length:
60
The original transfer authorization number referenced by the current transfer authorization. -
ReceiverIntercompanyOrgName: string
Title:
Intercompany Organization
Maximum Length:360
Name of the receiver intercompany organization. -
ReversedTransferAuthNumber: string
Read Only:
true
Maximum Length:60
Transfer authorization number generated by reversal process for the currency transfer authorization. -
SettlementCurrencyBasis: string
Maximum Length:
80
Basis for currency conversion from transaction currency to settlement currency that's defined for the intercompany agreement. -
Status: string
Maximum Length:
80
Status of the transfer authorization. This is derived based on the status of the transactions. -
transactions: array
Agreement Based Intercompany Transactions
Title:
Agreement Based Intercompany Transactions
The transactions represents intercompany transaction information that's generated from a transfer authorization. -
TransferAuthorizationAmount: number
Allocated transaction amount for the transfer authorization.
-
TransferAuthorizationDate: string
(date)
The date when the transfer authorization is processed.
-
transferAuthorizationDFF: array
transferAuthorizationDFF
-
TransferAuthorizationId: integer
(int64)
The unique identifier for the transfer authorization.
-
TransferAuthorizationNumber: string
Maximum Length:
60
The unique number assigned to the transfer authorization. -
TransferAuthReversalFlag: boolean
Maximum Length:
1
Indicates if the transfer authorization is created by the reversal process.
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 : 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 : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-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 : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-item-response
Type:
Show Source
object
-
ApInvoiceId: integer
(int64)
Read Only:
true
The unique identifier of the payables invoice. -
ApInvoiceNumber: string
Read Only:
true
Maximum Length:50
The unique number assigned to the customer invoice. -
ArCustomerTrxId: integer
(int64)
Read Only:
true
The unique identifier of the receivables invoice. -
ArInvoiceNumber: string
Read Only:
true
Maximum Length:50
The unique number assigned to the supplier invoice. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
CustomerAccountName: string
Read Only:
true
Maximum Length:240
Customer account name of the transaction recipient. -
CustomerAccountSite: string
Maximum Length:
150
The site code of the customer account site. The code representing the bill-to customer site assigned to the transaction. -
Description: string
Maximum Length:
240
A brief description of the intercompany transaction. -
ErrorReason: string
Read Only:
true
Maximum Length:2000
Lists transaction error reason details. -
ExchangeRate: number
The conversion rate used to convert the transaction currency to the ledger currency of the receiving organization.
-
ExchangeRateDate: string
(date)
The date as of which a conversion rate is used to convert the transaction currency to the ledger currency of the receiving organization.
-
IntercompanyTrxNumber: string
Maximum Length:
30
Intercompany transaction number generated based on the intercompany organization short codes. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
providerDistributionLines: array
Provider Accounting Previews
Title:
Provider Accounting Previews
The provider accounting preview presents a detailed distribution view of the provider organization. -
ProviderGLJournalName: string
Read Only:
true
Maximum Length:80
Journal entry header name of the provider. -
ProviderIntercompanyOrgName: string
Title:
Intercompany Organization
Maximum Length:360
Initiator of the intercompany transaction. -
ProviderJeBatchId: integer
Read Only:
true
The unique identifier of the provider ledger journal batch. -
ProviderJeHeaderId: integer
(int64)
Read Only:
true
The unique identifier of the provider ledger journal. -
ReceivablesTrxClass: string
Title:
Transaction Class Code
Read Only:true
Maximum Length:20
The class type of the receivables transaction. -
receiverDistributionLines: array
Receiver Accounting Previews
Title:
Receiver Accounting Previews
The receiver accounting preview presents a detailed distribution view of the receiver organization. -
ReceiverGLJournalName: string
Read Only:
true
Maximum Length:80
Journal entry header name of the receiver. -
ReceiverIntercompanyOrgName: string
Title:
Intercompany Organization
Maximum Length:360
Receiver of the intercompany transaction. -
ReceiverJeBatchId: integer
Read Only:
true
The unique identifier of the receiver ledger journal batch. -
ReceiverJeHeaderId: integer
(int64)
Read Only:
true
The unique identifier of the receiver ledger journal. -
RejectReason: string
Maximum Length:
240
Reason for rejection of the intercompany transaction. -
RouteType: string
Read Only:
true
Maximum Length:80
Route type of the intercompany multitier transaction. -
SettlementAmount: number
Read Only:
true
Settlement amount calculated in settlement currency which is received by the receiver organization -
SettlementCurrencyBasis: string
Maximum Length:
80
Basis for currency conversion from transaction currency to settlement currency that's defined for the intercompany agreement. -
SettlementCurrencyCode: string
Read Only:
true
Maximum Length:15
The code representing the currency in which the transaction amount is received by the receiver. -
SupplierName: string
Read Only:
true
Maximum Length:360
Supplier name of the transaction initiator. -
SupplierSite: string
Maximum Length:
240
The site code of the supplier site. The code representing the ship-to customer site assigned to the transaction. -
TransactionAmount: number
Transaction amount of the intercompany transaction.
-
TransactionCurrencyCode: string
Maximum Length:
15
The code representing the currency in which the transaction is initiated. -
TransactionDate: string
(date)
Transaction date of the intercompany transaction.
-
transactionDFF: array
transactionDFF
-
TransactionStatus: string
Maximum Length:
80
Status of the intercompany transaction. -
TrxId: integer
(int64)
The unique identifier of the intercompany transaction.
-
TrxNumber: number
Transaction number of the intercompany transaction.
-
UserConversionType: string
Title:
Conversion Rate Type
Maximum Length:30
The currency conversion type to convert the transaction currency to the ledger currency of the receiving organization.
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 : 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 : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-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 : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-providerDistributionLines-item-response
Type:
Show Source
object
-
AccountedCr: number
Read Only:
true
Credit amount calculated in ledger currency. -
AccountedCurrency: string
Read Only:
true
Maximum Length:3
Ledger currency of the transaction initiator. -
AccountedDr: number
Read Only:
true
Debit amount calculated in ledger currency. -
AmountCr: number
Read Only:
true
Settlement credit amount. -
AmountDr: number
Read Only:
true
Settlement debit amount. -
AmountType: string
Read Only:
true
Maximum Length:80
The abbreviated name that uniquely identifies the amount type. For examples, Principal, Interest, and Expense. These values are used for reporting. -
ConversionRateType: string
Maximum Length:
30
Currency conversion rate type to convert settlement currency to the provider ledger currency that's posted to provider general ledger. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
CurrencyConversionDate: string
(date)
Read Only:
true
The date as of which a conversion rate is used to convert the settlement currency to the transaction provider ledger currency. -
CurrencyConversionRate: number
Read Only:
true
The conversion rate used to convert the settlement currency to the transaction provider ledger currency. -
Description: string
Maximum Length:
250
A brief description of the provider distribution line. -
DistId: integer
(int64)
The unique identifier of the intercompany transaction distribution line.
-
DistNumber: integer
The unique number assigned to identify a distribution line in the transaction.
-
DistTypeCode: string
Maximum Length:
1
Default Value:L
Indicates whether the distribution line is user created or clearing line. Valid values are L, R, and P. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LedgerName: string
Read Only:
true
Maximum Length:30
Ledger name of the transaction provider. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyTypeCode: string
Maximum Length:
1
Default Value:I
Indicates whether the distribution is for a provider or receiver. Valid values are P and R. -
ProviderAccountDistribution: string
Distribution account code combination of the provider distribution line.
-
SettlementCurrencyCode: string
Read Only:
true
Maximum Length:15
Currency in which an intercompany transaction is received by the receiver. This is derived from the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-receiverDistributionLines-item-response
Type:
Show Source
object
-
AccountedCr: number
Read Only:
true
Credit amount calculated in the ledger currency. -
AccountedCurrency: string
Read Only:
true
Maximum Length:3
Ledger currency of the transaction recipient. -
AccountedDr: number
Read Only:
true
Debit amount calculated in the ledger currency. -
AmountCr: number
Read Only:
true
Settlement credit amount. -
AmountDr: number
Read Only:
true
Settlement debit amount. -
AmountType: string
Read Only:
true
Maximum Length:80
The abbreviated name that uniquely identifies the amount type. For examples, Principal, Interest, and Expense. These values are used for reporting. -
ConversionRateType: string
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
CurrencyConversionDate: string
(date)
Read Only:
true
The date as of which a conversion rate is used to convert the settlement currency to the transaction receiver ledger currency. -
CurrencyConversionRate: number
Read Only:
true
The conversion rate used to convert the settlement currency to the transaction receiver ledger currency. -
Description: string
Maximum Length:
250
A brief description of the receiver distribution line. -
DistId: integer
(int64)
The unique identifier of the intercompany transaction distribution line.
-
DistNumber: integer
The unique number assigned to identify a distribution line in the transaction.
-
DistTypeCode: string
Maximum Length:
1
Default Value:L
Indicates whether the distribution line is user created or clearing line. Valid values are L, R, and P. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LedgerName: string
Read Only:
true
Maximum Length:30
Ledger name of the transaction receiver. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyTypeCode: string
Maximum Length:
1
Default Value:R
Indicates whether the distribution is for a provider or receiver. Valid values are P and R. -
ReceiverAccountDistribution: string
Distribution account code combination of the receiver distribution line.
-
SettlementCurrencyCode: string
Read Only:
true
Maximum Length:15
Currency in which an intercompany transaction is received by the receiver. This is derived from the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-transactionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Additional Information Context
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Additional Information Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TrxId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transferAuthorizationDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransferAuthorizationId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Parameters:
- IntercompanyAgreementId:
$request.path.IntercompanyAgreementId
The attachments resource is used to view, create, and update attachments. - IntercompanyAgreementId:
- intercompanyAgreementDFF
-
Parameters:
- IntercompanyAgreementId:
$request.path.IntercompanyAgreementId
- IntercompanyAgreementId:
- transferAuthorizationGroups
-
Parameters:
- IntercompanyAgreementId:
$request.path.IntercompanyAgreementId
The transfer authorization group represents the receivers organizations definition information. - IntercompanyAgreementId:
Examples
The following example shows how to get an intercompany agreement 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/300100581686129
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AllowInvoicingFlag": false, "CreatedBy": "FIN_USER1", "CreationDate": "2024-01-23T18:34:58+00:00", "CurrencyCode": "CAD", "Description": "Fund Transfer Treasury to Singapore via 2 Clearing Org", "LastUpdateDate": "2024-01-23T20:48:56.048+00:00", "LastUpdatedBy": "FIN_USER1", "IntercompanyAgreementId": 300100581686129, "IntercompanyAgreementNumber": "Fund Transfer Treasury to Singapore", "ProviderIntercompanyOrgName": "3211 FusionOne Canada", "CurrencyConversionType": "Corporate", "TransactionTypeName": "Non Invoicing Agreement", "FirstClearingOrgName": "3111 FusionOne US Corp", "SecondClearingOrgName": "3121 FusionOne US Services", "SettlementCurrencyBasis": "Transaction Currency", "Status": "Active", "ActivationDate": "2024-01-23", "ClosureDate": null, "ControlAmount": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686129", "name": "intercompanyAgreements", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686129/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686129/child/intercompanyAgreementDFF", "name": "intercompanyAgreementDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686129/child/transferAuthorizationGroups", "name": "transferAuthorizationGroups", "kind": "collection" } ] }