Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.CancelCode

Http Call

/bsc/greenmile/cancelcode

Output Columns

Int32 id
String key
String description
Boolean enabled
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.DriverProfileCost

Http Call

/bsc/greenmile/driverprofilecost

Output Columns

Int32 id
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
String description	The name that will be displayed in the system for the Cost Profile.
Decimal fixedRouteCost	The amount of money the route will calculate for the driver.
Decimal costPerHour	The amount of driver wage based on each hour.
Int32 minimumTimeHours	The amount of time the driver is guaranteed pay for the route.
Decimal overtimeRatePerHour	The amount of driver wage once the amount of time in the Regular Time (minutes) box has been exceeded.
Decimal perDistanceRateKm	The amount of pay per unit for the driver.
Int32 minimumDistance	The minimum amount of miles the driver is paid.
Decimal perSize1Rate	The amount of pay per size1 delivered.
Int32 minimumSize1	The minimum amount of size1 the driver is paid.
Boolean enabled	Activates the Cost Profile in GreenMile to be utilized.
Int32 regularTimeMinutes	The amount of time for the route (in minutes) for regular pay.
Decimal fixedStopCost	The amount of money the route will be calculated at for each stop.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.Equipment

Http Call

/bsc/greenmile/equipment

Output Columns

Int32 id
String key	The unique database key associated with the specific Equipment template being defined.
String description	The name that will be displayed in the system for the Equipment.
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
Int32 equipmentType_id	The Equipment Type to which the current Equipment template will apply.
String equipmentType_key	The unique database key associated with the specific Equipment template being defined.
String equipmentType_description	The name that will be displayed in the system for the Equipment Type.
Boolean enabled	Activates the Equipment in GreenMile to allow them to log into the system.
String gpsUnitId	The Unit Code will be a unique identifier found on the GPS unit.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.EquipmentType

Http Call

/bsc/greenmile/equipmenttype

Output Columns

Int32 id
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
String key	The unique database key associated with the specific Equipment template being defined.
String description	The name that will be displayed in the system for the Equipment.
Decimal weight	The gross weight of the vehicle.
Decimal height	The maximum height of the vehicle.
Decimal averageFuelConsumption	The average amount of fuel the equipment type consumes.
Decimal carbonFactor	The Carbon Emission Factor for the vehicle type used in CO2 reporting.
Decimal size1	The equipment type’s Size1 capacity.
Decimal size2	The equipment type’s Size2 capacity.
Decimal size3	The equipment type’s Size3 capacity.
Decimal fixedRouteCost	The amount of money the route will calculate for the equipment.
Decimal costPerMinute	The amount of dollars and cents that the equipments costs to operate.
Int32 minimumTimeMinutes	The minimum amount of time used to calculate cost.
Decimal perDistanceRateKm	The amount of cost per unit traveled for the equipment.
Int32 minimumDistance	The minimum amount of miles the equipment cost per distance will be calculated.
Decimal perSize1Rate	The amount of cost charged per size1 carried on equipment.
Int32 minimumSize1	The minimum amount of size1 the Cost per Size1 will be calculated at.
Boolean enabled	Activates the Equipment in GreenMile to allow them to log into the system.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
address
locality
administrativeArea
postalCode
country		US

SQL Call

select * from GreenMile.GeoCode

Http Call

/bsc/greenmile/geocode

Output Columns

String types
String formattedAddress
String route
String routeShort
String routeTypes
String locality
String localityShort
String localityTypes
String subLocality
String subLocalityShort
String subLocalityTypes
String administrativeArea
String administrativeAreaShort
String administrativeAreaTypes
String country
String countryShort
String countryTypes
String postalCode
String postalCodeShort
String postalCodeTypes
Decimal locationLat
Decimal locationLng
String locationType
Decimal viewportSouthwestLat
Decimal viewportSouthwestLng
Decimal viewportNortheasttLat
Decimal viewportNortheastLng
Decimal boundsSouthwestLat
Decimal boundsSouthwestLng
Decimal boundsNortheasttLat
Decimal boundsNortheastLng
Boolean partialMatch
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.LocationType

