latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Returns the current series available on account for a user If you're checking a date range and any 1 of those dates cannot be paid for by the pricing option, the call will return "Invalid data"

get/Consumer/Sales/User/Location/{LocationId}/ServicePaymentOptions

Query parameters

locationIdstring required
request.locationIdinteger

LocationId

request.appointmentTypeIdinteger

AppointmentTypeId

request.startstring date-time

Start date

request.endstring date-time

End date

request.dependentIdstring

Optional user if of a dependent. When used, will get the service options for that dependent instead of the custodian making the request.

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Response

OK

Namestring

Name

PaymentRefNointeger

Payment reference number

Remaininginteger

Remaining

Initialinteger

Initial

RemainingFromAllAppliedinteger

Remaining from all applied

ActiveDatestring date-time

Active date

ExpirationDatestring date-time

Expiration date