Connect Square to Xero and automate your tasks

Describe to build

Activity reports

Fully supported

MESA's Square to Xero integration is the fastest way to sync data between the two — without touching a line of code. Choose which fields to send, how they're formatted, and when the sync happens. Start with a pre-built template, customize it with AI, or build something completely unique in under 10 minutes.

Try MESA for free

★★★★★ 4.9 rating on Shopify App Store

Start when...

Personalize with built-in tools...

Then, do this...

Trusted by 1,000+ Shopify merchants

Why integrate Square with Xero

The Square to Xero integration helps you sync data, automate manual tasks, and keep your stack aligned — without writing code.

Data integration →

Sync Square transactions into your Shopify customer records

When a purchase is made in Square — in-store, at an event, at a pop-up — MESA creates or updates the customer's record in Shopify. Your ecommerce and physical sales channels share a single view of every customer.

Inventory management →

Keep inventory accurate across Square and Shopify

When a sale is made in Square, MESA updates the corresponding stock level in Shopify. Your online storefront reflects what was just sold in person without a manual sync between your point-of-sale and your store.

Customer experience →

Trigger post-purchase workflows from Square transactions

When a customer buys in Square, MESA kicks off the right next step in Shopify — adding a tag, enrolling them in a Klaviyo flow, updating a loyalty record. Your in-person sales feed the same automation as your online ones.

Data integration →

Send every Shopify order to Xero without manual entry

When an order is placed, MESA creates the corresponding record in Xero — customer, line items, amount — automatically. Your accounts stay current from the moment a sale happens without anyone re-entering data.

Order automation →

Generate Xero invoices from Shopify wholesale orders

When a B2B or wholesale order comes in, MESA creates an invoice in Xero and routes it to the right customer account. Your billing runs without the manual step between your store and your accounting software.

Customer experience →

Keep customer records consistent across Shopify and Xero

When a new customer places their first order, MESA creates or updates their record in Xero to match Shopify. Your accounting and your storefront always reflect the same customer without periodic reconciliation.

Build any Square and Xero automation

MESA helps you connect apps to automate repetitive tasks. A trigger is an event that starts a workflow, and actions are the steps that occur when it's running.

Account Updated

Starts when a new account is updated.

• Code

• Name

• Account ID

• Type

• Bank Account Number

• Status

• Description

• Bank Account Type

• Currency Code

• Tax Type

• Enable Payments To Account

• Show In Expense Claims

• Class

• System Account

• Reporting Code

• Reporting Code Name

• Updated Date U T C

• Add To Watchlist

Contact Updated

Starts when a contact is updated.

• Contact ID

• Merged To Contact ID

• Contact Number

• Account Number

• Contact Status

• Name

• First Name

• Last Name

• Company Number

• Email Address

• Skype User Name

• Contact Persons

• Bank Account Details

• Tax Number

• Accounts Receivable Tax Type

• Accounts Payable Tax Type

• Addresses

• Phones

• Is Supplier

• Is Customer

• Sales Default Line Amount Type

• Purchases Default Line Amount Type

• Default Currency

• Xero Network Key

• Sales Default Account Code

• Purchases Default Account Code

• Sales Tracking Categories

• Purchases Tracking Categories

• Tracking Category Name

• Tracking Category Option

• Payment Terms

• Updated Date U T C

• Contact Groups

• Website

• Branding Theme

• Discount

• Balances

• Attachments

• Status Attribute String

Employee Updated

Starts when an employee is updated.

• Employee ID

• Status

• First Name

• Last Name

• External Link

• Updated Date U T C

• Status Attribute String

Expense Claim Updated

Starts when an expense claim is updated.

• Expense Claim ID

• Status

• Payments

• User

• Receipts

• Updated Date U T C

• Total

• Amount Due

• Amount Paid

• Payment Due Date

• Reporting Date

• Receipt ID

Invoice Updated

Starts when an invoice is updated.

• Type

• Contact

• Line Items

• Date

• Due Date

• Line Amount Types

• Invoice Number

• Reference

• Branding Theme ID

• URL

• Currency Code

• Currency Rate

• Status

• Sent To Contact

• Expected Payment Date

• Planned Payment Date

• CISDeduction

• CISRate

• Sub Total

• Total Tax

• Total

• Total Discount

• Invoice ID

• Repeating Invoice ID

• Is Discounted

• Payments

• Prepayments

• Overpayments

• Amount Due

• Amount Paid

• Fully Paid On Date

• Amount Credited

• Updated Date U T C

• Credit Notes

• Attachments

• Has Errors

• Status Attribute String

Payment Updated

Starts when a payment is updated.

• Type

• Contact

• Line Items

• Date

• Due Date

• Line Amount Types

• Invoice Number

• Reference

• Branding Theme ID

• URL

• Currency Code

• Currency Rate

• Status

• Sent To Contact

• Expected Payment Date

• Planned Payment Date

• CISDeduction

• CISRate

• Sub Total

• Total Tax

• Total

• Total Discount

• Invoice ID

• Repeating Invoice ID

• Is Discounted

• Payments

• Prepayments

• Overpayments

• Amount Due

• Amount Paid

• Fully Paid On Date

• Amount Credited

• Updated Date U T C

• Credit Notes

• Attachments

• Has Errors

• Status Attribute String

Purchase Order Updated

Starts when a purchase order is updated.

• Contact ID

• Merged To Contact ID

• Contact Number

• Account Number

• Contact Status

• Name

• First Name

• Last Name

• Company Number

• Email Address

• Skype User Name

• Contact Persons

• Bank Account Details

• Tax Number

• Accounts Receivable Tax Type

• Accounts Payable Tax Type

• Addresses

• Phones

• Is Supplier

• Is Customer

• Sales Default Line Amount Type

• Purchases Default Line Amount Type

• Default Currency

• Xero Network Key

• Sales Default Account Code

• Purchases Default Account Code

• Sales Tracking Categories

• Purchases Tracking Categories

• Tracking Category Name

• Tracking Category Option

• Payment Terms

• Updated Date U T C

• Contact Groups

• Website

• Branding Theme

• Discount

• Balances

• Attachments

• Status Attribute String

Quote Updated

Starts when a quote is updated.

• Quote ID

• Quote Number

• Reference

• Terms

• Contact

• Line Items

• Date

• Date String

• Expiry Date

• Expiry Date String

• Status

• Currency Code

• Currency Rate

• Sub Total

• Total Tax

• Total

• Total Discount

• Title

• Summary

• Branding Theme ID

• Updated Date U T C

• Line Amount Types

• Status Attribute String

Receipt Updated

Starts when a receipt is updated.

• Date

• Contact

• Line Items

• User

• Reference

• Line Amount Types

• Sub Total

• Total Tax

• Total

• Receipt ID

• Status

• Receipt Number

• Updated Date U T C

• URL

• Attachments

User Updated

Starts when an user is updated.

• User ID

• Email Address

• First Name

• Last Name

• Updated Date U T C

• Is Subscriber

• Organisation Role

Catalog Item Created

Starts when a catalog item is created.

• Type

• ID

• Updated At

• Version

• Is Deleted

• Custom Attribute Values

• Catalog V1 Ids

• Present At All Locations

• Present At Location Ids

• Absent At Location Ids

• Item Data

• Category Data

• Item Variation Data

• Tax Data

• Discount Data

• Modifier List Data

• Modifier Data

• Time Period Data

• Product Set Data

• Pricing Rule Data

• Image Data

• Subscription Plan Data

• Item Option Data

• Item Option Value Data

• Custom Attribute Definition Data

• Subscription Plan Variation Data

Catalog Item Updated

Starts when a catalog item is updated.

• Type

• ID

• Updated At

• Version

• Is Deleted

• Custom Attribute Values

• Catalog V1 Ids

• Present At All Locations

• Present At Location Ids

• Absent At Location Ids

• Item Data

• Category Data

• Item Variation Data

• Tax Data

• Discount Data

• Modifier List Data

• Modifier Data

• Time Period Data

• Product Set Data

• Pricing Rule Data

• Image Data

• Subscription Plan Data

• Item Option Data

• Item Option Value Data

• Custom Attribute Definition Data

• Subscription Plan Variation Data

Customer Created

Starts when a customer is created.

• ID

• Created At

• Updated At

• Given Name

• Family Name

• Nickname

• Company Name

• Email Address

• Address

• Phone Number

• Birthday

• Reference ID

• Note

• Preferences

• Creation Source

• Group Ids

• Segment Ids

• Version

• Tax Ids

Customer Updated

Starts when a customer is updated.

• ID

• Created At

• Updated At

• Given Name

• Family Name

• Nickname

• Company Name

• Email Address

• Address

• Phone Number

• Birthday

• Reference ID

• Note

• Preferences

• Creation Source

• Group Ids

• Segment Ids

• Version

• Tax Ids

Invoice Added

Starts when an invoice is added.

• ID

• Version

• Location ID

• Order ID

• Primary Recipient

• Payment Requests

• Delivery Method

• Invoice Number

• Title

• Description

• Scheduled At

• Public URL

• Next Payment Amount Money

• Status

• Timezone

• Created At

• Updated At

• Accepted Payment Methods

• Custom Fields

• Subscription ID

• Sale Or Service Date

• Payment Conditions

• Store Payment Method Enabled

• Attachments

• Creator Team Member ID

Order Created

Starts when an order is created.

• ID

• Location ID

• Reference ID

• Source

• Line Items

• Taxes

• Discounts

• Service Charges

• Fulfillments

• Created At

• Updated At

• Closed At

• State

• Total Money

• Total Tax Money

• Total Discount Money

• Total Tip Money

• Total Service Charge Money

• Pricing Options

• Net Amount Due Money

Order Updated

Starts when an order is updated.

• ID

• Location ID

• Reference ID

• Source

• Line Items

• Taxes

• Discounts

• Service Charges

• Fulfillments

• Created At

• Updated At

• Closed At

• State

• Total Money

• Total Tax Money

• Total Discount Money

• Total Tip Money

• Total Service Charge Money

• Pricing Options

• Net Amount Due Money

