Get detailed overage info
Only for FLAT billing mode. The corresponding invoice must be already generated. Shows how many vehicles were in the yard each day of the period, and how many of them were overage.
GET
/api/billing/invoice/info/flat-billing-overage/yard/{yardId}/carrier/{carrierId}/periodCode/{periodCode}
curl \
--request GET 'https://api-dev.gatego.io/api/billing/invoice/info/flat-billing-overage/yard/{yardId}/carrier/{carrierId}/periodCode/202406'
Response examples (200)
{
"yard_id": 67890,
"carrier_id": 11223,
"invoice_number": "IN23456",
"period_code": "202401",
"trucks_section": [
{
"date": "2022-03-10",
"vehicles_in_free_spot": [
{
"vehicle_number": "VH12345",
"check_in_before_billing_period": true,
"check_in_date_time": "2022-01-01T08:00:00Z",
"check_out_date_time": "2022-01-05T20:00:00Z",
"check_out_after_billing_period": true,
"billable_start_date_time": "2022-01-01T08:00:00Z",
"billable_end_date_time": "2022-01-05T20:00:00Z",
"show_check_in_today": true,
"show_check_out_today": true,
"billable_days": 5,
"spot_number": 52,
"overage_days": 0,
"took_reserved_spot_at_check_in": true,
"took_reserved_spot_that_became_available_while_in_yard": true,
"vehicle_number_that_left": "string",
"check_out_movement_id_of_vehicle_that_left": 42
}
],
"vehicles_in_overage": [
{
"vehicle_number": "VH12345",
"check_in_before_billing_period": true,
"check_in_date_time": "2022-01-01T08:00:00Z",
"check_out_date_time": "2022-01-05T20:00:00Z",
"check_out_after_billing_period": true,
"billable_start_date_time": "2022-01-01T08:00:00Z",
"billable_end_date_time": "2022-01-05T20:00:00Z",
"show_check_in_today": true,
"show_check_out_today": true,
"billable_days": 5,
"spot_number": 52,
"overage_days": 0,
"took_reserved_spot_at_check_in": true,
"took_reserved_spot_that_became_available_while_in_yard": true,
"vehicle_number_that_left": "string",
"check_out_movement_id_of_vehicle_that_left": 42
}
],
"overage_days": 42
}
],
"trailers_section": [
{
"date": "2022-03-10",
"vehicles_in_free_spot": [
{
"vehicle_number": "VH12345",
"check_in_before_billing_period": true,
"check_in_date_time": "2022-01-01T08:00:00Z",
"check_out_date_time": "2022-01-05T20:00:00Z",
"check_out_after_billing_period": true,
"billable_start_date_time": "2022-01-01T08:00:00Z",
"billable_end_date_time": "2022-01-05T20:00:00Z",
"show_check_in_today": true,
"show_check_out_today": true,
"billable_days": 5,
"spot_number": 52,
"overage_days": 0,
"took_reserved_spot_at_check_in": true,
"took_reserved_spot_that_became_available_while_in_yard": true,
"vehicle_number_that_left": "string",
"check_out_movement_id_of_vehicle_that_left": 42
}
],
"vehicles_in_overage": [
{
"vehicle_number": "VH12345",
"check_in_before_billing_period": true,
"check_in_date_time": "2022-01-01T08:00:00Z",
"check_out_date_time": "2022-01-05T20:00:00Z",
"check_out_after_billing_period": true,
"billable_start_date_time": "2022-01-01T08:00:00Z",
"billable_end_date_time": "2022-01-05T20:00:00Z",
"show_check_in_today": true,
"show_check_out_today": true,
"billable_days": 5,
"spot_number": 52,
"overage_days": 0,
"took_reserved_spot_at_check_in": true,
"took_reserved_spot_that_became_available_while_in_yard": true,
"vehicle_number_that_left": "string",
"check_out_movement_id_of_vehicle_that_left": 42
}
],
"overage_days": 42
}
],
"trailer_original_invoice_overage_days": 5,
"truck_original_invoice_overage_days": 7
}