List

GET

/billing_new/invoices/list/v1

GET

/billing_new/invoices/list/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.invoices.listV1({
8         filter_counterparty_account_id: "filter_counterparty_account_id",
9         filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
10         filter_counterparty_org_id: "filter_counterparty_org_id",
11         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
12         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
13         filter_currency_codes: [
14             "USD",
15         ],
16         filter_invoice_types: [
17             "accounts_receivable",
18         ],
19         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
20         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
21         filter_statuses: [
22             "draft",
23         ],
24         page: 1,
25         page_size: 1,
26         search: "search",
27         sort_by: "created_at_timestamp",
28         sort_order: "asc",
29     });
30 }
31 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "created_by_user_id": "created_by_user_id",
7       "currency_code": "USD",
8       "invoice_type": "accounts_receivable",
9       "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
10       "last_edited_by_user_id": "last_edited_by_user_id",
11       "owned_by_org_id": "owned_by_org_id",
12       "schema_version": 1,
13       "approved_at_timestamp": "2024-01-15T09:30:00Z",
14       "approved_by_user_id": "approved_by_user_id",
15       "counterparty_account_ids": [
16         "counterparty_account_ids"
17       ],
18       "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
19       "counterparty_org_id": "counterparty_org_id",
20       "description": "description",
21       "export_ref__sage__customer_id": "export_ref__sage__customer_id",
22       "export_ref__sage__department_id": "export_ref__sage__department_id",
23       "file_exported_at_timestamp": "2024-01-15T09:30:00Z",
24       "file_exported_by_user_id": "file_exported_by_user_id",
25       "invoice_line_item_ids": [
26         "invoice_line_item_ids"
27       ],
28       "merge_exported_at_timestamp": "2024-01-15T09:30:00Z",
29       "merge_exported_by_user_id": "merge_exported_by_user_id",
30       "merge_invoice_id": "merge_invoice_id",
31       "merge_invoice_number": "merge_invoice_number",
32       "merge_invoice_url": "merge_invoice_url",
33       "merge_linked_account_id": "merge_linked_account_id",
34       "merge_remote_id": "merge_remote_id",
35       "merge_remote_was_deleted": true,
36       "merge_status": "draft",
37       "name": "name",
38       "status": "draft",
39       "stripe_exported_at_timestamp": "2024-01-15T09:30:00Z",
40       "stripe_exported_by_user_id": "stripe_exported_by_user_id",
41       "stripe_invoice_id": "stripe_invoice_id",
42       "stripe_invoice_number": "stripe_invoice_number",
43       "stripe_invoice_url": "stripe_invoice_url",
44       "stripe_status": "draft",
45       "stripe_was_deleted": true,
46       "total_amount": 1.1,
47       "void_reason": "void_reason",
48       "voided_at_timestamp": "2024-01-15T09:30:00Z",
49       "voided_by_user_id": "voided_by_user_id"
50     }
51   ],
52   "total_count": 1
53 }

Lists owner-scoped invoices with search, filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Search invoice names and descriptions.

sort_byenumOptional

Field to sort by.

Allowed values:

sort_orderenumOptional

Sort order.

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_statusesenumOptional

Filter by one or more invoice statuses.

Allowed values:

filter_invoice_typesenumOptional

Filter by one or more invoice types.

Allowed values:

filter_currency_codesenumOptional

Filter by one or more currency codes.

filter_counterparty_org_idstringOptional

Filter by an on-CHRT counterparty organization.

filter_counterparty_off_chrt_org_data_idstringOptional

Filter by off-CHRT counterparty organization data.

filter_counterparty_account_idstringOptional

Filter by an associated counterparty account.

filter_created_at_timestamp_gtedatetimeOptional

Filter by created_at_timestamp greater than or equal.

filter_created_at_timestamp_ltedatetimeOptional

Filter by created_at_timestamp less than or equal.

filter_last_edited_at_timestamp_gtedatetimeOptional

Filter by last_edited_at_timestamp greater than or equal.

filter_last_edited_at_timestamp_ltedatetimeOptional

Filter by last_edited_at_timestamp less than or equal.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Invoices List V1request Unprocessable Entity Error