Xflow - Zoho books user guide

Xflow - Zoho Books integration

Last Updated: January 2025

Initial Setup

  1. Create an Xflow Account:

    • Sign up for a free Xflow account at Xflow Dashboard
    • Complete the KYC process
    • Contact support@xflowpay.com to obtain your live mode developer key. This key is essential for initiating payment collection via the integration
  2. Important Notes Before Signing Up:

    • Xflow supports only India-based merchants.
    • Xflow is designed for international business payments and supports countries listed here
    • It facilitates USD to INR transactions, with plans to support more currencies in the future
    • A complete list of Purpose Codes is available here

Connect Xflow with Zoho Books

  1. Install the Integration:

    • Download Xflow for Zoho Books from the Zoho Marketplace.
  2. Authorize Connections:

    1. Zoho Books:
      • Click on connect available on ZohoBooks-Xflow connection Install-zoho-books
      • Click Accept to allow Zoho Flow to access your account Accept-authorization
    2. Xflow Connection:
      • Click on connect available on Xflow-connection Install-xflow
      • Enter your live mode developer key prefixed with Bearer (e.g., Bearer sk_live_xxxxx) and click Connect xflow-accept
  3. Complete the Setup:

    • After authorizing both connections, click Install Extension
    • The installed extension will appear under Integrations & Marketplace → Installed Extensions Installed-extensions

Ways to receive funds

You can receive funds from your clients through Xflow by sharing the VBAN provided by Xflow with them or by adding the VBAN to your invoices.

Once the integration is installed, your VBAN (Virtual Bank Account Number) details can be found:

  1. In the Sidebar Widget While Creating Invoices:

    • Access the VBAN details in the Zoho Books sidebar widget during invoice creation
    • Use the Copy VBAN Details button to add these details to your customer notes to make the VBAN reflect on the invoice PDF create-invoice

    Ensure the following before sharing VBAN Details:

    • You are accepting USD payments
    • The customer is from an Xflow-supported country. See the list here
  2. On the Zoho Books Home Page:

    • View your Xflow-provided VBAN details and available funds on the home page widget home-page-widget

Withdraw your funds

To withdraw funds, follow these steps:

  1. Sync Your Customer with Xflow:

    1. From the Invoice Details Page:
      • Use the sidebar widget on the customer details page to sync customers partner-sync
    2. From the Customer Details Page:
      • Use the sidebar widget to sync the customer associated with the invoice
      • Provide the customer’s email and billing address if not already added partner-info
      • Click Sync Customer to Xflow from the widget. customer-sync-start
      • Once the synchronization is successfully, the sidebar appears like below customer-sync Note: Updates to customer information in Zoho Books will not reflect in Xflow. Use the Xflow Dashboard for updates.
  2. Sync Your Invoice with Xflow:

    • Ensure the invoice is in USD and add the required fields:
      • Purpose Code: See the supported list here
      • Transaction Type: Choose from Goods, Service, or Software
    • Use the sidebar widget to sync the invoice after providing these details. invoice-sync
    • After providing the required information, click on Sync Invoice to Xflow invoice-complete-sync

    Note: Updates to invoices in Zoho Books will not reflect in Xflow after synchronization.

  3. Withdraw Funds:

    • Go to the invoice details page and use the Xflow widget to withdraw funds.
    • Enter the withdrawal amount and click Withdraw. invoice-withdraw
    • Once the funds are withdrawn completely against the invoice, the widget appears like below after refreshing the page. invoice-full

Reach out to us

If you face any issues with our integration, please contact support@xflowpay.com.