Payment Created

Starts when a payment is created.

• ID

• Created At

• Updated At

• Amount Money

• Tip Money

• Total Money

• App Fee Money

• Approved Money

• Processing Fee

• Refunded Money

• Status

• Delay Duration

• Delay Action

• Delayed Until

• Source Type

• Card Details

• Cash Details

• Bank Account Details

• External Details

• Wallet Details

• Buy Now Pay Later Details

• Square Account Details

• Location ID

• Order ID

• Reference ID

• Customer ID

• Team Member ID

• Refund Ids

• Buyer Email Address

• Billing Address

• Shipping Address

• Note

• Statement Description Identifier

• Capabilities

• Receipt Number

• Receipt URL

• Device Details

• Application Details

• Is Offline Payment

• Offline Payment Details

• Version Token

Payment Updated

Starts when a payment is updated.

• ID

• Created At

• Updated At

• Amount Money

• Tip Money

• Total Money

• App Fee Money

• Approved Money

• Processing Fee

• Refunded Money

• Status

• Delay Duration

• Delay Action

• Delayed Until

• Source Type

• Card Details

• Cash Details

• Bank Account Details

• External Details

• Wallet Details

• Buy Now Pay Later Details

• Square Account Details

• Location ID

• Order ID

• Reference ID

• Customer ID

• Team Member ID

• Refund Ids

• Buyer Email Address

• Billing Address

• Shipping Address

• Note

• Statement Description Identifier

• Capabilities

• Receipt Number

• Receipt URL

• Device Details

• Application Details

• Is Offline Payment

• Offline Payment Details

• Version Token

Payout Created

Starts when a payout from the default location (associated with the seller) is created.

• ID

• Status

• Location ID

• Created At

• Updated At

• Amount Money

• Destination

• Version

• Type

• Payout Fee

• Arrival Date

• End To End ID

Refund Created

Starts when a refund is created.

• ID

• Location ID

• Transaction ID

• Tender ID

• Created At

• Reason

• Amount Money

• Status

• Processing Fee Money

Refund Updated

Starts when a refund is updated.

• ID

• Location ID

• Transaction ID

• Tender ID

• Created At

• Reason

• Amount Money

• Status

• Processing Fee Money

Bulk Create Contacts

Create multiple contacts.

• Contacts

Create a Purchase Order Attachment

Create an attachment for a purchase order.

Create Account

Create a new account.

• Code

• Name

• Account ID

• Type

• Bank Account Number

• Status

• Description

• Bank Account Type

• Currency Code

• Tax Type

• Enable Payments To Account

• Show In Expense Claims

• Reporting Code

• Add To Watchlist

Create Allocation for Overpayment

Create an allocation for an overpayment.

• Allocations

Create Attachment

Create an attachment for a specific account.

Create Attachment for Repeating Invoice

Create an attachment for a specific repeating invoice.

Create Bank Transaction

Create a bank transaction.

• Bank Transactions

Create Bank Transaction Attachment

Create an attachment for a bank transaction.

Create Bank Transfer

Create a bank transfer.

• Bank Transfers

Create Bank Transfer Attachment by File Name

Create a bank transfer attachment by file name.

Create Batch Payment

Create a batch payment.

Create Branding Theme Payment Service

Create a custom payment service for branding theme.

• Payment Services

Create Contact Attachment by File Name

Create a contact attachment by file name.

Create Contact for Contact Group

Create a contact for a contact group.

• Contacts

Create Contact Group

Create a contact group.

• Contact Groups

Create Credit Note

Create a new credit note.

• Credit Notes

Create Credit Note Allocation

Create an allocation for a credit note.

• Allocations

Create Credit Note Attachment

Create an attachment for a credit note.

• Include Online

Create Currency

Create a new currency.

• Code

• Description

Create Draft Fixed Asset

Create a draft fixed asset.

• Asset Name

• Asset ID

• Asset Type ID

• Asset Number

• Purchase Date

• Purchase Price

• Disposal Date

• Disposal Price

• Asset Status

• Warranty Expiry Date

• Serial Number

• Book Depreciation Setting

• Book Depreciation Detail

• Can Rollback

• Accounting Book Value

• Is Delete Enabled For Date

Create Employee

Create an employee.

• Employees

Create Expense Claim

Create an expense claim.

• Expense Claims

Create Feed Connection

Create new feed connection.

• Pagination

• Items

Create File Association

Create a new file association.

• File ID

• Object ID

• Object Group

• Object Type

Create Fixed Asset Type

Create a fixed asset type.

• Asset Type Name

• Book Depreciation Setting

• Asset Type ID

• Fixed Asset Account ID

• Depreciation Expense Account ID

• Accumulated Depreciation Account ID

• Locks

Create Folder

Create a new folder.

• Name

• File Count

• Email

• Is Inbox

• ID

Create History Record for Bank Transaction

Create a bank transaction history record.

• History Records

Create History Record for Bank Transfer

Create a bank transfer history record.

• History Records

Create History Record for Batch Payment

Create a history record for a batch payment.

Create History Record for Contact

Create a history record for a contact.

• History Records

Create History Record for Invoice

Create a history record for a specific invoice.

• History Records

Create History Record for Item

Create a history record for an item.

• History Records

Create History Record for Manual Journal

Create a history record for a manual journal.

• History Records

Create History Record for Overpayment

Create a history record for an overpayment.

• History Records

Create History Record for Payment

Create a history record for a payment.

• History Records

Create History Record for Prepayment

Create a prepayment history record.

• History Records

Create History Record for Purchase Order

Create a history record for a specific purchase order.

• History Records

Create History Record for Quote

Create a history record for a quote.

• History Records

Create History Record for Repeating Invoices

Create a history record for a repeating invoice.

• History Records

Create Invoice

Create an invoice.

• Invoices

Create Invoice's Attachment by File Name

Create an attachment for an invoice or purchase bill by filename.

• Include Online

Create Item

Create an item.

• Items

Create Leave Application

Create a leave application.

Create Linked Transaction

Create a linked transaction.

• Contact ID

• Source Transaction ID

• Source Line Item ID

• Target Transaction ID

• Target Line Item ID

• Linked Transaction ID

• Status

• Type

• Source Transaction Type Code

Create Manual Journal Attachment

Create an attachment for a manual journal.

Create Manual Journals

Create a manual journal.

• Manual Journals

Create Multiple Payments for Invoices or Credit Notes

Create multiple payments for invoices or credit notes.

• Payments

Create or Update Contacts

Create or modify contacts.

• Contacts

Create or Update Credit Notes

Create or modify an existing credit note.

• Credit Notes

Create or Update Employee

Create or update an employee.

• Employees

Create or Update Item

Create or modify an existing item.

• Items

Create or Update Manual Journal

Create or modify existing manual journal.

• Manual Journals

Create or Update Purchase Order

Create or modify existing purchase order.

• Purchase Orders

Create or Update Quote

Create or modify an existing quote.

• Quotes

Create or Update Repeating Invoice's

Create or modify an existing repeating invoice.

• Repeating Invoices

Create Pay Item

Create a pay item.

• Earnings Rates

• Deduction Types

• Leave Types

• Reimbursement Types

Create Pay Run

Create a pay run.

Create Payment for Invoices or Credit Notes

Create a payment for invoices or credit notes.

• Invoice

• Invoice Number

• Credit Note Number

• Account

• Code

• Date

• Currency Rate

• Amount

• Bank Amount

• Reference

• Is Reconciled

• Status

• Payment ID

• Batch Payment ID

• Bank Account Number

• Particulars

• Details

• Has Account

• Status Attribute String

Create Payment Service

Create a payment service.

• Payment Services

Create Payroll Calendar

Create a payroll calendar.

Create Prepayment

Create an allocation for prepayment.

• Allocations

Create Project

Create a project(s).

• Name

• Contact ID

• Estimate Amount

• Deadline Utc

Create Purchase Order

Create one or more purchase orders.

• Purchase Orders

Create Quote

Create one or more quotes.

• Quotes

Create Quote Attachment

Create an attachment for a quote.

Create Repeating Invoice Template

Create one or more repeating invoice templates.

• Repeating Invoices

Create Statement

Create one or more new statements.

• Pagination

• Items

Create Superfund

Create a superfund.

Create Task

Create a task.

• Name

• Charge Type

• Rate

• Estimate Minutes

Create Tax Rates

Create one or more tax rates.

• Tax Rates

Create Time Entry for Project

Create a time entry for a project.

• User ID

• Task ID

• Date Utc

• Duration

• Description

Create Timesheet

Create a timesheet.

Create Tracking Company

Create a tracking company.

• Tracking Category ID

• Tracking Option ID

• Name

• Option

• Status

• Options

Creates a Credit Note History

Create a credit note history.

• Details

• Changes

• User

• Date U T C

Creates History Record for Expense Claim

Create a history record for an expense claim.

• Details

• Changes

• User

• Date U T C

Creates Options for Tracking Category

Create tracking category options.

• Tracking Option ID

• Name

• Status

• Tracking Category ID

Creates Project for Contact

Create a project for a contact.

Delete Account

Remove an account.

• Code

• Name

• Account ID

• Type

• Bank Account Number

• Status

• Description

• Bank Account Type

• Currency Code

• Tax Type

• Enable Payments To Account

• Show In Expense Claims

• Class

• System Account

• Reporting Code

• Reporting Code Name

• Updated Date U T C

• Add To Watchlist

Delete Connection

Remove a connection.

Delete Contact from Contact Group

Remove a contact from a contact group.

Delete Contacts from Contact Group

Remove all contacts from a specific contact group.

Delete Feed Connection

Remove an existing feed connection.

• Page

• Page Size

• Page Count

• Item Count

Delete File

Remove a specific file.

Delete File Association

Remove an existing file association.

Delete Folder

Remove a folder.

Delete Item

Remove a specific item.

Delete Linked Transaction

Remove a linked transaction.

Delete Project's Time Entry

Remove a time entry for a project.

Delete Task

Remove a task.

Delete Tracking Category

Remove a tracking category.

• Tracking Category ID

