Preview selected charges

POST

/billing_new/invoices/preview/v1

POST

/billing_new/invoices/preview/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.invoices.previewV1({
        currency_code: "USD",
        invoice_type: "accounts_receivable",
        schema_version: 1,
    });
}
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,
      "awb_number": "awb_number",
      "billing_period_id": "billing_period_id",
      "counterparty_driver_id": "counterparty_driver_id",
      "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
      "counterparty_org_id": "counterparty_org_id",
      "currency_conversion": {
        "conversion_rate": 1.1,
        "source_currency_code": "USD",
        "source_unit_price": 1.1
      },
      "export_ref__sage__item_id": "export_ref__sage__item_id",
      "invoice_id": "invoice_id",
      "order_id": "order_id",
      "rate_sheet_id": "rate_sheet_id",
      "shipper_account_id": "shipper_account_id",
      "status": "draft",
      "task_group_id": "task_group_id",
      "tax_percentage": 1.1,
      "total_amount": 1.1,
      "unit": "each"
    }
  ],
  "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,
      "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
        }
      ]
    }
  }
}

Previews exact uninvoiced charges, current resolved taxes, and explicit or derived billing dates without saving. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceCreateReq) -> (InvoicePreviewRes)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

currency_codeenumRequired

invoice_typeenumRequired

Allowed values:

schema_versionintegerRequired

counterparty_driver_idstringOptional

counterparty_off_chrt_org_data_idstringOptional

counterparty_org_idstringOptional

Must be a string starting with org_

descriptionstringOptional<=32768 characters

export_ref__sage__customer_idstringOptional<=255 characters

export_ref__sage__department_idstringOptional<=255 characters

invoice_line_item_idslist of stringsOptional

namestringOptional<=255 characters

period_end_at_timestampdatetimeOptional

period_start_at_timestampdatetimeOptional

Response

Successful Response

calculationobject

invoiceobject

invoice_line_itemslist of objectsOptional

tax_configurations_by_line_item_idmap from strings to optional objectsOptional

Errors

422

Invoices Preview V1request Unprocessable Entity Error