List

GET

/billing_new/tax_configurations/list/v1

GET

/billing_new/tax_configurations/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.taxConfigurations.listV1({
        filter_archived: true,
        filter_counterparty_driver_id: "filter_counterparty_driver_id",
        filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
        filter_counterparty_org_id: "filter_counterparty_org_id",
        filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_shipper_account_id: "filter_shipper_account_id",
        page: 1,
        page_size: 1,
        sort_by: "name",
        sort_order: "asc",
    });
}
main();

{
  "total_count": 1,
  "items": [
    {
      "_id": "_id",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "created_by_user_id": "created_by_user_id",
      "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
      "last_edited_by_user_id": "last_edited_by_user_id",
      "name": "name",
      "owned_by_org_id": "owned_by_org_id",
      "schema_version": 1,
      "archived": true,
      "counterparty_driver_id": "counterparty_driver_id",
      "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
      "counterparty_org_id": "counterparty_org_id",
      "shipper_account_id": "shipper_account_id",
      "tax_rules": [
        {
          "name": "name",
          "percentage": 1.1
        }
      ]
    }
  ]
}

Lists owner-scoped tax configurations with counterparty, account, archive, date, sorting, and pagination filters. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (TaxConfigurationListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenumOptional

Allowed values:

sort_orderenumOptional

Sort order for query results

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_counterparty_org_idstringOptional

filter_counterparty_off_chrt_org_data_idstringOptional

filter_counterparty_driver_idstringOptional

filter_shipper_account_idstringOptional

filter_archivedbooleanOptional

filter_created_at_timestamp_gtedatetimeOptional

filter_created_at_timestamp_ltedatetimeOptional

Response

Successful Response

total_countinteger

itemslist of objectsOptional

Errors

422

Tax Configurations List V1request Unprocessable Entity Error