> ## 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. # Waybill Extract ## OpenAPI ````yaml /user-docs/api-reference/revenue_reporting.swagger.json get /revenue/reporting/waybill-extract 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/waybill-extract: get: tags: - RevenueReportingService summary: Waybill Extract operationId: ListWaybillExtractRows parameters: - description: >- Required. First reporting day, YYYY-MM-DD, railroad-local, inclusive. in: query name: startDate schema: type: string - description: >- Required. Last reporting day, YYYY-MM-DD, railroad-local, inclusive. Any range is allowed: each page covers at most 31 reporting days, so follow nextPageToken until it is absent. A page can hold fewer than pageSize rows, even none, and still have a nextPageToken. in: query name: endDate schema: type: string - description: >- Only rows for this car. Set both or neither. Leading zeros and letter case are ignored. in: query name: equipmentInitial schema: type: string - in: query name: equipmentNumber schema: type: string - description: Only rows for this waybill number. Leading zeros are ignored. 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 - description: >- Rows per page. Defaults to 500; values above 1000 are treated as 1000. in: query name: pageSize schema: format: int64 type: integer - description: >- nextPageToken from the previous response, sent with the same dates and filters. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1ListWaybillExtractRowsResponse' description: A successful response. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. components: schemas: v1ListWaybillExtractRowsResponse: properties: nextPageToken: description: Present when more rows remain; pass it back as pageToken. type: string rows: description: >- In the file's order: by transaction (or delete/undelete) time, then transaction id. items: $ref: '#/components/schemas/v1WaybillExtractRow' type: array type: object rpcStatus: properties: code: format: int32 type: integer details: items: $ref: '#/components/schemas/protobufAny' type: array message: type: string type: object v1WaybillExtractRow: properties: commodity: $ref: '#/components/schemas/v1Commodity' consignee: $ref: '#/components/schemas/v1Party' destination: $ref: '#/components/schemas/v1Station' equipment: $ref: '#/components/schemas/v1Equipment' freight: $ref: '#/components/schemas/v1Money' freightBillParty: $ref: '#/components/schemas/v1Party' methodOfPayment: $ref: '#/components/schemas/v1MethodOfPayment' netWeightLbs: format: int64 type: string numberOfCars: description: >- As rated; negative on a reversal, 0 on an adjustment (which moves only money). format: int64 type: string origin: $ref: '#/components/schemas/v1Station' ourProportion: $ref: '#/components/schemas/v1Money' prepaid: $ref: '#/components/schemas/v1Money' priceAuthority: description: The freight price authority number, without its suffix. type: string reportDate: description: >- The reporting day the row belongs to: the railroad-local day of the transaction, or of its delete or undelete. type: string revenueDate: type: string rule11Origin: type: boolean settlementStatus: $ref: '#/components/schemas/v1SettlementStatus' shipper: $ref: '#/components/schemas/v1Party' transaction: $ref: '#/components/schemas/v1Transaction' urrwin: $ref: '#/components/schemas/v1Urrwin' waybill: $ref: '#/components/schemas/v1Waybill' type: object protobufAny: additionalProperties: type: object properties: '@type': 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 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 v1Equipment: properties: initial: type: string number: type: string type: object 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 v1MethodOfPayment: enum: - PREPAID - COLLECT - RULE_11 type: string v1SettlementStatus: description: The Railinc Interline Settlement System status of a URRWIN. enum: - SETTLEMENT_FULLY_CONCURRED - SETTLED_SILENT_ROAD_ON_SILENT_CONCURRENCE - SETTLED_ACTIVE_ROAD_ON_SILENT_CONCURRENCE - SETTLED_FORCE_SETTLED_ON_DISPUTE - SETTLED_COMPOSITE_VERSION_DUE_TO_FORCED_SETTLEMENT - SETTLED_NULL_VALUE - CANCELLED_AND_FULLY_CONCURRED - CANCELLED_DISPUTED_STATUS - ACTIVE_ROAD_ON_SILENT_CONCURRENCE_DIVISIONS_GENERATED - SILENT_ROAD_ON_SILENT_CONCURRENCE_DIVISIONS_GENERATED type: string v1Transaction: properties: at: description: >- When the transaction was made, or deleted or undeleted (RFC 3339, railroad-local offset). type: string id: description: >- Stable id of the ledger transaction. A delete or undelete row carries the id of the transaction it deletes or restores. type: string originalAt: description: 'On a delete or undelete row: when the original transaction was made.' type: string type: $ref: '#/components/schemas/v1TransactionType' type: object v1Urrwin: properties: number: description: Blank on a local move. type: string reratedWithoutResubmission: description: >- True when the waybill was re-rated after its URRWIN settled and the railroad has not resubmitted it to ISS. The nightly file writes this as URRWIN Version 999. type: boolean version: description: The settled ISS version; 0 when not settled. format: int32 type: integer 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 v1TransactionType: description: |2- - TRANSACTION_DELETED: A transaction sent in an earlier row was deleted. - TRANSACTION_UNDELETED: A deleted transaction was restored. enum: - RATING_APPLIED - RATING_REVERSED - ESTIMATE_APPLIED - ESTIMATE_REVERSED - ADJUSTMENT - OVERCHARGE - WRITE_OFF - MANUAL_ADJUSTMENT - TRANSACTION_DELETED - TRANSACTION_UNDELETED 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) - [Interchanges](https://docs.cedarai.com/api-reference/revenuereportingservice/interchanges.md) - [Freight Billing](https://docs.cedarai.com/api-reference/revenuereportingservice/freight-billing.md) - [Daily Settlements](https://docs.cedarai.com/api-reference/revenuereportingservice/daily-settlements.md) - [Funds Transfers](https://docs.cedarai.com/api-reference/revenuereportingservice/funds-transfers.md)