Skip to main content
POST
/
ims
/
equipment
/
charged-history
List railcar charge history
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/equipment/charged-history \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '{
  "carrierId": 1234,
  "initialAndNumber": "XYZ 123456",
  "showDeletion": false
}'
{
  "items": [
    {
      "resourceId": 123,
      "equipment": {
        "resourceType": "Equipment",
        "resourceId": 123,
        "equipmentInitial": "<string>",
        "equipmentNumber": 123,
        "aarCarType": "<string>",
        "descriptionCode": "<string>",
        "arrivalState": "INBOUND",
        "parentGroupings": [
          {
            "resourceType": "Grouping",
            "resourceId": 123,
            "name": "<string>",
            "groupingType": "<string>",
            "sortOrder": 123
          }
        ],
        "waybill": {
          "loadStatus": "<string>",
          "commodityCode": "<string>",
          "netWeightTons": 123,
          "originCityName": "<string>",
          "originStateOrProvince": "<string>",
          "originFsac": "<string>",
          "destinationCityName": "<string>",
          "destinationStateOrProvince": "<string>",
          "destinationFsac": "<string>",
          "consignorCustomerName": "<string>",
          "consigneeCustomerName": "<string>",
          "originScac": "<string>",
          "trafficType": "LOCAL",
          "shipmentPaymentMethod": "11",
          "transportationMethod": "R",
          "shipmentId": "<string>",
          "weightUnitCode": "E",
          "shipmentQualifier": "1",
          "capacityLoadCode": "C",
          "customsDocumentationHandlingCode": "<string>",
          "confidentialBillingRequestCode": "C",
          "taxReasonCode": "<string>",
          "shipmentWeightCode": "A3",
          "referencedPatternIdentifier": "<string>",
          "billingCode": "A",
          "repetitivePatternNumber": 123,
          "extendedReferenceInfo": [
            {
              "referenceIdQualifier": "<string>",
              "referenceId": "<string>",
              "description": "<string>",
              "date": "<string>",
              "timestamp": "<string>"
            }
          ],
          "crossReferenceEquipment": [
            {
              "referenceIdQualifier": "<string>",
              "referenceId": "<string>",
              "equipmentInitial": "<string>",
              "equipmentNumber": 123,
              "crossReferenceTypeCode": "A",
              "equipmentOwnerScac": "<string>",
              "equipmentLength": "<string>",
              "equipmentOperatorScac": "<string>",
              "equipmentIsDamaged": true,
              "checkDigit": 123
            }
          ],
          "equipmentDetails": [
            {
              "equipmentInitial": "<string>",
              "equipmentNumber": 123,
              "netWeightLbs": 123,
              "grossWeightLbs": 123,
              "weightType": "ESTIMATED",
              "tareWeightLbs": 123,
              "weightAllowance": 123,
              "dunnage": 123,
              "ownershipCode": "L",
              "descriptionCode": "<string>",
              "owningCarrierCode": "<string>",
              "position": "<string>",
              "lengthIn": 123,
              "tareQualifierCode": "A",
              "checkDigit": 123,
              "heightIn": 123,
              "widthIn": 123,
              "isoContainerCode": "<string>",
              "carrierCode": "<string>",
              "aarCarType": "<string>",
              "chassisInitial": "<string>",
              "chassisNumber": 123
            }
          ],
          "intermodalStatusDetails": {
            "shipmentStatusCode": "A",
            "shipmentStatusTime": "<string>"
          },
          "specialHandlingCodes": [
            "<string>"
          ],
          "protectiveService": [
            {
              "ruleCode": "<string>",
              "serviceCode": "D",
              "temperatureUnit": "CE",
              "optimalTemperature": 123,
              "scac": "<string>",
              "fsac": "<string>",
              "cityName": "<string>",
              "stateOrProvince": "<string>",
              "precooled": true,
              "heaterLocation": "Y",
              "commodityType": "Y",
              "doorwaySpace": "Y",
              "originTemperature": 123
            }
          ],
          "originStation": {
            "fsac": "<any>",
            "cityName": "<any>",
            "stateOrProvince": "<any>",
            "postalCode": "<any>",
            "countryCode": "<any>",
            "splc": "<any>"
          },
          "originJunction": {
            "fsac": "<any>",
            "cityName": "<any>",
            "stateOrProvince": "<any>",
            "postalCode": "<any>",
            "countryCode": "<any>",
            "splc": "<any>"
          },
          "destinationStation": {
            "fsac": "<any>",
            "cityName": "<any>",
            "stateOrProvince": "<any>",
            "postalCode": "<any>",
            "countryCode": "<any>",
            "splc": "<any>"
          },
          "destinationJunction": {
            "fsac": "<any>",
            "cityName": "<any>",
            "stateOrProvince": "<any>",
            "postalCode": "<any>",
            "countryCode": "<any>",
            "splc": "<any>"
          },
          "parties": [
            {
              "partyType": "11",
              "name": "<string>",
              "idCodeQualifier": "1",
              "idCode": "<string>",
              "entitySubIdentifierRelationshipCode": "<string>",
              "entitySubIdentifierCode": "<string>",
              "additionalNames": [
                "<any>"
              ],
              "address": [
                "<any>"
              ],
              "cityName": "<string>",
              "stateOrProvince": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "locationQualifier": "<string>",
              "locationIdentifier": "<string>",
              "countrySubdivisionCode": "<string>",
              "administrativeContacts": [
                "<any>"
              ],
              "billingInfo": [
                "<any>"
              ],
              "referenceInfo": [
                "<any>"
              ]
            }
          ],
          "route": [
            {
              "carrierCode": "<string>",
              "junctionCode": "<string>",
              "routingSequenceCode": "1",
              "splc": "<string>",
              "intermodalServiceCode": "<string>",
              "additionalSwitchCarrierCodes": [
                "<any>"
              ]
            }
          ],
          "emptyCarDispositions": [
            {
              "destinationConsigneeName": "<string>",
              "destinationConsigneeIdQualifier": "<string>",
              "destinationConsigneeId": "<string>",
              "destinationCityName": "<string>",
              "destinationStateOrProvince": "<string>",
              "destinationPostalCode": "<string>",
              "destinationCountryCode": "<string>",
              "destinationAddress": "<string>",
              "destinationRoute": [
                {}
              ]
            }
          ],
          "lineItems": [
            {
              "number": 123,
              "descriptions": [
                {}
              ],
              "quantity": {
                "billedAsQuantity": 123,
                "billedAsQualifier": "DM",
                "weight": 123,
                "weightQualifier": "A3",
                "volume": 123,
                "volumeUnitQualifier": "B",
                "ladingQuantity": 123,
                "packagingFormCode": "<string>",
                "dunnageDescription": "<string>",
                "weightUnitCode": "<string>",
                "typeOfServiceCode": "<string>"
              },
              "measurements": [
                {}
              ],
              "priceAuthorities": [
                {}
              ]
            }
          ],
          "hazardousInfo": [
            {
              "ladingUnitCode": "1E",
              "ladingQuantity": 123,
              "unIdCode": "<string>",
              "unPageNumber": "<string>",
              "commodityCode": "<string>",
              "unitCode": "1E",
              "quantity": 123,
              "compartmentIdCode": "<string>",
              "residueIndicatorCode": "<string>",
              "packagingGroupCode": "<string>",
              "interimHazmatRegulatoryNumber": "<string>",
              "industryCode": "<string>",
              "classificationInfo": [
                {}
              ],
              "hazmatShippingNameInfo": [
                {}
              ],
              "hazmatAdditionalInfo": [
                {}
              ],
              "epaRequiredData": [
                {}
              ],
              "canadianDangerousRequirements": [
                {}
              ],
              "transborderHazardousRequirements": [
                {}
              ],
              "hazmatReferenceNumbers": [
                {}
              ],
              "administrativeContacts": [
                {}
              ],
              "parties": [
                {}
              ]
            }
          ],
          "hazardousCertifications": [
            {
              "name": "<string>"
            }
          ],
          "release": {
            "releaseCode": "B",
            "releaseDate": "<string>",
            "releaseTime": "<string>"
          },
          "defaultReceiver": "<string>",
          "waybillTemplateId": 123,
          "waybillTemplateName": "<string>",
          "originCarrierCode": "<string>",
          "consigneeLocationId": 123,
          "shipperLocationId": 123,
          "inCareOfLocationId": 123,
          "freightBillPartyLocationId": 123,
          "waybillNumber": 123,
          "waybillDate": "<string>",
          "billOfLadingNumber": "<string>",
          "originSystem": "ARMS",
          "preparationDate": "<string>",
          "preparationTime": "<string>",
          "revisionNumber": 123,
          "revisionTime": "<string>",
          "revisionSourceType": "WAYBILL",
          "armsTrackingId": "<string>",
          "resourceType": "Waybill",
          "resourceId": 123,
          "waybillStatus": "PENDING",
          "createdAt": "<string>"
        },
        "umler": {},
        "notes": "<string>",
        "intermodalUnits": [
          {
            "resourceType": "IntermodalUnit",
            "resourceId": 123
          }
        ],
        "loadStatus": "LOAD",
        "ichrTime": "2023-11-07T05:31:56Z"
      },
      "moveType": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "waybill": {
        "loadStatus": "<string>",
        "commodityCode": "<string>",
        "netWeightTons": 123,
        "originCityName": "<string>",
        "originStateOrProvince": "<string>",
        "originFsac": "<string>",
        "destinationCityName": "<string>",
        "destinationStateOrProvince": "<string>",
        "destinationFsac": "<string>",
        "consignorCustomerName": "<string>",
        "consigneeCustomerName": "<string>",
        "originScac": "<string>",
        "trafficType": "LOCAL",
        "shipmentPaymentMethod": "11",
        "transportationMethod": "R",
        "shipmentId": "<string>",
        "weightUnitCode": "E",
        "shipmentQualifier": "1",
        "capacityLoadCode": "C",
        "customsDocumentationHandlingCode": "<string>",
        "confidentialBillingRequestCode": "C",
        "taxReasonCode": "<string>",
        "shipmentWeightCode": "A3",
        "referencedPatternIdentifier": "<string>",
        "billingCode": "A",
        "repetitivePatternNumber": 123,
        "extendedReferenceInfo": [
          {
            "referenceIdQualifier": "<string>",
            "referenceId": "<string>",
            "description": "<string>",
            "date": "<string>",
            "timestamp": "<string>"
          }
        ],
        "crossReferenceEquipment": [
          {
            "referenceIdQualifier": "<string>",
            "referenceId": "<string>",
            "equipmentInitial": "<string>",
            "equipmentNumber": 123,
            "crossReferenceTypeCode": "A",
            "equipmentOwnerScac": "<string>",
            "equipmentLength": "<string>",
            "equipmentOperatorScac": "<string>",
            "equipmentIsDamaged": true,
            "checkDigit": 123
          }
        ],
        "equipmentDetails": [
          {
            "equipmentInitial": "<string>",
            "equipmentNumber": 123,
            "netWeightLbs": 123,
            "grossWeightLbs": 123,
            "weightType": "ESTIMATED",
            "tareWeightLbs": 123,
            "weightAllowance": 123,
            "dunnage": 123,
            "ownershipCode": "L",
            "descriptionCode": "<string>",
            "owningCarrierCode": "<string>",
            "position": "<string>",
            "lengthIn": 123,
            "tareQualifierCode": "A",
            "checkDigit": 123,
            "heightIn": 123,
            "widthIn": 123,
            "isoContainerCode": "<string>",
            "carrierCode": "<string>",
            "aarCarType": "<string>",
            "chassisInitial": "<string>",
            "chassisNumber": 123
          }
        ],
        "intermodalStatusDetails": {
          "shipmentStatusCode": "A",
          "shipmentStatusTime": "<string>"
        },
        "specialHandlingCodes": [
          "<string>"
        ],
        "protectiveService": [
          {
            "ruleCode": "<string>",
            "serviceCode": "D",
            "temperatureUnit": "CE",
            "optimalTemperature": 123,
            "scac": "<string>",
            "fsac": "<string>",
            "cityName": "<string>",
            "stateOrProvince": "<string>",
            "precooled": true,
            "heaterLocation": "Y",
            "commodityType": "Y",
            "doorwaySpace": "Y",
            "originTemperature": 123
          }
        ],
        "originStation": {
          "fsac": "<any>",
          "cityName": "<any>",
          "stateOrProvince": "<any>",
          "postalCode": "<any>",
          "countryCode": "<any>",
          "splc": "<any>"
        },
        "originJunction": {
          "fsac": "<any>",
          "cityName": "<any>",
          "stateOrProvince": "<any>",
          "postalCode": "<any>",
          "countryCode": "<any>",
          "splc": "<any>"
        },
        "destinationStation": {
          "fsac": "<any>",
          "cityName": "<any>",
          "stateOrProvince": "<any>",
          "postalCode": "<any>",
          "countryCode": "<any>",
          "splc": "<any>"
        },
        "destinationJunction": {
          "fsac": "<any>",
          "cityName": "<any>",
          "stateOrProvince": "<any>",
          "postalCode": "<any>",
          "countryCode": "<any>",
          "splc": "<any>"
        },
        "parties": [
          {
            "partyType": "11",
            "name": "<string>",
            "idCodeQualifier": "1",
            "idCode": "<string>",
            "entitySubIdentifierRelationshipCode": "<string>",
            "entitySubIdentifierCode": "<string>",
            "additionalNames": [
              "<any>"
            ],
            "address": [
              "<any>"
            ],
            "cityName": "<string>",
            "stateOrProvince": "<string>",
            "postalCode": "<string>",
            "countryCode": "<string>",
            "locationQualifier": "<string>",
            "locationIdentifier": "<string>",
            "countrySubdivisionCode": "<string>",
            "administrativeContacts": [
              "<any>"
            ],
            "billingInfo": [
              "<any>"
            ],
            "referenceInfo": [
              "<any>"
            ]
          }
        ],
        "route": [
          {
            "carrierCode": "<string>",
            "junctionCode": "<string>",
            "routingSequenceCode": "1",
            "splc": "<string>",
            "intermodalServiceCode": "<string>",
            "additionalSwitchCarrierCodes": [
              "<any>"
            ]
          }
        ],
        "emptyCarDispositions": [
          {
            "destinationConsigneeName": "<string>",
            "destinationConsigneeIdQualifier": "<string>",
            "destinationConsigneeId": "<string>",
            "destinationCityName": "<string>",
            "destinationStateOrProvince": "<string>",
            "destinationPostalCode": "<string>",
            "destinationCountryCode": "<string>",
            "destinationAddress": "<string>",
            "destinationRoute": [
              {}
            ]
          }
        ],
        "lineItems": [
          {
            "number": 123,
            "descriptions": [
              {}
            ],
            "quantity": {
              "billedAsQuantity": 123,
              "billedAsQualifier": "DM",
              "weight": 123,
              "weightQualifier": "A3",
              "volume": 123,
              "volumeUnitQualifier": "B",
              "ladingQuantity": 123,
              "packagingFormCode": "<string>",
              "dunnageDescription": "<string>",
              "weightUnitCode": "<string>",
              "typeOfServiceCode": "<string>"
            },
            "measurements": [
              {}
            ],
            "priceAuthorities": [
              {}
            ]
          }
        ],
        "hazardousInfo": [
          {
            "ladingUnitCode": "1E",
            "ladingQuantity": 123,
            "unIdCode": "<string>",
            "unPageNumber": "<string>",
            "commodityCode": "<string>",
            "unitCode": "1E",
            "quantity": 123,
            "compartmentIdCode": "<string>",
            "residueIndicatorCode": "<string>",
            "packagingGroupCode": "<string>",
            "interimHazmatRegulatoryNumber": "<string>",
            "industryCode": "<string>",
            "classificationInfo": [
              {}
            ],
            "hazmatShippingNameInfo": [
              {}
            ],
            "hazmatAdditionalInfo": [
              {}
            ],
            "epaRequiredData": [
              {}
            ],
            "canadianDangerousRequirements": [
              {}
            ],
            "transborderHazardousRequirements": [
              {}
            ],
            "hazmatReferenceNumbers": [
              {}
            ],
            "administrativeContacts": [
              {}
            ],
            "parties": [
              {}
            ]
          }
        ],
        "hazardousCertifications": [
          {
            "name": "<string>"
          }
        ],
        "release": {
          "releaseCode": "B",
          "releaseDate": "<string>",
          "releaseTime": "<string>"
        },
        "defaultReceiver": "<string>",
        "waybillTemplateId": 123,
        "waybillTemplateName": "<string>",
        "originCarrierCode": "<string>",
        "consigneeLocationId": 123,
        "shipperLocationId": 123,
        "inCareOfLocationId": 123,
        "freightBillPartyLocationId": 123,
        "waybillNumber": 123,
        "waybillDate": "<string>",
        "billOfLadingNumber": "<string>",
        "originSystem": "ARMS",
        "preparationDate": "<string>",
        "preparationTime": "<string>",
        "revisionNumber": 123,
        "revisionTime": "<string>",
        "revisionSourceType": "WAYBILL",
        "armsTrackingId": "<string>",
        "resourceType": "Waybill",
        "resourceId": 123,
        "waybillStatus": "PENDING",
        "createdAt": "<string>"
      },
      "previousTrack": {
        "resourceType": "Grouping",
        "resourceId": 123,
        "name": "<string>",
        "groupingType": "<string>",
        "sortOrder": 123
      },
      "previousStation": {
        "resourceType": "Grouping",
        "resourceId": 123,
        "name": "<string>",
        "groupingType": "<string>",
        "sortOrder": 123
      },
      "currentTrack": {
        "resourceType": "Grouping",
        "resourceId": 123,
        "name": "<string>",
        "groupingType": "<string>",
        "sortOrder": 123
      },
      "currentStation": {
        "resourceType": "Grouping",
        "resourceId": 123,
        "name": "<string>",
        "groupingType": "<string>",
        "sortOrder": 123
      },
      "reportingFlag": "ACCEPTED",
      "jobName": "<string>",
      "receiveFromCarrierCode": "<string>",
      "deliverToCarrierCode": "<string>",
      "umlerSnapshot": {},
      "carrierId": 123,
      "numCharges": 123,
      "revisionNumber": 123,
      "revisionTime": "<string>",
      "deletedAt": "<string>",
      "mutedAt": "<string>"
    }
  ]
}

Authorizations

​
x-arms-api-key
string
header
required

Your ARMS API key

​
x-arms-assume-user
string
header
required

Email of a user assigned to the appropriate user group

Query Parameters

​
carrierId
integer
required

Carrier identifier; required for all endpoints

​
viewAsUserGroup
string

Optional user group context

Body

application/json
​
carrierId
integer
required

Carrier identifier for which to list charge history.

​
showDeletion
boolean
required

Include deleted records when true (useful for audits).

​
initialAndNumber
string

Filter by equipment initial and number (e.g., 'XYZ 123456').

​
equipmentIds
integer[]

Filter by specific equipment resourceIds.

​
timestampBefore
string<date-time>

Only include records entered before this timestamp (ISO 8601).

​
timestampAfter
string<date-time>

Only include records entered after this timestamp (ISO 8601).

Response

OK

​
items
object[]
⌘I