# SalesOrderPaymentsByTypeOrderId Gets payments detail information for a single sales order Sample request: `GET /salesorders/SO/000101/payments` ## Documentation Sample request: `GET /salesorders/SO/000101/payments` - 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 `SalesOrderPaymentsByTypeOrderId`. 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 `SalesOrderPaymentsByTypeOrderId` 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. | | `amountAppliedToOrder` | `double` | | ☐ | The amount of the payment applied to the order | | `balance` | `double` | Balance | ☐ | The balance of the payment | | `billedAmount` | `double` | | ☐ | The amount of the payment that is applied to the order and transferred to related invoice(s) | | `cashAccount` | `varchar2` | Cash Account | ☐ | The cash account of the payment | | `currencyId` | `varchar2` | Currency ID | ☐ | The currency for the payment | | `documentType` | `varchar2` | Document Type | ☐ | The type of payment document that is applied to the sales order | | `paymentMethod` | `varchar2` | | ☐ | The payment method of the payment | | `referenceNumber` | `varchar2` | Reference Number | ☐ | The reference number of the payment document | | `reference` | `varchar2` | | ☐ | The external reference number of the payment | | `status` | `varchar2` | Status | ☐ | The status of the payment | | `totalAmount` | `double` | Total Amount | ☐ | The total amount of the payment |