Path parameters

• carrierId integer(int64) Required
• periodCode string Required

  Period for which the invoice will be generated. The invoices can be retrieved by period. Currently, only monthly periods in the format YYYYMM are supported, but in the future we might support others such as weekly periods in the form of '2025W12'

• yardId integer(int64) Required

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • yard_id integer(int64)

    Yard ID

  • carrier_id integer(int64)

    Carrier ID

  • invoice_number string

    Invoice number

  • period_code string Required

    Code representing the billing period

  • trucks_section array[object] Required

    Shows how many trucks were in the yard each day of the period, and how many of them were overage

    Hide trucks_section attributes Show trucks_section attributes object

    • date string(date)
    • vehicles_in_free_spot array[object] Required

      Vehicles that were in a free spot on a given day

      Hide vehicles_in_free_spot attributes Show vehicles_in_free_spot attributes object

      • vehicle_number string Required

        Vehicle number

      • check_in_before_billing_period boolean Required

        Whether the vehicle was checked in before the billing period

      • check_in_date_time Required

        Check-in timestamp for the vehicle

      • check_out_date_time Required

        Check-out timestamp for the vehicle

      • check_out_after_billing_period boolean Required

        Whether the vehicle checked out after the billing period

      • billable_start_date_time Required

        Start of the billable period for this vehicle

      • billable_end_date_time Required

        End of the billable period for this vehicle

      • show_check_in_today boolean Required

        true if the check in day was the same of the current DayInfo or if the check in was before the billing period and the current day is the first one in the period

      • show_check_out_today boolean Required

        true if the check out day was the same of the current DayInfo or if the check out was after the billing period and the current day is the last one in the period

      • grace_period Required

        Grace period info

      • billable_days integer(int32) Required

        Number of days the vehicle is billable in Yard. It takes account for the grace period. Note that in rate type FLAT overageDays represents the actual days the vehicle will be billed, taken into account the time it was on a reserved spot

      • spot_number integer(int32)

        Reserved spot number if applicable

      • overage_days integer(int32)

        The actual days the vehicle will be billed using the overage rate

      • took_reserved_spot_at_check_in boolean

        Flag to indicate if vehicle claimed a reserved spot upon check-in

      • took_reserved_spot_that_became_available_while_in_yard boolean

        Flag to indicate if vehicle claimed a reserved spot that became available while it was in yard.

      • vehicle_number_that_left string

        Vehicle number of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

      • check_out_movement_id_of_vehicle_that_left integer(int64)

        Checkout movement ID of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

    • vehicles_in_overage array[object] Required

      Vehicles that were in overage on a given day

      Hide vehicles_in_overage attributes Show vehicles_in_overage attributes object

      • vehicle_number string Required

        Vehicle number

      • check_in_before_billing_period boolean Required

        Whether the vehicle was checked in before the billing period

      • check_in_date_time Required

        Check-in timestamp for the vehicle

      • check_out_date_time Required

        Check-out timestamp for the vehicle

      • check_out_after_billing_period boolean Required

        Whether the vehicle checked out after the billing period

      • billable_start_date_time Required

        Start of the billable period for this vehicle

      • billable_end_date_time Required

        End of the billable period for this vehicle

      • show_check_in_today boolean Required

        true if the check in day was the same of the current DayInfo or if the check in was before the billing period and the current day is the first one in the period

      • show_check_out_today boolean Required

        true if the check out day was the same of the current DayInfo or if the check out was after the billing period and the current day is the last one in the period

      • grace_period Required

        Grace period info

      • billable_days integer(int32) Required

        Number of days the vehicle is billable in Yard. It takes account for the grace period. Note that in rate type FLAT overageDays represents the actual days the vehicle will be billed, taken into account the time it was on a reserved spot

      • spot_number integer(int32)

        Reserved spot number if applicable

      • overage_days integer(int32)

        The actual days the vehicle will be billed using the overage rate

      • took_reserved_spot_at_check_in boolean

        Flag to indicate if vehicle claimed a reserved spot upon check-in

      • took_reserved_spot_that_became_available_while_in_yard boolean

        Flag to indicate if vehicle claimed a reserved spot that became available while it was in yard.

      • vehicle_number_that_left string

        Vehicle number of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

      • check_out_movement_id_of_vehicle_that_left integer(int64)

        Checkout movement ID of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

    • overage_days integer(int32)
  • trailers_section array[object] Required

    Shows how many trailers were in the yard each day of the period, and how many of them were overage.

    Hide trailers_section attributes Show trailers_section attributes object

    • date string(date)
    • vehicles_in_free_spot array[object] Required

      Vehicles that were in a free spot on a given day

      Hide vehicles_in_free_spot attributes Show vehicles_in_free_spot attributes object

      • vehicle_number string Required

        Vehicle number

      • check_in_before_billing_period boolean Required

        Whether the vehicle was checked in before the billing period

      • check_in_date_time Required

        Check-in timestamp for the vehicle

      • check_out_date_time Required

        Check-out timestamp for the vehicle

      • check_out_after_billing_period boolean Required

        Whether the vehicle checked out after the billing period

      • billable_start_date_time Required

        Start of the billable period for this vehicle

      • billable_end_date_time Required

        End of the billable period for this vehicle

      • show_check_in_today boolean Required

        true if the check in day was the same of the current DayInfo or if the check in was before the billing period and the current day is the first one in the period

      • show_check_out_today boolean Required

        true if the check out day was the same of the current DayInfo or if the check out was after the billing period and the current day is the last one in the period

      • grace_period Required

        Grace period info

      • billable_days integer(int32) Required

        Number of days the vehicle is billable in Yard. It takes account for the grace period. Note that in rate type FLAT overageDays represents the actual days the vehicle will be billed, taken into account the time it was on a reserved spot

      • spot_number integer(int32)

        Reserved spot number if applicable

      • overage_days integer(int32)

        The actual days the vehicle will be billed using the overage rate

      • took_reserved_spot_at_check_in boolean

        Flag to indicate if vehicle claimed a reserved spot upon check-in

      • took_reserved_spot_that_became_available_while_in_yard boolean

        Flag to indicate if vehicle claimed a reserved spot that became available while it was in yard.

      • vehicle_number_that_left string

        Vehicle number of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

      • check_out_movement_id_of_vehicle_that_left integer(int64)

        Checkout movement ID of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

    • vehicles_in_overage array[object] Required

      Vehicles that were in overage on a given day

      Hide vehicles_in_overage attributes Show vehicles_in_overage attributes object

      • vehicle_number string Required

        Vehicle number

      • check_in_before_billing_period boolean Required

        Whether the vehicle was checked in before the billing period

      • check_in_date_time Required

        Check-in timestamp for the vehicle

      • check_out_date_time Required

        Check-out timestamp for the vehicle

      • check_out_after_billing_period boolean Required

        Whether the vehicle checked out after the billing period

      • billable_start_date_time Required

        Start of the billable period for this vehicle

      • billable_end_date_time Required

        End of the billable period for this vehicle

      • show_check_in_today boolean Required

        true if the check in day was the same of the current DayInfo or if the check in was before the billing period and the current day is the first one in the period

      • show_check_out_today boolean Required

        true if the check out day was the same of the current DayInfo or if the check out was after the billing period and the current day is the last one in the period

      • grace_period Required

        Grace period info

      • billable_days integer(int32) Required

        Number of days the vehicle is billable in Yard. It takes account for the grace period. Note that in rate type FLAT overageDays represents the actual days the vehicle will be billed, taken into account the time it was on a reserved spot

      • spot_number integer(int32)

        Reserved spot number if applicable

      • overage_days integer(int32)

        The actual days the vehicle will be billed using the overage rate

      • took_reserved_spot_at_check_in boolean

        Flag to indicate if vehicle claimed a reserved spot upon check-in

      • took_reserved_spot_that_became_available_while_in_yard boolean

        Flag to indicate if vehicle claimed a reserved spot that became available while it was in yard.

      • vehicle_number_that_left string

        Vehicle number of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

      • check_out_movement_id_of_vehicle_that_left integer(int64)

        Checkout movement ID of the vehicle that left, facilitating this vehicle to take a reserved spot in yard.

    • overage_days integer(int32)
  • trailer_original_invoice_overage_days integer(int32)

    The total number of days that trailers included in the original invoice were in overage

  • truck_original_invoice_overage_days integer(int32)

    The total number of days that trucks included in the original invoice were in overage

• 401

  Not Authorized

• 403

  Not Allowed