Jump to

• Request
• Response
• Examples

Get all channel transactions

get

/fscmRestApi/resources/11.13.18.05/channelTransactions

Request

Query Parameters

• 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
• finder: string
  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.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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 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; Name of the item in the inventory.
  • ItemId; integer; Value that uniquely identifies 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 sales order.
  • OrderCurrencyCode; string; Abbreviation that identifies the currency used in 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 channel program currency.
  • 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 when the user requested accounting.
  • ShipmentDate; string; Date when the user shipped the sales order.
  • ShipmentNumber; string; Number that 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.
• totalResults: boolean
  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

• 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 Top

Response

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.

Body ()

Root Schema : channelTransactions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/channelTransactions-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"OrderManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object channelTransactions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/channelTransactions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channelTransactions-item-response

Type: object

Show Source

• AccrualYear: integer (int64)
  Read Only: true

  Calendar year when the user generated the accrual.
• AdjustmentComments: string
  Read Only: true

  Maximum Length: 1000

  Comments for adjustment.
• AdjustmentDate: string (date)
  Read Only: true

  Date when the user created the adjustment or accrual record.
• AdjustmentFor: string
  Read Only: true

  Maximum Length: 255

  Name 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: true

  Maximum Length: 30

  Abbreviation 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: true

  Maximum Length: 255

  Number that identifies the manual adjustment.
• AdjustmentReason: string
  Read Only: true

  Maximum Length: 255

  Name of the user-created reason for adjustment.
• AdjustmentReasonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the user-created reason for adjustment.
• AdjustmentType: string
  Read Only: true

  Maximum Length: 30

  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 (int64)
  Read Only: true

  Value that uniquely identifies the user-created adjustment type.
• AmountInFunctionalCurrency: number
  Read Only: true

  Accrual amount in functional currency.
• AmountInOrderCurrency: number
  Read Only: true

  Accrual amount in the currency used in sales order.
• BillOfLadingNumber: string
  Read Only: true

  Maximum Length: 120

  Document issued by a carrier to acknowledge receipt of cargo for shipment.
• BusinessUnit: string
  Read Only: true

  Maximum Length: 255

  Name of the business unit.
• BusinessUnitId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business unit.
• ConversionDate: string (date)
  Read Only: true

  Date of amount conversion.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• FulFillLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sales order fulfilment line.
• FulFillLineNumber: string
  Read Only: true

  Number 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: true

  Maximum Length: 255

  Name of the ledger currency.
• FunctionalCurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the ledger currency.
• GlDate: string (date)
  Read Only: true

  Date when the channel transaction is accounted.
• GlPostedFlag: boolean
  Read Only: true

  Maximum Length: 1

  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
  Read Only: true

  Maximum Length: 255

  Name of the item in the inventory.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the item in the inventory.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item in the inventory.
• ItemLevel: string
  Read Only: true

  Maximum Length: 255

  Level 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: true

  Maximum Length: 30

  Abbreviation that identifies the level at which discounts are defined.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualAdjustmentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the manual adjustment.
• ManualFlag: boolean
  Read Only: true

  Maximum Length: 255

  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
  Read Only: true

  Maximum Length: 255

  Name of the sales order party who is legally responsible for payment.
• OrderBillToCustomerAccountId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bill to customer account in the sales order.
• OrderBillToCustomerAccountNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the bill to customer account in the sales order.
• OrderCurrency: string
  Read Only: true

  Maximum Length: 255

  Name of the currency used in sales order.
• OrderCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency used in sales order.
• OrderDate: string (date)
  Read Only: true

  Date when the user submitted the sales order.
• OrderHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sales order header.
• OrderInvoiceDate: string (date)
  Read Only: true

  Date when the sales order is invoiced.
• OrderInvoiceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sales order invoice.
• OrderInvoiceLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sales order invoice line.
• OrderInvoiceLineNumber: number
  Read Only: true

  Number that identifies the sales order invoice line.
• OrderInvoiceNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the sales order invoice.
• OrderInvoiceSource: string
  Read Only: true

  Maximum Length: 50

  Source of the feeder application from which an invoice is created.
• OrderNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the sales order.
• OrderSourceCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the source application that created the order.
• ProgramCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that uniquely identifies the channel program.
• ProgramCurrency: string
  Read Only: true

  Maximum Length: 255

  Name of the channel program currency.
• ProgramCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the channel program currency.
• ProgramId: integer (int64)
  Read Only: true

  Value that uniquely identifies the channel program.
• ProgramName: string
  Read Only: true

  Maximum Length: 255

  Name of the channel program.