• Tracking Option ID

• Name

• Option

• Status

• Options

Delete Tracking Category's Option

Remove a specific tracking category option.

• Tracking Option ID

• Name

• Status

• Tracking Category ID

Get List of 1099 Reports

Obtain a list of 1099 reports.

• Report Name

• Report Type

• Report Title

• Report Date

• Updated Date U T C

• Contacts

Get List of Account's Usage

Obtain a list of account's usage.

• Organisation ID

• Start Month

• End Month

• Account Usage

Get List of Accounting Bank Statements

Obtain a list of accounting bank statements.

• Bank Account ID

• Bank Account Name

• Bank Account Currency Code

• Statements

Get List of Accounts

Obtain a list of accounts.

• Code

• Name

• Account ID

• Type

• Bank Account Number

• Status

• Description

• Bank Account Type

• Currency Code

• Tax Type

• Enable Payments To Account

• Show In Expense Claims

• Class

• System Account

• Reporting Code

• Reporting Code Name

• Updated Date U T C

• Add To Watchlist

Get List of Aged Payables by Contact Reports

Obtain a list of aged payables by contact reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Aged Receivables by Contact Reports

Obtain a list of aged receivables by contact reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Asset Type

Obtain a list of asset types.

• Asset Type ID

• Asset Type Name

• Fixed Asset Account ID

• Depreciation Expense Account ID

• Accumulated Depreciation Account ID

• Book Depreciation Setting

• Locks

Get List of Assets

Obtain a list of assets.

• Page

• Page Size

• Page Count

• Item Count

Get List of Attachments

Obtain a list of account's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Balance Sheet Reports

Obtain a list of balance sheet reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Balance Sheet Reports

Obtain a list of balance sheet reports.

• Balance Date

• Asset

• Liability

• Equity

Get List of Bank Summary Reports

Obtain a list of bank summary reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Bank Transaction Attachments

Obtain a list of bank transaction attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Bank Transactions

Obtain a list of bank transactions.

• Type

• Contact

• Line Items

• Bank Account

• Is Reconciled

• Date

• Reference

• Currency Code

• Currency Rate

• URL

• Status

• Line Amount Types

• Sub Total

• Total Tax

• Total

• Bank Transaction ID

• Prepayment ID

• Overpayment ID

• Updated Date U T C

• Status Attribute String

Get List of Bank Transfer's Attachments

Obtain a list of bank transfer's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Bank Transfers

Obtain a list of bank transfers.

• From Bank Account

• To Bank Account

• Amount

• Date

• Bank Transfer ID

• Currency Rate

• From Bank Transaction ID

• To Bank Transaction ID

• From Is Reconciled

• To Is Reconciled

• Reference

• Created Date U T C

Get List of Batch Payments

Obtain a list of batch payments.

Get List of Branding Theme's Payment Services

Obtain a list of branding theme's payment services.

• Payment Service ID

• Payment Service Name

• Payment Service URL

• Pay Now Text

• Payment Service Type

Get List of Branding Themes

Obtain a list of branding themes.

• Branding Theme ID

• Name

• Logo URL

• Type

• Sort Order

• Created Date U T C

Get List of Budget Summary Reports

Obtain a list of budget summary reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Budgets

Obtain a list of budgets.

• Budget ID

• Type

• Description

• Updated Date U T C

• Budget Lines

• Tracking

Get List of Cash Flow Reports

Obtain a list of cash flow reports.

• Start Date

• End Date

• Cash Balance

• Cashflow Activities

Get List of Cash Validations

Obtain a list of cash validations.

• Account ID

• Statement Balance

• Statement Balance Date

• Bank Statement

• Cash Account

Get List of CIS Settings for Contact

Obtain a list of construction industry scheme settings for a contact.

• CISEnabled

• Rate

Get List of Connections

Obtain a list of connections.

Get List of Contact Groups

Obtain a list of contact groups.

• Name

• Status

• Contact Group ID

• Contacts

Get List of Contact's Attachments

Obtain a list of contact's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Contact's History Records

Obtain a list of contact's history records.

• Details

• Changes

• User

• Date U T C

Get List of Contacts

Obtain a list of contacts.

• Contact ID

• Merged To Contact ID

• Contact Number

• Account Number

• Contact Status

• Name

• First Name

• Last Name

• Company Number

• Email Address

• Skype User Name

• Contact Persons

• Bank Account Details

• Tax Number

• Accounts Receivable Tax Type

• Accounts Payable Tax Type

• Addresses

• Phones

• Is Supplier

• Is Customer

• Sales Default Line Amount Type

• Purchases Default Line Amount Type

• Default Currency

• Xero Network Key

• Sales Default Account Code

• Purchases Default Account Code

• Sales Tracking Categories

• Purchases Tracking Categories

• Tracking Category Name

• Tracking Category Option

• Payment Terms

• Updated Date U T C

• Contact Groups

• Website

• Branding Theme

• Discount

• Balances

• Attachments

• Status Attribute String

Get List of Credit Note's Attachments

Obtain a list of credit note's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Credit Note's History

Obtain a list of credit note's history.

• Details

• Changes

• User

• Date U T C

Get List of Credit Note's PDFs

Obtain a list of credit note's pdfs.

Get List of Credit Notes

Obtain a list of credit notes.

• Type

• Contact

• Date

• Due Date

• Status

• Line Amount Types

• Line Items

• Sub Total

• Total Tax

• Total

• CISDeduction

• CISRate

• Updated Date U T C

• Currency Code

• Fully Paid On Date

• Credit Note ID

• Credit Note Number

• Reference

• Sent To Contact

• Currency Rate

• Remaining Credit

• Allocations

• Applied Amount

• Payments

• Branding Theme ID

• Status Attribute String

• Has Errors

Get List of Currencies

Obtain a list of currencies.

• Code

• Description

Get List of Employees

Obtain a list of employees.

• Employee ID

• Status

• First Name

• Last Name

• External Link

• Updated Date U T C

• Status Attribute String

Get List of Executive Summary Reports

Obtain a list of executive summary reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Expense Claim's History Records

Obtain a list of expense claim's history records.

• Details

• Changes

• User

• Date U T C

Get List of Expense Claims

Obtain a list of expense claims.

• Expense Claim ID

• Status

• Payments

• User

• Receipts

• Updated Date U T C

• Total

• Amount Due

• Amount Paid

• Payment Due Date

• Reporting Date

• Receipt ID

Get List of Expense Contacts Reports

Obtain a list of expense reports by contacts.

• Start Date

• End Date

• Total

• Total Detail

• Total Other

• Contacts

• Manual Journals

Get List of Feed Connections

Obtain a list of feed connections.

• Page

• Page Size

• Page Count

• Item Count

Get List of File's Associations

Obtain a list of file's associations.

• File ID

• Object ID

• Object Group

• Object Type

Get List of Files

Obtain a list of files.

• Total Count

• Page

• Per Page

• Items

Get List of Finalized GST Reports

Obtain a list of finalized GST reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Fixed Asset Settings

Obtain a list of fixed asset settings.

• Asset Number Prefix

• Asset Number Sequence

• Asset Start Date

• Last Depreciation Date

• Default Gain On Disposal Account ID

• Default Loss On Disposal Account ID

• Default Capital Gain On Disposal Account ID

• Opt In For Tax

Get List of Folders

Obtain a list of folders.

• Name

• File Count

• Email

• Is Inbox

• ID

Get List of Inboxes

Obtain a list of inboxes.

• Name

• File Count

• Email

• Is Inbox

• ID

Get List of Invoice PDFs

Obtain a list of invoice pdfs.

Get List of Invoice Reminder's Settings

Obtain a list of invoice reminder's settings.

• Enabled

Get List of Invoice's Attachments

Obtain a list of invoice's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Invoice's History Records

Obtain a list of invoice's history records.

• Details

• Changes

• User

• Date U T C

Get List of Invoices

Obtain a list of invoices.

• Type

• Contact

• Line Items

• Date

• Due Date

• Line Amount Types

• Invoice Number

• Reference

• Branding Theme ID

• URL

• Currency Code

• Currency Rate

• Status

• Sent To Contact

• Expected Payment Date

• Planned Payment Date

• CISDeduction

• CISRate

• Sub Total

• Total Tax

• Total

• Total Discount

• Invoice ID

• Repeating Invoice ID

• Is Discounted

• Payments

• Prepayments

• Overpayments

• Amount Due

• Amount Paid

• Fully Paid On Date

• Amount Credited

• Updated Date U T C

• Credit Notes

• Attachments

• Has Errors

• Status Attribute String

Get List of Items

Obtain a list of items.

• Code

• Inventory Asset Account Code

• Name

• Is Sold

• Is Purchased

• Description

• Purchase Description

• Purchase Details

• Sales Details

• Is Tracked As Inventory

• Total Cost Pool

• Quantity On Hand

• Updated Date U T C

• Item ID

• Status Attribute String

Get List of Journals

Obtain a list of journals.

• Journal ID

• Journal Date

• Journal Number

• Created Date U T C

• Reference

• Source ID

• Source Type

• Journal Lines

Get List of Leave Applications

Obtain a list of leave applications.

• Leave Application ID

• Employee ID

• Leave Type ID

• Title

• Start Date

• End Date

• Description

• Pay Out Type

• Leave Periods

• Updated Date U T C

Get List of Linked Transaction

Obtain a list of linked transaction.

• Source Transaction ID

• Source Line Item ID

• Contact ID

• Target Transaction ID

• Target Line Item ID

• Linked Transaction ID

• Status

• Type

• Updated Date U T C

• Source Transaction Type Code

Get List of Lock History

Obtain a list of lock history.

• Organisation ID

• End Date

• Lock Dates

Get List of Manual Journal's Attachments

Obtain a list of manual journal's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Manual Journal's History

Obtain a list of manual journal's history.

• Details

• Changes

• User

• Date U T C

Get List of Manual Journals

Obtain a list of manual journals.

• Narration

• Journal Lines

• Date

• Line Amount Types

• Status

• URL

• Show On Cash Basis Reports

• Updated Date U T C