Http Call

/bsc/greenmile/getlocationtype

Output Columns

Int32 id
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
String key	LocationType’s key.
String description	The name that will be displayed in the system for the Location Type.
Boolean showOnMobileCreate	Allows the Location Type to be chosen in GreenMile Driver.
Boolean enabled	Activates the Location Type in GreenMile to allow them to log into the system.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

exec bsc.GreenMile.HoursOfServiceType
select * from GreenMile.HoursOfServiceType

Http Call

/bsc/greenmile/hoursofservicetype

Output Columns

Int32 id
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
String key	HoursOfServiceType’s key
DateTime disableDate	Disable Date.
String description	The name that will be displayed in the system for the Hours of Service Type.
Boolean allowBreakAppointment	The type created will be calculated as a break in Hours of Service.
Boolean allowLunchAppointment	The type will be considered as meal time in Hours of Service calculation.
Boolean allowWaitAppointment	The type created will be considered as a wait time for the Hours of Service calculation.
Boolean inferDriveTimeBasedRouteActions	The type created will be considered as drive time in the Hours of Service calculation.
Int32 breakTimeThresholdMinutes	Indicates when a break should be taken.
Int32 breakTimeDurationMinutes	Indicates how long this break will be.
Int32 lunchTimeThresholdMinutes	Indicates when a lunch break should be taken.
Int32 lunchTimeDurationMinutes	Indicates how long this lunch will be.
Boolean forceBreakTime	If the value of forceBreakTime is True the system forces the break time to be at least the value specified in breakTimeDurationMinutes
Boolean forceLunchTime	If the value of forceLunchTime is True the system forces the lunch time to be at least the value specified in lunchTimeDurationMinutes.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

exec GreenMile.ListDrivers
select * from GreenMile.Driver

Http Call

/bsc/greenmile/listdrivers

Output Columns

Int32 id	The entity’s auto-increment id.
String licenseNumber	The number issued to the driver.
String driverType	Type of Job for the Driver.
DateTime licenseExpires	Date the license expires on.
String driverProfileCost	The cost profile that will be utilized to compute the driver’s cost of the route.
DateTime lastDrugsTest	The date of the driver’s last drug test.
DateTime lastPhysicalTest	The date of the driver’s last physical.
DateTime lastAlcoholTest	The date of the driver’s last alcohol test.
Boolean smartTrack	Indicates if Driver has smart track or not.
Int32 failedAttempts	Amount of login attempts.
DateTime lockDate	Locked account Date.
DateTime expireDate	Date to lock account.
DateTime latestLogin	Date of last login.
Int32 passwordExpire	Days left to change password.
String login	The name the Driver will enter when logging into the GreenMile system.
String email	User’s e-mail address.
Boolean enabled	Activates the Driver in GreenMile to allow them to log into the system.
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
String key	The unique database key associated with the specific Driver template being defined.
String name	The name of the Driver you would like displayed in the GreenMile system.
String addressLine1	The street address for the driver.
String addressLine2	Additional address information such as apartment.
String city	City of driver’s address.
String state	State of driver’s address.
String zipCode	Postal code of driver’s address.
String district	District of driver’s address.
String country	County of driver’s address.
Decimal longitude	Map coordinates for Longitude of driver’s address.
Decimal latitude	Map coordinates for Latitude of driver’s address.
String phone1	User’s phone number (1) for informational use.
String phone1Type	The phone type entered in Phone 1.
String phone2	User’s phone number (2) for informational use.
String phone2Type	The phone type entered in Phone 2.
String adpFileNumber	The employee number provided by ADP for exporting of payroll data to ADP.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

exec bsc.GreenMile.ListStops
select * from GreenMile.Stop

Http Call

/bsc/greenmile/liststops

Output Columns

