List export rows

GET

/billing_new/invoices/export/list/v1/:invoice_id

GET

/billing_new/invoices/export/list/v1/:invoice_id

1 const url = 'https://localhost:8000/billing_new/invoices/export/list/v1/invoice_id?page=1&page_size=1';
2 const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "items": [
3     {
4       "airbill_charge": 1.1,
5       "base_rate": 1.1,
6       "billing_period_end_at_timestamp": "2024-01-15T09:30:00Z",
7       "billing_period_start_at_timestamp": "2024-01-15T09:30:00Z",
8       "charges_subtotal": 1.1,
9       "currency_code": "USD",
10       "invoice_number": "invoice_number",
11       "net_billing": 1.1,
12       "other_charges": 1.1,
13       "total_tax": 1.1,
14       "account_name": "account_name",
15       "airlines": [
16         "airlines"
17       ],
18       "awb_numbers": [
19         "awb_numbers"
20       ],
21       "cargo_types": [
22         "cargo_types"
23       ],
24       "charge_per_quantity": 1.1,
25       "delivery_address": "delivery_address",
26       "delivery_location_name": "delivery_location_name",
27       "delivery_status": "delivery_status",
28       "delivery_stop_number": 1,
29       "delivery_stops_on_order": 1,
30       "destination_iata": "destination_iata",
31       "flight_numbers": [
32         "flight_numbers"
33       ],
34       "invoice_approval_timestamp": "2024-01-15T09:30:00Z",
35       "mileage_estimated": 1.1,
36       "off_chrt_reference_id": "off_chrt_reference_id",
37       "order_placer_comments": "order_placer_comments",
38       "order_short_id": "order_short_id",
39       "origin_iata": "origin_iata",
40       "other_charges_detail": [
41         "other_charges_detail"
42       ],
43       "pod_date": "pod_date",
44       "pod_name": "pod_name",
45       "pod_time": "pod_time",
46       "quantity": 1,
47       "tax_1_amount": 1.1,
48       "tax_1_description": "tax_1_description",
49       "tax_2_amount": 1.1,
50       "tax_2_description": "tax_2_description",
51       "tax_3_amount": 1.1,
52       "tax_3_description": "tax_3_description",
53       "weight_pounds": 1.1
54     }
55   ],
56   "total_count": 1
57 }

Lists up to 1,000 shipment-level export rows for one accounts-receivable invoice owned by the caller’s organization, regardless of invoice status. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceExportListRes)

Authentication

AuthorizationBearer

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

Path parameters

invoice_idstringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-1000Defaults to 1000

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Export List V1request Unprocessable Entity Error