Archive

POST

/billing_new/tax_configurations/archive/v1/:tax_configuration_id

POST

/billing_new/tax_configurations/archive/v1/:tax_configuration_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.taxConfigurations.archiveV1("tax_configuration_id");
}
main();

{
  "_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,
      "export_ref__sage__item_id": "export_ref__sage__item_id"
    }
  ]
}

Archives a tax configuration so future resolution falls back to the next applicable scope. Repeated archival is unchanged. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (TaxConfiguration1)

Authentication

AuthorizationBearer

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

Path parameters

tax_configuration_idstringRequired

Response

Successful Response

_idstring

created_at_timestampdatetime

created_by_user_idstring

Must be a string starting with user_

last_edited_at_timestampdatetime

last_edited_by_user_idstring

Must be a string starting with user_

namestringformat: "\S"1-255 characters

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

archivedbooleanOptionalDefaults to false

counterparty_driver_idstringOptional

counterparty_off_chrt_org_data_idstringOptional

counterparty_org_idstringOptional

Must be a string starting with org_

shipper_account_idstringOptional

tax_ruleslist of objectsOptional

Errors

422

Tax Configurations Archive V1request Unprocessable Entity Error