Retrieve (via POST) ad-hoc preview

POST

/billing_new/invoice_line_items/ad_hoc/preview/v1

POST

/billing_new/invoice_line_items/ad_hoc/preview/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.invoiceLineItems.previewAdHocV1({
        ad_hoc_line_items: [
            {
                invoice_line_item: {
                    currency_code: "USD",
                    description: "string",
                    invoice_type: "accounts_receivable",
                    line_item_type: "base_rate",
                    quantity: 1.1,
                    schema_version: 1,
                    unit_price: 1.1,
                },
            },
        ],
        task_group_id: "string",
    });
}
main();

[
  {
    "created_at_timestamp": "2024-01-15T09:30:00Z",
    "created_by_user_id": "string",
    "currency_code": "USD",
    "description": "string",
    "invoice_type": "accounts_receivable",
    "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
    "last_edited_by_user_id": "string",
    "line_item_type": "base_rate",
    "owned_by_org_id": "string",
    "quantity": 1.1,
    "schema_version": 1,
    "unit_price": 1.1,
    "awb_number": "string",
    "billing_line_key": "string",
    "billing_period_id": "string",
    "counterparty_driver_id": "string",
    "counterparty_off_chrt_org_data_id": "string",
    "counterparty_org_id": "string",
    "currency_conversion": {
      "conversion_rate": 1.1,
      "source_currency_code": "USD",
      "source_unit_price": 1.1,
      "description": "string"
    },
    "edited_by_user": false,
    "export_ref__sage__item_id": "string",
    "generated_by_pricing": false,
    "invoice_id": "string",
    "needs_review": false,
    "order_id": "string",
    "rate_sheet_id": "string",
    "rate_sheet_revision": 1,
    "shipper_account_id": "string",
    "source_order_billing_quote_id": "string",
    "status": "draft",
    "task_group_id": "string",
    "task_ids": [
      "string"
    ],
    "task_short_ids": [
      "string"
    ],
    "tax_percentage": 1.1,
    "unit": "each"
  }
]

Previews account-split ad-hoc line items without persisting them. | authz: allowed_org_types=[provider], min_org_role=operator | (AdHocInvoiceLineItemsReq) -> (list[InvoiceLineItemServerCreate1])

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

ad_hoc_line_itemslist of objectsRequired

task_group_idstringRequired

Response

Successful Response

created_at_timestampstringformat: "date-time"

created_by_user_idstring

Must be a string starting with user_

currency_codeenum

descriptionstring1-32768 characters

invoice_typeenum

Allowed values:

last_edited_at_timestampstringformat: "date-time"

last_edited_by_user_idstring

Must be a string starting with user_

line_item_typeenum

owned_by_org_idstring

Must be a string starting with org_

quantitydouble

schema_versioninteger

unit_pricedouble

awb_numberstring or nullOptionalformat: "^\d{3}-\d{8}$"

billing_line_keystring or nullOptional1-1024 characters

billing_period_idstring or nullOptional

counterparty_driver_idstring or nullOptional

counterparty_off_chrt_org_data_idstring or nullOptional

counterparty_org_idstring or nullOptional

currency_conversionobject or nullOptional

edited_by_userbooleanOptionalDefaults to false

export_ref__sage__item_idstring or nullOptional<=255 characters

generated_by_pricingbooleanOptionalDefaults to false

invoice_idstring or nullOptional

needs_reviewbooleanOptionalDefaults to false

order_idstring or nullOptional

rate_sheet_idstring or nullOptional

rate_sheet_revisioninteger or nullOptional>=1

shipper_account_idstring or nullOptional

source_order_billing_quote_idstring or nullOptional

statusenumOptional

Allowed values:

task_group_idstring or nullOptional

task_idslist of stringsOptional

task_short_idslist of stringsOptional

tax_percentagedouble or nullOptional>=0

unitenum or nullOptional

Errors

422

Unprocessable Entity Error