Preview ad-hoc

POST

/billing_new/invoice_line_items/ad_hoc/preview/v1

POST

/billing_new/invoice_line_items/ad_hoc/preview/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.billingNew.invoiceLineItems.previewAdHocV1({
8         ad_hoc_line_items: [
9             {
10                 invoice_line_item: {
11                     currency_code: "USD",
12                     description: "description",
13                     invoice_type: "accounts_receivable",
14                     line_item_type: "base_rate",
15                     quantity: 1.1,
16                     schema_version: 1,
17                     unit_price: 1.1,
18                 },
19             },
20         ],
21         task_group_id: "task_group_id",
22     });
23 }
24 main();

1 [
2   {
3     "created_at_timestamp": "2024-01-15T09:30:00Z",
4     "created_by_user_id": "created_by_user_id",
5     "currency_code": "USD",
6     "description": "description",
7     "invoice_type": "accounts_receivable",
8     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
9     "last_edited_by_user_id": "last_edited_by_user_id",
10     "line_item_type": "base_rate",
11     "owned_by_org_id": "owned_by_org_id",
12     "quantity": 1.1,
13     "schema_version": 1,
14     "unit_price": 1.1,
15     "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
16     "counterparty_org_id": "counterparty_org_id",
17     "export_ref__sage__item_id": "export_ref__sage__item_id",
18     "invoice_id": "invoice_id",
19     "order_id": "order_id",
20     "rate_sheet_id": "rate_sheet_id",
21     "shipper_account_id": "shipper_account_id",
22     "status": "draft",
23     "task_group_id": "task_group_id",
24     "tax_percentage": 1.1,
25     "unit": "each"
26   }
27 ]

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_timestampdatetime

created_by_user_idstring

Must be a string starting with user_

currency_codeenum

descriptionstring1-32768 characters

invoice_typeenum

last_edited_at_timestampdatetime

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

counterparty_off_chrt_org_data_idstringOptional

counterparty_org_idstringOptional

Must be a string starting with org_

export_ref__sage__item_idstringOptional<=255 characters

invoice_idstringOptional

order_idstringOptional

rate_sheet_idstringOptional

shipper_account_idstringOptional

statusenumOptional

task_group_idstringOptional

tax_percentagedoubleOptional>=0

unitenumOptional

Errors

422

Invoice Line Items Preview Ad Hoc V1request Unprocessable Entity Error