Common errors

  1. Your customer’s email address is invalid (e.g., improperly formatted). Check that the email address is formatted correctly and only includes allowed characters: https://en.wikipedia.org/wiki/Email_address#Local-part.

    The email address you entered contains invalid characters or is incorrectly formatted. Please ensure that your customer’s email address is as per https://en.wikipedia.org/wiki/Email_address#Local-part

  2. The customer with the display name ${displayName} already exists in Xflow. Please retry the syncing after providing a unique display Name for the customer in Zoho Books.

    While syncing your customer to Xflow, please ensure that the display name is unique across your customers in Zoho Books.

  3. You have provided a customer account with status ${status}, which is not allowed for the operation you are performing. If your customer’s account is in verifying status, please try again after some time. For more information, please check out Xflow’s user guide(user guide link).

    If your Xflow account is in hold/verifying status or your customer’s account is in hold status, please contact support@xflowpay.com.
    If your customer’s account is in verifying status, please retry after some time.

  4. You are making a request with amount=${amount}. However, your currency is ${currency}, which can have only {currency_decimal_point}. Please retry the request using the correct number of decimals.

    As per ISO standards, an amount can contain specific decimal digits for a currency. The full list of the currency and its decimal digits can be found here.

  5. You cannot withdraw from an invoice unless it is in activated status. Please retry once the invoice is activated.

    In Xflow, you can withdraw the funds, only when the invoice is in activated status. If your invoice activation is delayed or is taking longer, please contact support@xflowpay.com

  6. You are trying to create a ${object} with an invalid amount. Please use an amount > 0 and retry

    You can create a ${object} only with amount > 0. Please retry the request with a valid amount.

  7. You cannot create an invoice in Xflow with a date greater than today. Please retry your request after changing the invoice date in Zoho Books.

    In Xflow, you cannot create an invoice for a future date. Please change your invoice date to not greater than today’s date and retry the request.

  8. You cannot withdraw an invoice with an amount greater than the available amount to withdraw, what the customer has deposited, or what is present in your Xflow-provided balance.

    You cannot withdraw an invoice with an amount greater than the available amount to withdraw, what the customer has deposited, or what is present in your Xflow-provided balance.

  9. The invoice you are trying to take action on is on `hold`. Please check out Xflow’s user guide for further instructions(user guide link to this point).

    The invoice you are trying to action is on hold status. Read actions are allowed, but other API calls are impossible on this invoice. Please contact support@xflowpay.com to change the invoice’s status from hold to activated.

  10. The developer key you've used to install your integration is invalid. Obtain your developer key from the Dashboard and update your integration to use them.

    The developer key you’ve used to install your integration is invalid. Please visit the Xflow Dashboard to get your live mode developer key under the developer's page. If you are facing any issues, please contact support@xflowpay.com, and we will help you.

  11. You can sync an invoice only if it is in draft or input_required status. Your invoice is in ${status} status.

    You can only sync your invoice to Xflow when it is in draft or input_required status. Please refresh your Zoho Books page so the invoice will reflect the correct status inside Zoho Books.

  12. You did not provide a developer key during the authorisation of the Xflow connection. Obtain your live mode developer key from the Xflow Dashboard and update your integration.

    Please visit the Xflow Dashboard to get your live mode developer key under the developer's page. If you are facing any issues, please contact support@xflowpay.com, and we will help you.

  13. You cannot withdraw from an invoice for an amount less than your payout fee while live_fx is enabled in Xflow. Please either increase the withdrawal amount above your payout fee or disable live_fx from the Xflow Dashboard and try again.

    You can find your payout fee from Xflow’s Dashboard. Please try withdrawing an amount greater than your payout fee or disabling the live_fx from your settings page in Xflow’s Dashboard and retry again.

  14. You are trying to withdraw from an invoice, but your payout address is not activated in Xflow. Please visit Xflow’s user guide for the next steps.

    Your payout address is not activated in Xflow. Please contact support@xflowpay.com, and we will help you.

  15. You have provided an invalid account identifier for your customer ID. Please see Xflow’s user guide for more information. (user guide link)

    Please contact support@xflowpay.com and send a screenshot; we will help you.

  16. You are trying to perform an operation with country ${country}, which Xflow does not support.

    The operation you are trying to perform has country ${country}, which Xflow does not support. Please look at the list of supported countries by Xflow(Footnote link to supported countries).

  17. You are trying to access ${object} that does not exist in Xflow. Please check out Xflow’s user guide for more information.

    You are trying to access an object that does not exist in Xflow. Please contact support@xflowpay.com with your Xflow account ID and the object you are trying to access.

  18. The purpose code you have provided is not supported by Xflow or an incorrect purpose code.

    The purpose code you have provided is not supported by Xflow or an incorrect purpose code. Please check the list of supported purpose codes: https://docs.xflowpay.com/purpose-codes

  19. The document you have provided is not a valid invoice. Please check out Xflow’s user guide for further instructions(user guide link to this point)

    The document you provided is not a valid invoice. Please contact support@xflowpay.com with the invoice ID to provide the correct PDF document.

  20. The invoice you are trying to sync already exists in Xflow. Please update your invoice number in Zoho Books to a unique value and try again.

    The invoice you are trying to sync to Xflow already exists. Please ensure that it has a unique invoice number and try again.

  21. We are unable to process this invoice currently. Please try again after sometime.

    Something went wrong from our end. Please retry again after some time or contact support@xflowpay.com for more details.

  22. You have provided an invalid request body. Please visit Xflow’s user guide for the next steps

    Something went wrong from our end. Please retry again after some time or contact support@xflowpay.com for more details.

  23. You have provided an invalid request query parameter (e.g., unexpected parameters or incorrect data type). Please check your request and retry.

    Something went wrong from our end. Please retry again after some time or contact support@xflowpay.com for more details.

  24. This object cannot be accessed now because another API request or Xflow process is currently accessing it. If you see this error intermittently, retry the request

    This object cannot be accessed now because another API request or Xflow process is currently accessing it. Please retry again after some time or contact support@xflowpay.com for more details.


