Uninvoiced tax estimates

GET

/billing_new/orders/tax_estimates/v1/:order_id

GET

/billing_new/orders/tax_estimates/v1/:order_id

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

[
  {
    "calculation": {
      "currency_code": "USD",
      "subtotal": 1.1,
      "tax_total": 1.1,
      "total_amount": 1.1,
      "net_amounts": {
        "key": 1.1
      },
      "tax_breakdown": [
        {
          "name": "name",
          "percentage": 1.1,
          "tax_amount": 1.1,
          "tax_configuration_id": "tax_configuration_id",
          "taxable_amount": 1.1,
          "order_id": null,
          "shipper_account_id": null
        }
      ]
    },
    "invoice": {
      "currency_code": "USD",
      "invoice_type": "accounts_receivable",
      "schema_version": 1,
      "counterparty_driver_id": "counterparty_driver_id",
      "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
      "counterparty_org_id": "counterparty_org_id",
      "description": "description",
      "export_ref__sage__customer_id": "export_ref__sage__customer_id",
      "export_ref__sage__department_id": "export_ref__sage__department_id",
      "name": "name",
      "period_end_at_timestamp": "2024-01-15T09:30:00Z",
      "period_start_at_timestamp": "2024-01-15T09:30:00Z"
    },
    "invoice_line_items": [
      {
        "_id": "_id",
        "created_at_timestamp": "2024-01-15T09:30:00Z",
        "created_by_user_id": "created_by_user_id",
        "currency_code": "USD",
        "description": "description",
        "invoice_type": "accounts_receivable",
        "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
        "last_edited_by_user_id": "last_edited_by_user_id",
        "line_item_type": "base_rate",
        "owned_by_org_id": "owned_by_org_id",
        "quantity": 1.1,
        "schema_version": 1,
        "unit_price": 1.1
      }
    ],
    "tax_configurations_by_line_item_id": {
      "key": {
        "_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
      }
    }
  }
]

Estimates current taxes for uninvoiced ordinary charges grouped by counterparty, direction, and currency. Returns an empty list when no charges qualify. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[InvoicePreviewRes])

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Response

Successful Response

calculationobject

invoiceobject

invoice_line_itemslist of objectsOptional

tax_configurations_by_line_item_idmap from strings to optional objectsOptional

Errors

422

Orders Tax Estimates V1request Unprocessable Entity Error