Int32 id
String key	The entity’s key.
Int32 route_id
String route_key
String route_description
Int32 location_id
String location_key
Int32 location_organization_id	The organization to which the item belongs.
String location_organization_key	Unique code identifying the organization.
Int32 baseLineSequenceNum
Int32 plannedSequenceNum
Int32 actualSequenceNum
Int32 stopType_id
String stopType_key
String udfs
DateTime baseLineArrival
Int32 originalStop_id
DateTime cloneDate
Int64 plannedWaiting
DateTime plannedArrival
DateTime projectedArrival
DateTime actualArrival
DateTime baseLineService
DateTime plannedService
DateTime projectedService
DateTime actualService
DateTime baseLineDeparture
DateTime plannedDeparture
DateTime projectedDeparture
DateTime actualDeparture
Decimal baseLineDistance
Decimal plannedDistance
Decimal projectedDistance
Decimal actualDistance
String actualArrivalDataQuality
String actualServiceDataQuality
String actualDepartureDataQuality
String actualDistanceDataQuality
String actualCancelDataQuality
Decimal baseLineSize1
Decimal baseLineSize2
Decimal baseLineSize3
Decimal plannedSize1
Decimal plannedSize2
Decimal plannedSize3
Decimal actualSize1
Decimal actualSize2
Decimal actualSize3
Decimal plannedPickupSize1
Decimal plannedPickupSize2
Decimal plannedPickupSize3
Decimal baseLinePickupSize1
Decimal baseLinePickupSize2
Decimal baseLinePickupSize3
Decimal actualPickupSize1
Decimal actualPickupSize2
Decimal actualPickupSize3
Decimal damagedSize1
Decimal damagedSize2
Decimal damagedSize3
String instructions
Int32 bulkArriveGroup
Int32 deliveryReasonCode_id
String deliveryReasonCode_key
Int32 overReasonCode_id
String overReasonCode_key
Int32 shortReasonCode_id
String shortReasonCode_key
Int32 damagedReasonCode_id
String damagedReasonCode_key
Int32 pickupReasonCode_id
String pickupReasonCode_key
Int32 cancelCode_id
String cancelCode_key
Int32 undeliverableCode_id
String undeliverableCode_key
Int32 redeliveryStop_id
String redeliveryStop_key
Decimal arrivalLatitude
Decimal arrivalLongitude
String arrivalMobileGpsProvider
Int32 arrivalAccuracyMeters
Boolean arrivedInTimeWindow
Decimal serviceLatitude
Decimal serviceLongitude
Int32 serviceAccuracyMeters
String serviceMobileGPSProvider
Boolean hasPicture
Boolean hasSignature
String signatureFilePath
Decimal longitude
Decimal latitude
DateTime actualCancel
String baselineTimeWindowOpen
String baselineTimeWindowClose
String baselineTimeWindowDay
String plannedTimeWindowOpen
String plannedTimeWindowClose
String plannedTimeWindowDay
String actualTimeWindowOpen
String actualTimeWindowClose
String actualTimeWindowDay
Int32 projectedMissedTWMinutes
Int32 stopEtaListeners_id
DateTime reprocessedAt
Decimal arrivalDistance
String stopDocuments
Int32 transport_id
Int32 size1AliasConfig_id
Int32 size2AliasConfig_id
Int32 size3AliasConfig_id
String signatureConformity
String arrivalConformity
Boolean inSequence
Boolean allowShort
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.Location

Http Call

/bsc/greenmile/location

Output Columns