Upcoming Features in the Next Version

  1. View your payment details within Zoho Books.
  2. View your deposits within Zoho Books.
  3. View your expected INR payout value during withdrawal within Zoho Books.
  4. Download your FIRA within Zoho Books.

Footnote

The list of countries supported by Xflow for partner

ISO-2 codeCountry
AFAfghanistan
ALAlbania
DZAlgeria
ADAndorra
AOAngola
AIAnguilla
AGAntigua and Barbuda
ARArgentina
AMArmenia
AWAruba
AUAustralia
ATAustria
AZAzerbaijan
BSBahamas
BHBahrain
BDBangladesh
BBBarbados
BYBelarus
BEBelgium
BZBelize
BJBenin
BMBermuda
BTBhutan
BOBolivia, Plurinational State of
BABosnia and Herzegovina
BWBotswana
BRBrazil
BNBrunei Darussalam
BGBulgaria
BFBurkina Faso
BIBurundi
KHCambodia
CMCameroon
CACanada
CVCape Verde
KYCayman Islands
CFCentral African Republic
TDChad
CLChile
CNChina
COColombia
KMComoros
CGCongo
CRCosta Rica
CICôte d'Ivoire
HRCroatia
CUCuba
CYCyprus
CZCzech Republic
DKDenmark
DJDjibouti
DMDominica
DODominican Republic
ECEcuador
EGEgypt
SVEl Salvador
GQEquatorial Guinea
EREritrea
EEEstonia
SZSwaziland
ETEthiopia
FJFiji
FIFinland
FRFrance
GAGabon
GMGambia
GEGeorgia
DEGermany
GHGhana
GRGreece
GDGrenada
GTGuatemala
GNGuinea
GWGuinea-Bissau
GYGuyana
HTHaiti
HNHonduras
HKHong Kong
HUHungary
ISIceland
INIndia
IDIndonesia
IRIran, Islamic Republic of
IQIraq
IEIreland
ILIsrael
ITItaly
JMJamaica
JPJapan
JOJordan
KZKazakhstan
KEKenya
KIKiribati
KRKorea, Republic of
KWKuwait
KGKyrgyzstan
LALao People's Democratic Republic
LVLatvia
LBLebanon
LSLesotho
LRLiberia
LYLibya
LILiechtenstein
LTLithuania
LULuxembourg
MOMacao
MKNorth Macedonia
MGMadagascar
MWMalawi
MYMalaysia
MVMaldives
MLMali
MTMalta
MHMarshall Islands
MQMartinique
MRMauritania
MUMauritius
YTMayotte
MXMexico
FMMicronesia, Federated States of
MDMoldova, Republic of
MCMonaco
MNMongolia
MEMontenegro
MSMontserrat
MAMorocco
MZMozambique
MMMyanmar
NANamibia
NRNauru
NPNepal
NLNetherlands
NCNew Caledonia
NZNew Zealand
NINicaragua
NENiger
NGNigeria
NUNiue
NONorway
OMOman
PKPakistan
PWPalau
PAPanama
PGPapua New Guinea
PYParaguay
PEPeru
PHPhilippines
PLPoland
PTPortugal
PRPuerto Rico
QAQatar
RERéunion
RORomania
RURussian Federation
RWRwanda
SHSaint Helena, Ascension and Tristan da Cunha
KNSaint Kitts and Nevis
LCSaint Lucia
PMSaint Pierre and Miquelon
VCSaint Vincent and the Grenadines
WSSamoa
SMSan Marino
STSao Tome and Principe
SASaudi Arabia
SNSenegal
RSSerbia
SCSeychelles
SLSierra Leone
SGSingapore
SKSlovakia
SISlovenia
SBSolomon Islands
SOSomalia
ZASouth Africa
SSSouth Sudan
ESSpain
LKSri Lanka
SDSudan
SRSuriname
SESweden
CHSwitzerland
SYSyrian Arab Republic
TWTaiwan, Province of China
TJTajikistan
TZTanzania, United Republic of
THThailand
TLTimor-Leste
TGTogo
TKTokelau
TOTonga
TTTrinidad and Tobago
TNTunisia
TRTurkey
TMTurkmenistan
TVTuvalu
UGUganda
UAUkraine
AEUnited Arab Emirates
GBUnited Kingdom
USUnited States
UYUruguay
UZUzbekistan
VUVanuatu
VEVenezuela, Bolivarian Republic of
VNVietnam
YEYemen
ZMZambia
ZWZimbabwe