This page is for Documentation, version Get certified.
For other versions, use one of these documentation indexes:
- Integration guides (default): https://avalara.ferndocs.com/docs/integration-guides/llms.txt
- Refactor guides: https://avalara.ferndocs.com/docs/refactor-guides/llms.txt
- Get certified: https://avalara.ferndocs.com/docs/get-certified/llms.txt
- Agent to Agent (A2A): https://avalara.ferndocs.com/docs/agent-to-agent-a2a/llms.txt
- AI use cases: https://avalara.ferndocs.com/docs/ai-use-cases/llms.txt
- API versioning: https://avalara.ferndocs.com/docs/api-versioning/llms.txt
Onboarding
| Name | Type | Description | Comments |
|---|---|---|---|
| Create a customer and add properties | Required | Create a new customer with the following information: * • Business Entity Data * ‐ First Name * ‐ Last Name * ‐ Email Address * ‐ Phone Number * ‐ Billing Address Add property data and include the following information: * • Location details * ‐ Location ID * ‐ Nickname * • Address information | |
| Direct customer to complete sign-up process | Required | Provide a URL in the response body directing users to complete the registration process. | Each link remains live for 90 days after generating. PMS monitors the notifications and will notifiy if any changes occur. |
| Display/confirm customer onboarding status | Required | Provide users with a clear understanding of their onboarding status with MyLodgeTax. Each time a customer is sent to the onboarding flow, pull the customer ID until it returns a successful response, indicating complete onboarding. |
(PMS) notification management
| Name | Type | Description | Comments |
|---|---|---|---|
| Respond to notifications | Required | The system must demonstrate the capability to respond appropriately to notifications received from the MyLodge Platform by initiating predefined actions or processes. Upon receipt of a homeowner notification, the system must trigger a comprehensive update procedure to refresh all associated property data for the specified homeowner. |
Property owner/location information
| Name | Type | Description | Comments |
|---|---|---|---|
| Location ID | Required | Location IDs must be unique across all merchants and locations on the platform. | |
| Add/update locations | Required | Allow users to update their locations and the location data. | |
| Delete locations | Required | Users need an ability to delete locations. | |
| Display location status | Required | Allow users to pull and review all location data. Locations must receive a tax rate prior to adding revenue. | |
| Display location tax rates | Suggested | You integration should provide the ability to view daily tax rate information for each location. |
Revenue
| Name | Type | Description | Comments |
|---|---|---|---|
| Add/update transactions | Required | Your integration should include the ability to add and update transactions to MyLodgeTax. The amount sent must be prior to any native tax calculation, as the calculation is done within MyLodgeTax. All new calls to revenue endpoint will update the revenue. | |
| Delete transactions | Conditional | When invoices are deleted/canceled, this information must be transmitted to MyLodgeTax. | If the source application supports void/delete, then the corresponding transaction in MyLodgeTax must be updated with the current transaction status. |
Tax returns
| Name | Type | Description | Comments |
|---|---|---|---|
| View summarized return information per property | Suggested | For a given location and transaction, users should have the ability to review summarized return information, including the jurisdiction name, form name, license number, due date, and filing status. |
Certification badge requirements. View on Avalara.