Get one channel transaction
get
/fscmRestApi/resources/11.13.18.05/channelTransactions/{TransactionId}
Request
Path Parameters
-
TransactionId(required): integer(int64)
Value that uniquely identifies the channel transaction.
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 : channelTransactions-item-response
Type:
Show Source
object-
AccrualYear: integer
(int64)
Read Only:
trueCalendar year when the user generated the accrual. -
AdjustmentComments: string
Read Only:
trueMaximum Length:1000Comments for adjustment. -
AdjustmentDate: string
(date)
Read Only:
trueDate when the user created the adjustment or accrual record. -
AdjustmentFor: string
Read Only:
trueMaximum Length:255Name that identifies whether the manual adjustment record is created for CUSTOMER or SUPPLIER. A list of accepted values is defined in the lookup type ORA_CJM_ACCRUAL_ADJ_FOR. -
AdjustmentForCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies whether the manual adjustment record is created for CUSTOMER or SUPPLIER. A list of accepted values is defined in the lookup type ORA_CJM_ACCRUAL_ADJ_FOR. -
AdjustmentNumber: string
Read Only:
trueMaximum Length:255Number that identifies the manual adjustment. -
AdjustmentReason: string
Read Only:
trueMaximum Length:255Name of the user-created reason for adjustment. -
AdjustmentReasonId: integer
(int64)
Read Only:
trueValue that uniquely identifies the user-created reason for adjustment. -
AdjustmentType: string
Read Only:
trueMaximum Length:30Name 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
(int64)
Read Only:
trueValue that uniquely identifies the user-created adjustment type. -
AmountInFunctionalCurrency: number
Read Only:
trueAccrual amount in functional currency. -
AmountInOrderCurrency: number
Read Only:
trueAccrual amount in the currency used in sales order. -
BillOfLadingNumber: string
Read Only:
trueMaximum Length:120Document issued by a carrier to acknowledge receipt of cargo for shipment. -
BusinessUnit: string
Read Only:
trueMaximum Length:255Name of the business unit. -
BusinessUnitId: integer
(int64)
Read Only:
trueValue that uniquely identifies the business unit. -
ConversionDate: string
(date)
Read Only:
trueDate of amount conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
FulFillLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales order fulfilment line. -
FulFillLineNumber: string
Read Only:
trueNumber that identifies Oracle Order Management Cloud fulfillment line. It is the concatenated value of display line number and fulfill line number. -
FunctionalCurrency: string
Read Only:
trueMaximum Length:255Name of the ledger currency. -
FunctionalCurrencyCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the ledger currency. -
GlDate: string
(date)
Read Only:
trueDate when the channel transaction is accounted. -
GlPostedFlag: boolean
Read Only:
trueMaximum Length:1Contains 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
Read Only:
trueMaximum Length:255Name of the item in the inventory. -
ItemDescription: string
Read Only:
trueMaximum Length:255Description of the item in the inventory. -
ItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the item in the inventory. -
ItemLevel: string
Read Only:
trueMaximum Length:255Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL. -
ItemLevelCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the level at which discounts are defined. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualAdjustmentId: integer
(int64)
Read Only:
trueValue that uniquely identifies the manual adjustment. -
ManualFlag: boolean
Read Only:
trueMaximum Length:255Contains 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
Read Only:
trueMaximum Length:255Name of the sales order party who is legally responsible for payment. -
OrderBillToCustomerAccountId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bill to customer account in the sales order. -
OrderBillToCustomerAccountNumber: string
Read Only:
trueMaximum Length:255Number that identifies the bill to customer account in the sales order. -
OrderCurrency: string
Read Only:
trueMaximum Length:255Name of the currency used in sales order. -
OrderCurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the currency used in sales order. -
OrderDate: string
(date)
Read Only:
trueDate when the user submitted the sales order. -
OrderHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales order header. -
OrderInvoiceDate: string
(date)
Read Only:
trueDate when the sales order is invoiced. -
OrderInvoiceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales order invoice. -
OrderInvoiceLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales order invoice line. -
OrderInvoiceLineNumber: number
Read Only:
trueNumber that identifies the sales order invoice line. -
OrderInvoiceNumber: string
Read Only:
trueMaximum Length:30Number that identifies the sales order invoice. -
OrderInvoiceSource: string
Read Only:
trueMaximum Length:50Source of the feeder application from which an invoice is created. -
OrderNumber: string
Read Only:
trueMaximum Length:255Number that identifies the sales order. -
OrderSourceCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the source application that created the order. -
ProgramCode: string
Read Only:
trueMaximum Length:255Abbreviation that uniquely identifies the channel program. -
ProgramCurrency: string
Read Only:
trueMaximum Length:255Name of the channel program currency. -
ProgramCurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the channel program currency. -
ProgramId: integer
(int64)
Read Only:
trueValue that uniquely identifies the channel program. -
ProgramName: string
Read Only:
trueMaximum Length:255Name of the channel program. -
ProgramTemplate: string
Read Only:
trueMaximum Length:255Name of the predefined program template on which the channel program is based. -
ProgramTemplateCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the predefined program template on which the channel program is based. -
ProgramType: string
Read Only:
trueMaximum Length:255Name of the program type on which the channel program is based. -
ProgramTypeId: string
Read Only:
trueMaximum Length:255Value that uniquely identifies the program type on which the channel program is based. -
RequestedGlDate: string
(date)
Read Only:
trueDate when the user requested accounting. -
ShipmentDate: string
(date)
Read Only:
trueDate when the user shipped the sales order. -
ShipmentNumber: string
Read Only:
trueMaximum Length:30Number that identifies the shipment. -
Supplier: string
Read Only:
trueMaximum Length:255Name of the supplier. -
SupplierId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier. -
SupplierItem: string
Read Only:
trueName of the supplier item. -
SupplierItemDescription: string
Description of the supplier item.
-
SupplierItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier item. -
SupplierNumber: string
Read Only:
trueMaximum Length:255Number that identifies the supplier. -
SupplierSite: string
Read Only:
trueMaximum Length:255Value that identifies the supplier site. -
SupplierSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier site. -
TransactionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the channel transaction. -
TransactionType: string
Read Only:
trueMaximum Length:255Name 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
Read Only:
trueMaximum Length:30Abbreviation 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. -
WaybillNumber: string
Read Only:
trueMaximum Length:30Number that tracks the shipment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Examples
This example describes how to get one channel transaction.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/channelTransactions/TransactionId"
For example, the following command gets one channel transaction:
curl -u username:password "https://servername/fscmRestApi/resources/version/channelTransactions/100100134844992"
Example Response Body
The following shows an example of the response body in JSON format.
{
"TransactionId": 100100134844992,
"TransactionType": "Adjustment",
"TransactionTypeCode": "ADJUSTMENT",
"BusinessUnit": "Vision Operations",
"BusinessUnitId": 204,
"AdjustmentFor": "Supplier",
"AdjustmentForCode": "SUPPLIER",
"ManualAdjustmentId": 300100185172778,
"AdjustmentNumber": "ADJ100000",
"AdjustmentType": "CJM_ADJUST_AUTO_22052005099AM",
"AdjustmentTypeId": 300100185082579,
"ManualFlag": true,
"AdjustmentDate": "2020-05-26",
"AdjustmentReasonId": null,
"AdjustmentReason": null,
"AdjustmentComments": null,
"Supplier": "CDS, Inc",
"SupplierId": 1178,
"SupplierNumber": "5102",
"SupplierSite": "PITTSBURGH",
"SupplierSiteId": 2854,
"OrderBillToCustomer": "Computer Service and Rentals",
"OrderBillToCustomerAccountNumber": "1006",
"OrderBillToCustomerAccountId": 1006,
"ProgramName": "CP_AUTO_220520051026AM",
"ProgramCode": "SSD10000",
"ProgramId": 300100185082580,
"ProgramTemplate": "Supplier Ship and Debit",
"ProgramTemplateCode": "SUPPLIER_SHIP_AND_DEBIT",
"ProgramType": "CPT_AUTO_220520050740AM",
"ProgramTypeId": "300100185082575",
"ItemLevel": "Item",
"ItemLevelCode": "ITEM",
"Item": "AS54999",
"ItemId": 2155,
"ItemDescription": "Sentinel Standard Desktop - Rugged",
"OrderInvoiceDate": "2010-02-25",
"OrderInvoiceId": 577139,
"OrderInvoiceNumber": "10001",
"OrderInvoiceSource": "Distributed Order Orchestration",
"OrderInvoiceLineId": 1000179,
"OrderInvoiceLineNumber": 1,
"OrderDate": "2010-02-25",
"OrderHeaderId": 100000016352713,
"OrderNumber": "61030",
"OrderSourceCode": "SIEBEL",
"FulFillLineId": 100000016352715,
"FulFillLineNumber": "1-1",
"ShipmentNumber": null,
"ShipmentDate": null,
"WaybillNumber": null,
"BillOfLadingNumber": null,
"GlDate": "2020-05-26",
"GlPostedFlag": true,
"AccrualYear": 2020,
"ProgramCurrencyCode": "USD",
"ProgramCurrency": "US Dollar",
"AmountInFunctionalCurrency": 1,
"FunctionalCurrencyCode": "USD",
"FunctionalCurrency": "US Dollar",
"AmountInOrderCurrency": 1,
"OrderCurrencyCode": "USD",
"OrderCurrency": "US Dollar",
"RequestedGlDate": "2020-05-26",
"CreatedBy": "channel_user",
"CreationDate": "2020-05-29T10:06:38.306+00:00",
"LastUpdatedBy": "channel_user",
"LastUpdateDate": "2020-05-29T10:06:38.306+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelTransactions/100100134844992",
"name": "channelTransactions",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelTransactions/100100134844992",
"name": "channelTransactions",
"kind": "item"
}
]
}