List by order

GET

/billing_new/invoice_line_items/by_order/v1/:order_id

GET

/billing_new/invoice_line_items/by_order/v1/:order_id

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.listByOrderV1("order_id");
8 }
9 main();

1 {
2   "counterparty_off_chrt_org_data": [
3     {
4       "_id": "_id",
5       "created_by_user_id": "created_by_user_id",
6       "name": "name",
7       "org_type": "provider",
8       "owned_by_org_id": "owned_by_org_id",
9       "schema_version": 1,
10       "email_address": "email_address",
11       "industry": "industry",
12       "phone_number": "phone_number",
13       "street_address": {
14         "geometry": {
15           "type": "GeometryCollection",
16           "geometries": [
17             {
18               "type": "LineString",
19               "coordinates": [
20                 []
21               ]
22             }
23           ]
24         },
25         "type": "Feature"
26       }
27     }
28   ],
29   "counterparty_orgs": [
30     {
31       "_id": "_id",
32       "name": "name",
33       "org_id": "org_id",
34       "org_type": "provider",
35       "schema_version": 1,
36       "description": "description",
37       "email_address": "email_address",
38       "handle": "handle",
39       "industry": "industry",
40       "phone_number": "phone_number",
41       "street_address": {
42         "geometry": {
43           "type": "GeometryCollection",
44           "geometries": [
45             {
46               "type": "LineString",
47               "coordinates": [
48                 []
49               ]
50             }
51           ]
52         },
53         "type": "Feature"
54       }
55     }
56   ],
57   "invoice_line_items": [
58     {
59       "_id": "_id",
60       "created_at_timestamp": "2024-01-15T09:30:00Z",
61       "created_by_user_id": "created_by_user_id",
62       "currency_code": "USD",
63       "description": "description",
64       "invoice_type": "accounts_receivable",
65       "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
66       "last_edited_by_user_id": "last_edited_by_user_id",
67       "line_item_type": "base_rate",
68       "owned_by_org_id": "owned_by_org_id",
69       "quantity": 1.1,
70       "schema_version": 1,
71       "unit_price": 1.1,
72       "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
73       "counterparty_org_id": "counterparty_org_id",
74       "export_ref__sage__item_id": "export_ref__sage__item_id",
75       "invoice_id": "invoice_id",
76       "order_id": "order_id",
77       "rate_sheet_id": "rate_sheet_id",
78       "shipper_account_id": "shipper_account_id",
79       "status": "draft",
80       "task_group_id": "task_group_id",
81       "tax_percentage": 1.1,
82       "unit": "each"
83     }
84   ],
85   "shipper_accounts": [
86     {
87       "_id": "_id",
88       "created_by_org_id": "created_by_org_id",
89       "created_by_user_id": "created_by_user_id",
90       "name": "name",
91       "schema_version": 1,
92       "location": {
93         "geometry": {
94           "type": "GeometryCollection",
95           "geometries": [
96             {
97               "type": "LineString",
98               "coordinates": [
99                 []
100               ]
101             }
102           ]
103         },
104         "type": "Feature"
105       },
106       "off_chrt_org_data_id": "off_chrt_org_data_id",
107       "org_id": "org_id"
108     }
109   ]
110 }

Lists owner-scoped line items for an order with counterparties and accounts expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceLineItemsByOrderExpandedRes)

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Response

Successful Response

counterparty_off_chrt_org_datalist of objects

counterparty_orgslist of objects

invoice_line_itemslist of objects

shipper_accountslist of objects

Errors

422

Invoice Line Items List by Order V1request Unprocessable Entity Error