> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryManualTaxMappings # Package: tax # Namespace: ManualTaxMappingService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/tax/manual-tax-mappings/query-manual-tax-mappings.md ## Permission Scopes: Manage Orders: SCOPE.DC-STORES.MANAGE-ORDERS ## Introduction Retrieves a list of manual tax mappings based on the provided query criteria. Use this method to find manual tax mappings by tax group, tax region, or other filter criteria. You can also sort and paginate the results. This is useful for managing large numbers of tax mappings or finding mappings that apply to specific regions or tax groups. To learn how to query manual tax mappings, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). --- ## REST API ### Schema ``` Method: queryManualTaxMappings Description: Retrieves a list of manual tax mappings based on the provided query criteria. Use this method to find manual tax mappings by tax group, tax region, or other filter criteria. You can also sort and paginate the results. This is useful for managing large numbers of tax mappings or finding mappings that apply to specific regions or tax groups. To learn how to query manual tax mappings, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). URL: https://www.wixapis.com/billing/v1/manual-tax-mappings/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryManualTaxMappingsResponse - name: manualTaxMappings | type: array | description: Manual tax mappings that match the query criteria. - name: id | type: string | description: Manual tax mapping GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the manual tax mapping is updated. To prevent conflicting changes, the current revision must be passed when updating the manual tax mapping. Ignored when creating a manual tax mapping. - name: createdDate | type: string | description: Date and time the manual tax mapping was created. - name: updatedDate | type: string | description: Date and time the manual tax mapping was last updated. - name: taxGroupId | type: string | description: Tax group GUID. Tax groups define collections of items or services that share the same tax treatment. - name: taxRegionId | type: string | description: Tax region GUID. Tax regions represent geographical areas where specific tax rules apply. - name: taxRate | type: string | description: Tax rate to apply for this tax group and region combination. Specified as a decimal value (for example, `0.080000` for 8%). - name: description | type: string | description: Description of the manual tax mapping. Use this field to add context or notes about the tax rate. - name: taxType | type: string | description: Type of tax being applied, such as `VAT`, `GST`, or `Sales Tax`. This depends on the jurisdiction's tax laws. - name: taxName | type: string | description: Name of the tax being applied. For example, `STATE TAX` or `GST`. - name: jurisdiction | type: string | description: Name of the jurisdiction where this tax rate applies. For example, `California` or `United Kingdom`. - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction where this tax rate applies, such as country, state, county, city, or special district. - enum: UNDEFINED, COUNTRY, STATE, COUNTY, CITY, SPECIAL - name: exemptRates | type: array | description: Tax exemption details for user-defined exempt groups. - name: taxRate | type: string | description: Tax override rate for given tax mapping. - name: extendedFields | type: ExtendedFields | description: Extended fields for storing additional custom data. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Pagination metadata. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query Manual Tax Mappings Retrieves manual tax mappings using filters and sorting, with support for pagination ```curl curl -X POST \ 'https://www.wixapis.com/billing/v1/manual-tax-mappings/query' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "query": { "filter": { "taxRegionId": "0115fa48-7167-46e1-a93f-e0d308124546" }, "sort": [ { "fieldName": "updatedDate", "order": "DESC" } ], "cursorPaging": { "limit": 2 } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.tax.ManualTaxMappingService.queryManualTaxMappings(query) Description: Retrieves a list of manual tax mappings based on the provided query criteria. Use this method to find manual tax mappings by tax group, tax region, or other filter criteria. You can also sort and paginate the results. This is useful for managing large numbers of tax mappings or finding mappings that apply to specific regions or tax groups. To learn how to query manual tax mappings, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: ManualTaxMappingQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: manualTaxMappings | type: array | description: Manual tax mappings that match the query criteria. - name: _id | type: string | description: Manual tax mapping GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the manual tax mapping is updated. To prevent conflicting changes, the current revision must be passed when updating the manual tax mapping. Ignored when creating a manual tax mapping. - name: _createdDate | type: Date | description: Date and time the manual tax mapping was created. - name: _updatedDate | type: Date | description: Date and time the manual tax mapping was last updated. - name: taxGroupId | type: string | description: Tax group GUID. Tax groups define collections of items or services that share the same tax treatment. - name: taxRegionId | type: string | description: Tax region GUID. Tax regions represent geographical areas where specific tax rules apply. - name: taxRate | type: string | description: Tax rate to apply for this tax group and region combination. Specified as a decimal value (for example, `0.080000` for 8%). - name: description | type: string | description: Description of the manual tax mapping. Use this field to add context or notes about the tax rate. - name: taxType | type: string | description: Type of tax being applied, such as `VAT`, `GST`, or `Sales Tax`. This depends on the jurisdiction's tax laws. - name: taxName | type: string | description: Name of the tax being applied. For example, `STATE TAX` or `GST`. - name: jurisdiction | type: string | description: Name of the jurisdiction where this tax rate applies. For example, `California` or `United Kingdom`. - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction where this tax rate applies, such as country, state, county, city, or special district. - enum: UNDEFINED, COUNTRY, STATE, COUNTY, CITY, SPECIAL - name: exemptRates | type: array | description: Tax exemption details for user-defined exempt groups. - name: taxRate | type: string | description: Tax override rate for given tax mapping. - name: extendedFields | type: ExtendedFields | description: Extended fields for storing additional custom data. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Pagination metadata. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryManualTaxMappings ```javascript import { manualTaxMappings } from '@wix/billing'; async function queryManualTaxMappings(query) { const response = await manualTaxMappings.queryManualTaxMappings(query); }; ``` ### queryManualTaxMappings (with elevated permissions) ```javascript import { manualTaxMappings } from '@wix/billing'; import { auth } from '@wix/essentials'; async function myQueryManualTaxMappingsMethod(query) { const elevatedQueryManualTaxMappings = auth.elevate(manualTaxMappings.queryManualTaxMappings); const response = await elevatedQueryManualTaxMappings(query); } ``` ### queryManualTaxMappings (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { manualTaxMappings } from '@wix/billing'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { manualTaxMappings }, // Include the auth strategy and host as relevant }); async function queryManualTaxMappings(query) { const response = await myWixClient.manualTaxMappings.queryManualTaxMappings(query); }; ``` ---