Int32 id
String key	The unique database key associated with the specific Location template being defined.
String description	The name that will be displayed in the system for the Location.
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
Int32 locationType_id	The location type associated with this location.
String locationType_key	LocationType’s key.
String locationType_description	The name that will be displayed in the system for the Location Type.
Int32 accountType_id	The account type associated with this location.
String accountType_key	Account type key.
String accountType_description	Description from Account Type.
String locationOverrideTimeWindows	Indicates the time window type specific for that customer (What time opens and closes).
Int32 serviceTimeType_id	Indicates the service time type for that customer.
String serviceTimeType_key	ServiceTimeType’s key.
String serviceTimeType_description	ServiceTimeType’s description.
Int32 timeWindowType_id	Indicates the time window type for that customer (What time opens and closes).
String timeWindowType_key	TimeWindowType’s key.
String timeWindowType_description	TimeWindowType’s description.
String taxID	Tax identifier (CPF/CNPJ).
String addressLine1	The street address for the Location.
String addressLine2	Additional address information such as apartment.
String city	City of Location’s address.
String state	State of Location’s address.
String zipCode	Postal code of Location’s address.
String district	District of Location’s address.
String country	Country of Location’s address.
Decimal longitude	Longitude using decimal format.
Decimal latitude	Latitude using decimal format.
String geocodingQuality	Quality of the geocoding information.
String phone1	Location’s phone number (1) for informational use.
String phone1Type	Primary phone number Valid values: 0,1,2,3,4. 0 = Work, 1 = Home, 2 = Other, 3 = Mobile, 4 = Fax.
String phone2	Location’s phone number (2) for informational use.
String phone2Type	Secondary phone number type. Valid values: 0,1,2,3,4. 0 = Work, 1 = Home, 2 = Other, 3 = Mobile, 4 = Fax.
String email	Location’s e-mail address.
String deliveryInstructions	Delivery instructions.
Int32 deliveryRadius	Creates a circle around the location with the radius of the circle configured according to the number entered in miles.
String deliveryDays	Delivery days can be represented by M,T,W,R,F,S,U. Each letter represents one delivery day on the week. Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. For example, the String "M,R" will represent the delivery days of Monday and Thursday.
Int32 nonHelperFixedTimeSecs	Time in seconds fixed of a Non Helper.
Int32 nonHelperVarTimeSecs	Time in seconds variable of a Non Helper.
Int32 helperFixedTimeSecs	Time in seconds fixed of a Helper.
Int32 helperVarTimeSecs	Time in seconds variableof a Helper.
Decimal perSize1Rate	Rate per Size 1.
Decimal fixedCost	Fixed Cost of Location.
String consignees	Consignees of the Location.
DateTime geocodingDate	Date when the location was geocoded.
DateTime geocodingLastCheck	Date time the location geocode was checked.
Int32 geocodingUser_id	User that geocoded the Location.
Int32 timeZone_id	The time zone associated with the specific Location template.
String allowedUsers	User’s that are allowed to see this Location.
Boolean enabled	Activates the Location in GreenMile to be utilized.
Boolean hasGeofence	Shows if the Location has a Geofence.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.Organization

Http Call

/bsc/greenmile/organization

Output Columns

Int32 id
String key	The entity’s key.
String addressLine1	The entity’s addressLine1.
String addressLine2	The entity’s addressLine2.
String city	The entity’s city.
String state	The entity’s state.
String zipCode	The entity’s zipcode.
String district	The entity’s district.
String country	The entity’s country.
String taxid	The entity’s taxid.
String description	The entity’s description.
String parentOrganization_id	Represents the parent organization.
String unitSystem	Organization’s unit system.
Int32 preferedLocale_id	Organization’s I18NLocale.
String timeZone	Organization time zone.
String listenerOrganizations	List of Organization that notified.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.ReasonCode

Http Call

/bsc/greenmile/reasoncode

Output Columns

Int32 id
String key	The entity’s key.
String description	The entity’s description.
Boolean enabled
Boolean delivery
Boolean over
Boolean shorts
Boolean damaged
Boolean pickup
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.Route

Http Call

/bsc/greenmile/route

Output Columns

