LogoLogo
User Guide
User Guide
  • Welcome to the Maica User Guide
  • Getting Started
    • Get Started with Maica
    • Your Maica Learning Path
    • The Maica Lifecycle
    • Salesforce Key Concepts
    • Maica Key Concepts
      • Participant
      • Resource
      • Price List
      • Asset
      • Service Agreement
      • Support Item
      • Appointment Service
      • Appointment
      • Shift
      • Location
      • Delivery Activity
      • Timesheet
      • Invoice
      • Checklist
    • Maica Usage Rules
  • Participants
    • Participant Profile
      • NDIS Funding
        • Synchronise Participant Information
        • Funding Record Overview
        • Service Booking Overview
        • Create Service Booking
        • Manage Service Booking
      • Home Care Package Funding
    • Billable Participant Notes
      • Take a Note
      • Custom Fields
      • Tasks
      • Files
    • Manage Preferences
    • Global Actions
      • New Appointment
      • New Shift
      • New Billable Participant Note
      • New Timesheet Entry
  • Resources
    • Resource Profile
  • The Planner
    • Planner Overview
    • Planner Views & Modes
      • Schedule
      • Participant View
      • Asset View
      • Accomodation View
      • Roster View
      • Shift View
    • Planner Actions
      • Order By
      • Group By
      • Select Date
      • Create new Appointment
      • Appointment Optimiser
      • Manage Unavailability
      • Billable Participant Note
    • Planner Filter
      • Basic Filters
      • Advanced Filters
  • Appointments
    • Create an Appointment
      • Basic Details
      • Location
      • Schedule
      • Additional Details
      • Custom Fields
      • Summary
      • Smart Selection Filter
    • Manage an Appointment
    • Appointment Actions
      • Check-In
      • Check-Out
      • Quick Completion
      • Cancellation
      • Attach Files
      • Participant Signatures
      • Appointment Breaks
      • Appointment Expenses
      • Participant Notes
      • Checklists
      • Open Appointment Profile
      • Google Maps
  • Shifts
    • Create a Shift
      • Basic Details
      • Location
      • Schedule
      • Additional Details
      • Shift Instructions
      • Custom Fields
      • Participant Notes
      • Summary
    • Manage a Shift
    • Shift Actions
      • Check-In
      • Check-Out
      • Quick Complete
      • Cancellation
      • Attach Files
      • Shift Breaks
      • Shift Expenses
      • Checklists
      • Shift Notes
      • Open Shift Profile
      • Google Maps
  • Timesheets
    • Timesheet Overview
      • Create a Timesheet Entry
      • Submit a Timesheet
  • Service Agreements
    • The Building Blocks
    • Agreement Management
      • NDIS Agreements
        • Manage Service Agreement
        • Manage Price List
      • Aged Care Agreements
        • Manage Budget
        • Manage Services
        • Discharge Services
  • Invoices
    • Invoice Overview
      • Invoice Line Item Overview
      • Payment Request Overview
    • Invoice Actions
      • Process an Invoice
      • Claim an Invoice
      • Reclaim an Invoice
      • Cancel an Invoice
      • Credit an Invoice
      • Sync with Xero
  • Integrations
    • Xero Integration Overview
    • Stripe Integration Overview
  • Troubleshooting
    • General Troubleshooting
  • ANNOUNCEMENTS
    • Support at Home Legislation
Powered by GitBook
On this page
  • What does the Xero Integration in Maica support?
  • Invoice Sync Process Overview
  • Invoice Payment Process Overview

Was this helpful?

Export as PDF
  1. Integrations

Xero Integration Overview

Get an overview of the Xero integration in Maica.

PreviousSync with XeroNextStripe Integration Overview

Last updated 8 months ago

Was this helpful?

What does the Xero Integration in Maica support?

In Maica, there are two main processes that the Xero Integration supports, these are:

  1. Invoice Sync Process

  2. Invoice Payment Process

