Integration
Xero and Salesforce
Xero to Salesforce, and changes in Salesforce back to Xero. Both directions are separate sync products, configured independently, and this page shows what the shipped catalogue sets up for this pair.
- Phase 1 · forward sync
- Phase 2 · write-back
In plain wordsRecords from Xero are pushed into Salesforce, and changes made in Salesforce are carried back to Xero. Each direction is its own sync with its own configuration.
This page documents what the shipped catalogue sets up. For the commercial overview of the same pair — editions, licensing and how to buy it — Commercient publishes Xero to Salesforce integration on commercient.com .
Phase 1 — Xero to Salesforce
What you getRecords from Xero become User, Content document, Commercient Invoices Credit Notes Managed Custom Object, accounts, contacts, Commercient Xero Contact Managed Custom Object, Commercient Xero Address Managed Custom Object, Commercient Xero Invoice Managed Custom Object, Commercient Xero Line Item Managed Custom Object, Commercient Xero Payment Managed Custom Object in Salesforce. New records are created and existing ones updated.
| Group | Business outcome | Objects | Source tables and views |
|---|---|---|---|
| Get Salesforce User | The templates push User to Salesforce. New records are created, existing ones updated, and records removed in the ERP are deleted. | User | — |
| Document Sync - Xero Invoices | ERP Invoices, Invoice attachments (Xero table) data becomes Content document in Salesforce. New records are created, existing ones updated, and records removed in the ERP are deleted. | Content document | invoice records, invoice attachments |
| Xero Credit Notes | ERP Contact, Credit notes (Xero table), Credit note contacts (Xero table) data becomes Commercient Invoices Credit Notes Managed Custom Object in Salesforce. New records are created, existing ones updated, and records removed in the ERP are deleted. | Commercient Invoices Credit Notes Managed Custom Object | credit notes, credit note payments, credit note contacts, contacts, invoice credit notes |
| Account | In addition to creating the Account record from your ERP customer records, Commercient syncs over the entire Accounting AR Customer record into a Commercient AR Customer object which is a Managed Custom Object (MCO). A lookup field is provided to lookup to the default AR Customer record MCO from the Account record. New records are created, existing ones updated, and records removed in the ERP are deleted. | Account, Contact, Commercient Xero Contact Managed Custom Object | contacts, contact addresses, contact phone numbers, contact sales tracking categories, contact accounts payable details, contact accounts receivable details |
| Customer Multi Ship Addresses | If you are using multiple ship to addresses for a given AR Customer in your ERP system then you will be able to see all the addresses inside the CRM Account screen in a Commercient Multi Ship To Address MCO related list. New records are created, existing ones updated, and records removed in the ERP are deleted. | Commercient Xero Address Managed Custom Object | contact addresses, contacts |
| Invoice | Both Open and Historical invoices are synchronized. Open invoice changes, such as a balance change, or a terms change are reflected in the CRM as they sync based on the frequency of the sync you have chosen (every hour, for example). New records are created, existing ones updated, and records removed in the ERP are deleted. | Commercient Xero Invoice Managed Custom Object, Commercient Xero Line Item Managed Custom Object, Commercient Xero Payment Managed Custom Object, Commercient Invoices Credit Notes Managed Custom Object | invoice records, invoice contacts, contacts, invoice line items, invoice payments, payments |
Destination objects
- User
- Content document
- Commercient Invoices Credit Notes Managed Custom Object
- Account
- Contact
- Commercient Xero Contact Managed Custom Object
- Commercient Xero Address Managed Custom Object
- Commercient Xero Invoice Managed Custom Object
- Commercient Xero Line Item Managed Custom Object
- Commercient Xero Payment Managed Custom Object
Phase 2 — Salesforce back to Xero
What you getChanges made in Salesforce to contacts, Order, Attachment, Invoice, products are carried back to Xero.
| Process | What it delivers | Source → destination | Templates | Operations |
|---|---|---|---|---|
| Contact Import | Create Contact from Salesforce to Xero | Contacts → Contacts | 2 | create / update |
| Attechment File Import | Salesforce Order files to Xero Invoice Attachment | Order → Attachment | 1 | create |
| Invoice Import | Create Invoice from Salesforce to Xero | Invoice → Invoice | 1 | create |
| Product Items Import | Create Product Items from Salesforce to Xero | Product → Product | 1 | create |
Objects moved
- Contacts
- Order
- Attachment
- Invoice
- Product
Setting up Xero and Salesforce from the CLI
One wizard stands the tenant up, and it is the same five steps for every pair: register, capture the server IP, connect the CRM, declare the ERP connector, then import and enable the sync processes. What changes between pairs is the CRM’s connection mode and the ERP’s connector type.
1. Register the tenant
Registration creates the account, emails a verification link, and — once the Data Lake is seeded — prints a once-only bootstrap API key valid for seven days. The three consent flags are the registrant’s own decision, and the server refuses start without all three.
# which instance types sign-up accepts - run this first and use Xero's code below
$ dlake register erps
# the three consent flags are the registrant’s decision - ask before passing them
$ dlake register start --generate-password \
$ --email <email> --company "<Company Name>" --phone <tel> \
$ --instance-type <code from dlake register erps> \
$ --consent-crm-backup --consent-erp-backup --consent-phone
# after the human clicks the verification link: watch for the seed and catch the key
$ dlake register status --watch
# the bootstrap key expires in 7 days - mint a durable one while it is still valid
$ dlake admin create_api_key --keyName "<tenant>-setup" --expirationDays 90
2. Connect Salesforce and declare Xero
Steps 3 to 5 of the wizard are admin-plane tools, they are safe to re-run, and the server enforces their order — attempt the CRM step before the server IP is captured and it answers 409 naming the step you skipped.
# the authoritative answer to where a registration got to - first call when resuming
$ dlake admin registration_state
# step 3: record the server IP (a prerequisite for the CRM step)
$ dlake admin registration_capture_server_ip --ipAddress <ip>
# step 4: the catalog lists every CRM with its authMode and the fields it needs
$ dlake admin registration_crm_catalog
$ dlake admin registration_crm_select --crmName Salesforce
# an OAuth CRM: the catalog’s callbackMode says which leg this one takes
$ dlake registration oauth --crm Salesforce
# this provider’s flow ends in a PIN, emailed by the complete call itself; the verb reads it hidden (or --pin-stdin)
$ dlake registration pin --crm Salesforce
# the connection is incomplete without this call, however healthy the rest looks
$ dlake registration action --crm Salesforce --action SalesforceSetup
$ dlake admin registration_crm_finalize
# step 5: the catalog lists the connector types and the fields each one needs
$ dlake admin registration_connector_catalog
$ dlake admin registration_connector_submit \
$ --connectorType <type from the catalog> --erpName <Xero code> --fields @fields.json
$ dlake admin registration_connector_provision
$ dlake admin registration_provisioning_status
3. Review and enable the Phase 1 processes
The shipped templates listed above are what crmpro_apply_template imports. Every one of them imports its process inactive, so an imported process does nothing until an operator activates it — read the process and its field mapping first, because an object with no mapped fields pushes nothing and records no error.
# the default-template catalog, and the mapping each template carries
$ dlake admin crmpro_templates --profile <tenant>
# what exists on the tenant now, and the master sync flag
$ dlake admin crmpro_list_processes --profile <tenant>
$ dlake admin crmpro_sync_status --profile <tenant>
# read a process and its field mapping BEFORE activating it
$ dlake admin crmpro_get_process --profile <tenant> --recordId <id>
$ dlake admin crmpro_field_mapping --profile <tenant> --recordId <id>
# turn the forward sync on
$ dlake admin crmpro_set_sync_enabled --profile <tenant> --enabled true
Processes run in a fixed order, and that order is a dependency order: a process that depends on another’s records sees them only once that process has run, so a parent flows on one run and its children on the next. The full order for this pair is on the Phase 1 page.
The wizard in full, including resuming a setup days later: Setting up an integration with dlake · Registering a new Data Lake · CRMPro (forward sync).
0Source on GitHub
This page is generated from the skill pages in the dlake CLI repository. Those pages are the authority; if they disagree with anything here, they are right.
Phase 1 source
dlake-crmpro-salesforce/erps/xero.md
Phase 2 source
dlake-txdownloaderpro-salesforce/erps/xero.md
Phase 1, in full
The complete upstream page for Xero into Salesforce, on this site.
Read the full pagePhase 2, in full
The complete upstream page for Salesforce back into Xero, on this site.
Read the full pageXero and Salesforce: common questions
Which way does data move between Xero and Salesforce?
Both ways, as two separate syncs. Phase 1 is CRMPro, the forward sync that pushes Xero records into Salesforce. Phase 2 is TxDownloaderPro, the write-back that carries changes made in Salesforce back to Xero. They are configured independently, and a tenant can run either on its own.
What do Phase 1 and Phase 2 mean?
They are the two sync products the on-premises agent can run. Phase 1 is CommercientCRMPro, product 11, the forward sync from the source system into the CRM. Phase 2 is CommercientTxDownloaderPro, product 22, the write-back in the other direction. Registering a product says what to run; the Phase 1 and Phase 2 configuration says what it runs on.
What does the forward sync into Salesforce actually create?
The shipped catalogue carries 6 template groups for this pair: Get Salesforce User, Document Sync - Xero Invoices, Xero Credit Notes, Account, Customer Multi Ship Addresses, Invoice. Each group sets up its own sync process, and the integration page says what each one delivers.
Which Salesforce objects does the forward sync write?
User, Content document, Commercient Invoices Credit Notes Managed Custom Object, Account, Contact, Commercient Xero Contact Managed Custom Object, Commercient Xero Address Managed Custom Object, Commercient Xero Invoice Managed Custom Object and 2 more. Those are the kinds of Salesforce record the shipped templates write for a Xero source; nothing else is written unless you add templates of your own.
Does the forward sync delete anything in the CRM?
Each template group carries its own insert, update and delete flags, and the integration page lists what each group does. Read a process with dlake admin crmpro_get_process before activating it.
What does the write-back from Salesforce create in Xero?
The default set ships 4 processes for this pair: Contact Import, Attechment File Import, Invoice Import, Product Items Import. Each one takes a saved query against Salesforce, an inbound mapping document, and writes the result into Xero.
View moreShow less
Which objects does the write-back move?
Contacts, Order, Attachment, Invoice, Product. Those are the kinds of Salesforce record the shipped processes carry back to Xero.
What does "Phase 2 ready" mean?
It means the tenant has at least one TxDownloaderPro process. Creating a process with txdownloaderpro_create_process is what flips a customer to Phase 2 ready; registering the product alone does not, because registering says what to run and the configuration says what it runs on.
How do I see the write-back processes and whether they are failing?
dlake admin txdownloaderpro_list_processes returns every Phase 2 process with its 30-day unresolved-error count, which is the same grid the portal shows. txdownloaderpro_get_process returns one process in its edit shape, including the query and both mapping documents.
How do I stop the two directions looping?
dlake admin txdownloaderpro_circular_sync_check takes a process id and names the CRM objects that also have an active Phase 1 configuration. Those are the objects where a write-back can be picked up again by the forward sync, so check it before activating a process on this pair.
Can an AI agent set this up?
Yes, over the admin control plane or the CLI — the same tools either way. The crmpro_* and txdownloaderpro_* tools cover listing, reading, creating and updating processes. They need a full-scope key that belongs to a user holding the Admin role, and every write is audited.
Where is the authoritative source for this pair?
The skill pages in the dlake CLI repository, which is where this page is generated from. The forward sync page is linked at the foot of the integration page, and the same text is readable in the terminal with dlake skills show.
Related
Every ERP and CRM integration · CRMPro (forward sync) · TxDownloaderPro (writeback sync) · AI agents & MCP · Salesforce integrations on commercient.com