Int32 id
String key	The entity’s key.
String description	The entity’s description.
DateTime date
DateTime driverAssignmentDate
Int32 driver_id
String driver_key
String driver_login
String driver_name
DateTime equipmentAssignmentDate
Int32 equipment_id
String equipment_key
String equipment_description
String equipment_equipmentType_id
String equipment_equipmentType_key
String equipment_equipmentType_description
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
String origin_id
String destination_id
Boolean lastStopIsDestination
DateTime plannedArrival
DateTime plannedDeparture
DateTime plannedComplete
DateTime plannedStart
Boolean hasHelper
Decimal origLatitude
Decimal origLongitude
Decimal destLatitude
Decimal destLongitude
Int32 stops
String extraLineItems
String udfs
DateTime baseLineArrival
DateTime baseLineDeparture
DateTime reopenedDate
Int32 reopenedBy_id
DateTime projectedArrival
DateTime projectedDeparture
DateTime actualArrival
DateTime actualDeparture
Decimal baseLineDistance
Decimal plannedDistance
Decimal projectedDistance
Decimal actualDistance
DateTime baseLineComplete
DateTime projectedComplete
DateTime actualComplete
String actualStartDataQuality
String actualDistanceDataQuality
String actualCompleteDataQuality
String actualDepartureDataQuality
Decimal baseLineCost
Decimal plannedCost
Decimal actualCost
DateTime baseLineStart
DateTime projectedStart
DateTime actualStart
String driverName
String driverAssignments
String equipmentAssignments
Int32 totalStops
Int32 canceledStops
Int32 undeliveredStops
Int32 redeliveredStops
Int32 actualDepartures
String status
Int32 actualTravelTimeMinutes
Int32 plannedTravelTimeMinutes
Int32 baselineTravelTimeMinutes
Boolean hasPicture
Decimal actualSize1
Decimal actualSize2
Decimal actualSize3
Decimal baselineSize1
Decimal baselineSize2
Decimal baselineSize3
Decimal plannedSize1
Decimal plannedSize2
Decimal plannedSize3
Decimal actualPickupSize1
Decimal actualPickupSize2
Decimal actualPickupSize3
Decimal baselinePickupSize1
Decimal baselinePickupSize2
Decimal baselinePickupSize3
Decimal plannedPickupSize1
Decimal plannedPickupSize2
Decimal plannedPickupSize3
Boolean hasGps
DateTime lastUpdatedProjectedTime
String helperAssignments
DateTime actualDistanceRecalculatedAt
String resequenceMethod
String locationPendingPayments
String driverPendingBalances
String additionalMaterials
String consignedSkus
String holderMaterials
String manifests
Int32 size1AliasConfig_id
Int32 size2AliasConfig_id
Int32 size3AliasConfig_id
Decimal amountReceived
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.RouteHelperAssignment

Http Call

/bsc/greenmile/routehelperassignment

Output Columns

Int32 id
Int32 driver_id
String driver_key
String driver_login
String driver_name
Int32 route_id
String route_key
Int32 location_id
String location_key
String location_description
Int32 location_locationType_id	The location type associated with this location.
String location_locationType_key
String location_locationType_description
Int32 location_organization_id	The organization to which the item belongs.
String location_organization_key	Unique code identifying the organization.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.ServiceTimeType

Http Call

/bsc/greenmile/servicetimetype

Output Columns

Int32 id
String key
String description
Boolean enabled
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
Int32 nonHelperFixedTimeSecs	The amount of time associated with a delivery.
Int32 nonHelperVarTimeSecs	The amount of time associated with each size1 quantity.
Int32 helperFixedTimeSecs	The amount of time associated with a delivery with Helper.
Int32 helperVarTimeSecs	The amount of time associated with each size1 quantity with Helper.
DateTime creationDate
DateTime lastModificationdDate
String raw

Arguments

Name	Description	Default
filter		{ "criteriaChain" : [] }
maxCount		2000

SQL Call

select * from GreenMile.TimeWindowType

Http Call

/bsc/greenmile/timewindowtype

Output Columns

Int32 id
String key
String description
Boolean enabled
Int32 organization_id	The organization to which the item belongs.
String organization_key	Unique code identifying the organization.
String timeWindowTypeDays	Shows if enabled.
DateTime creationDate
DateTime lastModificationdDate
String raw