RESTFUL APIs

When Rental Bills are Ready for Pickup

Rental bills will be available for pickup via GET /rental/bills/readyForPickup or GET /rental/bills/readyForPickup/new when:

  • The rental billing period that the bill is in is marked as "Open"

  • The rental bills have been "Sent To Printer", meaning that a user has pressed the "Create File For Printer" button in TrackAbout

Recalculating Rental Bills

Occasionally, a rental bill will need to be recalculated in TrackAbout. When this occurs, the bill in question will receive a new rental invoice number, and will be treated as though it had never been picked up via the API. Therefore it is possible that a rental invoice can be sent via the API twice.

Pre-Delivery (Pending) Orders API - Minimum Field Requirements

  • Order #

    • Order # may be optional.

    • If using POST /orders/pending/batch, then orderNumber is required.

    • If using PUT /orders/pending/{OrderNumber}, orderNumber can be an element in the file OR orderNumber can be in the url string. To see this, go to PUT /orders/pending/{OrderNumber}, type a number in the OrderNumber field, and tap, Send Request. A Request URL will appear, with the number you entered in that URL.

  • Customer Id

  • Location

    Determines what routes can be used

  • Route - same route for that truck for all time

    Determines in which mobile units the order appears.

    If the config, LocationAndRouteAreOptionalForPaperlessDelivery, is set to True and Proof of Delivery is enabled (IsPaperlessDeliveryFeatureEnabled), every device will use Proof of Delivery whether or not it is assigned to a truck and route. If set to False only devices assigned to a truck and route will use Proof of Delivery; devices that are not assigned will use standard delivery.

  • Order Date

  • Planned Delivery Date - needs to be today or in the future.

    Future orders will not show up on the handheld until the day of delivery, although an override can be set if needed

  • Order Line Items. The minimum requirements are:

    • accountingLineNumber (an integer)

    • productCode

    • quantityToDeliver

    • quantityToReturn

  • Billing codes currently are not required to be sent over with the Orders.

    However, if delivering an asset for which its classification is unknown, you will be required to select a Billing Code from a list when classifying the asset, pending fix of D-02717.

    Therefore, at least one Billing Code needs to be established.

    We recommend “T” (Handhelds only show one letter.)