• Manual Journal ID

• Status Attribute String

• Attachments

Get List of Organization's CIS Settings

Obtain a list of organization's CIS settings.

• C I S Contractor Enabled

• C I S Sub Contractor Enabled

• Rate

Get List of Overpayment's History

Obtain a list of overpayment's history.

• Details

• Changes

• User

• Date U T C

Get List of Overpayments

Obtain a list of overpayments.

• Type

• Contact

• Date

• Status

• Line Amount Types

• Line Items

• Sub Total

• Total Tax

• Total

• Updated Date U T C

• Currency Code

• Overpayment ID

• Currency Rate

• Remaining Credit

• Allocations

• Applied Amount

• Payments

• Attachments

Get List of Pay Items

Obtain a list of pay items.

• Earnings Rates

• Deduction Types

• Leave Types

• Reimbursement Types

Get List of Pay Runs

Obtain a list of pay runs.

• Payroll Calendar ID

• Pay Run ID

• Pay Run Period Start Date

• Pay Run Period End Date

• Pay Run Status

• Payment Date

• Payslip Message

• Updated Date U T C

• Payslips

• Wages

• Deductions

• Tax

• Super

• Reimbursement

• Net Pay

Get List of Payment Services

Obtain a list of payment services.

• Payment Service ID

• Payment Service Name

• Payment Service URL

• Pay Now Text

• Payment Service Type

Get List of Payment's History Records

Obtain a list of payment's history records.

• Details

• Changes

• User

• Date U T C

Get List of Payments for Invoices & Credit Notes

Obtain a list of payments for invoices and credit notes.

• Invoice

• Invoice Number

• Credit Note Number

• Account

• Code

• Date

• Currency Rate

• Amount

• Bank Amount

• Reference

• Is Reconciled

• Status

• Payment Type

• Updated Date U T C

• Payment ID

• Batch Payment ID

• Bank Account Number

• Particulars

• Details

• Has Account

• Status Attribute String

Get List of Payroll Calendars

Obtain a list of payroll calendars.

• Name

• Calendar Type

• Start Date

• Payment Date

• Payroll Calendar ID

• Updated Date U T C

• Reference Date

Get List of Payroll Settings

Obtain a list of payroll settings.

• Accounts

• Tracking Categories

• Days In Payroll Year

• Employees Are S T P2

Get List of Prepayment's History Records

Obtain a list of prepayment history records.

• Details

• Changes

• User

• Date U T C

Get List of Prepayments

Obtain a list of prepayments.

• Type

• Contact

• Date

• Status

• Line Amount Types

• Line Items

• Sub Total

• Total Tax

• Total

• Reference

• Updated Date U T C

• Currency Code

• Prepayment ID

• Currency Rate

• Remaining Credit

• Allocations

• Payments

• Applied Amount

• Attachments

Get List of Profit & Loss Reports

Obtain a list of profit & loss reports.

• Start Date

• End Date

• Net Profit Loss

• Revenue

• Expense

Get List of Profit and Loss Reports

Obtain a list of profit and loss reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Project Tasks

Obtain a list of project tasks.

• Page

• Page Size

• Page Count

• Item Count

Get List of Project Users

Obtain a list of project users.

• Page

• Page Size

• Page Count

• Item Count

Get List of Project's Time Entries

Obtain a list of time entries for a project.

• Page

• Page Size

• Page Count

• Item Count

Get List of Projects

Obtain a list of projects.

• Page

• Page Size

• Page Count

• Item Count

Get List of Purchase Order's Attachments

Obtain a list of purchase order's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Purchase Order's History

Obtain a list of purchase order's history.

• Details

• Changes

• User

• Date U T C

Get List of Purchase Orders

Obtain a list of purchase orders.

• Contact

• Line Items

• Date

• Delivery Date

• Line Amount Types

• Purchase Order Number

• Reference

• Branding Theme ID

• Currency Code

• Status

• Sent To Contact

• Delivery Address

• Attention To

• Telephone

• Delivery Instructions

• Expected Arrival Date

• Purchase Order ID

• Currency Rate

• Sub Total

• Total Tax

• Total

• Total Discount

• Updated Date U T C

• Status Attribute String

• Attachments

Get List of Quote's Attachments

Obtain a list of a quote's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Quote's History

Obtain a list of quote's history.

• Details

• Changes

• User

• Date U T C

Get List of Repeating Invoice's Attachments

Obtain a list of repeat invoice's attachments.

• Attachment ID

• File Name

• URL

• Mime Type

• Content Length

• Include Online

Get List of Repeating Invoice's History

Obtain a list of repeating invoice's history.

• Details

• Changes

• User

• Date U T C

Get List of Repeating Invoices

Obtain a list of repeating invoices.

• Type

• Contact

• Schedule

• Line Items

• Line Amount Types

• Reference

• Branding Theme ID

• Currency Code

• Status

• Sub Total

• Total Tax

• Total

• Repeating Invoice ID

• ID

• Attachments

• Approved For Sending

• Send Copy

• Mark As Sent

• Include P D F

Get List of Report Histories

Obtain a list of report histories.

• Organisation ID

• End Date

• Reports

Get List of Revenue Contacts Reports

Obtain a list of revenue report by contacts.

• Start Date

• End Date

• Total

• Total Detail

• Total Other

• Contacts

• Manual Journals

Get List of Sales Quotes

Obtain a list of sales quotes.

• Quote ID

• Quote Number

• Reference

• Terms

• Contact

• Line Items

• Date

• Date String

• Expiry Date

• Expiry Date String

• Status

• Currency Code

• Currency Rate

• Sub Total

• Total Tax

• Total

• Total Discount

• Title

• Summary

• Branding Theme ID

• Updated Date U T C

• Line Amount Types

• Status Attribute String

Get List of Statements

Obtain a list of statements.

• Page

• Page Size

• Page Count

• Item Count

Get List of Subscription's Usage Records

Obtain a list of subscription's usage records.

Get List of Superfund Products

Obtain a list of superfund products.

• ABN

• USI

• SPIN

• Product Name

Get List of Superfunds

Obtain a list of superfunds.

• Super Fund ID

• Type

• Name

• ABN

• BSB

• Account Number

• Account Name

• Electronic Service Address

• Employer Number

• SPIN

• USI

• Updated Date U T C

Get List of Tax Rates

Obtain a list of tax rates.

• Name

• Tax Type

• Tax Components

• Status

• Report Tax Type

• Can Apply To Assets

• Can Apply To Equity

• Can Apply To Expenses

• Can Apply To Liabilities

• Can Apply To Revenue

• Display Tax Rate

• Effective Rate

Get List of Timesheets

Obtain a list of timesheets.

• Employee ID

• Start Date

• End Date

• Status

• Hours

• Timesheet ID

• Timesheet Lines

• Updated Date U T C

Get List of Tracking Categories and Options

Obtain a list of tracking categories and options.

• Tracking Category ID

• Tracking Option ID

• Name

• Option

• Status

• Options

Get List of Trial Balance Reports

Obtain a list of trial balance reports.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Get List of Trial Balance Reports

Obtain a list of trial balance reports.

• Start Date

• End Date

• Accounts

Get List of User's Activities

Obtain a list of user's activities.

• Organisation ID

• Data Month

• Users

Get List of Users

Obtain a list of users.

• User ID

• Email Address

• First Name

• Last Name

• Updated Date U T C

• Is Subscriber

• Organisation Role

Retrieve Account

Grab all details about an account.

• Code

• Name

• Account ID

• Type

• Bank Account Number

• Status

• Description

• Bank Account Type

• Currency Code

• Tax Type

• Enable Payments To Account

• Show In Expense Claims

• Class

• System Account

• Reporting Code

• Reporting Code Name

• Updated Date U T C

• Add To Watchlist

Retrieve Association Count

Grab all details about an association count.

Retrieve Association Object

Grab all details about an association object.

• File ID

• Object ID

• Object Group

• Object Type

Retrieve Attachment by Attachment File Name

Grab all details about an account's attachment.

Retrieve Attachment by Attachment ID

Grab all details about an account's attachment.

Retrieve Bank Transaction

Grab all details about a bank transaction.

• Type

• Contact

• Line Items

• Bank Account

• Is Reconciled

• Date

• Reference

• Currency Code

• Currency Rate

• URL

• Status

• Line Amount Types

• Sub Total

• Total Tax

• Total

• Bank Transaction ID

• Prepayment ID

• Overpayment ID

• Updated Date U T C

• Status Attribute String

Retrieve Bank Transaction Attachment

Grab all details about a specific bank transaction attachment.

Retrieve Bank Transaction's Attachment by File Name

Grab all details about a bank transaction's attachment by file name.

Retrieve Bank Transaction's History

Grab all details about a bank transaction's history.

• Details

• Changes

• User

• Date U T C

Retrieve Bank Transfer

Grab all details about a bank transfer.

• From Bank Account

• To Bank Account

• Amount

• Date

• Bank Transfer ID

• Currency Rate

• From Bank Transaction ID

• To Bank Transaction ID

• From Is Reconciled

• To Is Reconciled

• Reference

• Created Date U T C

Retrieve Bank Transfer History

Grab all history details for a bank transfer.

• Details

• Changes

• User

• Date U T C

Retrieve Bank Transfer's Attachment

Grab all details about a bank transfer's attachment.

Retrieve Bank Transfer's Attachment by File Name

Grab all details about a bank transfer's attachment by file name.

Retrieve Batch Payment

Grab all details of a specific batch payment.

Retrieve Batch Payment History

Grab all details about the batch payment history.

Retrieve Branding Theme

Grab all details about a branding theme.

• Branding Theme ID

• Name

• Logo URL

• Type

• Sort Order

• Created Date U T C

Retrieve Budget

Grab all details about a specific budget including budget lines.

• Budget ID

• Type

• Description

• Updated Date U T C

• Budget Lines

• Tracking

Retrieve Contact

Grab all details about an existing contact.

• Contact ID

• Merged To Contact ID

• Contact Number

• Account Number

• Contact Status

• Name

• First Name

• Last Name

• Company Number

