Skip to content

Commit

Permalink
Update checkpoints-lending remove references to unlink endpoint.md
Browse files Browse the repository at this point in the history
Remove references to unlink connection endpoint following Xero feedback
  • Loading branch information
rmarcall authored Dec 17, 2024
1 parent 7c9940b commit 4bd55f5
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ While Codat handles the initial connection to Xero via the Codat Link UI, Xero r
| :-- | :-- |
| Display the name of the tenant that has been connected | This can be retrieved from our [Get company info](/lending-api#/operations/get-accounting-profile) endpoint. |
| Display the current status of the connection. If disconnected, provide a button to reconnect to Xero | Use our [Get connection](/lending-api#/operations/get-connection) endpoint to check the `status` of the connection and use the `linkUrl` to reconnect|
| Provide a button to terminate the connection | When a user clicks on the button, use our [Unlink connection](/lending-api#/operations/unlink-connection) endpoint to disconnect from Xero. |
| Provide a button to terminate the connection | When a user clicks on the button, use our [Delete connection](/platform-api#/operations/delete-connection) endpoint to disconnect from Xero. |
| Handle a disconnect from Xero's side | Use a webhook to listen to our [connection.disconnected](/using-the-api/webhooks/event-types) event that identifies when a disconnect happens. When the alert is triggered, change the connection status in your UI and display a "Reconnect" or "Connect" button. Xero recommends setting a regular daily sync of light data types so you can check each connected company's connection status every day.|
| Support one-to-one or multi-organizational connection | Codat allows your customers to select their Xero organization using the native Xero UI. You can enable them to connect to multiple organizations within Xero by creating a separate Codat company per organization. |
| Provide a disconnection process for off-boarding | Use our [Unlink connection](/lending-api#/operations/unlink-connection) endpoint to prevent further syncs or the [Delete connection](/lending-api#/operations/delete-connection) endpoint to prevent further syncs and querying of historically synced data.|
| Provide a disconnection process for off-boarding | Use our [Delete connection](/lending-api#/operations/delete-connection) endpoint to prevent further syncs and querying of historically synced data.|

### 4. Branding and naming

Expand Down

0 comments on commit 4bd55f5

Please sign in to comment.