# CreditMemos Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. ## Documentation Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. - Catalog: `Magento` - Schema: `Sales` - Primary Keys: `entity_id` This is a read-only table function. The Magento API may not support changing the data or the Invantive UniversalSQL driver for Magento does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Magento API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `CreditMemos`. 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 | |---|:---:|:---:|:---:|---| | `searchCriteria[currentPage]` | `` | ☐ | | Current page. | | `searchCriteria[filterGroups][0][filters][0][conditionType]` | `` | ☐ | | Condition type | | `searchCriteria[filterGroups][0][filters][0][field]` | `` | ☐ | | Field | | `searchCriteria[filterGroups][0][filters][0][value]` | `` | ☐ | | Value | | `searchCriteria[pageSize]` | `` | ☐ | | Page size. | | `searchCriteria[sortOrders][0][direction]` | `` | ☐ | | Sorting direction. | | `searchCriteria[sortOrders][0][field]` | `` | ☐ | | Sorting field. | ## Columns of Table Function The columns of the table function `CreditMemos` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `adjustment_negative` | `decimal` | | ☐ | Credit memo negative adjustment. | | `adjustment_positive` | `decimal` | | ☐ | Credit memo positive adjustment. | | `adjustment` | `decimal` | | ☐ | Credit memo adjustment. | | `base_adjustment_negative` | `decimal` | | ☐ | Credit memo negative base adjustment. | | `base_adjustment_positive` | `decimal` | | ☐ | Credit memo positive base adjustment. | | `base_adjustment` | `decimal` | | ☐ | Credit memo base adjustment. | | `base_currency_code` | `varchar2` | | ☐ | Credit memo base currency code. | | `base_discount_amount` | `decimal` | | ☐ | Credit memo base discount amount. | | `base_discount_tax_compensation_amount` | `decimal` | | ☐ | Credit memo base discount tax compensation amount. | | `base_grand_total` | `decimal` | | ☐ | Credit memo base grand total. | | `base_shipping_amount` | `decimal` | | ☐ | Credit memo base shipping amount. | | `base_shipping_discount_tax_compensation_amnt` | `decimal` | | ☐ | Credit memo base shipping discount tax compensation amount. | | `base_shipping_incl_tax` | `decimal` | | ☐ | Credit memo base shipping including tax. | | `base_shipping_tax_amount` | `decimal` | | ☐ | Credit memo base shipping tax amount. | | `base_subtotal_incl_tax` | `decimal` | | ☐ | Credit memo base subtotal including tax. | | `base_subtotal` | `decimal` | | ☐ | Credit memo base subtotal. | | `base_tax_amount` | `decimal` | | ☐ | Credit memo base tax amount. | | `base_to_global_rate` | `decimal` | | ☐ | Credit memo base-to-global rate. | | `base_to_order_rate` | `decimal` | | ☐ | Credit memo base-to-order rate. | | `billing_address_id` | `int64` | | ☐ | Credit memo billing address ID. | | `created_at` | `varchar2` | | ☐ | Credit memo created-at timestamp. | | `creditmemo_status` | `int64` | | ☐ | Credit memo status. | | `discount_amount` | `decimal` | | ☐ | Credit memo discount amount. | | `discount_description` | `varchar2` | | ☐ | Credit memo discount description. | | `discount_tax_compensation_amount` | `decimal` | | ☐ | Credit memo discount tax compensation amount. | | `email_sent` | `int64` | | ☐ | Credit memo email sent flag value. | | `entity_id` | `int64` | | ☐ | Credit memo ID. | | `extension_attributes` | `varchar2` | | ☐ | The JSON text of the nested object. | | `global_currency_code` | `varchar2` | | ☐ | Credit memo global currency code. | | `grand_total` | `decimal` | | ☐ | Credit memo grand total. | | `increment_id` | `varchar2` | | ☐ | Credit memo increment ID. | | `invoice_id` | `int64` | | ☐ | Credit memo invoice ID. | | `order_currency_code` | `varchar2` | | ☐ | Credit memo order currency code. | | `order_id` | `int64` | | ☐ | Credit memo order ID. | | `shipping_address_id` | `int64` | | ☐ | Credit memo shipping address ID. | | `shipping_amount` | `decimal` | | ☐ | Credit memo shipping amount. | | `shipping_discount_tax_compensation_amount` | `decimal` | | ☐ | Credit memo shipping discount tax compensation amount. | | `shipping_incl_tax` | `decimal` | | ☐ | Credit memo shipping including tax. | | `shipping_tax_amount` | `decimal` | | ☐ | Credit memo shipping tax amount. | | `state` | `int64` | | ☐ | Credit memo state. | | `store_currency_code` | `varchar2` | | ☐ | Credit memo store currency code. | | `store_id` | `int64` | | ☐ | Credit memo store ID. | | `store_to_base_rate` | `decimal` | | ☐ | Credit memo store-to-base rate. | | `store_to_order_rate` | `decimal` | | ☐ | Credit memo store-to-order rate. | | `subtotal_incl_tax` | `decimal` | | ☐ | Credit memo subtotal including tax. | | `subtotal` | `decimal` | | ☐ | Credit memo subtotal. | | `tax_amount` | `decimal` | | ☐ | Credit memo tax amount. | | `transaction_id` | `varchar2` | | ☐ | Credit memo transaction ID. | | `updated_at` | `varchar2` | | ☐ | Credit memo updated-at timestamp. |