• ProgramTemplate: string
  Read Only: true

  Maximum Length: 255

  Name of the predefined program template on which the channel program is based.
• ProgramTemplateCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the predefined program template on which the channel program is based.
• ProgramType: string
  Read Only: true

  Maximum Length: 255

  Name of the program type on which the channel program is based.
• ProgramTypeId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the program type on which the channel program is based.
• RequestedGlDate: string (date)
  Read Only: true

  Date when the user requested accounting.
• ShipmentDate: string (date)
  Read Only: true

  Date when the user shipped the sales order.
• ShipmentNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the shipment.
• Supplier: string
  Read Only: true

  Maximum Length: 255

  Name of the supplier.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier.
• SupplierItem: string
  Read Only: true

  Name of the supplier item.
• SupplierItemDescription: string
  Description of the supplier item.
• SupplierItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier item.
• SupplierNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the supplier.
• SupplierSite: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the supplier site.
• SupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.
• TransactionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the channel transaction.
• TransactionType: string
  Read Only: true

  Maximum Length: 255

  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
  Read Only: true

  Maximum Length: 30

  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.
• WaybillNumber: string
  Read Only: true

  Maximum Length: 30

  Number that tracks the shipment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the channel program currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the inventory.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManualAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manual adjustment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user-created adjustment type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TransactionTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the program type on which the channel program is based.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency used in sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTemplateCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the predefined program template on which the channel program is based.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedGlDate":{
            "type":"string",
            "description":"Date when the user requested accounting.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentFor":{
            "maxLength":"255",
            "type":"string",
            "description":"Name 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AdjustmentReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user-created reason for adjustment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"19"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the program type on which the channel program is based.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentForCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessUnit":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderInvoiceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order invoice line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FunctionalCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FulFillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order fulfilment line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConversionDate":{
            "type":"string",
            "description":"Date of amount conversion.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderInvoiceDate":{
            "type":"string",
            "description":"Date when the sales order is invoiced.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WaybillNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that tracks the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderInvoiceSource":{
            "maxLength":"50",
            "type":"string",
            "description":"Source of the feeder application from which an invoice is created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillOfLadingNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Document issued by a carrier to acknowledge receipt of cargo for shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderBillToCustomerAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the bill to customer account in the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FulFillLineNumber":{
            "type":"string",
            "description":"Number that identifies Oracle Order Management Cloud fulfillment line. It is the concatenated value of display line number and fulfill line number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AdjustmentNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the manual adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderInvoiceLineNumber":{
            "type":"number",
            "description":"Number that identifies the sales order invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"Level 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionalCurrencyCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentComments":{
            "maxLength":"1000",
            "type":"string",
            "description":"Comments for adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrderSourceCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the source application that created the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentReason":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the user-created reason for adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Supplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentDate":{
            "type":"string",
            "description":"Date when the user created the adjustment or accrual record.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GlPostedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the channel program currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GlDate":{
            "type":"string",
            "description":"Date when the channel transaction is accounted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderBillToCustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill to customer account in the sales order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrderInvoiceNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the sales order invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderBillToCustomer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the sales order party who is legally responsible for payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDate":{
            "type":"string",
            "description":"Date when the user submitted the sales order.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency used in sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentDate":{
            "type":"string",
            "description":"Date when the user shipped the sales order.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountInFunctionalCurrency":{
            "type":"number",
            "description":"Accrual amount in functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderInvoiceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order invoice.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AmountInOrderCurrency":{
            "type":"number",
            "description":"Accrual amount in the currency used in sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramTemplate":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the predefined program template on which the channel program is based.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccrualYear":{
            "type":"integer",
            "description":"Calendar year when the user generated the accrual.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierItemDescription":{
            "type":"string",
            "description":"Description of the supplier item.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierItem":{
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to get all channel transactions.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/versionchannelTransactions"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "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"
                }
            ]
        },
        {
            "TransactionId": 100100134844995,
            "TransactionType": "Adjustment",
            "TransactionTypeCode": "ADJUSTMENT",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "AdjustmentFor": "Supplier",
            "AdjustmentForCode": "SUPPLIER",
            "ManualAdjustmentId": 300100185172781,
            "AdjustmentNumber": "ADJ100001",
            "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": 2,
            "FunctionalCurrencyCode": "USD",
            "FunctionalCurrency": "US Dollar",
            "AmountInOrderCurrency": 2,
            "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/100100134844995",
                    "name": "channelTransactions",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/channelTransactions/100100134844995",
                    "name": "channelTransactions",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelTransactions",
            "name": "channelTransactions",
            "kind": "collection"
        }
    ]
}

Back to Top