Billing summary aggregated for a list of yard and carriers

GET /api/billing/dashboard/summary

Retrieves the billing summary aggregated for the given list of yards and carriers. If yardIdList and/or carrierIdList are not given, then the current authenticated account's visible yards and carriers will be used.

Query parameters

carrierIdList array[integer(int64)]

The ID of the yard for which to retrieve the dashboard summary
yardIdList array[integer(int64)]

The ID of the yard for which to retrieve the dashboard summary

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- ongoing_period_summary object Required
  
  TBC
  
  Additional properties are allowed.
  
  Hide ongoing_period_summary attributes Show ongoing_period_summary attributes object
  
  period_code string
  
  TBC
  
  total_amount number
  
  TBC
- past_period_summaries array[object] Required
  
  TBC
  
  TBC
  
  Hide past_period_summaries attributes Show past_period_summaries attributes object
  
  period_code string
  
  TBC
  
  total_amount number
  
  TBC
- billable_carriers integer(int32) Required
  
  TBC
- total_spots_reserved integer(int32) Required
  
  TBC
401

Not Authorized
403

Not Allowed

GET /api/billing/dashboard/summary

curl \
 --request GET 'https://api-dev.gatego.io/api/billing/dashboard/summary'

Response examples (200)

{
  "ongoing_period_summary": {
    "period_code": "TBC",
    "total_amount": "TBC"
  },
  "past_period_summaries": [
    "TBC"
  ],
  "billable_carriers": "TBC",
  "total_spots_reserved": "TBC"
}