This article further explains and provides an overview of both of those processes.

Syncing with Xero will only be supported if a Connection and Webhook has already been set up within your Organisation. Before attempting to Sync Invoices, please ensure this is the case. To learn more about configuring your Xero Integration, click . Syncing with Xero also requires your Support Items to be configured correctly. Please click to learn how to configure your Support Items in order to facilitate the Xero Integration.

Invoice Sync Process Overview

The Invoice Sync Process outlines the stages of Invoicing Syncing within Maica and Xero, as well as the outcomes of the process.

For clarity, any Italic text in the description refers to a record in Xero, and any standard text refers to a record in Maica.

Stage
Description
  1. Sync Executed

  1. Retrieve Invoice Data

During the Syncing process, Maica will retrieve the relevant Invoice (including Line Item and associated Participant) Data to share with Xero where the Invoice Finance_External_ID__c field is null. This essentially means that any Invoice that has not already been Synced or that had issues with a previous Sync will be retrieved.

  1. Check if Contact exists in Xero

Once Maica has retrieved the required Invoice Data, it will cross check if the Participant associated with the Invoice has an associated Contact in Xero.

  1. Create Contact

If there is no associated Contact in Xero for a Participant associated to an Invoice being Synced, one will be created.

  1. Update Contact

If there is an associated Contact in Xero for a Participant associated to an Invoice being Synced, it will be updated with the relevant information.

  1. Create Invoice

After the Invoices from Maica have been assigned to a Contact in Xero, an Invoice record will be created in Xero. Maica maps relevant information directly to Xero including the Invoice Reference Number and Date.

  1. Update Invoice

After an Invoice has been successfully synced, the Invoice Record in Maica will be updated accordingly. Two new fields will be automatically populated from Xero. These are the Xero Invoice Number and Xero ID.

  1. Process Ends

The process is complete.

Invoice Payment Process Overview

The Invoice Payment Process outlines the stages of Invoicing Payment within Xero and Maica, as well as the outcomes of the process.

As above, any Italic text in the description refers to a record in Xero, and any standard text refers to a record in Maica.

Stage
Description
  1. Payment Applied

The first stage of the Payment process is Payment being applied to the Invoice. Payment can be applied at any time, and can be done directly through the Invoice or through a reconciliation. Whether the Payment is Fully or Partially paid is irrelevant, the Payment Process will commence.

  1. Create Payment Record

  1. Update Invoice

After the Payment Record has been created, the associated will automatically update to reflect the Payment. Under Payment Information, the Total Payment Amount and Last Payment Date fields will populate.

  1. End

Payment Record Fields

As mentioned, after a Payment has been applied to an Invoice a Payment Record will be created. It includes a number of important fields, including:

Field
Description

Type

This field indicates the type of Payment Record, whether it is a transaction processed via Stripe or a Reconciliation following a Payment applied to an invoice in the Finance System (Xero).

Source

This field indicates how the Payment was created.

Paid

This field indicates if the Payment has been successfully processed. For example, the Invoice has been reconciled in Xero and synchronised with Maica.

Include

This field indicates if the Payment Amount should be included in the rollup to the Total Payment Amount on the Invoice record. The default value is checked.

Payment Date

This field indicates the Date & Time in which Payment was received

Finance External ID

The unique identifier of the Payment record in an external system. Maica uses this field as part of the Xero integration.

Payment Amount

The amount of the received Payment. This can be the full or a partial amount of the total Invoice.

The first stage of the Syncing process is the Sync itself. Maica has automation for Syncing invoices based on a Schedule that can be configured within the Maica - Xero Invoice Sync Scheduled Flow to match your organisations preferences. A Sync can also be manually executed if required, click here to learn how to manually .

Once a Payment has been made, an associated Payment Record will be created within the Invoice Record to reflect the Payment. This record includes a number of fields which are outlined in more detail in the table .

The process is complete and the takes over.

Sync an Invoice
below
here
here
Invoice Status Flow