Get requested yard

GET /api/automated-billing/config/yard/{yardId}/view/carrierIds

Retrieve the billing configuration for a specific yard including the carrierIds of all their configured carriers.

Path parameters

yardId integer(int64) Required

The ID of the yard for which to retrieve the billing configuration

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id integer(int64)
  
  Unique identifier of the yard configuration
- yard_id integer(int64)
  
  Identifier of the yard
- enabled boolean
  
  Indicates if the yard configuration is enabled
- carrier_ids array[object]
  
  List of carrier identifiers that have configurations associated with the yard
  
  Hide carrier_ids attribute Show carrier_ids attribute object
  
  carrier_id integer(int64)
  
  Identifier of the carrier associated with this configuration
- last_modified_at
  
  Timestamp when the configuration was last modified
- last_modified_by string
  
  Username of the last modifier of this configuration
401

Not Authorized
403

Not Allowed

GET /api/automated-billing/config/yard/{yardId}/view/carrierIds

curl \
 -X GET https://api-dev.gatego.io/api/automated-billing/config/yard/{yardId}/view/carrierIds

Response examples (200)

{
  "id": 1,
  "yard_id": 100,
  "enabled": true,
  "carrier_ids": [
    {
      "carrier_id": 250
    }
  ],
  "last_modified_at": "2023-04-06T11:25:42Z",
  "last_modified_by": "355c30f0-96d2-4dbe-bfe8-f8dd9eb7f778"
}