Interface Waybill

interface Waybill {
    armsTrackingId?: string;
    billOfLadingNumber?: string;
    billingCode?: BillingCode;
    capacityLoadCode?: CapacityLoadCode;
    commodityCode?: string;
    confidentialBillingRequestCode?: ConfidentialBillingRequestCode;
    consigneeCustomerName?: string;
    consigneeLocationId?: number;
    consignorCustomerName?: string;
    createdAt?: string;
    crossReferenceEquipment: CrossReferenceEquipment[];
    customsDocumentationHandlingCode?: string;
    defaultReceiver?: string;
    destinationCityName?: string;
    destinationFsac?: string;
    destinationJunction?: Station;
    destinationStateOrProvince?: string;
    destinationStation?: Station;
    emptyCarDispositions: EmptyCarDisposition[];
    equipmentDetails: EquipmentDetails[];
    extendedReferenceInfo: ExtendedReferenceInformation[];
    freightBillPartyLocationId?: number;
    hazardousCertifications: HazardousCertification[];
    hazardousInfo: HazardousInformation[];
    inCareOfLocationId?: number;
    intermodalStatusDetails?: IntermodalStatusDetails;
    lineItems: LineItem[];
    loadStatus?: string;
    netWeightTons?: number;
    originCarrierCode?: string;
    originCityName?: string;
    originFsac?: string;
    originJunction?: Station;
    originScac?: string;
    originStateOrProvince?: string;
    originStation?: Station;
    originSystem?: WaybillOriginSystem;
    parties: Party[];
    preparationDate?: string;
    preparationTime?: string;
    protectiveService: ProtectiveService[];
    referencedPatternIdentifier?: string;
    release?: Release;
    repetitivePatternNumber?: number;
    resourceId: number;
    resourceType: "Waybill";
    revisionNumber?: number;
    revisionSourceType?: WaybillRevisionSourceType;
    revisionTime?: string;
    route: RouteEntry[];
    shipmentId?: string;
    shipmentPaymentMethod?: ShipmentPaymentMethod;
    shipmentQualifier?: ShipmentQualifier;
    shipmentWeightCode?: ShipmentWeightCode;
    shipperLocationId?: number;
    specialHandlingCodes: string[];
    taxReasonCode?: string;
    trafficType?: TrafficType;
    transportationMethod?: TransportationMethod;
    waybillDate?: string;
    waybillNumber?: number;
    waybillStatus?: WaybillStatus;
    waybillTemplateId?: number;
    waybillTemplateName?: string;
    weightUnitCode?: WeightUnitCode;
}

Properties

armsTrackingId? billOfLadingNumber? billingCode? capacityLoadCode? commodityCode? confidentialBillingRequestCode? consigneeCustomerName? consigneeLocationId? consignorCustomerName? createdAt? crossReferenceEquipment customsDocumentationHandlingCode? defaultReceiver? destinationCityName? destinationFsac? destinationJunction? destinationStateOrProvince? destinationStation? emptyCarDispositions equipmentDetails extendedReferenceInfo freightBillPartyLocationId? hazardousCertifications hazardousInfo inCareOfLocationId? intermodalStatusDetails? lineItems loadStatus? netWeightTons? originCarrierCode? originCityName? originFsac? originJunction? originScac? originStateOrProvince? originStation? originSystem? parties preparationDate? preparationTime? protectiveService referencedPatternIdentifier? release? repetitivePatternNumber? resourceId resourceType revisionNumber? revisionSourceType? revisionTime? route shipmentId? shipmentPaymentMethod? shipmentQualifier? shipmentWeightCode? shipperLocationId? specialHandlingCodes taxReasonCode? trafficType? transportationMethod? waybillDate? waybillNumber? waybillStatus? waybillTemplateId? waybillTemplateName? weightUnitCode?

Properties

OptionalarmsTrackingId

armsTrackingId?: string

OptionalbillOfLadingNumber

billOfLadingNumber?: string

OptionalbillingCode

billingCode?: BillingCode

OptionalcapacityLoadCode

capacityLoadCode?: CapacityLoadCode

OptionalcommodityCode

commodityCode?: string

OptionalconfidentialBillingRequestCode

confidentialBillingRequestCode?: ConfidentialBillingRequestCode

OptionalconsigneeCustomerName

consigneeCustomerName?: string

OptionalconsigneeLocationId

consigneeLocationId?: number

OptionalconsignorCustomerName

consignorCustomerName?: string

OptionalcreatedAt

createdAt?: string

crossReferenceEquipment

crossReferenceEquipment: CrossReferenceEquipment[]

OptionalcustomsDocumentationHandlingCode

customsDocumentationHandlingCode?: string

