Description for the item. Max-length [2000]

ID of the tax to be associated to the item.

Set whether the tax type is intra/interstate

Specify the type of an item. Allowed values: 'goods' or 'service' or 'digital_service'

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

SKU value of item, should be unique throughout the product

Status of the item. It can be 'active' or 'inactive'

If there is a measurement unit for the items you are adding.

Add Unit Key Code for your goods/services. Download the CFDI Catalogs.

Mention whether the item is primary or not

Actual available stock in your warehouse.

Current available stock in your warehouse.

Items

Accounts

🇬🇧 , Europe only Total of the VAT Acquistion

The date the bill was created. [yyyy-mm-dd]

🇮🇳 only Place where the goods/services are supplied to. (If not given, organization's home state will be taken)

🇮🇳 only 15 digit GST identification number of the vendor.

🇮🇳 only Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst, business_none, overseas, consumer.

🇮🇳 only Applicable for transactions that fall before July 1, 2017

🇮🇳 only Applicable for transactions where you pay reverse charge

🇦🇪 only The permit number for the bill.

GCC only The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken) Supported codes for UAE emirates are: Abu Dhabi - AB, Ajman - AJ, Dubai - DU, Fujairah - FU, Ras al-Khaimah - RA, Sharjah - SH, Umm al-Quwain - UM. Supported codes for the GCC countries are: United Arab Emirates - AE, Saudi Arabia - SA, Bahrain - BH, Kuwait - KW, Oman - OM, Qatar - QA.

🇬🇧 , Europe only Total of the Reverse Charge

🇮🇳 only Place from where the goods/services are supplied. (If not given, the place of contact given for the contact will be taken)

GCC , 🇲🇽 only VAT treatment for the bill. Choose whether the vendor falls under: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc. dz_vat_registered and dz_vat_not_registered are supported only for UAE. home_country_mexico, border_region_mexico, non_mexico supported only for MX.

🇬🇧 , Avalara Integration only For UK Edition: VAT Registration number of a contact with Length should be between 2 and 12 characters. For Avalara: If you are doing sales in the European Union (EU) then provide VAT Registration Number of your customers here. This is used to calculate VAT for B2B sales, from Avalara.

🇬🇧 only (Optional) VAT treatment for the bill. VAT treatment denotes the location of the vendor, if the vendor resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered, and non_eu).

ID of the vendor the bill has to be created.

Bills

Contact Persons

Contacts

🇲🇽 only Choose CFDI Reference Type. Allowed values: credit_note, debit_note, return_of_merchandise, substitution_previous_cfdi, transfer_of_goods, invoice_generated_from_order, cfdi_for_advance.

🇲🇽 only Choose CFDI Usage. Allowed values: acquisition_of_merchandise, return_discount_bonus, general_expense, buildings, furniture_office_equipment, transport_equipment, computer_equipment, dye_molds_tools, telephone_communication, satellite_communication, other_machinery_equipment, hospital_expense, medical_expense_disability, funeral_expense, donation, interest_mortgage_loans, contribution_sar, medical_expense_insurance_premium, school_transportation_expense, deposit_saving_account, payment_educational_service, no_tax_effect, payment, payroll.

Unique ID of the credit note generated by the server.

Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]

Customer's currency code. This currency code is used in credit notes.

Customer ID of the customer for whom the credit note is raised.

Name of the customer to whom the credit note is raised. Max-Length [100]

The date on which the credit note is raised. Format [yyyy-mm-dd]

🇮🇳 only 15 digit GST identification number of the customer.

🇮🇳 only Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer.

A short note for the credit note. Max-length [5000]

🇮🇳 , GCC only Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)

Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]

Status of the credit note. This can be open, closed or void.

GCC , 🇲🇽 only VAT treatment for the credit note. Choose whether the contact falls under: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc. dz_vat_registered and dz_vat_not_registered supported only for UAE. home_country_mexico,border_region_mexico,non_mexico supported only for MX.

Terms & condition to be displayed in the credit note. Max-length [10000]

Total credits raised in this credit note.

🇬🇧 only (Optional) VAT treatment for the invoices. VAT treatment denotes the location of the customer.

Credit Notes

Currencies

Amount that is refund. Refunds are applicable only for payments whose payment_mode is autotransaction. Refunds would be made to the respective card provided by the customer.

