Skip to main content
PATCH
/
v2
/
tolls
/
{id}
cURL
curl --request PATCH \
  --url https://api.example.com/v2/tolls/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_status": 123
}
'
{
  "id": 123,
  "vehicle": {
    "id": 123,
    "custom_fields": "<string>",
    "added_date": "2023-11-07T05:31:56Z",
    "fleet": {
      "id": 123,
      "region_details": [
        {
          "id": 123,
          "title": "<string>"
        }
      ],
      "title": "<string>",
      "is_active": true,
      "billing_type": "PREPAID",
      "onboarding_stage": "INITIAL",
      "warning_threshold_per_vehicle": "<string>",
      "deactivation_threshold_per_vehicle": "<string>",
      "client": "<string>",
      "onboarding_vehicle_order": 123
    },
    "plate_number": "<string>",
    "plate_state": "<string>",
    "vehicle_number": "<string>",
    "active": true,
    "vehicle_make": "<string>",
    "vehicle_model": "<string>",
    "year": "<string>",
    "lessee_renter": "<string>",
    "vehicle_type_code": "<string>"
  },
  "transponder": {
    "id": 123,
    "number": "<string>",
    "status": "IN_STOCK"
  },
  "driver": {
    "id": 123,
    "first_name": "<string>",
    "address_line_1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "email": [
      "jsmith@example.com"
    ],
    "driver_id": "<string>",
    "last_name": "<string>",
    "address_line_2": "<string>",
    "contact_number": "<string>"
  },
  "exit_plaza": "<string>",
  "billing_status_fk": {
    "id": 123,
    "value": "<string>",
    "display_text": "<string>",
    "ticket_type": "<string>",
    "fleet": 123,
    "is_system": "<string>"
  },
  "cash_cost": 0,
  "amount": "<string>",
  "posting_date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "exit_time": "<string>",
  "billing_status": "NO_ACTION",
  "agency": "<string>",
  "entry_plaza": "<string>",
  "our_cost": "<string>",
  "is_billed": true,
  "billed_on": "2023-11-07T05:31:56Z",
  "confirmation_id": "<string>",
  "system_remarks": null,
  "violation": true,
  "violation_fee": "<string>",
  "source_id": 4611686018427388000,
  "driver_agreement": 123,
  "included_in_driver_invoice": 123,
  "source_type": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

billing_status
integer

Response

200 - application/json
id
integer
required
vehicle
object
required
transponder
object
required

Model serializer for raw transponder data

driver
object
required
exit_plaza
string
required
billing_status_fk
object
required
cash_cost
number<double>
required
Required range: -1000 < x < 1000
amount
string
required
posting_date
string<date>
required
transaction_date
string<date>
required
exit_time
string<time>
required
billing_status
enum<string>
default:NO_ACTION
  • NO_ACTION - No Action
  • CARD_NOT_ON_FILE - Card Not On File
  • INVOICED_NOT_PAID - Invoiced – Not Paid
  • PAID_SUCCESSFULLY - Paid Successfully
  • CREDIT_CARD_DECLINED - Credit Card Declined
  • EXPIRED_CREDIT_CARD - Expired Credit Card
  • EMPLOYEE_USE_OR_FLEET_LIABLE - Employee Use/Fleet Liable
  • USER_NOT_FOUND - User Not Found
  • DISPUTED_TOLL_OR_TICKET - Disputed Toll/Ticket
  • VALIDATION_ISSUES - Validation Issues
  • COD_SERVICE - COD Service
Available options:
NO_ACTION,
CARD_NOT_ON_FILE,
INVOICED_NOT_PAID,
PAID_SUCCESSFULLY,
CREDIT_CARD_DECLINED,
EXPIRED_CREDIT_CARD,
EMPLOYEE_USE_OR_FLEET_LIABLE,
USER_NOT_FOUND,
DISPUTED_TOLL_OR_TICKET,
VALIDATION_ISSUES,
COD_SERVICE
agency
string | null
Maximum string length: 25
entry_plaza
string | null
Maximum string length: 55
our_cost
string<decimal>
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
is_billed
boolean
billed_on
string<date-time> | null
confirmation_id
string | null
Maximum string length: 255
system_remarks
unknown
violation
boolean
violation_fee
string<decimal> | null
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
source_id
integer<int64> | null
Required range: 0 <= x <= 9223372036854776000
driver_agreement
integer | null
included_in_driver_invoice
integer | null
source_type
integer | null