Get all channel transactions

get

/fscmRestApi/resources/11.13.18.05/channelManualAdjustments/{ManualAdjustmentId}/child/channelTransactions

Request

Path Parameters
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 channel transactions according to the primary key.
      Finder Variables:
      • TransactionId; integer; Value that uniquely identifies the channel 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:
    • AccrualYear; integer; Calendar year when the user generated the accrual.
    • AdjustmentDate; string; Date when the user created the adjustment or accrual record.
    • AdjustmentNumber; string; Number that uniquely identifies the manual adjustment.
    • AdjustmentReasonId; integer; Value that uniquely identifies the user-created reason for adjustment.
    • AdjustmentType; string; Name that identifies the type of adjustment. Valid values include INCREASE_EARNED, DECREASE_EARNED, and so on. A list of accepted values is defined in the lookup type ORA_CJM_ADJUSTMENT_TYPE.
    • AdjustmentTypeId; integer; Value that uniquely identifies the user-created adjustment type.
    • BusinessUnit; string; Name of the business unit.
    • BusinessUnitId; integer; Value that uniquely identifies the business unit.
    • ConversionDate; string; Date of amount conversion.
    • FulFillLineId; integer; Value that uniquely identifies the sales order fulfilment line.
    • FunctionalCurrency; string; Name of the ledger currency.
    • FunctionalCurrencyCode; string; Abbreviation that identifies the ledger currency.
    • GlDate; string; Date when the channel transaction is accounted.
    • GlPostedFlag; boolean; Contains one of the following values: true or false. If true, then the transaction is accounted. If false, then the transaction is not accounted. This attribute does not have a default value.
    • Item; string; Value that uniquely identifies the item in the inventory.
    • ItemId; integer; Name of the item in the inventory.
    • ManualAdjustmentId; integer; Value that uniquely identifies the manual adjustment.
    • ManualFlag; boolean; Contains one of the following values: true or false. If true, then the channel transaction is created by using manual adjustment. If false, then the channel transaction is not created by using manual adjustment. This attribute does not have a default value.
    • OrderBillToCustomer; string; Name of the sales order party who is legally responsible for payment.
    • OrderBillToCustomerAccountId; integer; Value that uniquely identifies the bill to customer account in the sales order.
    • OrderBillToCustomerAccountNumber; string; Number that identifies the bill to customer account in the sales order.
    • OrderCurrency; string; Name of the currency used in a sales order.
    • OrderCurrencyCode; string; Abbreviation that identifies the currency used in a sales order.
    • OrderDate; string; Date when the user submitted the sales order.
    • OrderHeaderId; integer; Value that uniquely identifies the sales order header.
    • OrderInvoiceDate; string; Date when the sales order is invoiced.
    • OrderInvoiceId; integer; Value that uniquely identifies the sales order invoice.
    • OrderInvoiceLineId; integer; Value that uniquely identifies the sales order invoice line.
    • OrderInvoiceLineNumber; number; Number that identifies the sales order invoice line.
    • OrderInvoiceNumber; string; Number that identifies the sales order invoice.
    • OrderInvoiceSource; string; Source of the feeder application from which an invoice is created.
    • OrderNumber; string; Number that identifies the sales order.
    • OrderSourceCode; string; Abbreviation that identifies the source application that created the order.
    • ProgramCode; string; Abbreviation that uniquely identifies the channel program.
    • ProgramCurrency; string; Name of the currency used in the channel program.
    • ProgramCurrencyCode; string; Abbreviation that identifies the channel program currency.
    • ProgramId; integer; Value that uniquely identifies the channel program.
    • ProgramName; string; Name of the channel program.
    • ProgramTemplate; string; Name of the predefined program template on which the channel program is based.
    • ProgramTemplateCode; string; Abbreviation that identifies the predefined program template on which the channel program is based.
    • ProgramType; string; Name of the program type on which the channel program is based.
    • ProgramTypeId; string; Value that uniquely identifies the program type on which the channel program is based.
    • RequestedGlDate; string; Date on which the user requested accounting.
    • ShipmentDate; string; Date when the user shipped the sales order.
    • ShipmentNumber; string; Number that uniquely identifies the shipment.
    • Supplier; string; Name of the supplier.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierItem; string; Name of the supplier item.
    • SupplierItemId; integer; Value that uniquely identifies the supplier item.
    • SupplierNumber; string; Number that identifies the supplier.
    • SupplierSite; string; Value that identifies the supplier site.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
    • TransactionId; integer; Value that uniquely identifies the channel transaction.
    • TransactionType; string; Name that identifies the type of channel transaction. Valid values are ACCRUAL and ADJUSTMENT. A list of accepted values is defined in the lookup type ORA_CJM_TRANSACTION_TYPE.
    • TransactionTypeCode; string; Abbreviation that identifies the type of channel transaction. Valid values are ACCRUAL and ADJUSTMENT. A list of accepted values is defined in the lookup type ORA_CJM_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 : channelManualAdjustments-channelTransactions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : channelManualAdjustments-channelTransactions-item-response
Type: object
Show Source
Back to Top