Customer ID of the customer involved in the payment.

Name of the customer to whom the invoice is raised. Max-length [100]

Date on which payment is made. Format [yyyy-mm-dd]

Email address of the customer involved in the payment.

Unique ID of the payment generated by the server. Max-length [2000]

Mode through which payment is made. This can be check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Max-length [100]

Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]

Status of the payment. It can either be success or failure.

Customer Payments

Customize the adjustment description. E.g., Rounding off.

Search estimates by customer name. Variants: customer_name_startswith and customer_name_contains

Search estimates by estimate date. Variants: date_start, date_end, date_before, and date_after

Discount applied to the invoice. It can be either in % or in amount. e.g., 12.5% or 190.

How the discount is specified. Allowed values are entity_level or item_level. Allowed Values: entity_level and item_level

Search estimates by estimate number. Variants: estimate_number_startswith and estimate_number_contains

15 digit GST identification number of the customer (🇮🇳 only)

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst, business_none, overseas, consumer (🇮🇳 only)

Used to specify how the discount has to be applied. Either before or after the calculation of tax.

Applicable for transactions that fall before July 1, 2017 (🇮🇳 only)

Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken). Supported codes for UAE emirates are Abu Dhabi - AB, Ajman - AJ, Dubai - DU, Fujairah - FU, Ras al-Khaimah - RA, Sharjah - SH, Umm al-Quwain - UM. Supported codes for the GCC countries are United Arab Emirates - AE, Saudi Arabia - SA, Bahrain - BH, Kuwait - KW, Oman - OM, Qatar - QA.

Search estimates by reference number. Variants: reference_number_startswith and reference_number_contains

Search estimates by status. Allowed Values: draft, sent, invoiced, accepted, declined, and expired

VAT treatment for the Estimate. Allowed Values: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc. dz_vat_registered and dz_vat_not_registered supported only for UAE. home_country_mexico, border_region_mexico, non_mexico supported only for MX.

Search estimates by estimate total. Variants: total_less_than, total_less_equals, total_greater_than, and total_greater_equals

Estimates

Name of the Customer for which expense is raised. Max-length [100]

Description of the expense. Max-length [100]

Place where the goods/services are supplied to. (If not given, organization's home state will be taken) (🇮🇳 only)

State to where goods/services are supplied (🇮🇳 only)

End reading of odometer when creating a mileage expense where mileage_type is odometer.

15 digit GST identification number of the vendor (🇮🇳 only)

Add HSN/SAC code for your goods/services (🇮🇳 only)

Mileage rate for a particular mileage expense.

Enter the name of the paid-through account.

The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken). Supported codes for UAE emirates are Abu Dhabi - AB, Ajman - AJ, Dubai - DU, Fujairah - FU, Ras al-Khaimah - RA, Sharjah - SH, Umm al-Quwain - UM. Supported codes for the GCC countries are United Arab Emirates - AE, Saudi Arabia - SA, Bahrain - BH, Kuwait - KW, Oman - OM, Qatar - QA.

ID of the project associated with the customer.

Reference number of the expense. Max-length [100]

(🇮🇳 only) Enter amount of the reverse charge tax

(🇮🇳 only) Enter name of the reverse charge tax

(🇮🇳 only) Enter percentage of the reverse charge tax

(🇮🇳 only) Enter total of the reverse charge VAT tax

Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken) (🇮🇳 only)

Start reading of odometer when creating a mileage expense where mileage_type is odometer.

VAT treatment for the expense. Choose whether the contact falls under: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc. dz_vat_registered and dz_vat_not_registered are supported only for UAE.

Expenses

Choose CFDI Reference Type. Allowed values: return_of_merchandise, substitution_previous_cfdi, transfer_of_goods, invoice_generated_from_order, cfdi_for_advance (🇲🇽 only).

Choose CFDI Usage. Allowed values: acquisition_of_merchandise, return_discount_bonus, general_expense, buildings, furniture_office_equipment, transport_equipment, computer_equipment, dye_molds_tools, telephone_communication, satellite_communication, other_machinery_equipment, hospital_expense, medical_expense_disability, funeral_expense, donation, interest_mortgage_loans, contribution_sar, medical_expense_insurance_premium, school_transportation_expense, deposit_saving_account, payment_educational_service, no_tax_effect, payment, payroll (🇲🇽 only).

