Printful to Xero Integration | MESA

Connect Printful to Xero and automate your tasks

Describe to build

Activity reports

Fully supported

MESA's Printful 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 Printful with Xero

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

Fulfillment operations →

Send Shopify orders to Printful for fulfillment automatically

When an order is placed in Shopify, MESA routes it to Printful with the right product details, variants, and shipping information already attached. Your print-on-demand fulfillment starts the moment a customer checks out without anyone manually submitting the order.

Inventory management →

Keep Shopify product and variant data in sync with Printful

When a product is added, updated, or repriced in Shopify, MESA reflects the change in Printful. Your fulfillment partner always works from accurate product data without a manual sync step between your store and your print provider.

Customer experience →

Update Shopify the moment Printful ships an order

When Printful generates a tracking number and marks an order as shipped, MESA writes the update back to Shopify and triggers any downstream actions — a Klaviyo notification, a customer tag, a loyalty point. Your post-purchase workflow starts the moment Printful ships, not when someone checks the dashboard.

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 Printful 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

Order Canceled

Starts when an order is canceled.

Order Created

Starts when an order is created.

Order Failed

Starts when an order has failed.

Order Updated

Starts when an order is updated.

Package Returned

Starts when a package is returned.

Package Shipped

Starts when a package is shipped.

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

Add File

Upload a new file to the library by providing URL of the file.

Type
ID
URL
Options
Hash
Filename
Mime Type
Size
Width
Height
Dpi
Status
Created
Thumbnail URL
Preview URL
Visible

Approve Design

Uses the confirm hash of an approval sheet to approve a design and remove the hold on an order.

Message

Calculate Shipping Rates

Obtain a list of available shipping options and rates for a given list of products.

Code
Result

Calculate Tax Rate

Calculate sales tax rate for a given address if required.

Code
Result

Cancel Order

Cancel a pending order or draft. Charged amount is returned to the store owner's credit card.

ID
External ID
Store
Status
Shipping
Shipping Service Name
Created
Updated
Recipient
Items
Branding Items
Incomplete Items
Costs
Retail Costs
Pricing Breakdown
Shipments
Gift
Packing Slip

Change Packing Slip

Modifies packing slip information of the currently authorized Printful store.

Code
Result

Confirm Draft for Fulfillment

Approve a draft order for fulfillment. Store owner's credit card is charged when the order is submitted for fulfillment.

ID
External ID
Store
Status
Shipping
Shipping Service Name
Created
Updated
Recipient
Items
Branding Items
Incomplete Items
Costs
Retail Costs
Pricing Breakdown
Shipments
Gift
Packing Slip

Create Mockup Generation Task

Create an asynchronous mockup generation task.

Variant Ids
Format
Width
Product Options
Option Groups
Options
Files
Product Template ID

Create New Sync Product

Create a new sync product together with its sync variants.

Sync Product
Sync Variants

Create Order

Create a new order and optionally submits it for fulfillment.

ID
External ID
Store
Status
Shipping
Shipping Service Name
Created
Updated
Recipient
Items
Branding Items
Incomplete Items
Costs
Retail Costs
Pricing Breakdown
Shipments
Gift
Packing Slip

Create Sync Variant

Create a new sync variant for an existing sync product.

ID
External ID
Sync Product ID
Name
Synced
Variant ID
Retail Price
Currency
Is Ignored
Sku
Product
Files
Options
Main Category ID
Warehouse Product Variant ID

Delete Product Template

Remove a product template.

Success

Delete Sync Product

Remove a sync product with all of its sync variants.

Sync Product
Sync Variants

Delete Sync Product

Remove a sync product with all of its sync variants.

Sync Product
Sync Variants

Delete Sync Variant

Remove a single sync variant.

Sync Variant
Sync Product

Delete Sync Variant

Remove configuration information and disables automatic order importing for a sync variant.

Sync Variant
Sync Product

Disable Webhook Support /Webhooks

Removes the webhook URL and all event types from the store. Method returns current webhook configuration after the update.

Estimate Order Costs

Calculates the estimated order costs including item costs, print costs, shipping, and taxes.

Costs
Retail Costs

Get List of Approval Sheets

Obtain a list of approval sheets confirming suggested changes to files of on hold orders.

ID
Status
Confirm Hash
Submitted Design
Recommended Design
Approval Sheet

Get List of Available Thread Colors from Provided Image URL

Obtain a list of colors in hexadecimal format.

Get List of Categories

Obtain a list of catalog categories available in Printful.

ID
Parent ID
Image URL
Size
Title

Get List of Countries

Obtain a list of countries and states that are accepted by Printful.

Code
Name
States

Get List of Countries for Tax Calculation

