CedarAI Data Depot

Retrieves a list of railcar inventory items based on specified criteria (pagination, filters like loadStatus, station, track, etc.). Usage notes: - Pagination: Use pageSize, pageNextToken, and pagePrevToken to navigate paginated results. - Filtering: Combine multiple criteria (e.g., loadStatus, aarCarType, station, track, tag) to narrow results. - IDs: Station, track, and tag identifiers should come from the listStationTracks endpoint. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

railcar_list_inventory

Retrieves a list of station tracks and their associated groupings for a specific carrier. This tool only returns existing ARMS records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

railcar_list_station_tracks

Retrieves charged history records, filterable by equipment, time range, and flags. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

railcar_list_charged_history

Retrieves equipment history records, filterable by equipment, time range, and flags. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

railcar_list_equipment_history

Retrieves the list of tasks associated with specified class lists. Usage notes: - Pagination: Use pageSize, pageNextToken, and pagePrevToken to navigate paginated results. - Filtering: Combine multiple criteria (e.g., workOrderId, status, equipmentName) to narrow results. - Date ranges: carrierDateRange is assumed to be in the carrier's timezone. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

railcar_list_class_list_tasks

Returns Truck Load Tenders. This tool only returns existing ARMS records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

truck_load_tender_list_truck_load_tender

Returns a list of tasks for a given work order. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

work_order_list_work_order_tasks

Returns a one-row summary for a single entity: total note count and the latest note. Use this to populate badges/counters without fetching the full thread. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

notes_get_note_summary

Returns a page of charges export rows using the requested columns, filters, sorting, and pagination. Downstream finance systems such as NetSuite, Sage, or ERP middleware typically call `Get Charges Table Definition` first, choose a subset of fields, and then request rows for export, reconciliation, or incremental sync jobs. Key request fields: | Input | How downstream systems commonly use it | | --- | --- | | `table_data_request.requested_columns` | Select the Cedar fields to include in each exported row. | | `table_data_request.additional_filters` | Limit the export to a specific invoice, accounting period, billing type, service type, GL code, customer, or other supported charge dimension. | | `table_data_request.sort_columns` | Create a stable export order for repeatable batching and reconciliation. | | `page_size`, `page_next_token`, `page_previous_token` | Page through large exports without re-reading the full result set. | Each row is returned as a column-keyed structure rather than a fixed finance schema, so consumers can request only the columns they actively map into their downstream system. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

charges_list_charges_table_rows

Returns a simplified list of groupings for a carrier, filtering out consist-related grouping types for third-party consumers. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

railcar_list_groupings_third_party

Returns a single Truck Load Tender. This tool only returns existing ARMS records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

truck_load_tender_get_truck_load_tender

Returns a single invoice This tool only returns existing ARMS records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

shipper_invoices_get_invoice

Returns aggregate summary values for the charges table using the requested filters and aggregations, without returning full row detail. Downstream finance systems can use this endpoint to validate export scope, reconcile totals, and compare Cedar results against imported batches in NetSuite, Sage, or another ERP. Common reconciliation patterns: | Aggregate request | Typical downstream use | | --- | --- | | `COUNT` on `chargeId` | Confirm the number of charges in an export batch. | | `SUM` on `amount` | Compare Cedar totals with external invoice or journal totals. | | `SUM` on `adjustment_total` | Measure the net effect of adjustments before posting. | | `MIN` / `MAX` on `appliedAt` | Verify the date window covered by an incremental export. | Use the same filter set you would pass to `List Charges Table Rows` when you want summary numbers for the exact same population of charges. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

charges_list_charges_table_summary

Returns expected stops from bookings, including reservations without assigned equipment. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

bookings_list_booking_expected_stops

Returns list of Work Orders ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

work_order_list_work_orders

Returns list of invoices This tool only returns existing ARMS records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

shipper_invoices_list_invoices

Returns note summaries for many entities in one round trip. Designed for list/grid pages that show a notes-count column. Entities with zero notes are omitted from the response. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

notes_batch_get_note_summaries

Returns notes on a given entity in descending chronological order (newest first). Supports cursor-based pagination via `page_size` and `page_token`. When both `referenced_entity_type` and `referenced_entity_id` are set, the request switches to reverse-lookup mode (notes mentioning the given entity), capped at 100 results without pagination. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

notes_list_notes

Returns the available charges export columns and default columns. Downstream finance systems such as NetSuite, Sage, or ERP middleware can use this metadata to map Cedar fields before requesting charge rows. This response is metadata only: it tells consumers which columns are available, how Cedar labels them, which columns are searchable, and which columns Cedar returns by default. Common export-oriented columns: | Column | Meaning for downstream systems | | --- | --- | | `chargeId` | Stable Cedar charge identifier for reconciliation, upserts, or idempotent imports. | | `customerLocationAccountNumber` | Customer location account number often used to map a charge into an external account or business unit. | | `invoice` | Invoice number or sequence used to group already-invoiced charges. | | `accountingPeriod` | Cedar accounting period label that can be used for period-close exports or batching. | | `billingType` | High-level charge category such as storage, demurrage, switching, or ISS shipment. | | `serviceType` | Service-specific classification that can help downstream mapping rules route charges to the right workflow. | | `glCode` | General ledger code used for financial posting and account mapping. | | `rateTableEntry` / `rateDescription` | Human-readable pricing fields that explain why the amount was calculated. | | `adjustment_total` | Net difference between the original amount and the final adjusted amount. | The response example below shows a representative subset of these columns. This tool only returns existing ARMS records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

charges_list_charges_table_def

Returns the carrier's train reason codes grouped by category. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

work_order_list_train_reason_codes

Searches across all configured entity types in parallel and returns the top N matches per type. Used by the note editor's `@`-mention typeahead to look up equipment, shipments, customers, waybills, work orders, invoices, etc. by identifier or display text. ARMS uses POST so list/filter parameters can be sent in the JSON body; this tool only returns existing records. Pass carrier_code (railroad road mark, for example TRLD) and/or carrier_id (the carrier's ARMS integer id as a string) when the user named a carrier. Does not create, update, move, or delete records.

notes_search_references