# SalesOrderDiscountsByTypeOrderId Gets discount details information for a single sales order Sample request: `GET /salesorders/SO/000101/discounts` ## Documentation Sample request: `GET /salesorders/SO/000101/discounts` - Catalog: `NgSalesOrders` - Schema: `SalesOrders` This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `SalesOrderDiscountsByTypeOrderId`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `orderId` | `` | ☑ | | The id of the sales order to get | | `type` | `` | ☑ | | The type of sales order to get | ## Columns of Table Function The columns of the table function `SalesOrderDiscountsByTypeOrderId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `COMPANY_CODE` | `varchar2(30)` | Company Code | ☑ | Partition code, segmenting the data. | | `COMPANY_NAME` | `varchar2(240)` | Company Name | ☑ | Name of the partition. | | `discountAmount` | `double` | | ☐ | The amount of the discount | | `discountId` | `varchar2` | | ☐ | The identifier of the discount applied to the order | | `discountPercent` | `double` | Discount Percent | ☐ | The discount percent, if the discount is defined to be calculated as a percentage | | `discountSequenceId` | `varchar2` | | ☐ | The identifier of the discount sequence of the discount ID applied to the order | | `discountableAmount` | `double` | | ☐ | The amount used as a base for discount calculation if the discount is based on amount. | | `discountableQuantity` | `double` | | ☐ | The quantity used as a base for discount calculation if the discount is based on quantity. | | `freeItemQuantity` | `double` | | ☐ | The quantity of the free item. Used to set the quantity for the order line generate by a free item discount | | `freeItem_description` | `varchar2` | | ☐ | The description | | `freeItem_id` | `varchar2` | | ☐ | The id | | `isManual` | `char` | | ☐ | Indicates that the discount has been applied manually | | `manualOrderIndex` | `int32` | | ☐ | The number of discount line set for the order | | `skipDiscount` | `char` | | ☐ | Indicates if the discount has been cancelled for the order and is not applicable | | `type` | `varchar2` | Type | ☐ | The type of discount whose sequence was applied to the document(Group or Document) |