# Plan your integration

Source: https://developer.avalara.com/products/mylodge/integration-guides/mylodgetax/xsl0843779624916/

Guide: MyLodgeTax

# Plan your integration

Review the integration requirements to plan how to connect MyLodgeTax to your property management system or booking platform.

Review these integration requirements to understand what you need to integrate Avalara MyLodgeTax with your system. This overview of the integration setup helps you plan your approach before starting development.

## Onboarding

Understand the requirements and endpoints for successful onboarding integration.

This table outlines the key requirements, use cases, endpoints, and their necessity for onboarding integration.

Requirement

Use case

Endpoint/model

Required/conditional/suggested

[Onboard leads](/mylodgetax/dyg3486672965194/ "Learn how to use the addPartnerLead endpoint to create new partner leads and manage their account creation process.")

Your integration must provide a way to add or create new records for leads including their contact information and property location information.

[addPartnerLead](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Onboarding/addPartnerLead/)

Required

[Direct the customer to complete the registration process](/mylodgetax/zfr1948665822688/ "Learn how to use the registration link in the onboarding process for Avalara MyLodgeTax leads.")

Your integration must include a registration URL in the response body and surface it to the user so they can complete account registration.

[PostPartnerLeadsResponse](https://developer.avalara.com/api-reference/myLodgeAPI/overview-onboarding/models/PostPartnerLeadsResponse/)

Required

[Display onboarding status](/mylodgetax/vuh8596759573145/ "Learn how to view a customer's onboarding status using the getCustomerLocationsv2 endpoint.")

Your integration must provide users with a clear understanding of their onboarding status.

[getCustomerLocationsv2](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Customer%20Information/getCustomerLocationsv2/)

Required

## Property owner and location information

Understand the requirements and use cases for managing property owner and location information in your integration.

This table outlines the key requirements, use cases, endpoints, and conditions for managing property owner and location information in your integration.

Requirement

Use case

Endpoints/models

Required/conditional/suggested

[Location IDs](/mylodgetax/vls9957989599168/ "Understand the role of location IDs in managing rental properties and their creation during onboarding or location updates.")

Each location must be designated with a location ID that’s unique across all merchants and locations on your platform.

[addPartnerLead](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Onboarding/addPartnerLead/),

[addOrUpdateCustomerLocations](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Customer%20Information/addOrUpdateCustomerLocations/)

Required

[Add or update locations](/mylodgetax/iai3760659421587/ "Understand how to add new locations or update existing location information in MyLodgeTax.")

Your integration must allow users to add new locations and update existing location information.

[addOrUpdateCustomerLocations](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Customer%20Information/addOrUpdateCustomerLocations/)

Required

[Location tax rates](/mylodgetax/vtw9997522105937/ "Understand how to retrieve and interpret tax rate details for specific locations using Avalara's MyLodgeTax API.")

Your integration must allow users to see detailed or summary tax rate information for taxes owed by the location owner, based on the rental platform.

[getOwnerTaxDetail](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Tax%20Rate/getOwnerTaxDetail/),

[getOwnerTaxSummary](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Tax%20Rate/getOwnerTaxSummary/)

Required

[Location statuses](/mylodgetax/spd7456957769217/ "Understand the status codes for customer locations and how to retrieve them using Avalara APIs.")

Your integration must provide a way to retrieve status information for all locations defined for a customer.

[getCustomerLocations](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Customer%20Information/getCustomerLocations/)

Required

[Delete locations](/mylodgetax/uxm1193549786713/ "Learn how to delete customer locations using the deleteCustomerLocations endpoint.")

Your integration must provide a way to delete customer locations.

[deleteCustomerLocations](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Customer%20Information/deleteCustomerLocation/)

Required

## Revenue

Understand the requirements and use cases for revenue-related integrations.

This table outlines the key requirements, use cases, endpoints, and conditions for revenue-related integrations.

Requirement

Use case

Endpoint/model

Required/conditional/suggested

[Create and update transactions](/mylodgetax/prr8080814548621/)

Your integration must show that it successfully creates and updates transactions in MyLodgeTax.

[addOrUpdateRevenueTransactions](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Revenue/addOrUpdateRevenueTransaction/)

Required

[Delete transactions](/mylodgetax/foj6792328086636/)

If your source application supports voiding/deleting transactions, then your integration must update the corresponding MyLodgeTax transaction with the correct status.

[deleteRevenueTransactions](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Revenue/deleteRevenueTransaction/)

Conditional

## Avalara Managed Returns

Understand the requirements and use cases for tax return integrations.

This table outlines the key requirements, use cases, and endpoints for tax return integrations.

Requirement

Use case

Endpoint/model

Required/conditional/suggested

[View MyLodgeTax returns](/mylodgetax/mto5794798645522/)

Your integration must allow users to view a list of tax returns that a given transaction will be or has been paid on.

[getRevenueTransactionTaxReturns](https://developer.avalara.com/api-reference/myLodgeAPI/v1/methods/Tax%20Returns/getRevenueTransactionTaxReturns/)

Required