OptionaldefaultReceiver

defaultReceiver?: string

OptionaldestinationCityName

destinationCityName?: string

OptionaldestinationFsac

destinationFsac?: string

OptionaldestinationJunction

destinationJunction?: Station

OptionaldestinationStateOrProvince

destinationStateOrProvince?: string

OptionaldestinationStation

destinationStation?: Station

emptyCarDispositions

emptyCarDispositions: EmptyCarDisposition[]

equipmentDetails

equipmentDetails: EquipmentDetails[]

extendedReferenceInfo

extendedReferenceInfo: ExtendedReferenceInformation[]

OptionalfreightBillPartyLocationId

freightBillPartyLocationId?: number

hazardousCertifications

hazardousCertifications: HazardousCertification[]

hazardousInfo

hazardousInfo: HazardousInformation[]

OptionalinCareOfLocationId

inCareOfLocationId?: number

OptionalintermodalStatusDetails

intermodalStatusDetails?: IntermodalStatusDetails

lineItems

lineItems: LineItem[]

OptionalloadStatus

loadStatus?: string

OptionalnetWeightTons

netWeightTons?: number

OptionaloriginCarrierCode

originCarrierCode?: string

OptionaloriginCityName

originCityName?: string

OptionaloriginFsac

originFsac?: string

OptionaloriginJunction

originJunction?: Station

OptionaloriginScac

originScac?: string

OptionaloriginStateOrProvince

originStateOrProvince?: string

OptionaloriginStation

originStation?: Station

OptionaloriginSystem

originSystem?: WaybillOriginSystem

parties

parties: Party[]

OptionalpreparationDate

preparationDate?: string

OptionalpreparationTime

preparationTime?: string

protectiveService

protectiveService: ProtectiveService[]

OptionalreferencedPatternIdentifier

referencedPatternIdentifier?: string

Optionalrelease

release?: Release

OptionalrepetitivePatternNumber

repetitivePatternNumber?: number

resourceId

resourceId: number

To prevent from having to re-query to get the correct foreign key for known records, we can store this here when passing event information around.

resourceType

resourceType: "Waybill"

OptionalrevisionNumber

revisionNumber?: number

OptionalrevisionSourceType

revisionSourceType?: WaybillRevisionSourceType

OptionalrevisionTime

revisionTime?: string

route

route: RouteEntry[]

OptionalshipmentId

shipmentId?: string

OptionalshipmentPaymentMethod

shipmentPaymentMethod?: ShipmentPaymentMethod

OptionalshipmentQualifier

shipmentQualifier?: ShipmentQualifier

OptionalshipmentWeightCode

shipmentWeightCode?: ShipmentWeightCode

OptionalshipperLocationId

shipperLocationId?: number

specialHandlingCodes

specialHandlingCodes: string[]

OptionaltaxReasonCode

taxReasonCode?: string

OptionaltrafficType

trafficType?: TrafficType

OptionaltransportationMethod

transportationMethod?: TransportationMethod

OptionalwaybillDate

waybillDate?: string

OptionalwaybillNumber

waybillNumber?: number

OptionalwaybillStatus

waybillStatus?: WaybillStatus

OptionalwaybillTemplateId

waybillTemplateId?: number

OptionalwaybillTemplateName

waybillTemplateName?: string

OptionalweightUnitCode

weightUnitCode?: WeightUnitCode

Settings

Member Visibility

On This Page

Properties
armsTrackingIdbillOfLadingNumberbillingCodecapacityLoadCodecommodityCodeconfidentialBillingRequestCodeconsigneeCustomerNameconsigneeLocationIdconsignorCustomerNamecreatedAtcrossReferenceEquipmentcustomsDocumentationHandlingCodedefaultReceiverdestinationCityNamedestinationFsacdestinationJunctiondestinationStateOrProvincedestinationStationemptyCarDispositionsequipmentDetailsextendedReferenceInfofreightBillPartyLocationIdhazardousCertificationshazardousInfoinCareOfLocationIdintermodalStatusDetailslineItemsloadStatusnetWeightTonsoriginCarrierCodeoriginCityNameoriginFsacoriginJunctionoriginScacoriginStateOrProvinceoriginStationoriginSystempartiespreparationDatepreparationTimeprotectiveServicereferencedPatternIdentifierreleaserepetitivePatternNumberresourceIdresourceTyperevisionNumberrevisionSourceTyperevisionTimerouteshipmentIdshipmentPaymentMethodshipmentQualifiershipmentWeightCodeshipperLocationIdspecialHandlingCodestaxReasonCodetrafficTypetransportationMethodwaybillDatewaybillNumberwaybillStatuswaybillTemplateIdwaybillTemplateNameweightUnitCode