Obtain a list of countries that requires sales tax calculation.

Code
Result

Get List of Layout Templates

Obtain a list of templates that can be used for client-side positioning.

Version
Min Dpi
Variant Mapping
Templates
Conflicting Placements

Get List of Orders

Obtain a list of orders from your store.

ID
External ID
Store
Status
Shipping
Shipping Service Name
Created
Updated
Recipient
Items
Branding Items
Incomplete Items
Costs
Retail Costs
Pricing Breakdown
Shipments
Gift
Packing Slip

Get List of Product Variant Print Files

Obtain a list of print files available for products variants.

Product ID
Available Placements
Printfiles
Variant Printfiles
Option Groups
Options

Get List of Products

Obtain a list of products available in Printful.

ID
Main Category ID
Type
Type Name
Title
Brand
Model
Image
Variant Count
Currency
Files
Options
Is Discontinued
Avg Fulfillment Time
Description
Techniques

Get List of Sync Products

Obtain a list of sync product objects from your custom Printful store.

ID
External ID
Name
Variants
Synced
Thumbnail
Thumbnail URL
Is Ignored

Get List of Sync Products

Obtain a list of sync product objects from your store.

ID
External ID
Name
Variants
Synced
Thumbnail
Thumbnail URL
Is Ignored

Get List of Templates

Obtain a list of templates.

Items

Get List of Warehouse Products

Obtain a list of warehouse products from your store.

ID
Name
Status
Currency
Image URL
Retail Price
Variants

Get Scopes for Token /Oauth/Scopes

Returns a list of scopes associated with the token

Get Webhook Configuration /Webhooks

Returns configured webhook URL and list of webhook event types enabled for the store

Retrieve Basic Information About a Store

Grab all details about a store's basic information.

ID
Type
Name

Retrieve Basic Information About Multiple Stores

Grab all details about multiple store's basic information.

ID
Type
Name

Retrieve Category

Grab all details about the category.

ID
Parent ID
Image URL
Size
Title

Retrieve File

Grab all details about a file.

Type
ID
URL
Options
Hash
Filename
Mime Type
Size
Width
Height
Dpi
Status
Created
Thumbnail URL
Preview URL
Visible

Retrieve Mockup Generation Task Result

Grab all details about an asynchronous mockup generation task result.

Task Key
Status
Error
Mockups
Printfiles

Retrieve Order

Grab all details about an order.

ID
External ID
Store
Status
Shipping
Shipping Service Name
Created
Updated
Recipient
Items
Branding Items
Incomplete Items
Costs
Retail Costs
Pricing Breakdown
Shipments
Gift
Packing Slip

Retrieve Product

Grab all details about a specific product and a list of variants for the product.

Product
Variants

Retrieve Product Size Guide

Grab all details about the size guide for a specific product.

Product ID
Available Sizes
Size Tables

Retrieve Product Template

Grab all details about a product template.

ID
Product ID
External Product ID
Title
Available Variant Ids
Option Data
Colors
Sizes
Mockup File URL
Placements
Created At
Updated At

Retrieve Sync Product

Grab all details about a single sync product and its sync variants.

Sync Product
Sync Variants

Retrieve Sync Product

Grab all details about a single sync product and its sync variants.

Sync Product
Sync Variants

Retrieve Sync Variant

Grab all details about a single sync variant.

Sync Variant
Sync Product

Retrieve Sync Variant

Grab all details about a single sync variant.

Sync Variant
Sync Product

Retrieve Variant

Grabs all details about a specific variant and its product.

Variant
Product

Retrieve Warehouse Product Data

Grab all details about a warehouse product data.

ID
Name
Status
Currency
Image URL
Retail Price
Variants

Set Up Webhook Configuration /Webhooks

Allows to enable webhook URL for the store and select webhook event types that will be sent to this URL. Note that only one webhook URL can be active for a store, so calling this method disables all existing webhook configuration. Setting up the [Stock updated](#operation/stockUpdated) webhook requires passing IDs for products that need to be monitored for changes. Stock update webhook will only include information for specified products. These product IDs need to be set up using params property. Method returns current webhook configuration after the update.

Update Order

Modify an unsubmitted order and optionally submits it for the fulfillment.

ID
External ID
Store
Status
Shipping
Shipping Service Name
Created
Updated
Recipient
Items
Branding Items
Incomplete Items
Costs
Retail Costs
Pricing Breakdown
Shipments
Gift
Packing Slip

Update Sync Product

Modifies an existing sync product with its sync variants.

Sync Product
Sync Variants

Update Sync Variant

Modifies an existing sync variant.

Update Sync Variant

Modifies an existing sync variant.

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 Printful 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.