Update a booking adjustments

PATCH 
/v1/bookings/:bookId/adjustments

Update a booking adjustments

Supported roles

• Fleet manager

Request

Path Parameters

bookId stringrequired

ID of booking

application/json

Body

required

bookId string
payable number
customerAdjustments object[]
Array [
reason string
amount number
]
supplierAdjustments object[]
Array [
reason string
amount number
]
onlyNewAdjustments boolean

Controls how adjustments are handled when updating a booking: - If true, new adjustments will be added to existing adjustments - If false, all current adjustments will be replaced by the request adjustments

Responses

200

Successful operation

application/json

Schema

Schema

bookId string
totalFare number
paidAmount number
amountDue number
paymentStatus string

Possible values: [paid, pending, partial]

customerAdjustments object[]
Array [
reason string
amount number
]
supplierAdjustments object[]
Array [
reason string
amount number
]

Example (from schema)

{
  "bookId": "string",
  "totalFare": 100,
  "paidAmount": 100,
  "amountDue": 0,
  "paymentStatus": "paid",
  "customerAdjustments": [
    {
      "reason": "string",
      "amount": 0
    }
  ],
  "supplierAdjustments": [
    {
      "reason": "string",
      "amount": 0
    }
  ]
}

400

Validation error

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Loading...