Expanded

GET

/billing_new/invoices/expanded/v1/:invoice_id

GET

/billing_new/invoices/expanded/v1/:invoice_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.invoices.getExpandedV1("invoice_id");
8 }
9 main();

1 {
2   "invoice": {
3     "_id": "_id",
4     "created_at_timestamp": "2024-01-15T09:30:00Z",
5     "created_by_user_id": "created_by_user_id",
6     "currency_code": "USD",
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     "owned_by_org_id": "owned_by_org_id",
11     "schema_version": 1,
12     "approved_at_timestamp": "2024-01-15T09:30:00Z",
13     "approved_by_user_id": "approved_by_user_id",
14     "counterparty_account_ids": [
15       "counterparty_account_ids"
16     ],
17     "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
18     "counterparty_org_id": "counterparty_org_id",
19     "description": "description",
20     "export_ref__sage__customer_id": "export_ref__sage__customer_id",
21     "export_ref__sage__department_id": "export_ref__sage__department_id",
22     "file_exported_at_timestamp": "2024-01-15T09:30:00Z",
23     "file_exported_by_user_id": "file_exported_by_user_id",
24     "invoice_line_item_ids": [
25       "invoice_line_item_ids"
26     ],
27     "merge_exported_at_timestamp": "2024-01-15T09:30:00Z",
28     "merge_exported_by_user_id": "merge_exported_by_user_id",
29     "merge_invoice_id": "merge_invoice_id",
30     "merge_invoice_number": "merge_invoice_number",
31     "merge_invoice_url": "merge_invoice_url",
32     "merge_linked_account_id": "merge_linked_account_id",
33     "merge_remote_id": "merge_remote_id",
34     "merge_remote_was_deleted": true,
35     "merge_status": "draft",
36     "name": "name",
37     "status": "draft",
38     "stripe_exported_at_timestamp": "2024-01-15T09:30:00Z",
39     "stripe_exported_by_user_id": "stripe_exported_by_user_id",
40     "stripe_invoice_id": "stripe_invoice_id",
41     "stripe_invoice_number": "stripe_invoice_number",
42     "stripe_invoice_url": "stripe_invoice_url",
43     "stripe_status": "draft",
44     "stripe_was_deleted": true,
45     "total_amount": 1.1,
46     "void_reason": "void_reason",
47     "voided_at_timestamp": "2024-01-15T09:30:00Z",
48     "voided_by_user_id": "voided_by_user_id"
49   },
50   "counterparty_accounts": [
51     {
52       "_id": "_id",
53       "created_by_org_id": "created_by_org_id",
54       "created_by_user_id": "created_by_user_id",
55       "name": "name",
56       "schema_version": 1,
57       "location": {
58         "geometry": {
59           "type": "GeometryCollection",
60           "geometries": [
61             {
62               "type": "LineString",
63               "coordinates": [
64                 []
65               ]
66             }
67           ]
68         },
69         "type": "Feature"
70       },
71       "off_chrt_org_data_id": "off_chrt_org_data_id",
72       "org_id": "org_id"
73     }
74   ],
75   "counterparty_off_chrt_org_data": {
76     "_id": "_id",
77     "created_by_user_id": "created_by_user_id",
78     "name": "name",
79     "org_type": "provider",
80     "owned_by_org_id": "owned_by_org_id",
81     "schema_version": 1,
82     "email_address": "email_address",
83     "industry": "industry",
84     "phone_number": "phone_number",
85     "street_address": {
86       "geometry": {
87         "type": "GeometryCollection",
88         "geometries": [
89           {
90             "type": "LineString",
91             "coordinates": [
92               []
93             ]
94           }
95         ]
96       },
97       "type": "Feature",
98       "id": 1
99     }
100   },
101   "counterparty_org": {
102     "_id": "_id",
103     "name": "name",
104     "org_id": "org_id",
105     "org_type": "provider",
106     "schema_version": 1,
107     "description": "description",
108     "email_address": "email_address",
109     "handle": "handle",
110     "industry": "industry",
111     "phone_number": "phone_number",
112     "street_address": {
113       "geometry": {
114         "type": "GeometryCollection",
115         "geometries": [
116           {
117             "type": "LineString",
118             "coordinates": [
119               []
120             ]
121           }
122         ]
123       },
124       "type": "Feature",
125       "id": 1
126     }
127   },
128   "invoice_line_items": [
129     {
130       "_id": "_id",
131       "created_at_timestamp": "2024-01-15T09:30:00Z",
132       "created_by_user_id": "created_by_user_id",
133       "currency_code": "USD",
134       "description": "description",
135       "invoice_type": "accounts_receivable",
136       "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
137       "last_edited_by_user_id": "last_edited_by_user_id",
138       "line_item_type": "base_rate",
139       "owned_by_org_id": "owned_by_org_id",
140       "quantity": 1.1,
141       "schema_version": 1,
142       "unit_price": 1.1,
143       "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
144       "counterparty_org_id": "counterparty_org_id",
145       "export_ref__sage__item_id": "export_ref__sage__item_id",
146       "invoice_id": "invoice_id",
147       "order_id": "order_id",
148       "rate_sheet_id": "rate_sheet_id",
149       "shipper_account_id": "shipper_account_id",
150       "status": "draft",
151       "task_group_id": "task_group_id",
152       "tax_percentage": 1.1,
153       "unit": "each"
154     }
155   ]
156 }

Retrieves an owner-scoped invoice with its line items, counterparty organization data, and accounts expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceExpandedRes)

Authentication

AuthorizationBearer

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

Path parameters

invoice_idstringRequired

Response

Successful Response

invoiceobject

counterparty_accountslist of objectsOptional

counterparty_off_chrt_org_dataobjectOptional

counterparty_orgobjectOptional

invoice_line_itemslist of objectsOptional

Errors

422

Invoices Get Expanded V1request Unprocessable Entity Error