List (via POST) by shipper

POST

/oort/shipper_pay_courier_statements/list/by_shipper_org_id/v1

POST

/oort/shipper_pay_courier_statements/list/by_shipper_org_id/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         environment: "https://localhost:8000",
6         token: "YOUR_TOKEN_HERE",
7     });
8     await client.shipperPayCourierStatements.listByShipperOrgIdV1({
9         statuses: [
10             "invoice_not_yet_created",
11         ],
12     });
13 }
14 main();

Try it

1 {
2   "statements": [
3     {
4       "schema_version": 1,
5       "shipper_pay_courier_line_item_group_ids": [
6         "string"
7       ],
8       "task_group_ids": [
9         "string"
10       ],
11       "courier_org_id": "string",
12       "statement_amount": 1.1,
13       "_id": "string",
14       "off_chrt_shipper_org_id": "string",
15       "shipper_org_id": "string",
16       "shipper_customer_id_for_courier_stripe_connect_account": "string",
17       "stripe_invoice_id": "string",
18       "stripe_invoice_url": "string",
19       "stripe_invoice_created_timestamp": "2024-01-15T09:30:00Z",
20       "stripe_invoice_created_by_user_id": "string",
21       "stripe_invoice_status": "invoice_not_yet_created",
22       "stripe_invoice_completed_timestamp": "2024-01-15T09:30:00Z"
23     }
24   ]
25 }

Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync. | (ListStatementsByShipperReq) -> (GetShipperPayCourierStatementsForShipperRes)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

statuseslist of enumsRequired

courier_org_idstring or nullOptional

Response

Successful Response

statementslist of objects

Authentication

Request

Response

Errors