• Email Address

• Skype User Name

• Contact Persons

• Bank Account Details

• Tax Number

• Accounts Receivable Tax Type

• Accounts Payable Tax Type

• Addresses

• Phones

• Is Supplier

• Is Customer

• Sales Default Line Amount Type

• Purchases Default Line Amount Type

• Default Currency

• Xero Network Key

• Sales Default Account Code

• Purchases Default Account Code

• Sales Tracking Categories

• Purchases Tracking Categories

• Tracking Category Name

• Tracking Category Option

• Payment Terms

• Updated Date U T C

• Contact Groups

• Website

• Branding Theme

• Discount

• Balances

• Attachments

• Status Attribute String

Retrieve Contact by Contact Number

Grab all details about a contact by contact number.

Retrieve Contact Group

Grab all details about a contact group.

• Name

• Status

• Contact Group ID

• Contacts

Retrieve Contact's Attachment

Grab all details about a contact's attachment.

Retrieve Contact's Attachment by File Name

Grab all details about a contact's attachment by file name.

Retrieve Credit Note

Grab all details about a credit note.

• Type

• Contact

• Date

• Due Date

• Status

• Line Amount Types

• Line Items

• Sub Total

• Total Tax

• Total

• CISDeduction

• CISRate

• Updated Date U T C

• Currency Code

• Fully Paid On Date

• Credit Note ID

• Credit Note Number

• Reference

• Sent To Contact

• Currency Rate

• Remaining Credit

• Allocations

• Applied Amount

• Payments

• Branding Theme ID

• Status Attribute String

• Has Errors

Retrieve Credit Note's Attachment

Grab all details about a credit note's attachment.

Retrieve Credit Note's Attachment by File Name

Grab all details about a credit note's attachment by file name.

Retrieve Employee

Grab details of a specific employee.

• Employee ID

• Status

• First Name

• Last Name

• External Link

• Updated Date U T C

• Status Attribute String

Retrieve Expense Claim

Grab all details about an expense claim.

• Expense Claim ID

• Status

• Payments

• User

• Receipts

• Updated Date U T C

• Total

• Amount Due

• Amount Paid

• Payment Due Date

• Reporting Date

• Receipt ID

Retrieve Feed Connection

Grab all details about a feed connection.

• ID

• Account Token

• Account Number

• Account Name

• Account ID

• Account Type

• Currency

• Country

• Status

• Error

Retrieve File

Grab all details about file.

• Name

• Mime Type

• Size

• Created Date Utc

• Updated Date Utc

• User

• ID

• Folder ID

Retrieve File's Content

Retrieve the file's content.

Retrieve Fixed Asset

Grab all details of a fixed asset.

• Asset ID

• Asset Name

• Asset Type ID

• Asset Number

• Purchase Date

• Purchase Price

• Disposal Date

• Disposal Price

• Asset Status

• Warranty Expiry Date

• Serial Number

• Book Depreciation Setting

• Book Depreciation Detail

• Can Rollback

• Accounting Book Value

• Is Delete Enabled For Date

Retrieve Folder

Grab all details about a folder.

• Name

• File Count

• Email

• Is Inbox

• ID

Retrieve invoice

Grab all details about an invoice.

• Type

• Contact

• Line Items

• Date

• Due Date

• Line Amount Types

• Invoice Number

• Reference

• Branding Theme ID

• URL

• Currency Code

• Currency Rate

• Status

• Sent To Contact

• Expected Payment Date

• Planned Payment Date

• CISDeduction

• CISRate

• Sub Total

• Total Tax

• Total

• Total Discount

• Invoice ID

• Repeating Invoice ID

• Is Discounted

• Payments

• Prepayments

• Overpayments

• Amount Due

• Amount Paid

• Fully Paid On Date

• Amount Credited

• Updated Date U T C

• Credit Notes

• Attachments

• Has Errors

• Status Attribute String

Retrieve Invoice's Attachment

Grab all details about an invoice's attachment.

Retrieve Invoice's Attachment by File Name

Grab all details about an invoice's attachment by file name.

Retrieve Item

Grab all details about an item.

• Code

• Inventory Asset Account Code

• Name

• Is Sold

• Is Purchased

• Description

• Purchase Description

• Purchase Details

• Sales Details

• Is Tracked As Inventory

• Total Cost Pool

• Quantity On Hand

• Updated Date U T C

• Item ID

• Status Attribute String

Retrieve Item's History

Grab all details about an item's history.

• Details

• Changes

• User

• Date U T C

Retrieve Journal

Grab all details about the journal.

• Journal ID

• Journal Date

• Journal Number

• Created Date U T C

• Reference

• Source ID

• Source Type

• Journal Lines

Retrieve Journal by Journal Number

Grab all details about the journal by journal number.

• Journal ID

• Journal Date

• Journal Number

• Created Date U T C

• Reference

• Source ID

• Source Type

• Journal Lines

Retrieve Leave Application

Grab all details about a leave application.

• Leave Application ID

• Employee ID

• Leave Type ID

• Title

• Start Date

• End Date

• Description

• Pay Out Type

• Leave Periods

• Updated Date U T C

Retrieve Linked Transaction

Grab all details of a linked transaction.

• Source Transaction ID

• Source Line Item ID

• Contact ID

• Target Transaction ID

• Target Line Item ID

• Linked Transaction ID

• Status

• Type

• Updated Date U T C

• Source Transaction Type Code

Retrieve Manual Journal

Grab all details about a manual journal.

• Narration

• Journal Lines

• Date

• Line Amount Types

• Status

• URL

• Show On Cash Basis Reports

• Updated Date U T C

• Manual Journal ID

• Status Attribute String

• Attachments

Retrieve Manual Journal's Attachment

Grab all details about a manual journal's attachment.

Retrieve Manual Journal's Attachment by File Name

Grab all details about a manual journal's attachment by file name.

Retrieve Online Invoice URL

Grab all details about an online invoice url.

• Online Invoice URL

Retrieve Organization

Grab all details about an organization.

• Organisation ID

• APIKey

• Name

• Legal Name

• Pays Tax

• Version

• Organisation Type

• Base Currency

• Country Code

• Is Demo Company

• Organisation Status

• Registration Number

• Employer Identification Number

• Tax Number

• Financial Year End Day

• Financial Year End Month

• Sales Tax Basis

• Sales Tax Period

• Default Sales Tax

• Default Purchases Tax

• Period Lock Date

• End Of Year Lock Date

• Created Date U T C

• Timezone

• Organisation Entity Type

• Short Code

• Class

• Edition

• Line Of Business

• Addresses

• Phones

• External Links

• Payment Terms

Retrieve Overpayment

Grab all details about an overpayment.

• Type

• Contact

• Date

• Status

• Line Amount Types

• Line Items

• Sub Total

• Total Tax

• Total

• Updated Date U T C

• Currency Code

• Overpayment ID

• Currency Rate

• Remaining Credit

• Allocations

• Applied Amount

• Payments

• Attachments

Retrieve Pay Run

Grab all details of a pay run.

• Payroll Calendar ID

• Pay Run ID

• Pay Run Period Start Date

• Pay Run Period End Date

• Pay Run Status

• Payment Date

• Payslip Message

• Updated Date U T C

• Payslips

• Wages

• Deductions

• Tax

• Super

• Reimbursement

• Net Pay

Retrieve Payment

Grab all details about a payment.

• Invoice

• Invoice Number

• Credit Note Number

• Account

• Code

• Date

• Currency Rate

• Amount

• Bank Amount

• Reference

• Is Reconciled

• Status

• Payment Type

• Updated Date U T C

• Payment ID

• Batch Payment ID

• Bank Account Number

• Particulars

• Details

• Has Account

• Status Attribute String

Retrieve Payroll Calendar

Grab all details about a payroll calendar.

• Name

• Calendar Type

• Start Date

• Payment Date

• Payroll Calendar ID

• Updated Date U T C

• Reference Date

Retrieve Payslip

Grab all details about a payslip.

• Employee ID

• Payslip ID

• First Name

• Last Name

• Wages

• Deductions

• Tax

• Super

• Reimbursements

• Net Pay

• Earnings Lines

• Leave Earnings Lines

• Timesheet Earnings Lines

• Deduction Lines

• Leave Accrual Lines

• Reimbursement Lines

• Superannuation Lines

• Tax Lines

• Updated Date U T C

Retrieve Prepayment

Grab all details about a prepayment.

• Type

• Contact

• Date

• Status

• Line Amount Types

• Line Items

• Sub Total

• Total Tax

• Total

• Reference

• Updated Date U T C

• Currency Code

• Prepayment ID

• Currency Rate

• Remaining Credit

• Allocations

• Payments

• Applied Amount

• Attachments

Retrieve Project

Grab all details about a project.

• Project ID

• Contact ID

• Name

• Currency Code

• Minutes Logged

• Total Task Amount

• Total Expense Amount

• Estimate Amount

• Minutes To Be Invoiced

• Task Amount To Be Invoiced

• Task Amount Invoiced

• Expense Amount To Be Invoiced

• Expense Amount Invoiced

• Project Amount Invoiced

• Deposit

• Deposit Applied

• Credit Note Amount

• Deadline Utc

• Total Invoiced

• Total To Be Invoiced

• Estimate

• Status

Retrieve Project's Time Entry

Grab all details about a time entry for a project.

• Time Entry ID

• User ID

• Project ID

• Task ID

• Date Utc

• Date Entered Utc

• Duration

• Description

• Status

Retrieve Purchase Order

Grab all details about a purchase order.

• Contact

• Line Items

• Date

• Delivery Date

• Line Amount Types

• Purchase Order Number

• Reference

• Branding Theme ID

• Currency Code

• Status

• Sent To Contact

• Delivery Address

• Attention To

• Telephone

• Delivery Instructions

• Expected Arrival Date

• Purchase Order ID

• Currency Rate

• Sub Total

• Total Tax

• Total

• Total Discount

• Updated Date U T C

• Status Attribute String

• Attachments

Retrieve Purchase Order as PDF

Grab all details about a purchase order as a pdf.

