MyLodgeTax API - Overview and Onboarding - Models

Model Summary
Address

Represents a physical address. When used as input, all fields are required -except- addressLine2

ArrayOfOnboardingLocations

Array of Location objects

ArrayOfStateProvinces

Array of StateProvince objects

Customer

Represents a customer or potential customer. When used as input, all fields are required.

ErrorResponse

Generic response message containing error detail

GetStateProvincesResponse

Representation of a successful response from a GET /v1/countries/us/stateprovinces

OnboardingLocation

Represents a location being onboarded. When used as input, the address for location must currently be in the United States (country: us), and the stateProvince of the address must be one that matches list returned from /v1/countries/us/stateprovinces response

PostPartnerLeadsRequest

Request body definition for call to POST /v1/partnerleads

PostPartnerLeadsResponse

Representation of a successful response from a POST /v1/partnerleads operation

PostPartnerLeadsResponseErrorDataExists

Error response returned when customer or location with given id already exists.

StateProvince

Representation of a state or province within a country