> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Interchanges



## OpenAPI

````yaml /user-docs/api-reference/revenue_reporting.swagger.json get /revenue/reporting/interchanges
openapi: 3.0.1
info:
  title: protobuf/reporting/v1/revenue_reporting.proto
  version: version not set
servers:
  - description: Production (US)
    url: https://api-lg-k.arms.cedarai.com
security:
  - ApiKeyAuth: []
    AssumeUserAuth: []
    CarrierAuth: []
tags:
  - name: RevenueReportingService
paths:
  /revenue/reporting/interchanges:
    get:
      tags:
        - RevenueReportingService
      summary: Interchanges
      operationId: ListInterchangeRows
      parameters:
        - description: Dates, filters and paging as in ListWaybillExtractRowsRequest.
          in: query
          name: startDate
          schema:
            type: string
        - in: query
          name: endDate
          schema:
            type: string
        - description: Only rows for this car. Set both or neither.
          in: query
          name: equipmentInitial
          schema:
            type: string
        - in: query
          name: equipmentNumber
          schema:
            type: string
        - description: Only rows for this waybill number.
          in: query
          name: waybillNumber
          schema:
            type: string
        - description: Only rows for a waybill dated this day, YYYY-MM-DD.
          in: query
          name: waybillDate
          schema:
            type: string
        - in: query
          name: pageSize
          schema:
            format: int64
            type: integer
        - in: query
          name: pageToken
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ListInterchangeRowsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
          description: An unexpected error response.
components:
  schemas:
    v1ListInterchangeRowsResponse:
      properties:
        nextPageToken:
          type: string
        rows:
          items:
            $ref: '#/components/schemas/v1InterchangeRow'
          type: array
      type: object
    rpcStatus:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        message:
          type: string
      type: object
    v1InterchangeRow:
      properties:
        aarCarType:
          type: string
        billOfLading:
          $ref: '#/components/schemas/v1BillOfLading'
        commodity:
          $ref: '#/components/schemas/v1Commodity'
        consignee:
          $ref: '#/components/schemas/v1Party'
        direction:
          $ref: '#/components/schemas/v1InterchangeDirection'
        equipment:
          $ref: '#/components/schemas/v1Equipment'
        eventAt:
          description: RFC 3339, railroad-local offset.
          type: string
        interchangeCarrier:
          description: The connecting railroad the car came from or went to, when known.
          type: string
        loadStatus:
          $ref: '#/components/schemas/v1LoadStatus'
        location:
          $ref: '#/components/schemas/v1Station'
        reportDate:
          type: string
        waybill:
          $ref: '#/components/schemas/v1Waybill'
      type: object
    protobufAny:
      additionalProperties:
        type: object
      properties:
        '@type':
          type: string
      type: object
    v1BillOfLading:
      properties:
        date:
          type: string
        number:
          type: string
      type: object
    v1Commodity:
      properties:
        name:
          description: The commodity description on the waybill.
          type: string
        stcc:
          description: Standard Transportation Commodity Code.
          type: string
      type: object
    v1Party:
      properties:
        accountNumber:
          description: >-
            The railroad's own account (patron) number for the customer, from
            its ARMS customer location.
          type: string
        address:
          $ref: '#/components/schemas/v1Address'
        cif:
          description: >-
            The Railinc Customer Identification File number with its 4-character
            location suffix (13

            characters, for example 0529862500000), as on the waybill or the
            customer location.
          type: string
        name:
          description: >-
            The party-mapped customer name when the railroad mapped the party,
            else the waybill's name.
          type: string
      type: object
    v1InterchangeDirection:
      enum:
        - RECEIVED
        - DELIVERED
      type: string
    v1Equipment:
      properties:
        initial:
          type: string
        number:
          type: string
      type: object
    v1LoadStatus:
      enum:
        - LOADED
        - EMPTY
      type: string
    v1Station:
      properties:
        carrier:
          description: The railroad serving the station on this move.
          type: string
        fsac:
          description: Freight Station Accounting Code; unset when unknown.
          type: string
        splc:
          description: >-
            Standard Point Location Code; unset when the station is not in the
            station master.
          type: string
        state:
          type: string
        station:
          type: string
      type: object
    v1Waybill:
      properties:
        date:
          description: YYYY-MM-DD; unset when unknown.
          type: string
        number:
          type: string
      type: object
    v1Address:
      properties:
        city:
          type: string
        country:
          type: string
        lines:
          description: Street lines as on the waybill.
          items:
            type: string
          type: array
        postalCode:
          description: >-
            Unset when the source does not carry it (the 417 parties ISS stores
            have no postal code or

            country; ARMS waybills do).
          type: string
        state:
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-arms-api-key
      type: apiKey
    AssumeUserAuth:
      in: header
      name: x-arms-assume-user
      type: apiKey
    CarrierAuth:
      description: >-
        The railroad whose reports to return, by mark (for example WTNN or
        TKEN).
      in: header
      name: Carrier
      type: apiKey

````

## Related topics

- [Interchanges](https://docs.cedarai.com/user-docs/mobile/interchanges.md)
- [Cedar Mobile](https://docs.cedarai.com/user-docs/mobile/overview.md)
- [Inventory](https://docs.cedarai.com/user-docs/mobile/inventory.md)
- [Revenue Reporting API](https://docs.cedarai.com/user-docs/api-reference/revenue-reporting.md)
- [Sandbox](https://docs.cedarai.com/user-docs/arms/ops/sandbox.md)