Retrieve Purchase Order by Order Number

Grab all details about a purchase order using order number.

• Contact

• Line Items

• Date

• Delivery Date

• Line Amount Types

• Purchase Order Number

• Reference

• Branding Theme ID

• Currency Code

• Status

• Sent To Contact

• Delivery Address

• Attention To

• Telephone

• Delivery Instructions

• Expected Arrival Date

• Purchase Order ID

• Currency Rate

• Sub Total

• Total Tax

• Total

• Total Discount

• Updated Date U T C

• Status Attribute String

• Attachments

Retrieve Purchase Order's Attachment

Grab all details about a purchase order's attachment.

Retrieve Purchase Order's Attachment by File Name

Grab all details about a purchase order's attachment by file name.

Retrieve Quote

Grab all details about a quote.

• Quote ID

• Quote Number

• Reference

• Terms

• Contact

• Line Items

• Date

• Date String

• Expiry Date

• Expiry Date String

• Status

• Currency Code

• Currency Rate

• Sub Total

• Total Tax

• Total

• Total Discount

• Title

• Summary

• Branding Theme ID

• Updated Date U T C

• Line Amount Types

• Status Attribute String

Retrieve Quote as PDF

Grab all details about a quote as a pdf.

Retrieve Quote's Attachment

Grab all details about a quote's attachment.

Retrieve Quote's Attachment by FIle Name

Grab all details about a quote's attachment by file name.

Retrieve Repeating Invoice

Grab all details of a repeating invoice.

• Type

• Contact

• Schedule

• Line Items

• Line Amount Types

• Reference

• Branding Theme ID

• Currency Code

• Status

• Sub Total

• Total Tax

• Total

• Repeating Invoice ID

• ID

• Attachments

• Approved For Sending

• Send Copy

• Mark As Sent

• Include P D F

Retrieve Repeating Invoice's Attachment

Grab all details about a repeating invoice's attachment.

Retrieve Repeating Invoice's Attachment by File Name

Grab all details about a repeating invoice's attachment by file name.

Retrieve Report

Grab all details about a report.

• Report ID

• Report Name

• Report Title

• Report Type

• Report Titles

• Report Date

• Rows

• Updated Date U T C

• Fields

Retrieve Statement

Grab all details about a statement.

• ID

• Feed Connection ID

• Status

• Start Date

• End Date

• Start Balance

• End Balance

• Statement Lines

• Errors

• Statement Line Count

Retrieve Subscriptions

Grab all details about a subscription.

Retrieve Superfund

Grab all details about a superfund.

• Super Fund ID

• Type

• Name

• ABN

• BSB

• Account Number

• Account Name

• Electronic Service Address

• Employer Number

• SPIN

• USI

• Updated Date U T C

Retrieve Task

Grab all details about a project task.

• Task ID

• Name

• Rate

• Charge Type

• Estimate Minutes

• Project ID

• Total Minutes

• Total Amount

• Minutes Invoiced

• Minutes To Be Invoiced

• Fixed Minutes

• Non Chargeable Minutes

• Amount To Be Invoiced

• Amount Invoiced

• Status

Retrieve Timesheet

Grab all details about a timesheet.

• Employee ID

• Start Date

• End Date

• Status

• Hours

• Timesheet ID

• Timesheet Lines

• Updated Date U T C

Retrieve Tracking Company

Grab all details about a tracking company.

• Tracking Category ID

• Tracking Option ID

• Name

• Option

• Status

• Options

Retrieve User

Grab all details about a user.

• User ID

• Email Address

• First Name

• Last Name

• Updated Date U T C

• Is Subscriber

• Organisation Role

Send Copy of Invoice by Email

Send a copy of an invoice to related contact via email.

Send Metered Usage for Subscription and Subscription Item

Send metered usage for a subscription and subscription item.

Set Chart of Accounts, Conversion Date, and Conversion Balances

Set the chart of accounts, conversion date, and conversion balances.

• Accounts

• Organisation

Update a Spent or Received Bank Transaction

Modify an existing bank transaction.

• Bank Transactions

Update Account

Modify an existing account's details.

• Accounts

Update Attachment

Modify an account's attachment.

Update Bank Transaction's Attachment by File Name

Modify a specific attachment from a specific bank transaction by filename.

Update Bank Transfer's Attachment

Modify a bank transfer's attachment.

Update Batch Payment

Modify a specific batch payment for invoices and credit notes.

Update Batch Payment by URL

Modify a specific batch payment for invoices and credit notes.

Update Contact

Modify an existing contact's details.

• Contacts

Update Contact Attachment by File Name

Modify an existing contact attachment by file name.

Update Contact Group

Modify a contact group.

• Contact Groups

Update Credit Note

Modify a credit note.

• Credit Notes

Update Credit Note's Attachment by File Name

Modify a credit note's attachment by file name.

Update Expense Claim

Modify a specific expense claim.

• Expense Claims

Update File

Modify a file.

• Name

• Mime Type

• Size

• Created Date Utc

• Updated Date Utc

• User

• ID

• Folder ID

Update Folder

Modify an existing folder.

• Name

• File Count

• Email

• Is Inbox

• ID

Update Invoice

Modify a specific sales invoice or purchase bill.

• Invoices

Update Invoice's Attachment by File Name

Modify the attachment of a specific invoice or purchase bill using its file name.

Update Item

Modify an item's details.

• Items

Update Leave Application

Modify a leave application.

Update Linked Transaction

Modify a specific linked transaction.

• Linked Transactions

Update Manual Journal

Modify a specific manual journal.

• Manual Journals

Update Manual Journal's Attachment by File Name

Modify a manual journal's attachment by file name.

Update Metered Usage for Subscription and Subscription Item

Modify metered usage for a subscription and subscription item.

Update or Create a Spent Or Received Bank Transaction

Modify or create a spent or received money bank transaction.

• Bank Transactions

Update Pay Run

Modify a pay run.

Update Payment for Invoices & Credit Notes

Modify a payment's details for invoices and credit notes.

• Status

Update Payslip

Modify a payslip.

Update Project

Modify a project.

• Name

• Contact ID

• Estimate Amount

• Deadline Utc

Update Project's Time Entry

Modify a project's time entry.

• User ID

• Task ID

• Date Utc

• Duration

• Description

Update Purchase Order

Modify a purchase order.

• Purchase Orders

Update Purchase Order Attachment

Modify a purchase order attachment.

Update Quote

Modify a specific quote.

• Quotes

Update Quote Attachment

Modify a quote's attachment.

Update Repeating Invoice Template

Modify a specific repeating invoice template.

• Repeating Invoices

Update Repeating Invoice's Attachment

Modify an existing repeating invoice's attachment.

Update Superfund

Modify a superfund.

Update Task

Modify task.

• Name

• Charge Type

• Rate

• Estimate Minutes

Update Tax Rate

Modify an existing tax rate.

• Tax Rates

Update Timesheet

Modify a timesheet.

Update Tracking Category's Option

Modify a tracking category option.

• Tracking Option ID

• Name

• Status

• Tracking Category ID

Update Tracking Company

Modify a specific tracking category.

• Tracking Category ID

• Tracking Option ID

• Name

• Option

• Status

• Options

Accept Dispute

Accept the loss on a dispute.

• ID

• Amount Money

• Reason

• State

• Due At

• Disputed Payment

• Card Brand

• Created At

• Updated At

• Brand Dispute ID

• Reported At

• Version

• Location ID

Accumulate Loyalty Points

Add points earned from a purchase to a loyalty account.

• ID

• Type

• Created At

• Accumulate Points

• Create Reward

• Redeem Reward

• Delete Reward

• Adjust Points

• Loyalty Account ID

• Location ID

• Source

• Expire Points

• Other Event

• Accumulate Promotion Points

Add Group to Customer

Add a group membership to a customer.

Adjust Loyalty Points

Add points to or subtract points from a buyer's account.

Calculate Loyalty Points

Calculate the number of points a buyer can earn from a purchase.

• Points

• Promotion Points

Calculate Order

Enables applications to preview order pricing without creating an order.

Cancel Booking

Cancel a booking.

• ID

• Version

• Status

• Created At

• Updated At

• Start At

• Location ID

• Customer ID

• Customer Note

• Seller Note

• Appointment Segments

• Transition Time Minutes

• All Day

• Location Type

• Creator Details

• Source

• Address

Cancel Payment

Cancel a payment.

• ID

• Created At

• Updated At

• Amount Money

• Tip Money

• Total Money

• App Fee Money

• Approved Money

• Processing Fee

• Refunded Money

• Status

• Delay Duration

• Delay Action

• Delayed Until

• Source Type

• Card Details

• Cash Details

• Bank Account Details

• External Details

• Wallet Details

• Buy Now Pay Later Details

• Square Account Details

• Location ID

• Order ID

• Reference ID

• Customer ID

• Team Member ID

• Refund Ids

• Buyer Email Address

• Billing Address

• Shipping Address

• Note

• Statement Description Identifier

• Capabilities

• Receipt Number

• Receipt URL

• Device Details

• Application Details

• Is Offline Payment

• Offline Payment Details

• Version Token

Cancel Subscription

Cancel a subscription.

• ID

• Location ID

• Plan Variation ID

• Customer ID

• Start Date

• Canceled Date

• Charged Through Date

• Status

• Tax Percentage

• Invoice Ids

• Price Override Money

• Version

• Created At

• Card ID

• Timezone

• Phases

Cancel Terminal Checkout

Cancel a terminal checkout.

• ID

• Amount Money

• Reference ID

• Note

• Order ID

• Payment Options

• Device Options

• Status

• Cancel Reason

• Payment Ids

• Created At

• Updated At

• App ID

• Location ID

• Payment Type

• Team Member ID

• Customer ID

• App Fee Money

• Statement Description Identifier

• Tip Money

Complete Payment

Complete a payment.

• ID

• Created At

• Updated At

• Amount Money

• Tip Money

• Total Money

• App Fee Money

• Approved Money

• Processing Fee

• Refunded Money

• Status

• Delay Duration

• Delay Action

• Delayed Until