ID of the customer the invoice has to be created.

The name of the customer. Max-length [100]

Search invoices by invoice date. Default date format is yyyy-mm-dd. Variants: due_date_start, due_date_end, due_date_before, and due_date_after.

Search invoices by due date. Default date format is yyyy-mm-dd. Variants: due_date_start, due_date_end, due_date_before, and due_date_after.

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst, business_none, overseas, consumer (🇮🇳 only).

Search invoices by invoice number. Variants: invoice_number_startswith and invoice_number_contains. Max-length [100]

Boolean to check if partial payments are allowed for the contact

Boolean to check if reminders have been enabled

Shipping charges applied to the invoice. Max-length [100]

Payment terms in days, e.g., 15, 30, 60. Invoice due date will be calculated based on this. Max-length [100]

Used to override the default payment terms label. Default value for 15 days is 'Net 15 Days'. Max-length [100]

Associate the reference invoice (🇲🇽 only).

Search invoices by invoice status. Allowed Values: sent, draft, overdue, paid, void, unpaid, partially_paid, and viewed.

VAT treatment for the invoice. Choose whether the contact falls under: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc. dz_vat_registered and dz_vat_not_registered supported only for UAE. home_country_mexico, border_region_mexico, non_mexico supported only for MX. (GCC, 🇲🇽 only).

Optional VAT treatment for the invoices. VAT treatment denotes the location of the customer. If the customer resides in the UK, then the VAT treatment is uk. If the customer is in an EU country and VAT registered, and you are residing in Northern Ireland and selling Goods, then his VAT treatment is eu_vat_registered. If he resides outside of the UK, then his VAT treatment is overseas. For Pre-Brexit, this can be split as eu_vat_registered, eu_vat_not_registered, and non_eu (🇬🇧 only).

Invoices

Code of the Currency Associated with the Journal

ID of the Currency Associated with the Journal

Symbol of the Currency Associated with the Journal

Europe, 🇬🇧 only. Check if Journal should be included in VAT Return.

(🇦🇺 only) Check if Journal is created for BAS Adjustment

Date on which the journal to be recorded.

Type of the Journal. Allowed values: Cash and Both.

(🇬🇧 only) Type of the journal. This denotes whether the journal is to be treated as goods or service. Allowed Values: digital_service, goods, and service.

Search Journal by journal status. Allowed Values: draft and published.

(🇬🇧, Europe only) VAT treatment for the journals. VAT treatment denotes the location of the customer, if the customer resides in the UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are residing in Northern Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered, and non_eu).

Journals

Organizations

The way you bill your customer. Allowed Values: fixed_cost_for_project, based_on_project_hours, based_on_staff_hours, and based_on_task_hours

Projects

Discount to be applied on Purchase Order.

🇮🇳 only
15 digit GST identification number of the vendor.

🇮🇳 only Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

Discount applied before or after applying tax.

Not applicable 🇺🇸 Used to specify whether the line item rates are inclusive or exclusive of tax.

🇮🇳 only
Applicable for transactions that fall before July 1, 2017

🇮🇳 only
Applicable for transactions where you pay reverse charge

GCC only The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken) Supported codes for UAE emirates are : Abu Dhabi - AB, Ajman - AJ, Dubai - DU, Fujairah - FU, Ras al-Khaimah - RA, Sharjah - SH, Umm al-Quwain - UM. Supported codes for the GCC countries are : United Arab Emirates - AE, Saudi Arabia - SA, Bahrain - BH, Kuwait - KW, Oman - OM, Qatar - QA.

Mandatory if auto number generation is disabled.

🇮🇳 only Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)

GCC , 🇲🇽 only VAT treatment for the purchase order. Choose whether the vendor falls under: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc. dz_vat_registered and dz_vat_not_registered are supported only for UAE. home_country_mexico, border_region_mexico, non_mexico supported only for MX.

🇬🇧 only (Optional) VAT treatment for the purchase order. VAT treatment denotes the location of the vendor, if the vendor resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northern Ireland and purchasing Goods then his VAT treatment is eu_vat_registered and if he resides outside the UK then his VAT treatment is overseas(For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).

ID of the vendor the purchase order has to be created.

Purchase Orders

Array of contact persons for whom the sales order has to be sent

