Get all transactions

get

/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/{IntercompanyAgreementId}/child/transferAuthorizationGroups/{TransferAuthorizationGroupId}/child/transferAuthorizations/{TransferAuthorizationId}/child/transactions

Request

Path Parameters
  • 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=
  • 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=
  • 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
  • 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>
  • 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 transactions with the specified primary key.
      Finder Variables
      • TrxId; integer; The unique identifier of the intercompany transaction.
  • 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:
    • ApInvoiceNumber; string; The unique number assigned to the customer invoice.
    • ArInvoiceNumber; string; The unique number assigned to the supplier invoice.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • CustomerAccountSite; string; The site code of the customer account site. The code representing the bill-to customer site assigned to the transaction.
    • Description; string; A brief description of the intercompany transaction.
    • ErrorReason; string; 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; 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; Intercompany transaction number generated based on the intercompany organization short codes.
    • LastUpdateDate; string; The date and time when the record was created.
    • LastUpdatedBy; string; The user who last updated the record.
    • ProviderGLJournalName; string; Journal entry header name of the provider.
    • ProviderIntercompanyOrgName; string; Initiator of the intercompany transaction.
    • ReceiverGLJournalName; string; Journal entry header name of the receiver.
    • ReceiverIntercompanyOrgName; string; Receiver of the intercompany transaction.
    • RejectReason; string; Reason for rejection of the intercompany transaction.
    • RouteType; string; Route type of the intercompany multitier transaction.
    • SettlementAmount; number; Settlement amount calculated in settlement currency which is received by the receiver organization
    • SettlementCurrencyBasis; string; Basis for currency conversion from transaction currency to settlement currency that's defined for the intercompany agreement.
    • SettlementCurrencyCode; string; The code representing the currency in which the transaction amount is received by the receiver.
    • SupplierSite; string; 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; The code representing the currency in which the transaction is initiated.
    • TransactionDate; string; Transaction date of the intercompany transaction.
    • TransactionStatus; string; Status of the intercompany transaction.
    • TrxId; integer; The unique identifier of the intercompany transaction.
    • TrxNumber; number; Transaction number of the intercompany transaction.
    • UserConversionType; string; The currency conversion type to convert the transaction currency to the ledger currency of the receiving organization.
  • 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-transferAuthorizationGroups-transferAuthorizations-transactions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
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
Back to Top