• Source Type

• Card Details

• Cash Details

• Bank Account Details

• External Details

• Wallet Details

• Buy Now Pay Later Details

• Square Account Details

• Location ID

• Order ID

• Reference ID

• Customer ID

• Team Member ID

• Refund Ids

• Buyer Email Address

• Billing Address

• Shipping Address

• Note

• Statement Description Identifier

• Capabilities

• Receipt Number

• Receipt URL

• Device Details

• Application Details

• Is Offline Payment

• Offline Payment Details

• Version Token

Create Booking

Create a booking.

• Idempotency Key

• Booking

Create Break Type

Create a new break type.

• Idempotency Key

• Break Type

Create Card

Add a card on file to an existing merchant.

• Idempotency Key

• Source ID

• Verification Token

• Card

Create Checkout

Create a checkout.

• Idempotency Key

• Order

• Ask For Shipping Address

• Merchant Support Email

• Pre Populate Buyer Email

• Pre Populate Shipping Address

• Redirect URL

• Additional Recipients

• Note

Create Customer

Create a new customer for the business, which can have associated cards on file.

• Idempotency Key

• Given Name

• Family Name

• Company Name

• Nickname

• Email Address

• Address

• Phone Number

• Reference ID

• Note

• Birthday

• Tax Ids

Create Customer Card

Add a card on file to an existing customer.

Create Customer Group

Create a customer group.

Create Dispute Evidence File

Upload a file to use as evidence in a dispute challenge.

Create Dispute Evidence Text

Upload text to use as evidence for a dispute challenge.

• Idempotency Key

• Evidence Type

• Evidence Text

Create Gift Card

Create a gift card.

• Idempotency Key

• Location ID

• Gift Card

Create Gift Card Activity

Create a gift card activity to manage the balance or state of a gift card.

• Idempotency Key

• Gift Card Activity

Create Invoice

Create an invoice.

• Invoice

• Idempotency Key

Create Location

Create a location.

Create Location Transaction

Create a location transaction.

Create Loyalty Account

Create a loyalty account.

Create Loyalty Rewards

Create a loyalty reward.

• Reward

• Idempotency Key

Create Order Shipment

Create an order shipment.

Create Payment

Create a payment.

• Source ID

• Idempotency Key

• Amount Money

• Tip Money

• App Fee Money

• Delay Duration

• Delay Action

• Autocomplete

• Order ID

• Customer ID

• Location ID

• Team Member ID

• Reference ID

• Verification Token

• Accept Partial Authorization

• Buyer Email Address

• Buyer Phone Number

• Billing Address

• Shipping Address

• Note

• Statement Description Identifier

• Cash Details

• External Details

• Customer Details

• Offline Payment Details

Create Refund

Initiates a refund for a previously charged tender.

Create Shift

Create a new shift.

Create Subscription

Create a subscription.

• Idempotency Key

• Location ID

• Plan Variation ID

• Customer ID

• Start Date

• Canceled Date

• Tax Percentage

• Price Override Money

• Card ID

• Timezone

• Phases

Create Team Member

Create a team member.

• Idempotency Key

• Team Member

Create Terminal Checkout

Create a terminal checkout.

• Idempotency Key

• Checkout

Delete Break Type

Remove a break type.

Delete Catalog Object

Remove a catalog object.

• 0

Delete Customer

Remove a customer.

Delete Customer Card

Remove a card on file from a customer.

Delete Customer Group

Remove a customer group.

Delete Dispute

Remove a specified evidence from a dispute.

Delete Group from Customer

Remove a customer from a business.

Delete Invoice

Remove an invoice.

Delete Loyalty Reward

Remove a loyalty reward.

Delete Shift

Remove a shift.

Disable Card

Disable a card, preventing any further updates or changes.

Get List of Additional Recipient Receivables

Obtain a list of additional recipient receivables.

Get List of Additional Recipient Receivables Refunds

Obtain a list of additional recipient receivables refunds.

Get List of Bank Accounts

Obtain a list of bank accounts linked to a Square account.

• ID

• Account Number Suffix

• Country

• Currency

• Account Type

• Holder Name

• Primary Bank Identification Number

• Secondary Bank Identification Number

• Debit Mandate Reference ID

• Reference ID

• Location ID

• Status

• Creditable

• Debitable

• Fingerprint

• Version

• Bank Name

Get List of Cards

Obtain a list of cards owned by the account.

• ID

• Card Brand

• Last 4

• Exp Month

• Exp Year

• Cardholder Name

• Billing Address

• Fingerprint

• Customer ID

• Merchant ID

• Reference ID

• Enabled

• Card Type

• Prepaid Type

• Bin

• Version

• Card Co Brand

Get List of Catalog

Obtain a list of catalog objects.

• Cursor

• Objects

Get List of Customer Groups

Obtain a list of customer groups.

• ID

• Name

• Created At

• Updated At

Get List of Customer Segments

Obtain a list of customer segments.

• ID

• Name

• Created At

• Updated At

Get List of Customers

Obtain a list of customers.

• ID

• Created At

• Updated At

• Given Name

• Family Name

• Nickname

• Company Name

• Email Address

• Address

• Phone Number

• Birthday

• Reference ID

• Note

• Preferences

• Creation Source

• Group Ids

• Segment Ids

• Version

• Tax Ids

Get List of Dispute Evidence

Obtain a list of evidence associated with a dispute.

• ID

• Dispute ID

• Evidence File

• Evidence Text

• Uploaded At

• Evidence Type

Get List of Disputes

Obtain a list of disputes.

• ID

• Amount Money

• Reason

• State

• Due At

• Disputed Payment

• Card Brand

• Created At

• Updated At

• Brand Dispute ID

• Reported At

• Version

• Location ID

Get List of Employee Wages

Obtain a list of employee wages.

Get List of Employees

Obtain a list of employees.

Get List of Invoices

Obtain a list of invoices.

• ID

• Version

• Location ID

• Order ID

• Primary Recipient

• Payment Requests

• Delivery Method

• Invoice Number

• Title

• Description

• Scheduled At

• Public URL

• Next Payment Amount Money

• Status

• Timezone

• Created At

• Updated At

• Accepted Payment Methods

• Custom Fields

• Subscription ID

• Sale Or Service Date

• Payment Conditions

• Store Payment Method Enabled

• Attachments

• Creator Team Member ID

Get List of Locations

Obtain a list of all of a seller's locations.

• ID

• Name

• Address

• Timezone

• Capabilities

• Status

• Created At

• Merchant ID

• Country

• Language Code

• Currency

• Phone Number

• Business Name

• Type

• Website URL

• Business Hours

• Business Email

• Description

• Twitter Username

• Instagram Username

• Facebook URL

• Coordinates

• Logo URL

• Pos Background URL

• Full Format Logo URL

Get List of Loyalty Programs

Obtain a list of loyalty programs.

Get List of Merchants

Obtain a list of merchants.

Get List of Payment Refunds

Obtain a list of payment refunds.

• ID

• Status

• Location ID

• Unlinked

• Destination Type

• Destination Details

• Amount Money

• App Fee Money

• Processing Fee

• Payment ID

• Order ID

• Reason

• Created At

• Updated At

• Team Member ID

Get List of Payments

Obtain a list of payments.

• ID

• Created At

• Updated At

• Amount Money

• Tip Money

• Total Money

• App Fee Money

• Approved Money

• Processing Fee

• Refunded Money

• Status

• Delay Duration

• Delay Action

• Delayed Until

• Source Type

• Card Details

• Cash Details

• Bank Account Details

• External Details

• Wallet Details

• Buy Now Pay Later Details

• Square Account Details

• Location ID

• Order ID

• Reference ID

• Customer ID

• Team Member ID

• Refund Ids

• Buyer Email Address

• Billing Address

• Shipping Address

• Note

• Statement Description Identifier

• Capabilities

• Receipt Number

• Receipt URL

• Device Details

• Application Details

• Is Offline Payment

• Offline Payment Details

• Version Token

Get List of Refunds

Obtain a list of refunds.

Get List of Sites

Obtain a list of Square Online sites that belong to a seller.

Get List of Subscription Events

Obtain a list of subscription events.

• ID

• Subscription Event Type

• Effective Date

• Info

• Phases

• Plan Variation ID

Get List of Team Member Booking Profiles

Obtain a list of booking profiles for team members.

Get List of Team Member Wages

Obtain a list of team member wages.

Get List of Transactions

Obtain a list of transactions for a particular location.

Get List of Workweek Configs

Obtain a list of workweek configs instances for a business.

Link Customer to Gift Card

Link a customer to a gift card, which is also referred to as adding a card on file.

• ID

• Type

• Gan Source

• State

• Balance Money

• Gan

• Created At

• Customer Ids

List Break Type

Get list of all break types

• ID

• Location ID

• Break Name

• Expected Duration

• Is Paid

• Version

• Created At

• Updated At

Pay Order

Pay for an order using one or more approved payments or settle an order with a total of 0.

Publish Invoice

Publish the specified draft invoice.

Redeem Loyalty Rewards

Redeem a loyalty reward.

Refund Payment

Refund a payment.

• ID

• Status

• Location ID

• Unlinked

• Destination Type

• Destination Details

• Amount Money

• App Fee Money

• Processing Fee

• Payment ID

• Order ID

• Reason

• Created At

• Updated At

• Team Member ID

Register Domain

Activates a domain for us with Apple Pay on the Web and Square.

• Status

Retrieve Bank Account

Grab all details about a bank account.

• ID

• Account Number Suffix

• Country

• Currency

• Account Type

• Holder Name

• Primary Bank Identification Number

• Secondary Bank Identification Number

• Debit Mandate Reference ID

• Reference ID

• Location ID

• Status

• Creditable

• Debitable

• Fingerprint

• Version

• Bank Name

Retrieve Bank Account by V1 ID

Grab all details about a bank account by V1 bank account id.

Retrieve Booking

Grab all details about a booking.

Retrieve Break Type

Grab all details about a break type.

• ID

• Location ID

• Break Name

• Expected Duration

• Is Paid

• Version