ID of the customer for whom the sales order is created

Name of the customer associated with the Sales Order

Discount applied to the sales order (e.g., 12.5% or 190)

How the discount is specified. Allowed values: entity_level and item_level

15-digit GST identification number of the customer in 🇮🇳 (India)

Choose whether the contact is GST registered/unregistered/consumer/overseas in 🇮🇳 (India). Allowed values are business_gst, business_none, overseas, consumer.

Used to specify how the discount is applied, either before or after the calculation of tax

Applicable for transactions that fall before July 1, 2017 in 🇮🇳 (India)

Place where the goods/services are supplied to. Supported codes for UAE and GCC countries are provided.

Mandatory if auto-number generation is disabled

VAT treatment for the sales order in GCC and 🇲🇽 (Mexico). Allowed values: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc.

VAT treatment for the sales order in 🇬🇧 (UK). Denotes the location of the customer.

Sales Orders

Tasks

Taxes

Users

Code of the Currency Involved in the Vendor Credit

ID of the Currency Involved in the Vendor Credit

The date the vendor credit is created. [yyyy-mm-dd]

🇮🇳 only. Place where the goods/services are supplied to. (If not given, organization's home state will be taken)

🇬🇧 only. ID of the VAT Return the Vendor Credit is filed in

🇬🇧 only. Name of the VAT Return the Vendor Credit is filed in

🇬🇧 only. Type of the VAT Return the Vendor Credit is filed in

🇮🇳 only. 15-digit GST identification number of the vendor.

🇮🇳 only. Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst, business_none, overseas, consumer.

Not applicable 🇺🇸. Used to specify whether the line item rates are inclusive or exclusive of tax.

🇮🇳 only. Applicable for transactions where you pay reverse charge

GCC only. The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken)

Reference number for the refund recorded.

🇮🇳 only. Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)

GCC, 🇲🇽 only. VAT treatment for the vendor credit. Choose whether the vendor falls under: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc. dz_vat_registered and dz_vat_not_registered are supported only for UAE. home_country_mexico, border_region_mexico, non_mexico supported only for MX.

🇬🇧 only. VAT treatment for the vendor credits. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northern Ireland and purchasing Goods then his VAT treatment is eu_vat_registered and if he resides outside the EU then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).

ID of the vendor the vendor credit is associated with

Name of the Vendor Associated with the Vendor Credit

Vendor Credits

Total Amount of Vendor Payment (Required).

Individual bill payment details as an array.

Check details (applicable in the United States, Canada, and Mexico).

Description for the Vendor Payment recorded.

Check if the Bill Payment is paid via the Print Check Option (applicable in the United States, Canada, and Mexico).

ID of the cash/bank account from which the payment is made.

Reference number for the Vendor Payment recorded.

ID of the vendor associated with the Vendor Payment.

Vendor Payments

Zoho Books

Quickbooks

# Continuous Import of Bills to Your App

This scenario enables your application to continuously sync Bills from any external application to your app's API. It handles the initial import of Bills and keeps them synchronized when a Bill is created, updated, or deleted in the external application.

When receiving Bills data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Bills to my App

Import Bills and receive created/updated or deleted events

Xero

Sage Accounting

Exact Online

# Continuous Import of Ledger Accounts to Your App

This scenario enables your application to continuously sync Ledger Accounts from any external application to your app's API. It handles the initial import of Ledger Accounts and keeps them synchronized when a Ledger Account is created, updated, or deleted in the external application.

When receiving Ledger Accounts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Ledger Accounts to my App

Import Ledger Accounts and receive created/updated or deleted events

Salesforce

# Continuous Import of Products to Your App

This scenario enables your application to continuously sync Products from any external application to your app's API. It handles the initial import of Products and keeps them synchronized when a Product is created, updated, or deleted in the external application.

When receiving Products data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Products to my App

Import Products and receive created/updated or deleted events

Zoho Books API Integration Profile

How to work with Items in Zoho Books API

Items Fields

Operations on Items Collection

Supercharge your product integrations today

Field Name	API Key	Type	Description
Item Id	item_id	string	ID of the item.
Name	name	string	Name of the item. Max-length [100]
Status	status	string	Status of the item. It can be 'active' or 'inactive'
Description	description	string	Description for the item. Max-length [2000]
Rate	rate	number	Price of the item.