> ## 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.

# Freight Billing



## OpenAPI

````yaml /user-docs/api-reference/revenue_reporting.swagger.json get /revenue/reporting/freight-billing
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/freight-billing:
    get:
      tags:
        - RevenueReportingService
      summary: Freight Billing
      operationId: ListFreightBillingRows
      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/v1ListFreightBillingRowsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
          description: An unexpected error response.
components:
  schemas:
    v1ListFreightBillingRowsResponse:
      properties:
        nextPageToken:
          type: string
        rows:
          items:
            $ref: '#/components/schemas/v1FreightBillingRow'
          type: array
      type: object
    rpcStatus:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        message:
          type: string
      type: object
    v1FreightBillingRow:
      properties:
        billTo:
          $ref: '#/components/schemas/v1Party'
        document:
          $ref: '#/components/schemas/v1BillingDocument'
        leadCar:
          $ref: '#/components/schemas/v1Equipment'
        leadWaybill:
          $ref: '#/components/schemas/v1Waybill'
        methodOfPayment:
          $ref: '#/components/schemas/v1MethodOfPayment'
        reportDate:
          type: string
        totalCharges:
          $ref: '#/components/schemas/v1Money'
      type: object
    protobufAny:
      additionalProperties:
        type: object
      properties:
        '@type':
          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
    v1BillingDocument:
      properties:
        billingDate:
          type: string
        number:
          description: The freight bill number the document belongs to.
          type: string
        revision:
          description: >-
            1 for the first bill, then 2, 3, ... for each later credit memo,
            rebill or void of the same

            freight bill number, as the nightly file numbers them.
          format: int32
          type: integer
        transactionId:
          description: The ledger transaction the document is reported on.
          type: string
        type:
          $ref: '#/components/schemas/v1DocumentType'
      type: object
    v1Equipment:
      properties:
        initial:
          type: string
        number:
          type: string
      type: object
    v1Waybill:
      properties:
        date:
          description: YYYY-MM-DD; unset when unknown.
          type: string
        number:
          type: string
      type: object
    v1MethodOfPayment:
      enum:
        - PREPAID
        - COLLECT
        - RULE_11
      type: string
    v1Money:
      properties:
        amount:
          description: >-
            A decimal string in the currency's major unit, with its minor-unit
            digits: "1225.00",

            "-12.50". A string, not a number, so no client rounds it through a
            float.
          type: string
        currency:
          description: ISO 4217 code, e.g. USD.
          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
    v1DocumentType:
      enum:
        - INVOICE
        - INVOICE_VOID
        - CREDIT_MEMO
        - CREDIT_MEMO_VOID
      type: string
  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

- [Revenue Reporting API](https://docs.cedarai.com/user-docs/api-reference/revenue-reporting.md)
- [API Introduction](https://docs.cedarai.com/user-docs/api-reference/introduction.md)
- [Switch Billing](https://docs.cedarai.com/user-docs/arms/switch-billing.md)
- [Haulage Management](https://docs.cedarai.com/user-docs/arms/haulage.md)
- [Introduction](https://docs.cedarai.com/user-docs/index.md)