• Created At

• Updated At

Retrieve Card

Grab all details about a card.

• ID

• Card Brand

• Last 4

• Exp Month

• Exp Year

• Cardholder Name

• Billing Address

• Fingerprint

• Customer ID

• Merchant ID

• Reference ID

• Enabled

• Card Type

• Prepaid Type

• Bin

• Version

• Card Co Brand

Retrieve Catalog Object

Grab all details about a catalog object.

• Type

• ID

• Updated At

• Version

• Is Deleted

• Custom Attribute Values

• Catalog V1 Ids

• Present At All Locations

• Present At Location Ids

• Absent At Location Ids

• Item Data

• Category Data

• Item Variation Data

• Tax Data

• Discount Data

• Modifier List Data

• Modifier Data

• Time Period Data

• Product Set Data

• Pricing Rule Data

• Image Data

• Subscription Plan Data

• Item Option Data

• Item Option Value Data

• Custom Attribute Definition Data

• Subscription Plan Variation Data

Retrieve Customer

Grab all details about a customer.

• ID

• Created At

• Updated At

• Given Name

• Family Name

• Nickname

• Company Name

• Email Address

• Address

• Phone Number

• Birthday

• Reference ID

• Note

• Preferences

• Creation Source

• Group Ids

• Segment Ids

• Version

• Tax Ids

Retrieve Customer Group

Grab all details about a customer group.

Retrieve Customer Segments

Grab all details about a customer segment.

Retrieve Dispute

Grab all details about a dispute.

• ID

• Amount Money

• Reason

• State

• Due At

• Disputed Payment

• Card Brand

• Created At

• Updated At

• Brand Dispute ID

• Reported At

• Version

• Location ID

Retrieve Dispute Evidence

Grab all details about a dispute evidence.

• ID

• Dispute ID

• Evidence File

• Evidence Text

• Uploaded At

• Evidence Type

Retrieve Employee

Grab all details about an employee.

Retrieve Employee Wage

Grab all details about an employee's wage.

Retrieve Gift Card

Grab all details about a gift card.

Retrieve Inventory Adjustment

Grab all details about an inventory adjustment.

Retrieve Inventory Changes

Grab all details about an inventory change.

Retrieve Inventory Count

Grab the inventory count for a given catalog.

• Catalog Object ID

• Catalog Object Type

• State

• Location ID

• Quantity

• Calculated At

Retrieve Inventory Physical Count

Grab the inventory physical count.

Retrieve Invoice

Grab all details about an invoice

• ID

• Version

• Location ID

• Order ID

• Primary Recipient

• Payment Requests

• Delivery Method

• Invoice Number

• Title

• Description

• Scheduled At

• Public URL

• Next Payment Amount Money

• Status

• Timezone

• Created At

• Updated At

• Accepted Payment Methods

• Custom Fields

• Subscription ID

• Sale Or Service Date

• Payment Conditions

• Store Payment Method Enabled

• Attachments

• Creator Team Member ID

Retrieve Location

Grab all details about a location's details.

Retrieve Loyalty Account

Grab all details about a loyalty account.

• ID

• Program ID

• Balance

• Lifetime Points

• Customer ID

• Enrolled At

• Created At

• Updated At

• Mapping

• Expiring Point Deadlines

Retrieve Loyalty Reward

Grab all details about a loyalty reward.

• ID

• Status

• Loyalty Account ID

• Reward Tier ID

• Points

• Order ID

• Created At

• Updated At

• Redeemed At

Retrieve Merchant

Grab all details about a merchant.

• ID

• Business Name

• Country

• Language Code

• Currency

• Status

• Main Location ID

• Created At

Retrieve Order

Grab all details about an order.

• ID

• Location ID

• Reference ID

• Source

• Line Items

• Taxes

• Discounts

• Service Charges

• Fulfillments

• Created At

• Updated At

• Closed At

• State

• Total Money

• Total Tax Money

• Total Discount Money

• Total Tip Money

• Total Service Charge Money

• Pricing Options

• Net Amount Due Money

Retrieve Payment

Grab all details about a payment.

• ID

• Created At

• Updated At

• Amount Money

• Tip Money

• Total Money

• App Fee Money

• Approved Money

• Processing Fee

• Refunded Money

• Status

• Delay Duration

• Delay Action

• Delayed Until

• Source Type

• Card Details

• Cash Details

• Bank Account Details

• External Details

• Wallet Details

• Buy Now Pay Later Details

• Square Account Details

• Location ID

• Order ID

• Reference ID

• Customer ID

• Team Member ID

• Refund Ids

• Buyer Email Address

• Billing Address

• Shipping Address

• Note

• Statement Description Identifier

• Capabilities

• Receipt Number

• Receipt URL

• Device Details

• Application Details

• Is Offline Payment

• Offline Payment Details

• Version Token

Retrieve Payment Refund

Grab all details about a payment refund.

• ID

• Status

• Location ID

• Unlinked

• Destination Type

• Destination Details

• Amount Money

• App Fee Money

• Processing Fee

• Payment ID

• Order ID

• Reason

• Created At

• Updated At

• Team Member ID

Retrieve Shift

Grab all details about a shift.

Retrieve Subscription

Grab all details about a subscription.

• ID

• Location ID

• Plan Variation ID

• Customer ID

• Start Date

• Canceled Date

• Charged Through Date

• Status

• Tax Percentage

• Invoice Ids

• Price Override Money

• Version

• Created At

• Card ID

• Timezone

• Phases

Retrieve Team Member

Grab all details about a team member.

• ID

• Reference ID

• Is Owner

• Status

• Given Name

• Family Name

• Email Address

• Phone Number

• Created At

• Updated At

• Assigned Locations

Retrieve Terminal Checkout

Grab all details about a terminal checkout.

• ID

• Amount Money

• Reference ID

• Note

• Order ID

• Payment Options

• Device Options

• Status

• Cancel Reason

• Payment Ids

• Created At

• Updated At

• App ID

• Location ID

• Payment Type

• Team Member ID

• Customer ID

• App Fee Money

• Statement Description Identifier

• Tip Money

Retrieve Transaction

Grab all details about a transaction.

Retrieve Wage Setting

Grab all details about a wage setting.

Search Availability

Search availabilities for booking.

• Start At

• Location ID

• Appointment Segments

Search Catalog

Search for a catalog.

• Cursor

• Objects

• Related Objects

Search Customer

Search for a customer.

• ID

• Created At

• Updated At

• Given Name

• Family Name

• Nickname

• Company Name

• Email Address

• Address

• Phone Number

• Birthday

• Reference ID

• Note

• Preferences

• Creation Source

• Group Ids

• Segment Ids

• Version

• Tax Ids

Search for Catalog Item

Search for a catalog item.

Search Invoice

Search for an invoice.

Search Loyalty Account

Search for a loyalty account.

• ID

• Program ID

• Balance

• Lifetime Points

• Customer ID

• Enrolled At

• Created At

• Updated At

• Mapping

• Expiring Point Deadlines

Search Loyalty Event

Search for a loyalty event.

• ID

• Type

• Created At

• Accumulate Points

• Create Reward

• Redeem Reward

• Delete Reward

• Adjust Points

• Loyalty Account ID

• Location ID

• Source

• Expire Points

• Other Event

• Accumulate Promotion Points

Search Loyalty Rewards

Search for a loyalty reward.

• ID

• Status

• Loyalty Account ID

• Reward Tier ID

• Points

• Order ID

• Created At

• Updated At

• Redeemed At

Search Shifts

Search for a shift.

Search Subscription

Search for a subscription.

Search Team Members

Search for a team member.

• ID

• Reference ID

• Is Owner

• Status

• Given Name

• Family Name

• Email Address

• Phone Number

• Created At

• Updated At

• Assigned Locations

Search Terminal Checkout

Search for a terminal checkout.

Searchorders /V2/Orders/Search

SearchOrders

Submit Evidence

Submit evidence to the cardholder's bank.

• ID

• Amount Money

• Reason

• State

• Due At

• Disputed Payment

• Card Brand

• Created At

• Updated At

• Brand Dispute ID

• Reported At

• Version

• Location ID

Update Booking

Modify a booking's details.

• Idempotency Key

• Booking

Update Break Type

Modify a break type's details.

• Break Type

Update Customer

Modify a customer's details.

• Given Name

• Family Name

• Company Name

• Nickname

• Email Address

• Address

• Phone Number

• Reference ID

• Note

• Birthday

• Version

• Tax Ids

Update Customer Group

Modify a customer group.

Update Inventory

Modify inventory for an item.

• Idempotency Key

• Changes

• Ignore Unchanged Counts

Update Invoice

Modify an invoice's details.

• Invoice

• Idempotency Key

• Fields To Clear

Update Item Modifier Lists

Modify a catalog modifier list object that apply to the targeted catalog item.

Update Item Taxes

Modify a catalog tax object that apply to the targeted catalog item.

Update Location

Modify a location's details.

Update Order Fulfillment

Modify an order fulfillment's details.

Update Shift

Modify a shift's details.

Update Subscription

Modify a subscription's details.

• Subscription

Update Team Member

Modify a team member's details.

• Team Member

Update Wage Setting

Modify a wage setting's details.

Update Workweek Config

Modify a workweek's config details.

Void Transaction

Cancel a transaction.

View all

Not just software—partnership

Expert support included

MESA includes hands-on support from automation experts who know how to get things done.

Free workflow setup

We'll build your first workflow with you live. Most merchants walk away with automation saving 5+ hours/week.

Fast response times

Average first response: Same day. Critical issues: Immediate escalation. Complex builds: 24-48 hours.

Managed services available

Personalized workflow reviews, and quarterly check-ins to identify new opportunities as your business grows.

Real humans, always

Chat with real automation experts (not bots). Email support 9am-5pm PST. Google Meet sessions for complex workflows.

Integrate Square with Xero today.

Enjoy a 7-day free trial. Get your first workflow in minutes.

Try MESA today →

MESA AI assistant

+×

Describe your task...

You've known what your store should be doing. Now it can. Describe the task then MESA handles it from there.