List for courier org

const url = 'https://localhost:8000/billing/line_item_groups/list/for_courier_org/v1?filter_driver_id=filter_driver_id&filter_attached_to_statement=true&filter_order_id=filter_order_id&filter_payment_role=origin&sort_order=asc&page=1&page_size=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "items": [
    {
      "schema_version": 1,
      "_id": "_id",
      "line_items": [
        {
          "item": "base_rate",
          "quantity": 1.1,
          "rate": 1.1,
          "amount": 1.1
        }
      ],
      "owned_by_org_id": "owned_by_org_id",
      "payment_vector_type": "shipper_pay_forwarder",
      "settlement_type": "stripe_connect",
      "is_ad_hoc": true,
      "task_group_id": "task_group_id",
      "order_id": "order_id",
      "order_short_id": "order_short_id",
      "order_off_chrt_reference_id": "order_off_chrt_reference_id",
      "rate_sheet_id": "rate_sheet_id",
      "line_item_group_s3_object_metadata_ids": [
        "line_item_group_s3_object_metadata_ids"
      ],
      "statement_id": "statement_id",
      "payment_origin_org_id": "payment_origin_org_id",
      "payment_origin_off_chrt_shipper_org_id": "payment_origin_off_chrt_shipper_org_id",
      "payment_destination_org_id": "payment_destination_org_id",
      "payment_destination_driver_id": "payment_destination_driver_id",
      "status": "staged",
      "messages": [
        {
          "message": "message",
          "user_id": "user_id",
          "org_id": "org_id",
          "timestamp": "2024-01-15T09:30:00Z"
        }
      ]
    }
  ],
  "total_count": 1
}

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

Authentication

AuthorizationBearer

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

Query parameters

filter_driver_idstringOptional

Filter by driver ID (payment_destination_driver_id)

filter_statusenumOptional

Filter by line item group status(es)

filter_attached_to_statementbooleanOptional

Filter by whether line item group is attached to a statement

filter_order_idstringOptional

Filter by order ID

filter_payment_roleenumOptional

Filter by payment role: origin (courier pays) or destination (courier receives). Returns both if not specified.

Allowed values:

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Line Item Groups List for Courier Org V1request Unprocessable Entity Error