Overview
Configuration is provided for establishing connections with Zoho Books service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Zoho Books REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Zoho Books.. Then click New in the Token File parameter to create a new token file.
Step 3: Provide value for organization_id parameter in the next wizard and hit and then press Next button.
Step 4: Provide Email or Mobile Number and hit Next button.
Step 5: Once you have completed the login process, you will be redirected to the Authorization screen. Click on Accept to continue with token generation process.
Step 6: Save generated access token. Specify token protection password. Click OK.
Step 7. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Zoho Books instance.
In this guide, we will show how to read data from the Zoho Books service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Zoho Books connection from the combo. Select from available Zoho Books resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Zoho Books resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Zoho Books service.
In this guide, we will show how to write data to the Zoho Books service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Zoho Books connection from the combo. Also, select resource action and Zoho Books resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Zoho Books resource.
Configuration
Base URL address: https://books.zoho.com/api/v3.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300000)}}.The authentication has the following user-defined parameters:
- Scope:
- organization_id: Required. Specify the organization identifier.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
organization_id:
{{=connection.token.organization_id}}
Documentation: https://www.zoho.com/books/api/v3/oauth/#overview.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.Documentation: https://www.zoho.com/books/api/v3/contacts/#list-contacts.
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/contacts/#get-contact.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://www.zoho.com/books/api/v3/contacts/#create-a-contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.contact_id}}.Documentation: https://www.zoho.com/books/api/v3/contacts/#update-a-contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.contact_id}}.Documentation: https://www.zoho.com/books/api/v3/contacts/#delete-a-contact.
- contact_id
A key field. Template: ShortText.
- contact_name
Template: ShortText.
- company_name
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- designation
Template: ShortText.
- department
Template: ShortText.
- website
Template: ShortText.
- is_bcy_only_contact
Data type: DT_BOOL
- is_credit_limit_migration_completed
Data type: DT_BOOL
- language_code
Template: ShortText.
- language_code_formatted
Template: ShortText.
- contact_salutation
Template: ShortText.
Template: ShortText.
- phone
Template: ShortText.
- mobile
Template: ShortText.
- portal_status
Template: ShortText.
- is_client_review_asked
Data type: DT_BOOL
- has_transaction
Data type: DT_BOOL
- contact_type
Template: ShortText.
- customer_sub_type
Template: ShortText.
- owner_id
Template: ShortText.
- owner_name
Template: ShortText.
- source
Template: ShortText.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
Template: ShortText.
Template: ShortText.
- is_crm_customer
Data type: DT_BOOL
- is_linked_with_zohocrm
Data type: DT_BOOL
- primary_contact_id
Template: ShortText.
- zcrm_account_id
Template: ShortText.
- zcrm_contact_id
Template: ShortText.
- crm_owner_id
Template: ShortText.
- payment_terms
Data type: DT_I4
- payment_terms_label
Template: ShortText.
- credit_limit_exceeded_amount
Template: Numeric.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- price_precision
Data type: DT_I4
- exchange_rate
Template: Numeric.
- can_show_customer_ob
Data type: DT_BOOL
- can_show_vendor_ob
Data type: DT_BOOL
- opening_balance_amount
Template: Numeric.
- opening_balance_amount_bcy
Template: ShortText.
- outstanding_ob_receivable_amount
Template: Numeric.
- outstanding_ob_payable_amount
Template: Numeric.
- outstanding_receivable_amount
Template: Numeric.
- outstanding_receivable_amount_bcy
Template: Numeric.
- outstanding_payable_amount
Template: Numeric.
- outstanding_payable_amount_bcy
Template: Numeric.
- unused_credits_receivable_amount
Template: Numeric.
- unused_credits_receivable_amount_bcy
Template: Numeric.
- unused_credits_payable_amount
Template: Numeric.
- unused_credits_payable_amount_bcy
Template: Numeric.
- unused_retainer_payments
Data type: DT_I4
- payment_reminder_enabled
Data type: DT_BOOL
- is_sms_enabled
Data type: DT_BOOL
- is_consent_agreed
Data type: DT_BOOL
- consent_date
Template: ShortText.
- is_client_review_settings_enabled
Data type: DT_BOOL
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- track_1099
Data type: DT_BOOL
- tax_id_type
Template: ShortText.
- tax_id_value
Template: ShortText.
- contact_category
Template: ShortText.
- sales_channel
Template: ShortText.
- ach_supported
Data type: DT_BOOL
- portal_receipt_count
Data type: DT_I4
- opening_balances
Template: LongText. A composite field.
- pricebook_id
Template: ShortText.
- pricebook_name
Template: ShortText.
- associated_with_square
Data type: DT_BOOL
- cards
Template: LongText. A composite field.
- checks
Template: LongText. A composite field.
- bank_accounts
Field components:
- An array.
- Contains the following components: account_id, account_name, account_code, currency_id, currency_code, currency_symbol, price_precision, account_type, account_number, uncategorized_transactions, total_unprinted_checks, is_active, is_feeds_subscribed, is_feeds_active, balance, bank_balance, bcy_balance, bank_name, routing_number, is_primary_account, is_paypal_account, description, refresh_status_code, feeds_last_refresh_date, service_id, is_system_account, is_show_warning_for_feeds_refresh.
- vpa_list
Template: LongText. A composite field.
- notes
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- created_date
Template: ShortText.
- created_by_name
Template: ShortText.
- last_modified_time
Template: DateTime. A read-only field.
- tags
Field components:
- An array.
-
Uses template:
TagT.
- zohopeople_client_id
Template: ShortText.
- customer_currency_summaries
Field components:
- An array.
- Contains the following components: currency_id, currency_code, currency_symbol, price_precision, is_base_currency, currency_name_formatted, outstanding_receivable_amount, unused_credits_receivable_amount.
- billing_address
Template: GeneralAddressT.
- shipping_address
Template: GeneralAddressT.
- contact_persons
Field components:
- An array.
-
Uses template:
ContactPersonT.
- default_templates
Field components:
-
Uses template:
ShortText. - Contains the following components: invoice_template_id, invoice_template_name, bill_template_id, bill_template_name, estimate_template_name, estimate_template_id, creditnote_template_id, creditnote_template_name, purchaseorder_template_id, salesorder_template_id, retainerinvoice_template_id, paymentthankyou_template_id, paymentthankyou_template_name, retainerinvoice_paymentthankyou_template_id, invoice_email_template_id, invoice_email_template_name, estimate_email_template_id, estimate_email_template_name, creditnote_email_template_id, creditnote_email_template_name, purchaseorder_email_template_id, salesorder_email_template_id, retainerinvoice_email_template_id, paymentthankyou_email_template_id, paymentthankyou_email_template_name, retainerinvoice_paymentthankyou_email_template_name.
-
Uses template:
- statementMailContent
A read-only field. The value is gathered from
/contacts/{{=item.contact_id}}/statements/emailaddress. The gathered value is processed with{{=response.data}}expression. Field components:-
Uses template:
LongText. - Contains the following components: code, message, body, error_list, subject, to_contacts, file_name, from_emails, customer_id.
-
Uses template:
- refunds
A read-only field. The value is gathered from
/contacts/{{=item.contact_id}}/refundsaddress. The gathered value is processed with{{=response.creditnote_refunds}}expression. Field components:- An array.
-
Uses template:
RefundT.
- comments
A read-only field. The value is gathered from
/contacts/{{=item.contact_id}}/commentsaddress. The gathered value is processed with{{=response.contact_comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- addresses
A read-only field. The value is gathered from
/contacts/{{=item.contact_id}}/addressaddress. The gathered value is processed with{{=response.addresses}}expression. Field components:- An array.
-
Uses template:
GeneralAddressT.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: enablePortableAccess, emailStatement, enablePaymentReminder, disablePaymentReminder, track1099, untrack1099.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/address.The action has the following user-defined parameters:
- contact_id: Required. Specify contact identifier.
Documentation: https://www.zoho.com/books/api/v3/contacts/#get-contact-addresses.
- [Create] action
-
Endpoint URL address:
/contacts/{{=item.contact_id}}/address.Documentation: https://www.zoho.com/books/api/v3/contacts/#add-additional-address.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.contact_id}}/address/{{=item.address_id}}.Documentation: https://www.zoho.com/books/api/v3/contacts/#edit-additional-address.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.contact_id}}/address/{{=item.address_id}}.Documentation: https://www.zoho.com/books/api/v3/contacts/#delete-additional-address.
The resource includes the fields from the GeneralAddressT template.
- contact_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/contactpersons.The action has the following user-defined parameters:
- contact_id: Required. Specify contact identifier.
Documentation: https://www.zoho.com/books/api/v3/contact-persons/#list-contact-persons.
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/contactpersons/{{=parameters.id}}.The action has the following user-defined parameters:
- contact_id: Required. Specify contact identifier.
Documentation: https://www.zoho.com/books/api/v3/contact-persons/#get-a-contact-person.
- [Create] action
-
Endpoint URL address:
/contacts/contactpersons.Documentation: https://www.zoho.com/books/api/v3/contact-persons/#create-a-contact-person.
- [Update] action
-
Endpoint URL address:
/contacts/contactpersons/{{=item.contact_person_id}}.Documentation: https://www.zoho.com/books/api/v3/contact-persons/#update-a-contact-person.
- [Delete] action
-
Endpoint URL address:
/contacts/contactpersons/{{=item.contact_person_id}}.Documentation: https://www.zoho.com/books/api/v3/contact-persons/#delete-a-contact-person.
The resource includes the fields from the ContactPersonT template.
- action
Template: ShortText. Field components:
- Contains the following components: markPrimaryContact.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/estimates.Documentation: https://www.zoho.com/books/api/v3/estimates/#list-estimates.
- [Read single] action
-
Endpoint URL address:
/estimates/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/estimates/#get-an-estimate.
- [Create] action
-
Endpoint URL address:
/estimates.Documentation: https://www.zoho.com/books/api/v3/estimates/#create-an-estimate.
- [Update] action
-
Endpoint URL address:
/estimates/{{=item.estimate_id}}.Documentation: https://www.zoho.com/books/api/v3/estimates/#update-an-estimate.
- [Delete] action
-
Endpoint URL address:
/estimates/{{=item.estimate_id}}.Documentation: https://www.zoho.com/books/api/v3/estimates/#delete-an-estimate.
- estimate_id
A key field. Template: ShortText.
- estimate_number
Template: ShortText.
- zcrm_potential_id
Template: ShortText.
- zcrm_potential_name
Template: ShortText.
- date
Template: Date.
- created_date
Template: Date. A read-only field.
- reference_number
Template: ShortText.
- color_code
Template: ShortText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- customer_id
Template: ShortText.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- customer_name
Template: ShortText.
- is_transaction_created
Data type: DT_BOOL
- is_converted_to_open
Data type: DT_BOOL
- contact_category
Template: ShortText.
- contact_persons
Template: LongText. A composite field.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- exchange_rate
Data type: DT_R8
- expiry_date
Template: ShortText.
- discount_amount
Data type: DT_R8
- discount
Data type: DT_R8
- discount_applied_on_amount
Data type: DT_R8
- is_discount_before_tax
Data type: DT_BOOL
- discount_type
Template: ShortText.
- is_viewed_by_client
Data type: DT_BOOL
- client_viewed_time
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- tax_rounding
Template: ShortText.
- estimate_url
Template: ShortText.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- submitter_id
Template: ShortText.
- submitted_date
Template: Date.
- submitted_by
Template: ShortText.
- approver_id
Template: ShortText.
- shipping_charge
Data type: DT_R8
- bcy_shipping_charge
Data type: DT_R8
- adjustment
Data type: DT_R8
- bcy_adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- roundoff_value
Data type: DT_R8
- transaction_rounding_type
Template: ShortText.
- sub_total
Data type: DT_R8
- bcy_sub_total
Data type: DT_R8
- sub_total_inclusive_of_tax
Data type: DT_R8
- sub_total_exclusive_of_discount
Data type: DT_R8
- discount_total
Data type: DT_R8
- bcy_discount_total
Data type: DT_R8
- discount_percent
Data type: DT_R8
- total
Data type: DT_R8
- bcy_total
Data type: DT_R8
- tax_total
Data type: DT_R8
- bcy_tax_total
Data type: DT_R8
- price_precision
Data type: DT_I4
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- invoice_ids
Template: LongText. A composite field.
- billing_address
Template: GeneralAddressT.
- shipping_address
Template: GeneralAddressT.
- customer_default_billing_address
Template: GeneralAddressT.
- notes
Template: ShortText.
- terms
Template: ShortText.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- template_type
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- contact_persons_details
Field components:
- An array.
-
Uses template:
ContactPersonT.
- salesperson_id
Template: ShortText.
- salesperson_name
Template: ShortText.
- attachment_name
Template: ShortText.
- can_send_in_mail
Data type: DT_BOOL
- can_send_estimate_sms
Data type: DT_BOOL
- allow_partial_payments
Data type: DT_BOOL
- payment_options
Field components:
- Contains the following components: payment_gateways.
- retainerinvoices
Field components:
- An array.
-
Uses template:
InvoiceT.
- project
Field components:
-
Uses template:
ShortText. - Contains the following components: project_id, project_name, customer_id, customer_name, description, status, billing_type, rate.
-
Uses template:
- subject_content
Template: ShortText.
- approvers_list
Template: LongText. A composite field.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- emailContent
Template: ContentT. A read-only field. The value is gathered from
/estimates/{{=item.estimate_id}}/emailaddress. The gathered value is processed with{{=response}}expression.- comments
A read-only field. The value is gathered from
/estimates/{{=item.estimate_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: submit, approve, emailSingleEstimates.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/salesorders.Documentation: https://www.zoho.com/books/api/v3/sales-order/#list-sales-orders.
- [Read single] action
-
Endpoint URL address:
/salesorders/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/sales-order/#get-a-sales-order.
- [Create] action
-
Endpoint URL address:
/salesorders.Documentation: https://www.zoho.com/books/api/v3/sales-order/#create-a-sales-order.
- [Update] action
-
Endpoint URL address:
/salesorders/{{=item.salesorder_id}}.Documentation: https://www.zoho.com/books/api/v3/sales-order/#update-a-sales-order.
- [Delete] action
-
Endpoint URL address:
/salesorders/{{=item.salesorder_id}}.Documentation: https://www.zoho.com/books/api/v3/sales-order/#delete-a-sales-order.
- salesorder_id
A key field. Template: ShortText.
- zcrm_potential_id
Template: ShortText.
- zcrm_potential_name
Template: ShortText.
- salesorder_number
Template: ShortText.
- date
Template: Date.
- offline_created_date_with_time
Template: DateTime.
- tracking_url
Template: ShortText.
- has_discount
Data type: DT_BOOL
- color_code
Template: ShortText.
- reason
Template: LongText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- order_sub_status_id
Template: ShortText.
- invoiced_sub_status_id
Template: ShortText.
- order_sub_status
Template: ShortText.
- invoiced_sub_status
Template: ShortText.
- shipment_date
Template: ShortText.
- reference_number
Template: ShortText.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- contact_persons
Template: LongText. A composite field.
- contact_person_details
Field components:
- An array.
-
Uses template:
ContactPersonT.
- source
Template: ShortText.
- contact_category
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- exchange_rate
Data type: DT_R8
- is_discount_before_tax
Data type: DT_BOOL
- discount_type
Template: ShortText.
- estimate_id
Template: ShortText.
- delivery_method
Template: ShortText.
- delivery_method_id
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- tax_rounding
Template: ShortText.
- order_status
Template: ShortText.
- invoiced_status
Template: ShortText.
- paid_status
Template: ShortText.
- account_identifier
Template: ShortText.
- integration_id
Template: ShortText.
- has_qty_cancelled
Data type: DT_BOOL
- shipping_details
Template: LongText. A composite field.
- created_by_email
Template: ShortText.
- total_quantity
Data type: DT_I4
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- entity_tags
Template: ShortText.
- submitter_id
Template: ShortText.
- approver_id
Template: ShortText.
- submitted_date
Template: Date.
- submitted_by
Template: ShortText.
- order_sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- invoice_sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- price_precision
Data type: DT_I4
- is_emailed
Data type: DT_BOOL
- purchaseorders
Field components:
- An array.
- Contains the following components: purchaseorder_id, purchaseorder_number, purchaseorder_date, purchaseorder_status.
- billing_address_id
Template: ShortText.
- billing_address
Template: GeneralAddressT.
- shipping_address_id
Template: ShortText.
- shipping_address
Template: GeneralAddressT.
- is_test_order
Data type: DT_BOOL
- notes
Template: ShortText.
- terms
Template: ShortText.
- payment_terms
Data type: DT_I4
- payment_terms_label
Template: ShortText.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- template_type
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: ShortText.
- created_by_id
Template: ShortText.
- created_date
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- attachment_name
Template: ShortText.
- can_send_in_mail
Data type: DT_BOOL
- salesperson_id
Template: ShortText.
- salesperson_name
Template: ShortText.
- merchant_id
Template: ShortText.
- merchant_name
Template: ShortText.
- pickup_location_id
Template: ShortText.
- discount_amount
Data type: DT_I4
- discount
Data type: DT_I4
- discount_applied_on_amount
Data type: DT_I4
- is_adv_tracking_in_package
Data type: DT_BOOL
- shipping_charge
Data type: DT_R8
- bcy_shipping_charge
Data type: DT_R8
- adjustment
Data type: DT_R8
- bcy_adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- status_code
A key field. Template: ShortText.
- roundoff_value
Data type: DT_I4
- transaction_rounding_type
Template: ShortText.
- sub_total
Data type: DT_R8
- bcy_sub_total
Data type: DT_R8
- sub_total_inclusive_of_tax
Data type: DT_R8
- sub_total_exclusive_of_discount
Data type: DT_R8
- discount_total
Data type: DT_R8
- bcy_discount_total
Data type: DT_R8
- discount_percent
Data type: DT_I4
- tax_total
Data type: DT_R8
- bcy_tax_total
Data type: DT_R8
- total
Data type: DT_R8
- computation_type
Template: ShortText.
- bcy_total
Data type: DT_R8
- invoices
Field components:
- An array.
-
Uses template:
InvoiceT.
- balance
Data type: DT_R8
- approvers_list
Template: LongText. A composite field.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- contact_persons_details
Field components:
- An array.
-
Uses template:
ContactPersonT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- emailContent
Template: ContentT. A read-only field. The value is gathered from
/salesorders/{{=item.salesorder_id}}/emailaddress. The gathered value is processed with{{=response.data}}expression.- comments
A read-only field. The value is gathered from
/estimates/{{=item.salesorder_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: submit, approve, updateSubStatus, emailSingleSaleOrder.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/invoices.Documentation: https://www.zoho.com/books/api/v3/invoices/#list-invoices.
- [Read single] action
-
Endpoint URL address:
/invoices/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/invoices/#get-an-invoice.
- [Create] action
-
Endpoint URL address:
/invoices.Documentation: https://www.zoho.com/books/api/v3/invoices/#create-an-invoice.
- [Update] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}.Documentation: https://www.zoho.com/books/api/v3/invoices/#update-an-invoice.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item.invoice.id}}.Documentation: https://www.zoho.com/books/api/v3/invoices/#delete-an-invoice.
- invoice_id
A key field. Template: ShortText.
- invoice_number
Template: ShortText.
- date
Template: Date.
- due_date
Template: Date.
- offline_created_date_with_time
Template: ShortText.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- currency_name_formatted
Template: ShortText.
- recurring_invoice_id
Template: ShortText.
- payment_terms
Data type: DT_I4
- payment_terms_label
Template: ShortText.
- payment_reminder_enabled
Data type: DT_BOOL
- payment_made
Data type: DT_R8
- zcrm_potential_id
Template: ShortText.
- zcrm_potential_name
Template: ShortText.
- reference_number
Template: ShortText.
- lock_details
Template: LongText. A composite field.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- exchange_rate
Data type: DT_R8
- is_autobill_enabled
Data type: DT_BOOL
- inprocess_transaction_present
Data type: DT_BOOL
- allow_partial_payments
Data type: DT_BOOL
- price_precision
Data type: DT_I4
- sub_total
Data type: DT_R8
- tax_total
Data type: DT_R8
- discount_total
Data type: DT_R8
- discount_percent
Data type: DT_R8
- discount_amount
Data type: DT_R8
- discount
Data type: DT_R8
- discount_applied_on_amount
Data type: DT_R8
- discount_type
Template: ShortText.
- is_discount_before_tax
Data type: DT_BOOL
- adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- shipping_charge
Data type: DT_R8
- bcy_shipping_charge
Data type: DT_R8
- bcy_adjustment
Data type: DT_R8
- bcy_sub_total
Data type: DT_R8
- bcy_discount_total
Data type: DT_R8
- bcy_tax_total
Data type: DT_R8
- bcy_total
Data type: DT_R8
- total
Data type: DT_R8
- balance
Data type: DT_R8
- write_off_amount
Data type: DT_R8
- roundoff_value
Data type: DT_R8
- transaction_rounding_type
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- sub_total_inclusive_of_tax
Data type: DT_R8
- contact_category
Template: ShortText.
- tax_rounding
Template: ShortText.
- can_send_invoice_sms
Data type: DT_BOOL
- payment_expected_date
Template: ShortText.
- payment_discount
Data type: DT_R8
- stop_reminder_until_payment_expected_date
Data type: DT_BOOL
- last_payment_date
Template: ShortText.
- ach_supported
Data type: DT_BOOL
- ach_payment_initiated
Data type: DT_BOOL
- payment_options
Field components:
- Contains the following components: payment_gateways.
- reader_offline_payment_initiated
Data type: DT_BOOL
- attachment_name
Template: ShortText.
- computation_type
Template: ShortText.
- deliverychallans
Template: LongText. A composite field.
- merchant_id
Template: ShortText.
- merchant_name
Template: ShortText.
- ecomm_operator_id
Template: ShortText.
- ecomm_operator_name
Template: ShortText.
- salesorder_id
Template: ShortText.
- salesorder_number
Template: ShortText.
- salesorders
Template: LongText. A composite field.
- shipping_bills
Template: LongText. A composite field.
- salesperson_id
Template: ShortText.
- salesperson_name
Template: ShortText.
- is_emailed
Data type: DT_BOOL
- reminders_sent
Data type: DT_I4
- last_reminder_sent_date
Template: ShortText.
- next_reminder_date_formatted
Template: ShortText.
- is_viewed_by_client
Data type: DT_BOOL
- client_viewed_time
Template: ShortText.
- is_viewed_in_mail
Data type: DT_BOOL
- mail_first_viewed_time
Template: ShortText.
- mail_last_viewed_time
Template: ShortText.
- submitter_id
Template: ShortText.
- approver_id
Template: ShortText.
- submitted_date
Template: ShortText.
- submitted_by
Template: ShortText.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- template_type
Template: ShortText.
- notes
Template: ShortText.
- terms
Template: ShortText.
- invoice_url
Template: ShortText.
- subject_content
Template: ShortText.
- can_send_in_mail
Data type: DT_BOOL
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: DateTime. A read-only field.
- created_date
Template: Date.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- is_backorder
Template: ShortText.
- sales_channel
Template: ShortText.
- color_code
Template: ShortText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- estimate_id
Template: ShortText.
- is_client_review_settings_enabled
Data type: DT_BOOL
- unused_retainer_payments
Data type: DT_R8
- credits_applied
Data type: DT_R8
- tax_amount_withheld
Data type: DT_R8
- schedule_time
Template: ShortText.
- customer_default_billing_address
Template: GeneralAddressT.
- includes_package_tracking_info
Data type: DT_BOOL
- approvers_list
Template: LongText. A composite field.
- billing_address
Template: GeneralAddressT.
- shipping_address_id
Template: ShortText.
- shipping_address
Template: GeneralAddressT.
- invoice_ids
Template: LongText. A composite field.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- contact_persons_details
Field components:
- An array.
-
Uses template:
ContactPersonT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- customer_custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- emailContent
Template: ContentT. A read-only field. The value is gathered from
/invoices/{{=item.invoice_id}}/emailaddress. The gathered value is processed with{{=response.data}}expression.- paymentReminderMail
Template: ContentT. A read-only field. The value is gathered from
/invoices/{{=item.invoice_id}}/paymentreminderaddress. The gathered value is processed with{{=response.data}}expression.- payments
A read-only field. The value is gathered from
/invoices/{{=item.invoice_id}}/paymentsaddress. The gathered value is processed with{{=response.payments}}expression. Field components:- An array.
-
Uses template:
PaymentT.
- creditApplied
A read-only field. The value is gathered from
/invoices/{{=item.invoice_id}}/creditsappliedaddress. The gathered value is processed with{{=response.credits}}expression. Field components:- An array.
- Contains the following components: creditnote_id, creditnotes_invoice_id, creditnotes_number, credited_date.
- comments
A read-only field. The value is gathered from
/invoices/{{=item.invoice_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: submit, approve, enablePaymentReminder, disablePaymentReminder, writeOff, cancelWriteOff, emailSingleInvoice, reminderCustomer.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}. - [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=response.fields}}.- customer_custom.{{=external.field_name_formatted}}
Template: {{=ZohoBooks.getFieldTemplate(external.data_type)}}. Before setting, the value is processed with
{{=ZohoBooks.getFieldValue(field, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/invoices/{{=parameters.invoice_id}}/creditsapplied.The action has the following user-defined parameters:
- invoice_id: Required. Specify invoice identifier.
Documentation: https://www.zoho.com/books/api/v3/invoices/#list-credits-applied.
- [Create] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}/credits.Documentation: https://www.zoho.com/books/api/v3/invoices/#apply-credits.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}/creditsapplied/{{=item.creditnotes_invoice_id}}.Documentation: https://www.zoho.com/books/api/v3/invoices/#delete-applied-credit.
- creditnotes_invoice_id
A key field. Template: ShortText.
- invoice_payments
Field components:
- An array.
-
Uses template:
PaymentT.
- apply_creditnotes
Field components:
- An array.
- Contains the following components: creditnote_id, amount_applied.
- creditnote_id
Template: ShortText.
- creditnotes_number
Template: ShortText.
- credited_date
Template: ShortText.
- amount_applied
Data type: DT_R8
- invoice_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/invoices/{{=parameters.invoice_id}}/payments.The action has the following user-defined parameters:
- invoice_id: Required. Specify invoice identifier.
Documentation: https://www.zoho.com/books/api/v3/invoices/#list-invoice-payments.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}/payments/{{=item.payment_id}}.Documentation: https://www.zoho.com/books/api/v3/invoices/#delete-a-payment.
The resource includes the fields from the PaymentT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recurringinvoices.Documentation: https://www.zoho.com/books/api/v3/recurring-invoices/#list-all-recurring-invoice.
- [Read single] action
-
Endpoint URL address:
/recurringinvoices/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-invoices/#get-a-recurring-invoice.
- [Create] action
-
Endpoint URL address:
/recurringinvoices.Documentation: https://www.zoho.com/books/api/v3/recurring-invoices/#create-a-recurring-invoice.
- [Update] action
-
Endpoint URL address:
/recurringinvoices/{{=item.recurring_invoice_id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-invoices/#update-recurring-invoice.
- [Delete] action
-
Endpoint URL address:
/recurringinvoices/{{=item.recurring_invoice_id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-invoices/#delete-a-recurring-invoice.
- recurring_invoice_id
A key field. Template: ShortText.
- recurrence_name
Template: ShortText.
- reference_number
Template: ShortText.
- recurrence_frequency
Template: ShortText.
- repeat_every
Data type: DT_I4
- child_entity_type
Template: ShortText.
- start_date
Template: Date.
- end_date
Template: Date.
- last_sent_date
Template: ShortText.
- next_invoice_date
Template: ShortText.
- payment_terms
Data type: DT_I4
- payment_terms_label
Template: ShortText.
- contact_category
Template: ShortText.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- customer_email
Template: ShortText.
- customer_phone
Template: ShortText.
- customer_mobile_phone
Template: ShortText.
- photo_url
Template: LongText.
- company_name
Template: ShortText.
- contact_persons
Template: LongText. A composite field.
- currency_id
Template: ShortText.
- price_precision
Data type: DT_I4
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- exchange_rate
Data type: DT_R8
- discount_amount
Data type: DT_R8
- discount
Template: ShortText.
- discount_applied_on_amount
Data type: DT_R8
- is_discount_before_tax
Data type: DT_BOOL
- discount_type
Template: ShortText.
- tax_rounding
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- paid_invoices_total
Data type: DT_R8
- unpaid_invoices_balance
Data type: DT_R8
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- bcy_shipping_charge
Data type: DT_R8
- bcy_adjustment
Data type: DT_R8
- bcy_sub_total
Data type: DT_R8
- bcy_discount_total
Data type: DT_R8
- bcy_tax_total
Data type: DT_R8
- bcy_total
Data type: DT_R8
- discount_percent
Data type: DT_R8
- discount_total
Data type: DT_R8
- adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- recurrence_preferences
Template: ShortText.
- is_general_preference
Data type: DT_BOOL
- shipping_charge
Data type: DT_R8
- roundoff_value
Data type: DT_R8
- transaction_rounding_type
Template: ShortText.
- sub_total
Data type: DT_R8
- sub_total_inclusive_of_tax
Data type: DT_R8
- total
Data type: DT_R8
- tax_total
Data type: DT_R8
- allow_partial_payments
Data type: DT_BOOL
- payment_options
Field components:
- Contains the following components: payment_gateways.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- notes
Data type: DT_WSTR ( length 4000 )
- terms
Template: LongText.
- actual_child_invoices_count
Data type: DT_I4
- manual_child_invoices_count
Data type: DT_I4
- unpaid_child_invoices_count
Data type: DT_I4
- is_autobill_enabled
Data type: DT_BOOL
- salesperson_id
Template: ShortText.
- salesperson_name
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- project_details
Field components:
- An array.
- Contains the following components: project_id, billing_type, name, view_type, description, project_name, tax_id.
- billing_address
Template: GeneralAddressT.
- shipping_address
Template: GeneralAddressT.
- comments
Field components:
- An array.
-
Uses template:
CommentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- customer_custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- status
Template: ShortText.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/creditnotes.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#list-all-credit-notes.
- [Read single] action
-
Endpoint URL address:
/creditnotes/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#get-a-credit-note.
- [Create] action
-
Endpoint URL address:
/creditnotes.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#create-a-credit-note.
- [Update] action
-
Endpoint URL address:
/creditnotes/{{=item.creditnote_id}}.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#update-a-credit-note.
- [Delete] action
-
Endpoint URL address:
/creditnotes/{{=item.creditnote_id}}.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#delete-a-credit-note.
- creditnote_id
A key field. Template: ShortText.
- contact_persons
Template: LongText. A composite field.
- billing_address
Template: GeneralAddressT.
- updated_time
Template: ShortText.
- shipping_address
Template: GeneralAddressT.
- creditnote_number
Template: ShortText.
- date
Template: Date.
- reference_number
Template: ShortText.
- is_emailed
Data type: DT_BOOL
- notes
Data type: DT_WSTR ( length 4000 )
- terms
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- last_modified_time
Template: DateTime. A read-only field.
- place_of_supply
Template: ShortText.
- vat_treatment
Template: ShortText.
- vat_reg_no
Template: ShortText.
- gst_no
Template: ShortText.
- gst_treatment
Template: ShortText.
- tax_treatment
Template: ShortText.
Template: ShortText.
- template_name
Template: ShortText.
- subject_content
Template: ShortText.
- invoice_id
Template: ShortText.
- invoices_credited
Field components:
- An array.
-
Uses template:
InvoiceCreditT.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- salesperson_id
Template: ShortText.
- salesperson_name
Template: ShortText.
- contact_category
Template: ShortText.
- tax_rounding
Template: ShortText.
- color_code
Template: ShortText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- template_id
Template: ShortText.
- template_type
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- currency_name_formatted
Template: ShortText.
- exchange_rate
Data type: DT_R8
- price_precision
Data type: DT_I4
- is_inclusive_tax
Data type: DT_BOOL
- discount_amount
Data type: DT_R8
- discount
Template: ShortText.
- discount_applied_on_amount
Data type: DT_R8
- is_pre_gst
Data type: DT_BOOL
- is_discount_before_tax
Data type: DT_BOOL
- discount_type
Template: ShortText.
- submitter_id
Template: ShortText.
- approver_id
Template: ShortText.
- submitted_date
Template: ShortText.
- submitted_by
Template: ShortText.
- shipping_charge
Data type: DT_R8
- adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- roundoff_value
Data type: DT_R8
- transaction_rounding_type
Template: ShortText.
- sub_total
Data type: DT_R8
- sub_total_inclusive_of_tax
Data type: DT_R8
- tax_total
Data type: DT_R8
- total
Data type: DT_R8
- total_credits_used
Data type: DT_R8
- total_refunded_amount
Data type: DT_R8
- balance
Data type: DT_R8
- creditnote_refunds
Field components:
- An array.
-
Uses template:
RefundT.
- lock_details
Template: LongText. A composite field.
- approvers_list
Template: LongText. A composite field.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- invoices
Field components:
- An array.
-
Uses template:
InvoiceT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- comments
A read-only field. The value is gathered from
/creditnotes/{{=item.creditnote_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- invoiceCredited
A read-only field. The value is gathered from
/creditnotes/{{=item.creditnote_id}}/invoicesaddress. The gathered value is processed with{{=response.invoices_credited}}expression. Field components:- An array.
-
Uses template:
InvoiceCreditT.
- creditnoteRefund
A read-only field. The value is gathered from
/creditnotes/{{=item.creditnote_id}}/refundsaddress. The gathered value is processed with{{=response.creditnote_refunds}}expression. Field components:- An array.
-
Uses template:
RefundT.
- emailContent
Template: ContentT. A read-only field. The value is gathered from
/creditnotes/{{=item.creditnote_id}}/emailaddress. The gathered value is processed with{{=response.data}}expression.- status
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: submit, approve, emailSingleCreditNote, refundCreditNote.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/creditnotes/{{=parameters.creditnote_id}}/invoices.The action has the following user-defined parameters:
- creditnote_id: Required. Specify creditnote identifier.
Documentation: https://www.zoho.com/books/api/v3/credit-notes/#list-all-credit-notes.
- [Create] action
-
Endpoint URL address:
/creditnotes/{{=item.creditnote_id}}/invoices.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#credit-to-an-invoice.
- [Delete] action
-
Endpoint URL address:
/creditnotes/{{=item.creditnote_id}}/invoices/{{=item.creditnote_invoice_id}}.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#delete-invoices-credited.
- creditnote_invoice_id
A key field. Template: ShortText.
- creditnote_id
A key field. Template: ShortText.
- invoice_id
Template: ShortText.
- date
Template: Date.
- invoice_number
Template: ShortText.
- creditnote_number
Template: ShortText.
- credited_amount
Data type: DT_R8
- amount_applied
Data type: DT_R8
- invoices
Field components:
- An array.
-
Uses template:
InvoiceT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/creditnotes/{{=parameters.creditnote_id}}/refunds.The action has the following user-defined parameters:
- creditnote_id: Required. Specify creditnote identifier.
Documentation: https://www.zoho.com/books/api/v3/credit-notes/#list-refunds-of-a-credit-note.
- [Read single] action
-
Endpoint URL address:
/creditnotes/{{=parameters.creditnote_id}}/refunds/{{=parameters.id}}.The action has the following user-defined parameters:
- creditnote_id: Required. Specify creditnote identifier.
Documentation: https://www.zoho.com/books/api/v3/credit-notes/#list-refunds-of-a-credit-note.
- [Create] action
-
Endpoint URL address:
/creditnotes/{{=item.creditnote_id}}/refunds.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#refund-credit-note.
- [Update] action
-
Endpoint URL address:
/creditnotes/{{=item.creditnote_id}}/refunds/{{=item.creditnote_refund_id}}.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#update-credit-note-refund.
- [Delete] action
-
Endpoint URL address:
/creditnotes/{{=item.creditnote_id}}/refunds/{{=item.creditnote_refund_id}}.Documentation: https://www.zoho.com/books/api/v3/credit-notes/#update-credit-note-refund.
The resource includes the fields from the RefundT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customerpayments.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#list-customer-payments.
- [Read single] action
-
Endpoint URL address:
/customerpayments/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#retrieve-a-payment.
- [Create] action
-
Endpoint URL address:
/customerpayments.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#create-a-payment.
- [Update] action
-
Endpoint URL address:
/customerpayments/{{=item.payment_id}}.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#update-a-payment.
- [Delete] action
-
Endpoint URL address:
/customerpayments/{{=item.payment_id}}.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#delete-a-payment.
- payment_id
A key field. Template: ShortText.
- payment_number
Template: ShortText.
- payment_link_id
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- updated_time
Template: DateTime. A read-only field.
- payment_number_prefix
Template: ShortText.
- payment_number_suffix
Template: ShortText.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- payment_mode
Template: ShortText.
- card_type
Template: ShortText.
- date
Template: ShortText.
- offline_created_date_with_time
Template: ShortText.
- account_id
Template: ShortText.
- account_name
Template: ShortText.
- account_type
Template: ShortText.
- customer_advance_account_id
Template: ShortText.
- customer_advance_account_name
Template: ShortText.
- currency_id
Template: ShortText.
- currency_symbol
Template: ShortText.
- currency_code
Template: ShortText.
- exchange_rate
Data type: DT_R8
- amount
Data type: DT_R8
- amount_refunded
Data type: DT_R8
- unused_amount
Data type: DT_R8
- bank_charges
Data type: DT_R8
- tax_account_id
Template: ShortText.
- is_client_review_settings_enabled
Data type: DT_BOOL
- tax_account_name
Template: ShortText.
- tax_amount_withheld
Data type: DT_R8
- discount_amount
Data type: DT_R8
- description
Template: LongText.
- reference_number
Template: ShortText.
- online_transaction_id
Template: ShortText.
- payment_gateway
Template: ShortText.
- settlement_status
Template: ShortText.
- invoices
Field components:
- An array.
-
Uses template:
InvoiceT.
- payment_refunds
Field components:
- An array.
-
Uses template:
RefundT.
- last_four_digits
Template: ShortText.
- template_id
Template: ShortText.
Template: ShortText.
- template_name
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- template_type
Template: ShortText.
- attachment_name
Template: ShortText.
- can_send_in_mail
Data type: DT_BOOL
- can_send_payment_sms
Data type: DT_BOOL
- is_payment_details_required
Data type: DT_BOOL
- custom_fields
Template: CustomFieldT.
- imported_transactions
Field components:
- An array.
-
Uses template:
ImportedTransactionT.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customerpayments/{{=parameters.customer_payment_id}}/refunds.The action has the following user-defined parameters:
- customer_payment_id: Required. Specify customer payment identifier.
Documentation: https://www.zoho.com/books/api/v3/customer-payments/#list-refunds-of-a-customer-payment.
- [Create] action
-
Endpoint URL address:
/customerpayments/{{=item.payment_id}}/refunds.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#refund-an-excess-customer-payment.
- [Update] action
-
Endpoint URL address:
/customerpayments/{{=item.payment_id}}/refunds/{{=item.payment_refund_id}}.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#update-a-refund.
- [Delete] action
-
Endpoint URL address:
/customerpayments/{{=item.payment_id}}/refunds/{{=item.payment_refund_id}}.Documentation: https://www.zoho.com/books/api/v3/customer-payments/#delete-a-refund.
The resource includes the fields from the RefundT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/expenses.Documentation: https://www.zoho.com/books/api/v3/expenses/#list-expenses.
- [Read single] action
-
Endpoint URL address:
/expenses/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/expenses/#get-an-expense.
- [Create] action
-
Endpoint URL address:
/expenses.Documentation: https://www.zoho.com/books/api/v3/expenses/#create-an-expense.
- [Update] action
-
Endpoint URL address:
/expenses/{{=item.expense_id}}.Documentation: https://www.zoho.com/books/api/v3/expenses/#update-an-expense.
- [Delete] action
-
Endpoint URL address:
/expenses/{{=item.expense_id}}.Documentation: https://www.zoho.com/books/api/v3/expenses/#delete-an-expense.
- expense_id
A key field. Template: ShortText.
- transaction_type
Template: ShortText.
- transaction_type_formatted
Template: ShortText.
- expense_item_id
Template: ShortText.
- account_id
Template: ShortText.
- account_name
Template: ShortText.
- paid_through_account_id
Template: ShortText.
- paid_through_account_name
Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- documents
Template: DocumentT.
- date
Template: Date.
- markup_percent
Data type: DT_R8
- tax_id
Template: ShortText.
- tax_name
Template: ShortText.
- tax_percentage
Data type: DT_R8
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- exchange_rate
Data type: DT_R8
- tax_amount
Data type: DT_R8
- sub_total
Data type: DT_R8
- total
Data type: DT_R8
- bcy_total
Data type: DT_R8
- amount
Data type: DT_R8
- is_inclusive_tax
Data type: DT_BOOL
- reference_number
Template: ShortText.
- description
Template: ShortText.
- is_billable
Data type: DT_BOOL
- is_personal
Data type: DT_BOOL
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- expense_receipt_name
Template: ShortText.
- expense_receipt_type
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- last_modified_time
Template: DateTime. A read-only field.
- claimant_id
Template: ShortText.
- claimant_name
Template: ShortText.
- employee_id
Template: ShortText.
- employee_name
Template: ShortText.
- employee_email
Template: ShortText.
- vehicle_id
Template: ShortText.
- vehicle_name
Template: ShortText.
- distance
Data type: DT_R8
- mileage_rate
Data type: DT_R8
- mileage_unit
Template: ShortText.
- mileage_type
Template: ShortText.
- expense_type
Template: ShortText.
- start_reading
Template: ShortText.
- end_reading
Template: ShortText.
- status
Template: ShortText.
- invoice_id
Template: ShortText.
- invoice_number
Template: ShortText.
- report_id
Template: ShortText.
- report_name
Template: ShortText.
- report_number
Template: ShortText.
- user_id
Template: ShortText.
- user_name
Template: ShortText.
- user_email
Template: ShortText.
- approver_id
Template: ShortText.
- approver_name
Template: ShortText.
- approver_email
Template: ShortText.
- report_status
Template: ShortText.
- is_reimbursable
Data type: DT_BOOL
- trip_id
Template: ShortText.
- trip_number
Template: ShortText.
- location
Template: ShortText.
- merchant_id
Template: ShortText.
- merchant_name
Template: ShortText.
- payment_mode
Template: ShortText.
- project_id
Template: ShortText.
- project_name
Template: ShortText.
- tags
Field components:
- An array.
-
Uses template:
TagT.
- custom_fields
Template: CustomFieldT.
- is_recurring_applicable
Data type: DT_BOOL
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- is_surcharge_applicable
Data type: DT_BOOL
- fcy_surcharge_amount
Data type: DT_R8
- bcy_surcharge_amount
Data type: DT_R8
- zcrm_potential_id
Template: ShortText.
- zcrm_potential_name
Template: ShortText.
- imported_transactions
Field components:
- An array.
-
Uses template:
ImportedTransactionT.
- comments
A read-only field. The value is gathered from
/expenses/{{=item.expense_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- downloadReceipt
Data type: DT_IMAGE A read-only field. The value is gathered from
/expenses/{{=item.expense_id}}/receiptaddress. The gathered value is processed with{{=response}}expression.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/expenses/{{=parameters.expense_id}}/receipt.
The result is extracted from:{{=response}}.
The result is paginated.The action has the following user-defined parameters:
- expense_id: Required. Specify expense identifier
The following request parameters will be automatically processed:
-
Accept:
*/*
Documentation: https://www.zoho.com/books/api/v3/expenses/#get-an-expense-receipt.
- [Create] action
-
Endpoint URL address:
/expenses/{{=item.expense_id}}/receipt.The following request parameters will be automatically processed:
-
receipt:
{{=item.receipt}}
Documentation: https://www.zoho.com/books/api/v3/expenses/#add-receipt-to-an-expense.
-
receipt:
- [Delete] action
-
Endpoint URL address:
/expenses/{{=item.expense_id}}/receipt.Documentation: https://www.zoho.com/books/api/v3/expenses/#delete-a-receipt.
- expense_id
A key field. Template: ShortText.
- filename
Template: ShortText.
- receipt
Data type: DT_IMAGE
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recurringexpenses.Documentation: https://www.zoho.com/books/api/v3/recurring-expenses/#list-recurring-expenses.
- [Read single] action
-
Endpoint URL address:
/recurringexpenses/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-expenses/#get-a-recurring-expense.
- [Create] action
-
Endpoint URL address:
/recurringexpenses.Documentation: https://www.zoho.com/books/api/v3/recurring-expenses/#create-a-recurring-expense.
- [Update] action
-
Endpoint URL address:
/recurringexpenses/{{=item.recurring_expense_id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-expenses/#update-a-recurring-expense.
- [Delete] action
-
Endpoint URL address:
/recurringexpenses/{{=item.recurring_expense_id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-expenses/#delete-a-recurring-expense.
- recurring_expense_id
A key field. Template: ShortText.
- recurrence_name
Template: ShortText.
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- recurrence_frequency
Template: ShortText.
- repeat_every
Data type: DT_I4
- last_created_date
Template: DateTime.
- next_expense_date
Template: DateTime.
- account_id
Template: ShortText.
- account_name
Template: ShortText.
- paid_through_account_id
Template: ShortText.
- paid_through_account_name
Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- vendor_country_code
Template: ShortText.
- employee_id
Template: ShortText.
- employee_name
Template: ShortText.
- employee_email
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- exchange_rate
Data type: DT_I4
- tax_id
Template: ShortText.
- tax_name
Template: ShortText.
- tax_percentage
Data type: DT_R8
- tax_amount
Data type: DT_R8
- sub_total
Data type: DT_I4
- total
Data type: DT_R8
- bcy_total
Data type: DT_R8
- amount
Data type: DT_R8
- description
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- is_billable
Data type: DT_BOOL
- markup_percent
Data type: DT_R8
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- last_modified_time
Template: DateTime. A read-only field.
- project_id
Template: ShortText.
- project_name
Template: ShortText.
- mileage_rate
Data type: DT_R8
- mileage_unit
Template: ShortText.
- custom_fields
Template: CustomFieldT.
- is_pre_gst
Data type: DT_BOOL
- source_of_supply
Template: ShortText.
- destination_of_supply
Template: ShortText.
- place_of_supply
Template: ShortText.
- gst_no
Template: ShortText.
- gst_treatment
Template: ShortText.
- destination_of_supply_state
Template: ShortText.
- hsn_or_sac
Data type: DT_I4
- vat_treatment
Template: ShortText.
- tax_treatment
Template: ShortText.
- reverse_charge_tax_id
Template: ShortText.
- reverse_charge_tax_name
Template: ShortText.
- reverse_charge_tax_percentage
Data type: DT_R8
- reverse_charge_tax_amount
Data type: DT_R8
- is_reverse_charge_applied
Data type: DT_BOOL
- acquisition_vat_total
Data type: DT_R8
- reverse_charge_vat_total
Data type: DT_R8
- tags
Field components:
- An array.
-
Uses template:
TagT.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- acquisition_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- reverse_charge_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- comments
A read-only field. The value is gathered from
/recurringexpenses/{{=item.recurring_expense_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- childExpenses
A read-only field. The value is gathered from
/recurringexpenses/{{=item.recurring_expense_id}}/expensesaddress. The gathered value is processed with{{=response.expensehistory}}expression. Field components:- An array.
- Contains the following components: expense_id, date, account_name, customer_name, total, status, vendor_name, paid_through_account_name.
- status
Template: ShortText.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/retainerinvoices.Documentation: https://www.zoho.com/books/api/v3/retainer-invoices/#list-a-retainer-invoices.
- [Read single] action
-
Endpoint URL address:
/retainerinvoices/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/retainer-invoices/#get-a-retainer-invoice.
- [Create] action
-
Endpoint URL address:
/retainerinvoices.Documentation: https://www.zoho.com/books/api/v3/retainer-invoices/#create-a-retainerinvoice.
- [Update] action
-
Endpoint URL address:
/retainerinvoices/{{=item.retainerinvoice_id}}.Documentation: https://www.zoho.com/books/api/v3/retainer-invoices/#update-a-retainerinvoice.
- [Delete] action
-
Endpoint URL address:
/retainerinvoices/{{=item.retainerinvoice_id}}.Documentation: https://www.zoho.com/books/api/v3/retainer-invoices/#delete-a-retainer-invoice.
- retainerinvoice_id
A key field. Template: ShortText.
- retainerinvoice_number
Template: ShortText.
- is_pre_gst
Data type: DT_BOOL
- date
Template: Date.
- place_of_supply
Template: ShortText.
- color_code
Template: ShortText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- current_sub_status_formatted
Template: ShortText.
- last_payment_date
Template: ShortText.
- reference_number
Template: ShortText.
- customer_id
Template: ShortText.
- roundoff_value
Data type: DT_R8
- roundoff_value_formatted
Template: ShortText.
- transaction_rounding_type
Template: ShortText.
- customer_name
Template: ShortText.
- is_portal_enabled
Data type: DT_BOOL
- contact_persons
Template: LongText. A composite field.
- project_id
Template: ShortText.
- project_name
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- exchange_rate
Data type: DT_R8
- is_cloneable
Data type: DT_BOOL
- is_viewed_by_client
Data type: DT_BOOL
- unused_retainer_payments
Data type: DT_I4
- unused_retainer_payments_formatted
Template: ShortText.
- client_viewed_time
Template: ShortText.
- client_viewed_time_formatted
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- tax_rounding
Template: ShortText.
- sub_total
Data type: DT_R8
- total
Data type: DT_R8
- payment_made
Data type: DT_R8
- payment_drawn
Data type: DT_R8
- balance
Data type: DT_R8
- allow_partial_payments
Data type: DT_BOOL
- price_precision
Data type: DT_I4
- notes
Template: ShortText.
- terms
Template: ShortText.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- template_type
Template: ShortText.
- template_type_formatted
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- attachment_name
Template: ShortText.
- can_send_in_mail
Data type: DT_BOOL
- can_send_comment_notification
Data type: DT_BOOL
- warn_convert_to_open
Data type: DT_BOOL
- invoice_url
Template: ShortText.
- submitted_date
Template: Date.
- submitted_by
Template: ShortText.
- approvers_list
Template: LongText. A composite field.
- is_emailed
Data type: DT_BOOL
- billing_address
Template: GeneralAddressT.
- shipping_address
Template: GeneralAddressT.
- contact_persons_associated
Field components:
- An array.
- Contains the following components: contact_person_id, contact_person_name, contact_person_email.
- payment_options
Field components:
- Contains the following components: payment_gateways.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- payments
Field components:
- An array.
-
Uses template:
PaymentT.
- payment_refunds
Field components:
- An array.
-
Uses template:
RefundT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- comments
A read-only field. The value is gathered from
/retainerinvoices/{{=item.retainernvoice_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- emailContent
Template: ContentT. A read-only field. The value is gathered from
/retainerinvoices/{{=item.retainernvoice_id}}/emailaddress. The gathered value is processed with{{=response}}expression.- status
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: submit, approve, emailSingleRetainerInvoice.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/purchaseorders.Documentation: https://www.zoho.com/books/api/v3/purchase-order/#list-purchase-orders.
- [Read single] action
-
Endpoint URL address:
/purchaseorders/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/purchase-order/#get-a-purchase-order.
- [Create] action
-
Endpoint URL address:
/purchaseorders.Documentation: https://www.zoho.com/books/api/v3/purchase-order/#create-a-purchase-order.
- [Update] action
-
Endpoint URL address:
/purchaseorders/{{=item.purchaseorder_id}}.Documentation: https://www.zoho.com/books/api/v3/purchase-order/#update-a-purchase-order.
- [Delete] action
-
Endpoint URL address:
/purchaseorders/{{=item.purchaseorder_id}}.Documentation: https://www.zoho.com/books/api/v3/purchase-order/#delete-purchase-order.
- purchaseorder_id
A key field. Template: ShortText.
- contact_category
Template: ShortText.
- purchaseorder_number
Template: ShortText.
- date
Template: Date.
- client_viewed_time
Template: ShortText.
- is_viewed_by_client
Data type: DT_BOOL
- expected_delivery_date
Template: ShortText.
- vat_treatment
Template: ShortText.
- gst_no
Template: ShortText.
- gst_treatment
Template: ShortText.
- tax_treatment
Template: ShortText.
- is_pre_gst
Data type: DT_BOOL
- source_of_supply
Template: ShortText.
- destination_of_supply
Template: ShortText.
- place_of_supply
Template: ShortText.
- pricebook_id
Template: ShortText.
- pricebook_name
Template: ShortText.
- is_reverse_charge_applied
Data type: DT_BOOL
- currency_symbol
Template: ShortText.
- exchange_rate
Data type: DT_I4
- delivery_date
Template: ShortText.
- is_emailed
Data type: DT_BOOL
- is_inclusive_tax
Data type: DT_BOOL
- discount
Data type: DT_R8
- discount_account_id
Template: ShortText.
- is_discount_before_tax
Data type: DT_BOOL
- reference_number
Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- crm_owner_id
Template: ShortText.
- order_status
Template: ShortText.
- billed_status
Template: ShortText.
- color_code
Template: ShortText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- contact_persons
Template: LongText. A composite field.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- tax_rounding
Template: ShortText.
- is_adv_tracking_in_receive
Data type: DT_BOOL
- total_quantity
Data type: DT_I4
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- has_qty_cancelled
Data type: DT_BOOL
- adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- discount_amount
Data type: DT_R8
- discount_applied_on_amount
Data type: DT_R8
- discount_type
Template: ShortText.
- sub_total
Data type: DT_R8
- sub_total_inclusive_of_tax
Data type: DT_R8
- tax_total
Data type: DT_R8
- total
Data type: DT_R8
- price_precision
Data type: DT_I4
- submitted_date
Template: Date.
- submitted_by
Template: ShortText.
- submitter_id
Template: ShortText.
- approver_id
Template: ShortText.
- approvers_list
Template: LongText. A composite field.
- billing_address_id
Template: ShortText.
- billing_address
Template: GeneralAddressT.
- notes
Template: ShortText.
- terms
Template: ShortText.
- payment_terms
Data type: DT_I4
- payment_terms_label
Template: ShortText.
- ship_via
Template: ShortText.
- ship_via_id
Template: ShortText.
- attention
Template: ShortText.
- delivery_org_address_id
Template: ShortText.
- delivery_customer_id
Template: ShortText.
- delivery_customer_address_id
Template: ShortText.
- delivery_address
Template: GeneralAddressT.
- attachment_name
Template: ShortText.
- can_send_in_mail
Data type: DT_BOOL
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- template_type
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_time
Template: DateTime. A read-only field.
- can_mark_as_bill
Data type: DT_BOOL
- can_mark_as_unbill
Data type: DT_BOOL
- salesorders
Template: LongText. A composite field.
- bills
Template: LongText. A composite field.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- entity_tags
Template: ShortText.
- order_sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- contact_persons_details
Field components:
- An array.
-
Uses template:
ContactPersonT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- emailContent
Template: ContentT. A read-only field. The value is gathered from
/purchaseorders/{{=item.purchaseorder_id}}/emailaddress. The gathered value is processed with{{=response.data}}expression.- comments
A read-only field. The value is gathered from
/purchaseorders/{{=item.purchaseorder_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: submit, approve, emailSinglePurchaseOrder.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bills.Documentation: https://www.zoho.com/books/api/v3/bills/#list-bills.
- [Read single] action
-
Endpoint URL address:
/bills/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/bills/#get-a-bill.
- [Create] action
-
Endpoint URL address:
/bills.Documentation: https://www.zoho.com/books/api/v3/bills/#create-a-bill.
- [Update] action
-
Endpoint URL address:
/bills/{{=item.bill_id}}.Documentation: https://www.zoho.com/books/api/v3/bills/#update-a-bill.
- [Delete] action
-
Endpoint URL address:
/bills/{{=item.bill_id}}.Documentation: https://www.zoho.com/books/api/v3/bills/#delete-a-bill.
- bill_id
A key field. Template: ShortText.
- purchaseorder_ids
Template: LongText. A composite field.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- contact_category
Template: ShortText.
- unused_credits_payable_amount
Data type: DT_R8
- color_code
Template: ShortText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- bill_number
Template: ShortText.
- date
Template: Date.
- due_date
Template: Date.
- discount_setting
Template: ShortText.
- payment_terms
Data type: DT_I4
- payment_terms_label
Template: ShortText.
- payment_expected_date
Template: ShortText.
- reference_number
Template: ShortText.
- recurring_bill_id
Template: ShortText.
- due_by_days
Template: ShortText.
- due_in_days
Data type: DT_I4
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- currency_name_formatted
Template: ShortText.
- price_precision
Data type: DT_I4
- exchange_rate
Data type: DT_R8
- custom_field_hash
Template: LongText. A composite field.
- is_viewed_by_client
Data type: DT_BOOL
- client_viewed_time
Template: ShortText.
- is_item_level_tax_calc
Data type: DT_BOOL
- is_inclusive_tax
Data type: DT_BOOL
- tax_rounding
Template: ShortText.
- is_uber_bill
Data type: DT_BOOL
- is_tally_bill
Data type: DT_BOOL
- track_discount_in_account
Data type: DT_BOOL
- submitted_date
Template: Date.
- submitted_by
Template: ShortText.
- submitter_id
Template: ShortText.
- approver_id
Template: ShortText.
- adjustment
Data type: DT_I4
- adjustment_description
Template: ShortText.
- discount
Data type: DT_R8
- discount_applied_on_amount
Data type: DT_R8
- is_discount_before_tax
Data type: DT_BOOL
- discount_account_id
Template: ShortText.
- discount_account_name
Template: ShortText.
- vat_treatment
Template: ShortText.
- vat_reg_no
Template: ShortText.
- source_of_supply
Template: ShortText.
- destination_of_supply
Template: ShortText.
- place_of_supply
Template: ShortText.
- permit_number
Template: ShortText.
- gst_no
Template: ShortText.
- gst_treatment
Template: ShortText.
- tax_treatment
Template: ShortText.
- is_pre_gst
Data type: DT_BOOL
- pricebook_id
Template: ShortText.
- sub_total
Data type: DT_R8
- tax_total
Data type: DT_R8
- total
Data type: DT_R8
- payment_made
Data type: DT_R8
- vendor_credits_applied
Data type: DT_R8
- is_line_item_invoiced
Data type: DT_BOOL
- purchaseorders
Field components:
- An array.
- Contains the following components: purchaseorder_id, purchaseorder_number, purchaseorder_date, purchaseorder_status.
- acquisition_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- acquisition_vat_total
Data type: DT_R8
- reverse_charge_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- reverse_charge_vat_total
Data type: DT_R8
- balance
Data type: DT_R8
- billing_address
Template: GeneralAddressT.
- payments
Field components:
- An array.
-
Uses template:
PaymentT.
- vendor_credits
Field components:
- An array.
- Contains the following components: vendor_credit_id, vendor_credit_bill_id, vendor_credit_number, date, amount.
- created_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_time
Template: ShortText.
- reference_id
Template: ShortText.
- notes
Template: ShortText.
- terms
Template: ShortText.
- attachment_name
Template: ShortText.
- open_purchaseorders_count
Data type: DT_I4
- pricebook_name
Template: ShortText.
- is_tds_applied
Data type: DT_BOOL
- filed_in_vat_return_id
Template: ShortText.
- filed_in_vat_return_name
Template: ShortText.
- filed_in_vat_return_type
Template: ShortText.
- is_abn_quoted
Template: ShortText.
- is_reverse_charge_applied
Data type: DT_BOOL
- discount_type
Template: ShortText.
- sub_total_inclusive_of_tax
Data type: DT_R8
- last_modified_id
Template: ShortText.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- template_type
Template: ShortText.
- is_approval_required
Data type: DT_BOOL
- allocated_landed_costs
Template: LongText. A composite field.
- unallocated_landed_costs
Template: LongText. A composite field.
- entity_type
Template: ShortText.
- can_send_in_mail
Data type: DT_BOOL
- approvers_list
Template: LongText. A composite field.
- entity_tags
Template: ShortText.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- order_sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- comments
A read-only field. The value is gathered from
/bills/{{=item.bill_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: submit, approve, applyCredit.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bills/{{=parameters.bill_id}}/payments.The action has the following user-defined parameters:
- bill_id: Required. Specify bill identifier.
Documentation: https://www.zoho.com/books/api/v3/bills/#get-a-bill.
- [Delete] action
-
Endpoint URL address:
/bills/{{=item.bill_id}}/payments/{{=item.payment_id}}.Documentation: https://www.zoho.com/books/api/v3/bills/#delete-a-payment.
The resource includes the fields from the PaymentT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recurringbills.Documentation: https://www.zoho.com/books/api/v3/recurring-bills/#list-recurring-bills.
- [Read single] action
-
Endpoint URL address:
/recurringbills/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/bills/#get-a-bill.
- [Create] action
-
Endpoint URL address:
/recurringbills.Documentation: https://www.zoho.com/books/api/v3/bills/#create-a-bill.
- [Update] action
-
Endpoint URL address:
/recurringbills/{{=item.recurring_bill_id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-bills/#update-a-recurring-bill.
- [Delete] action
-
Endpoint URL address:
/recurringbills/{{=item.recurring_bill_id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-bills/#delete-a-recurring-bill.
- recurring_bill_id
A key field. Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- contact_category
Template: ShortText.
- recurrence_name
Template: ShortText.
- recurrence_frequency
Template: ShortText.
- repeat_every
Data type: DT_I4
- start_date
Template: Date.
- end_date
Template: Date.
- last_sent_date
Template: Date.
- next_bill_date
Template: Date.
- tds_tax_name
Template: ShortText.
- payment_terms
Data type: DT_I4
- payment_terms_label
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- price_precision
Data type: DT_I4
- exchange_rate
Data type: DT_R8
- is_item_level_tax_calc
Data type: DT_BOOL
- is_inclusive_tax
Data type: DT_BOOL
- tax_rounding
Template: ShortText.
- track_discount_in_account
Data type: DT_BOOL
- sub_total
Data type: DT_R8
- tax_total
Data type: DT_R8
- acquisition_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- reverse_charge_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- discount_setting
Template: ShortText.
- discount_amount
Data type: DT_R8
- discount
Data type: DT_R8
- discount_type
Template: ShortText.
- discount_applied_on_amount
Data type: DT_R8
- is_discount_before_tax
Data type: DT_BOOL
- discount_account_id
Template: ShortText.
- total
Data type: DT_R8
- created_time
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- last_modified_time
Template: DateTime. A read-only field.
- reference_id
Template: ShortText.
- notes
Template: ShortText.
- terms
Template: ShortText.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- history
A read-only field. The value is gathered from
/recurringbills/{{=item.recurring_bill_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- status
Template: ShortText.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/vendorcredits.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#list-vendor-credits.
- [Read single] action
-
Endpoint URL address:
/vendorcredits/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#get-vendor-credit.
- [Create] action
-
Endpoint URL address:
/vendorcredits.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#create-a-vendor-credit.
- [Update] action
-
Endpoint URL address:
/vendorcredits/{{=item.vendor_credit_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#update-vendor-credit.
- [Delete] action
-
Endpoint URL address:
/vendorcredits/{{=item.vendor_credit_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#delete-vendor-credit.
- vendor_credit_id
A key field. Template: ShortText.
- vendor_credit_number
Template: ShortText.
- date
Template: Date.
- color_code
Template: ShortText.
- current_sub_status_id
Template: ShortText.
- current_sub_status
Template: ShortText.
- reference_number
Template: ShortText.
- source_of_supply
Template: ShortText.
- destination_of_supply
Template: ShortText.
- acquisition_vat_total
Data type: DT_R8
- sub_total
Data type: DT_R8
- total
Data type: DT_R8
- total_credits_used
Data type: DT_R8
- total_refunded_amount
Data type: DT_R8
- balance
Data type: DT_R8
- notes
Data type: DT_WSTR ( length 4000 )
- place_of_supply
Template: ShortText.
- gst_no
Template: ShortText.
- gst_treatment
Template: ShortText.
- tax_treatment
Template: ShortText.
- pricebook_id
Template: ShortText.
- is_reverse_charge_applied
Data type: DT_BOOL
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- exchange_rate
Data type: DT_I4
- price_precision
Data type: DT_I4
- vat_treatment
Template: ShortText.
- filed_in_vat_return_id
Template: ShortText.
- filed_in_vat_return_name
Template: ShortText.
- filed_in_vat_return_type
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- currency_symbol
Template: ShortText.
- tax_rounding
Template: ShortText.
- contact_category
Template: ShortText.
- submitted_date
Template: ShortText.
- submitter_id
Template: ShortText.
- submitted_by
Template: ShortText.
- approver_id
Template: ShortText.
- adjustment
Data type: DT_R8
- adjustment_description
Template: ShortText.
- discount_setting
Template: ShortText.
- discount_amount
Data type: DT_R8
- discount
Data type: DT_R8
- discount_applied_on_amount
Data type: DT_R8
- is_discount_before_tax
Data type: DT_BOOL
- discount_account_id
Template: ShortText.
- sub_total_inclusive_of_tax
Data type: DT_R8
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: DateTime. A read-only field.
- template_id
Template: ShortText.
- template_name
Template: ShortText.
- page_width
Template: ShortText.
- page_height
Template: ShortText.
- orientation
Template: ShortText.
- template_type
Template: ShortText.
- approvers_list
Template: LongText. A composite field.
- vendor_credit_refunds
Field components:
- An array.
-
Uses template:
RefundT.
- acquisition_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- reverse_charge_vat_summary
Field components:
- An array.
-
Uses template:
TaxT.
- sub_statuses
Field components:
- An array.
-
Uses template:
StatusT.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- comments
Field components:
- An array.
-
Uses template:
CommentT.
- bills_credited
Field components:
- An array.
-
Uses template:
CreditPaymentBillT.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: submit, approve.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/vendorcredits/{{=parameters.vendor_credit_id}}/bills.The action has the following user-defined parameters:
- vendor_credit_id: Required. Specify vendor credit identfier.
Documentation: https://www.zoho.com/books/api/v3/recurring-bills/#list-recurring-bills.
- [Create] action
-
Endpoint URL address:
/vendorcredits/{{=item.vendor_credit_id}}/bills.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#apply-credits-to-a-bill.
- [Delete] action
-
Endpoint URL address:
/vendorcredits/{{=item.vendor_credit_id}}/bills/{{=item.vendor_credit_bill_id}}.Documentation: https://www.zoho.com/books/api/v3/recurring-bills/#delete-a-recurring-bill.
The resource includes the fields from the CreditPaymentBillT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/vendorcredits/{{=parameters.vendor_credit_id}}/refunds.The action has the following user-defined parameters:
- vendor_credit_id: Required. Specify vendor credit identfier.
Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#list-refunds-of-a-vendor-credit.
- [Read single] action
-
Endpoint URL address:
/vendorcredits/{{=parameters.vendor_credit_id}}/refunds/{{=parameters.id}}.The action has the following user-defined parameters:
- vendor_credit_id: Required. Specify vendor credit identfier.
Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#get-vendor-credit-refund.
- [Create] action
-
Endpoint URL address:
/vendorcredits/{{=item.vendor_credit_id}}/refunds.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#refund-a-vendor-credit.
- [Update] action
-
Endpoint URL address:
/vendorcredits/{{=item.vendor_credit_id}}/refunds/{{=item.vendor_credit_refund_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#update-vendor-credit-refund.
- [Delete] action
-
Endpoint URL address:
/vendorcredits/{{=item.vendor_credit_id}}/bills/{{=item.vendor_credit_refund_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-credits/#delete-vendor-credit-refund.
The resource includes the fields from the RefundT template.
- imported_transactions
Field components:
- An array.
-
Uses template:
ImportedTransactionT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/vendorpayments.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#list-vendor-payments.
- [Read single] action
-
Endpoint URL address:
/vendorpayments/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#get-a-vendor-payment.
- [Create] action
-
Endpoint URL address:
/vendorpayments.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#create-a-vendor-payment.
- [Update] action
-
Endpoint URL address:
/vendorcredits/{{=item.payment_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#update-a-vendor-payment.
- [Delete] action
-
Endpoint URL address:
/vendorcredits/{{=item.payment_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#delete-a-vendor-payment.
- payment_id
A key field. Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- payment_mode
Template: ShortText.
- payment_number
Data type: DT_I4
- description
Template: LongText.
- date
Template: Date.
- reference_number
Template: ShortText.
- exchange_rate
Data type: DT_R8
- tax_account_name
Template: ShortText.
- tax_amount_withheld
Data type: DT_R8
- amount
Data type: DT_R8
- balance
Data type: DT_R8
- currency_id
Template: ShortText.
- currency_symbol
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: DateTime. A read-only field.
- paid_through_account_id
Template: ShortText.
- paid_through_account_name
Template: ShortText.
- paid_through_account_type
Template: ShortText.
- is_paid_via_print_check
Data type: DT_BOOL
- is_ach_payment
Data type: DT_BOOL
- ach_payment_status
Template: ShortText.
- check_details
Template: CheckDetailT.
- billing_address
Template: GeneralAddressT.
- comments
Template: ShortText.
- vendorpayment_refunds
Field components:
- An array.
-
Uses template:
RefundT.
- bills
Field components:
- An array.
-
Uses template:
CreditPaymentBillT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- refunds
A read-only field. The value is gathered from
/vendorpayments/{{=item.payment_id}}/refundsaddress. The gathered value is processed with{{=response.vendorpayment_refunds}}expression. Field components:- An array.
-
Uses template:
RefundT.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/vendorpayments/{{=parameters.payment_id}}/refunds.The action has the following user-defined parameters:
- payment_id: Required. Specify payment identifier.
Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#list-refunds-of-a-vendor-payment.
- [Read single] action
-
Endpoint URL address:
/vendorpayments/{{=parameters.payment_id}}/refunds/{{=parameters.id}}.The action has the following user-defined parameters:
- payment_id: Required. Specify payment identifier.
Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#details-of-a-refund.
- [Create] action
-
Endpoint URL address:
/vendorpayment_refunds.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#refund-an-excess-vendor-payment.
- [Update] action
-
Endpoint URL address:
/vendorpayment_refunds/{{=item.refund_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#update-a-refund.
- [Delete] action
-
Endpoint URL address:
/vendorpayment_refunds/{{=item.refund_id}}.Documentation: https://www.zoho.com/books/api/v3/vendor-payments/#delete-a-refund.
The resource includes the fields from the RefundT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bankaccounts.Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#list-view-of-accounts.
- [Read single] action
-
Endpoint URL address:
/bankaccounts/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#get-account-details.
- [Create] action
-
Endpoint URL address:
/bankaccounts.Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#create-a-bank-account.
- [Update] action
-
Endpoint URL address:
/bankaccounts/{{=item.account_id}}.Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#update-bank-account.
- [Delete] action
-
Endpoint URL address:
/bankaccounts/{{=item.account_id}}.Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#delete-an-account.
- account_id
A key field. Template: ShortText.
- account_name
Template: ShortText.
- account_code
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- price_precision
Data type: DT_I4
- account_type
Template: ShortText.
- account_number
Template: ShortText.
- uncategorized_transactions
Data type: DT_I4
- total_unprinted_checks
Data type: DT_I4
- is_active
Data type: DT_BOOL
- balance
Data type: DT_R8
- bank_balance
Data type: DT_R8
- bcy_balance
Data type: DT_R8
- bank_name
Template: ShortText.
- description
Template: LongText.
- feeds_last_refresh_date
Template: ShortText.
- can_show_in_ze
Data type: DT_BOOL
- is_direct_paypal
Data type: DT_BOOL
- can_show_paypal_direct_integ_banner
Data type: DT_BOOL
- can_access_all_branches
Data type: DT_BOOL
- latest_transaction_date
Template: ShortText.
- is_feeds_subscribed
Data type: DT_BOOL
- is_feeds_active
Data type: DT_BOOL
- routing_number
Template: ShortText.
- is_primary_account
Data type: DT_BOOL
- is_paypal_account
Data type: DT_BOOL
- refresh_status_code
Template: ShortText.
- service_id
Template: ShortText.
- is_system_account
Data type: DT_BOOL
- is_show_warning_for_feeds_refresh
Data type: DT_BOOL
- action
Template: ShortText. Field components:
- Contains the following components: activate, deactivate.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bankaccounts/{{=parameters.account_id}}/statement/lastimported.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#get-last-imported-statement.
- [Create] action
-
Endpoint URL address:
/bankstatements.Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#import-a-bankcredit-card-statement.
- [Delete] action
-
Endpoint URL address:
/bankaccounts/{{=item.account_id}}/statement/{{=item.statement_id}}.Documentation: https://www.zoho.com/books/api/v3/bank-accounts/#delete-last-imported-statement.
- statement_id
A key field. Template: ShortText.
- from_date
Template: Date.
- to_date
Template: Date.
- source
Template: ShortText.
- transactions
Field components:
- An array.
-
Uses template:
TransactionT.
- account_id
Template: ShortText.
- start_date
Template: Date.
- end_date
Template: Date.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/banktransactions.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#get-transactions-list.
- [Read single] action
-
Endpoint URL address:
/banktransactions/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#get-transaction.
- [Create] action
-
Endpoint URL address:
/banktransactions.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#create-a-transaction-for-an-account.
- [Update] action
-
Endpoint URL address:
/banktransactions/{{=item.transaction_id}}.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#update-a-transaction.
- [Delete] action
-
Endpoint URL address:
/banktransactions/{{=item.transaction_id}}.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#delete-a-transaction.
- transaction_id
A key field. Template: ShortText.
- from_account_id
Template: ShortText.
- from_account_name
Template: ShortText.
- to_account_id
Template: ShortText.
- to_account_name
Template: ShortText.
- transaction_type
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- payment_mode
Template: ShortText.
- exchange_rate
Data type: DT_I4
- date
Template: Date.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- reference_number
Template: ShortText.
- description
Template: ShortText.
- bank_charges
Data type: DT_R8
- tax_id
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- tax_name
Template: ShortText.
- tax_percentage
Data type: DT_I4
- tax_amount
Data type: DT_I4
- sub_total
Data type: DT_I4
- tax_authority_id
Template: ShortText.
- tax_authority_name
Template: ShortText.
- tax_exemption_id
Template: ShortText.
- tax_exemption_code
Template: ShortText.
- total
Data type: DT_R8
- bcy_total
Data type: DT_R8
- amount
Data type: DT_R8
- vat_treatment
Template: ShortText.
- product_type
Template: ShortText.
- acquisition_vat_id
Template: ShortText.
- acquisition_vat_name
Template: ShortText.
- acquisition_vat_percentage
Template: ShortText.
- acquisition_vat_amount
Template: ShortText.
- reverse_charge_vat_id
Template: ShortText.
- reverse_charge_vat_name
Template: ShortText.
- reverse_charge_vat_percentage
Template: ShortText.
- reverse_charge_vat_amount
Template: ShortText.
- filed_in_vat_return_id
Template: ShortText.
- filed_in_vat_return_name
Template: ShortText.
- filed_in_vat_return_type
Template: ShortText.
- imported_transactions
Field components:
- An array.
-
Uses template:
ImportedTransactionT.
- tags
Field components:
- An array.
-
Uses template:
TagT.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- action
Template: ShortText. Field components:
- Contains the following components: restore, exclude.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}. - [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}. - [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/banktransactions/uncategorized/{{=parameters.transaction_id}}/match.The action has the following user-defined parameters:
- transaction_id: Required. Specify the transaction identifier.
Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#get-matching-transactions.
- [Create] action
-
Endpoint URL address:
/banktransactions/uncategorized/{{=item.transaction_id}}/match.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#match-a-transaction.
- [Update] action
-
Endpoint URL address:
/banktransactions/uncategorized/{{=item.transaction_id}}/unmatch.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#update-a-transaction.
- transaction_id
A key field. Template: ShortText.
- transaction_type
Template: ShortText.
- date
Template: ShortText.
- reference_number
Template: ShortText.
- amount
Data type: DT_R8
- debit_or_credit
Template: ShortText.
- transaction_number
Template: ShortText.
- is_paid_via_print_check
Data type: DT_BOOL
- contact_name
Template: ShortText.
- is_best_match
Data type: DT_BOOL
Based on resource template Editors.
- [Create] action
-
Endpoint URL address:
/banktransactions/uncategorized/{{=item.transaction_id}}/categorize{{=item.categorize_as && '/' + item.categorize_as || ''}}.
- [Update] action
-
Endpoint URL address:
/banktransactions/{{=item.transaction_id}}/uncategorize.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#uncategorize-a-categorized-transaction.
- from_account_id
Template: ShortText.
- statement_line_id
Template: ShortText.
- to_account_id
Template: ShortText.
- transaction_id
A key field. Template: ShortText.
- creditnote_id
Template: ShortText.
- vendor_credit_id
Template: ShortText.
- date
Template: ShortText.
- refund_mode
Template: ShortText.
- vendorpayment_id
Template: ShortText.
- reference_number
Template: ShortText.
- amount
Data type: DT_R8
- exchange_rate
Data type: DT_R8
- description
Template: ShortText.
- account_id
Template: ShortText.
- transaction_type
Template: ShortText.
- customer_id
Template: ShortText.
- retainerinvoice_id
Data type: DT_I4
- user_id
Data type: DT_I4
- tax_authority_id
Template: ShortText.
- payment_mode
Template: ShortText.
- bank_charges
Data type: DT_R8
- template_id
Data type: DT_I4
- contact_persons
Template: LongText. A composite field.
- paid_through_account_id
Template: ShortText.
- tax_id
Template: ShortText.
- project_id
Template: ShortText.
- is_paid_via_print_check
Data type: DT_BOOL
- vendor_id
Template: ShortText.
- tax_exemption_code
Template: ShortText.
- tax_exemption_id
Template: ShortText.
- is_inclusive_tax
Data type: DT_BOOL
- is_billable
Data type: DT_BOOL
- zp_project_id
Data type: DT_I4
- zp_project_name
Template: ShortText.
- zp_client_id
Data type: DT_I4
- vehicle_id
Template: ShortText.
- mileage_unit
Template: ShortText.
- mileage_rate
Data type: DT_R8
- can_reclaim_vat_on_mileage
Data type: DT_BOOL
- fuel_type
Template: ShortText.
- engine_capacity_range
Template: ShortText.
- employee_id
Data type: DT_I4
- mileage_type
Template: ShortText.
- expense_type
Template: ShortText.
- distance
Data type: DT_I4
- start_reading
Template: ShortText.
- end_reading
Template: ShortText.
- currency_id
Template: ShortText.
- recurring_expense_id
Data type: DT_I4
- vat_treatment
Template: ShortText.
- acquisition_vat_id
Template: ShortText.
- reverse_charge_vat_id
Template: ShortText.
- is_update_customer
Data type: DT_BOOL
- product_type
Template: ShortText.
- invoices
Field components:
- An array.
-
Uses template:
InvoiceT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- bills
Field components:
- An array.
-
Uses template:
CreditPaymentBillT.
- check_details
Field components:
- An array.
-
Uses template:
CheckDetailT.
- tags
Field components:
- An array.
-
Uses template:
TagT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- reason
Template: ShortText.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- zcrm_potential_id
Data type: DT_I4
- to_account_tags
Field components:
- An array.
-
Uses template:
TagT.
- from_account_tags
Field components:
- An array.
-
Uses template:
TagT.
- categorize_as
Template: ShortText.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}. - [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}. - [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bankaccounts/rules.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://www.zoho.com/books/api/v3/bank-rules/#get-rules-list.
- [Read single] action
-
Endpoint URL address:
/bankaccounts/rules/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/bank-rules/#get-a-rule.
- [Create] action
-
Endpoint URL address:
/bankaccounts/rules.Documentation: https://www.zoho.com/books/api/v3/bank-rules/#create-a-rule.
- [Update] action
-
Endpoint URL address:
/bankaccounts/rules/{{=item.rule_id}}.Documentation: https://www.zoho.com/books/api/v3/bank-transactions/#update-a-transaction.
- [Delete] action
-
Endpoint URL address:
/bankaccounts/rules/{{=item.rule_id}}.Documentation: https://www.zoho.com/books/api/v3/bank-rules/#delete-a-rule.
- rule_id
A key field. Template: ShortText.
- rule_name
Template: ShortText.
- rule_order
Data type: DT_I4
- target_account_id
Template: ShortText.
- apply_to
Template: ShortText.
- criteria_type
Template: ShortText.
- criterion
Field components:
- An array.
- Contains the following components: criteria_id, field, comparator, value.
- record_as
Template: ShortText.
- account_id
Template: ShortText.
- customer_id
Template: ShortText.
- tax_id
Template: ShortText.
- reference_number
Template: ShortText.
- vat_treatment
Template: ShortText.
- product_type
Template: ShortText.
- tax_authority_id
Template: ShortText.
- tax_exemption_id
Template: ShortText.
- account_name
Template: ShortText.
- tags
Field components:
- An array.
-
Uses template:
TagT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/chartofaccounts.Documentation: https://www.zoho.com/books/api/v3/chart-of-accounts/#list-chart-of-accounts.
- [Read single] action
-
Endpoint URL address:
/chartofaccounts/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/chart-of-accounts/#get-an-account.
- [Create] action
-
Endpoint URL address:
/chartofaccounts.Documentation: https://www.zoho.com/books/api/v3/chart-of-accounts/#create-an-account.
- [Update] action
-
Endpoint URL address:
/chartofaccounts/{{=item.account_id}}.Documentation: https://www.zoho.com/books/api/v3/chart-of-accounts/#update-an-account.
- [Delete] action
-
Endpoint URL address:
/chartofaccounts/{{=item.account_id}}.Documentation: https://www.zoho.com/books/api/v3/chart-of-accounts/#delete-an-account.
- account_id
A key field. Template: ShortText.
- account_type
Template: ShortText.
- is_active
Data type: DT_BOOL
- account_name
Template: ShortText.
- account_code
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- description
Template: ShortText.
- is_system_account
Data type: DT_BOOL
- is_involved_in_transaction
Data type: DT_BOOL
- can_show_in_ze
Data type: DT_BOOL
- include_in_vat_return
Data type: DT_BOOL
- closing_balance
Data type: DT_R8
- parent_account_id
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: DateTime. A read-only field.
- transactions
Field components:
- An array.
-
Uses template:
TransactionT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- action
Template: ShortText. Field components:
- Contains the following components: active, inactive.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/chartofaccounts/transactions.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://www.zoho.com/books/api/v3/chart-of-accounts/#list-of-transactions-for-an-account.
- [Delete] action
-
Endpoint URL address:
/chartofaccounts/transactions/{{=item.transaction_id}}.Documentation: https://www.zoho.com/books/api/v3/chart-of-accounts/#delete-a-transaction.
- transaction_id
A key field. Template: ShortText.
- categorized_transaction_id
Template: ShortText.
- transaction_type
Template: ShortText.
- transaction_status
Template: ShortText.
- transaction_source
Template: ShortText.
- transaction_date
Template: Date.
- account_id
Template: ShortText.
- customer_id
Template: ShortText.
- payee
Template: ShortText.
- description
Template: ShortText.
- entry_number
Template: ShortText.
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- debit_or_credit
Template: ShortText.
- offset_account_name
Template: ShortText.
- reference_number
Template: ShortText.
- reconcile_status
Template: ShortText.
- debit_amount
Data type: DT_R8
- credit_amount
Data type: DT_R8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/journals.Documentation: https://www.zoho.com/books/api/v3/journals/#get-journal-list.
- [Read single] action
-
Endpoint URL address:
/journals/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/journals/#get-journal.
- [Create] action
-
Endpoint URL address:
/journals.Documentation: https://www.zoho.com/books/api/v3/journals/#create-a-journal.
- [Update] action
-
Endpoint URL address:
/journals/{{=item.journal_id}}.Documentation: https://www.zoho.com/books/api/v3/journals/#update-a-journal.
- [Delete] action
-
Endpoint URL address:
/journals/{{=item.journal_id}}.Documentation: https://www.zoho.com/books/api/v3/journals/#delete-a-journal.
- journal_id
A key field. Template: ShortText.
- entry_number
Template: ShortText.
- journal_template_name
Template: ShortText.
- reference_number
Template: ShortText.
- journal_number_prefix
Template: ShortText.
- journal_number_suffix
Template: ShortText.
- notes
Data type: DT_WSTR ( length 4000 )
- currency_id
Template: ShortText.
- currency_code
Template: ShortText.
- currency_symbol
Template: ShortText.
- exchange_rate
Data type: DT_R8
- journal_date
Template: Date.
- journal_type
Template: ShortText.
- line_item_total
Data type: DT_R8
- total
Data type: DT_R8
- bcy_total
Data type: DT_R8
- available_receivables_credits
Data type: DT_R8
- available_payables_credits
Data type: DT_R8
- created_time
Template: DateTime. A read-only field.
- last_modified_time
Template: ShortText.
- price_precision
Data type: DT_I4
- project_name
Template: ShortText.
- vat_treatment
Template: ShortText.
- product_type
Template: ShortText.
- include_in_vat_return
Data type: DT_BOOL
- is_bas_adjustment
Data type: DT_BOOL
- invoices_credited
Field components:
- An array.
-
Uses template:
InvoiceCreditT.
- bills_credited
Field components:
- An array.
-
Uses template:
CreditPaymentBillT.
- imported_transactions
Field components:
- An array.
-
Uses template:
ImportedTransactionT.
- line_items
Field components:
- An array.
-
Uses template:
LineItemT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- taxes
Field components:
- An array.
-
Uses template:
TaxT.
- comments
Field components:
- An array.
-
Uses template:
CommentT.
- project_id
Template: ShortText.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- status
Template: ShortText.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/basecurrencyadjustment.Documentation: https://www.zoho.com/books/api/v3/base-currency-adjustment/#list-base-currency-adjustment.
- [Read single] action
-
Endpoint URL address:
/basecurrencyadjustment/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/base-currency-adjustment/#get-a-base-currency-adjustment.
- [Create] action
-
Endpoint URL address:
/basecurrencyadjustment.Documentation: https://www.zoho.com/books/api/v3/base-currency-adjustment/#create-a-base-currency-adjustment.
- [Delete] action
-
Endpoint URL address:
/basecurrencyadjustment/{{=item.base_currency_adjustment_id}}.Documentation: https://www.zoho.com/books/api/v3/base-currency-adjustment/#delete-a-base-currency-adjustment.
- base_currency_adjustment_id
A key field. Template: ShortText.
- adjustment_date
Template: ShortText.
- exchange_rate
Data type: DT_R8
- currency_id
Template: ShortText.
- accounts
Field components:
- An array.
- Contains the following components: account_id, account_name, bcy_balance, fcy_balance, adjusted_balance, gain_or_loss, gl_specific_type.
- notes
Data type: DT_WSTR ( length 4000 )
- currency_code
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects.Documentation: https://www.zoho.com/books/api/v3/projects/#list-projects.
- [Read single] action
-
Endpoint URL address:
/projects/{{=ZohoBooks.UI.ProjectEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- project_id: Required. Specify the project identifier.
Documentation: https://www.zoho.com/books/api/v3/projects/#get-a-project.
- [Create] action
-
Endpoint URL address:
/projects.Documentation: https://www.zoho.com/books/api/v3/projects/#create-a-project.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}.Documentation: https://www.zoho.com/books/api/v3/projects/#update-project.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}.Documentation: https://www.zoho.com/books/api/v3/projects/#delete-project.
- project_id
A key field. Template: ShortText.
- project_name
Template: ShortText.
- customer_id
Template: ShortText.
- currency_id
Template: ShortText.
- customer_name
Template: ShortText.
- currency_code
Template: ShortText.
- description
Template: ShortText.
- status
Template: ShortText.
- billing_type
Template: ShortText.
- rate
Data type: DT_R8
- is_from_zoho_projects
Data type: DT_BOOL
- budget_type
Template: ShortText.
- budget_amount
Data type: DT_R8
- cost_budget_amount
Data type: DT_R8
- is_budget_threshold_notification_enabled
Data type: DT_BOOL
- is_client_approval_needed
Data type: DT_BOOL
- is_user_approval_needed
Data type: DT_BOOL
- project_head_id
Template: ShortText.
- project_head_name
Template: ShortText.
- is_valid_project_head
Data type: DT_BOOL
- budget_threshold
Data type: DT_R8
- budget_threshold_formatted
Template: ShortText.
- is_expense_inclusive
Data type: DT_I4
- total_hours
Template: ShortText.
- total_amount
Data type: DT_R8
- total_amount_expense_inclusive
Template: ShortText.
- billed_hours
Template: ShortText.
- billed_amount
Data type: DT_I4
- un_billed_hours
Template: ShortText.
- un_billed_amount
Data type: DT_I4
- billable_hours
Template: ShortText.
- billable_amount
Data type: DT_I4
- non_billable_hours
Template: ShortText.
- non_billable_amount
Data type: DT_R8
- unused_retainer_payments
Data type: DT_R8
- has_active_recurring_profiles
Data type: DT_BOOL
- created_time
A key field. Template: DateTime.
- zohopeople_project_id
Template: ShortText.
- is_from_zoho_people
Data type: DT_BOOL
- zohoworkerly_project_id
Template: ShortText.
- show_in_dashboard
Data type: DT_BOOL
- accounts_budgets
Field components:
- An array.
- Contains the following components: budget_id, name, status, frequency, year.
- tasks
Field components:
- An array.
- Contains the following components: task_id, task_name, description, rate, budget_hours, budget_hours_in_time, total_hours, billed_hours, un_billed_hours, billable_hours, non_billable_hours, status, is_billable, task_custom_fields, zohopeople_job_id.
- users
Field components:
- An array.
-
Uses template:
UserT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- invoices
A read-only field. The value is gathered from
/projects/{{=item.project_id}}/invoicesaddress. The gathered value is processed with{{=response.invoices}}expression. Field components:- An array.
-
Uses template:
InvoiceT.
- comments
A read-only field. The value is gathered from
/projects/{{=item.project_id}}/commentsaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
CommentT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: activate, inactive, clone, inviteUser, assign_user.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects/{{=ZohoBooks.UI.ProjectEditor.getValue(parameters)}}/users.The action has the following user-defined parameters:
- project_id: Required. Specify the project identifier.
Documentation: https://www.zoho.com/books/api/v3/projects/#get-a-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=ZohoBooks.UI.ProjectEditor.getValue(parameters)}}/users/{{=parameters.id}}.The action has the following user-defined parameters:
- project_id: Required. Specify the project identifier.
Documentation: https://www.zoho.com/books/api/v3/projects/#get-a-user.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/users.The following request parameters will be automatically processed:
-
application/json:
{{={ users : [item] }}
Documentation: https://www.zoho.com/books/api/v3/projects/#assign-users.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/users/{{=item.user_id}}.Documentation: https://www.zoho.com/books/api/v3/projects/#update-user.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/users/{{=item.user_id}}.Documentation: https://www.zoho.com/books/api/v3/projects/#delete-user.
The resource includes the fields from the UserT template.
- project_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects/{{=ZohoBooks.UI.ProjectEditor.getValue(parameters)}}/tasks.The action has the following user-defined parameters:
- project_id: Required. Specify the project identifier.
Documentation: https://www.zoho.com/books/api/v3/tasks/#list-tasks.
- [Read single] action
-
Endpoint URL address:
/projects/{{=ZohoBooks.UI.ProjectEditor.getValue(parameters)}}/tasks/{{=parameters.id}}.The action has the following user-defined parameters:
- project_id: Required. Specify the project identifier.
Documentation: https://www.zoho.com/books/api/v3/tasks/#get-a-task.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/tasks.Documentation: https://www.zoho.com/books/api/v3/tasks/#add-a-task.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/tasks/{{=item.task_id}}.Documentation: https://www.zoho.com/books/api/v3/tasks/#update-a-task.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/tasks/{{=item.task_id}}.Documentation: https://www.zoho.com/books/api/v3/tasks/#delete-task.
- task_id
A key field. Template: ShortText.
- project_id
A key field. Template: ShortText.
- currency_id
Template: ShortText.
- customer_id
Template: ShortText.
- task_name
Template: ShortText.
- description
Template: ShortText.
- project_name
Template: ShortText.
- rate
Data type: DT_R8
- status
Template: ShortText.
- is_billable
Data type: DT_BOOL
- zohopeople_job_id
Template: ShortText.
- customer_name
Template: ShortText.
- billed_hours
Template: ShortText.
- log_time
Template: ShortText.
- un_billed_hours
Template: ShortText.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects/timeentries.Documentation: https://www.zoho.com/books/api/v3/time-entries/#list-time-entries.
- [Read single] action
-
Endpoint URL address:
/projects/timeentries/{{=parameters.id}}.Documentation: https://www.zoho.com/books/api/v3/time-entries/#get-a-time-entry.
- [Create] action
-
Endpoint URL address:
/projects/timeentries.Documentation: https://www.zoho.com/books/api/v3/time-entries/#log-time-entries.
- [Update] action
-
Endpoint URL address:
/projects/timeentries/{{=item.time_entry_id}}.Documentation: https://www.zoho.com/books/api/v3/time-entries/#update-time-entry.
- [Delete] action
-
Endpoint URL address:
/projects/timeentries/{{=item.time_entry_id}}.Documentation: https://www.zoho.com/books/api/v3/time-entries/#delete-time-entry.
- time_entry_id
A key field. Template: ShortText.
- project_id
Template: ShortText.
- project_name
Template: ShortText.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- task_id
Template: ShortText.
- task_name
Template: ShortText.
- user_id
Template: ShortText.
- user_name
Template: ShortText.
- is_current_user
Data type: DT_BOOL
- log_date
Template: Date.
- project_head_id
Template: ShortText.
- project_head_name
Template: ShortText.
- can_be_invoiced
Data type: DT_BOOL
- begin_time
Template: DateTime.
- end_time
Template: DateTime.
- can_continue_timer
Data type: DT_BOOL
- log_time
Template: ShortText.
- is_billable
Data type: DT_BOOL
- billed_status
Template: ShortText.
- is_client_approval_needed
Data type: DT_BOOL
- can_create_client_approval
Data type: DT_BOOL
- can_create_user_approval
Data type: DT_BOOL
- invoice_id
Template: ShortText.
- invoice_number
Template: ShortText.
- notes
Template: ShortText.
- timer_started_at
Template: ShortText.
- is_paused
Data type: DT_BOOL
- timer_duration_in_minutes
Data type: DT_I4
- zohopeople_time_entry_id
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- timer_started_at_utc_time
Template: DateTime.
- timer_duration_in_seconds
Data type: DT_I4
- timesheet_custom_fields
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: start, stop.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.Documentation: https://www.zoho.com/books/api/v3/users/#list-users.
- [Read single] action
-
Endpoint URL address:
/users/{{=ZohoBooks.UI.UserEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Specify the user identifier.
Documentation: https://www.zoho.com/books/api/v3/users/#get-a-user.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://www.zoho.com/books/api/v3/users/#create-a-user.
- [Update] action
-
Endpoint URL address:
/users/{{=item.user_id}}.Documentation: https://www.zoho.com/books/api/v3/users/#update-a-user.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}.Documentation: https://www.zoho.com/books/api/v3/users/#delete-a-user.
- user_id
A key field. Template: ShortText.
- name
Template: ShortText.
- email_ids
Field components:
- An array.
- Contains the following components: is_selected, email.
- status
Template: ShortText.
- user_role
Template: ShortText.
- user_type
Template: ShortText.
- role_id
Template: ShortText.
- photo_url
Template: ShortText.
- role
Field components:
-
Uses template:
ShortText. - Contains the following components: role, role_id, name, email, zuid.
-
Uses template:
- is_claimant
Data type: DT_BOOL
- is_employee
Data type: DT_BOOL
Template: ShortText.
- is_customer_segmented
Data type: DT_BOOL
- is_vendor_segmented
Data type: DT_BOOL
- is_accountant
Data type: DT_BOOL
- created_time
Template: DateTime. A read-only field.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- is_associated_for_approval
Data type: DT_BOOL
- is_associated_with_org_email
Data type: DT_BOOL
- branches
Template: LongText. A composite field.
- default_branch_id
Template: ShortText.
- associated_clients
Template: LongText. A composite field.
- action
Template: ShortText. Field components:
- Contains the following components: invite, active, inactive.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/items.Documentation: https://www.zoho.com/books/api/v3/items/#list-items.
- [Read single] action
-
Endpoint URL address:
/items/{{=ZohoBooks.UI.ItemEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Specify the user identifier.
Documentation: https://www.zoho.com/books/api/v3/items/#get-an-item.
- [Create] action
-
Endpoint URL address:
/items.Documentation: https://www.zoho.com/books/api/v3/items/#create-an-item.
- [Update] action
-
Endpoint URL address:
/items/{{=item.item_id}}.Documentation: https://www.zoho.com/books/api/v3/items/#update-an-item.
- [Delete] action
-
Endpoint URL address:
/items/{{=item.item_id}}.Documentation: https://www.zoho.com/books/api/v3/items/#delete-an-item.
- item_id
A key field. Template: ShortText.
- name
Template: ShortText.
- sku
Template: ShortText.
- brand
Template: ShortText.
- manufacturer
Template: ShortText.
- image_name
Template: ShortText.
- image_type
Template: ShortText.
- status
Template: ShortText.
- source
Template: ShortText.
- is_linked_with_zohocrm
Data type: DT_BOOL
- zcrm_product_id
Template: ShortText.
- crm_owner_id
Template: ShortText.
- unit
Template: ShortText.
- description
Template: LongText.
- rate
Data type: DT_R8
- account_id
Template: ShortText.
- account_name
Template: ShortText.
- tax_id
Template: ShortText.
- tax_name
Template: ShortText.
- tax_percentage
Template: ShortText.
- tax_type
Template: ShortText.
- is_default_tax_applied
Data type: DT_BOOL
- associated_template_id
Template: ShortText.
- purchase_description
Template: ShortText.
- pricebook_rate
Data type: DT_R8
- sales_rate
Data type: DT_R8
- purchase_rate
Data type: DT_R8
- purchase_account_id
Template: ShortText.
- purchase_account_name
Template: ShortText.
- inventory_account_id
Template: ShortText.
- inventory_account_name
Template: ShortText.
- created_time
Template: DateTime. A read-only field.
- offline_created_date_with_time
Template: DateTime.
- last_modified_time
Template: DateTime. A read-only field.
- item_type
Template: ShortText.
- product_type
Template: ShortText.
- minimum_order_quantity
Template: ShortText.
- maximum_order_quantity
Template: ShortText.
- initial_stock
Template: ShortText.
- initial_stock_rate
Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- hsn_or_sac
Template: ShortText.
- is_taxable
Data type: DT_BOOL
- tax_exemption_id
Template: ShortText.
- avatax_tax_code
Template: ShortText.
- avatax_use_code
Template: ShortText.
- reorder_level
Template: ShortText.
- sat_item_key_code
Template: ShortText.
- unitkey_code
Template: ShortText.
- sales_channels
Template: LongText. A composite field.
- preferred_vendors
Template: LongText. A composite field.
- warehouses
Field components:
- An array.
- Contains the following components: warehouse_id, warehouse_name, status, is_primary, warehouse_stock_on_hand, warehouse_available_stock, warehouse_actual_available_stock.
- tags
Field components:
- An array.
-
Uses template:
TagT.
- item_tax_preferences
Field components:
- An array.
-
Uses template:
TaxT.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- documents
Field components:
- An array.
-
Uses template:
DocumentT.
- action
Template: ShortText. Field components:
- Contains the following components: active, inactive.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=ZohoBooks.getCustomFields(response.fields)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/currencies.Documentation: https://www.zoho.com/books/api/v3/currency/#list-currencies.
- [Read single] action
-
Endpoint URL address:
/settings/currencies/{{=ZohoBooks.UI.CurrencyEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Specify the currency identifier.
Documentation: https://www.zoho.com/books/api/v3/currency/#get-a-currency.
- [Create] action
-
Endpoint URL address:
/settings/currencies.Documentation: https://www.zoho.com/books/api/v3/currency/#create-a-currency.
- [Update] action
-
Endpoint URL address:
/settings/currencies/{{=item.currency_id}}.Documentation: https://www.zoho.com/books/api/v3/currency/#update-a-currency.
- [Delete] action
-
Endpoint URL address:
/settings/currencies/{{=item.currency_id}}.Documentation: https://www.zoho.com/books/api/v3/currency/#delete-a-currency.
- currency_id
A key field. Template: ShortText.
- currency_code
Template: ShortText.
- currency_name
Template: ShortText.
- currency_name_formatted
Template: ShortText.
- currency_symbol
Template: ShortText.
- price_precision
Data type: DT_I4
- currency_format
Template: ShortText.
- is_base_currency
Data type: DT_BOOL
- exchangeRates
A read-only field. The value is gathered from
/settings/currencies/{{=item.currency_id}}/exchangeratesaddress. The gathered value is processed with{{=response.exchange_rates}}expression. Field components:- An array.
- Contains the following components: exchange_rate_id, currency_id, currency_code, effective_date.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/settings/currencies/{{=ZohoBooks.UI.CurrencyEditor.getValue(parameters)}}/exchangerates.The action has the following user-defined parameters:
- currency_id: Required. Specify the currency identifier.
Documentation: https://www.zoho.com/books/api/v3/currency/#list-exchange-rates.
- [Read single] action
-
Endpoint URL address:
/settings/currencies/{{=ZohoBooks.UI.CurrencyEditor.getValue(parameters)}}/exchangerates/{{=parameters.id}}.The action has the following user-defined parameters:
- currency_id: Required. Specify the currency identifier.
Documentation: https://www.zoho.com/books/api/v3/currency/#get-an-exchange-rate.
- [Create] action
-
Endpoint URL address:
/settings/currencies/{{=item.currency_id}}/exchangerates.Documentation: https://www.zoho.com/books/api/v3/currency/#create-an-exchange-rate.
- [Update] action
-
Endpoint URL address:
/settings/currencies/{{=item.currency_id}}/exchangerates/{{=item.exchange_rate_id}}.Documentation: https://www.zoho.com/books/api/v3/currency/#update-an-exchange-rate.
- [Delete] action
-
Endpoint URL address:
/settings/currencies/{{=item.currency_id}}/exchangerates/{{=item.exchange_rate_id}}.Documentation: https://www.zoho.com/books/api/v3/currency/#delete-an-exchage-rate.
- exchange_rate_id
A key field. Template: ShortText.
- rate_formatted
Template: ShortText.
- rate
Data type: DT_R8
- effective_date_formatted
Template: ShortText.
- effective_date
Template: ShortText.
- is_market_closed_rates
Data type: DT_BOOL
- currency_id
A key field. Template: ShortText.
- currency_code
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/taxes.Documentation: https://www.zoho.com/books/api/v3/taxes/#list-taxes.
- [Read single] action
-
Endpoint URL address:
/settings/taxes/{{=ZohoBooks.UI.TaxEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Specify the tax identifier.
Documentation: https://www.zoho.com/books/api/v3/taxes/#get-a-tax.
- [Create] action
-
Endpoint URL address:
/settings/taxes.Documentation: https://www.zoho.com/books/api/v3/taxes/#create-a-tax.
- [Update] action
-
Endpoint URL address:
/settings/taxes/{{=item.tax_id}}.Documentation: https://www.zoho.com/books/api/v3/taxes/#update-a-tax-group.
- [Delete] action
-
Endpoint URL address:
/settings/taxes/{{=item.tax_id}}.Documentation: https://www.zoho.com/books/api/v3/taxes/#delete-a-tax-group.
- tax_id
A key field. Template: ShortText.
- tax_name
Template: ShortText.
- tax_percentage
Data type: DT_R8
- tax_type
Template: ShortText.
- tax_specific_type
Template: ShortText.
- tax_authority_id
Template: ShortText.
- tax_authority_name
Template: ShortText.
- is_value_added
Data type: DT_BOOL
- purchase_tax_expense_account_id
Data type: DT_I4
- is_default_tax
Data type: DT_BOOL
- is_editable
Data type: DT_BOOL
- country_code
Template: ShortText.
- update_recurring_invoice
Data type: DT_BOOL
- update_recurring_expense
Data type: DT_BOOL
- update_draft_invoice
Data type: DT_BOOL
- update_recurring_bills
Data type: DT_BOOL
- update_draft_so
Data type: DT_BOOL
- update_subscription
Data type: DT_BOOL
- update_project
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/taxauthorities.Documentation: https://www.zoho.com/books/api/v3/taxes/#list-tax-authorities-us-edition-only.
- [Read single] action
-
Endpoint URL address:
/settings/taxauthorities/{{=ZohoBooks.UI.TaxAuthorityEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Specify the tax authority identifier.
Documentation: https://www.zoho.com/books/api/v3/taxes/#get-a-tax-authority-us-and-ca-edition-only.
- [Create] action
-
Endpoint URL address:
/settings/taxauthorities.Documentation: https://www.zoho.com/books/api/v3/taxes/#create-a-tax.
- [Update] action
-
Endpoint URL address:
/settings/taxauthorities/{{=item.tax_authority_id}}.Documentation: https://www.zoho.com/books/api/v3/taxes/#update-a-tax-authority-us-and-ca-edition-only.
- [Delete] action
-
Endpoint URL address:
/settings/taxauthorities/{{=item.tax_authority_id}}.Documentation: https://www.zoho.com/books/api/v3/taxes/#delete-a-tax-authority-us-and-ca-edition-only.
- tax_authority_id
A key field. Template: ShortText.
- tax_authority_name
Template: ShortText.
- description
Template: ShortText.
- state_code
Template: ShortText.
- state
Template: ShortText.
- registration_number
Template: ShortText.
- registration_number_label
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/taxexemptions.Documentation: https://www.zoho.com/books/api/v3/taxes/#list-tax-exemptions-us-edition-only.
- [Read single] action
-
Endpoint URL address:
/settings/taxexemptions/{{=ZohoBooks.UI.TaxExemptionEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- id: Required. Specify the tax exemption identifier.
Documentation: https://www.zoho.com/books/api/v3/taxes/#get-a-tax-exemption-us-edition-only.
- [Create] action
-
Endpoint URL address:
/settings/taxexemptions.Documentation: https://www.zoho.com/books/api/v3/taxes/#create-a-tax-exemption-us-edition-only.
- [Update] action
-
Endpoint URL address:
/settings/taxexemptions/{{=item.tax_exemption_id}}.Documentation: https://www.zoho.com/books/api/v3/taxes/#update-a-tax-exemption-us-edition-only.
- [Delete] action
-
Endpoint URL address:
/settings/taxexemptions/{{=item.tax_exemption_id}}.Documentation: https://www.zoho.com/books/api/v3/taxes/#delete-a-tax-exemption-us-edition-only.
- tax_exemption_id
A key field. Template: ShortText.
- tax_exemption_code
Template: ShortText.
- description
Template: ShortText.
- type
Template: ShortText.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/settings/openingbalances.
The result is extracted from:{{=[response]}}.Documentation: https://www.zoho.com/books/api/v3/opening-balance/#get-opening-balance.
- [Create] action
-
Endpoint URL address:
/settings/openingbalances.Documentation: https://www.zoho.com/books/api/v3/opening-balance/#create-opening-balance.
- [Update] action
-
Endpoint URL address:
/settings/openingbalances.Documentation: https://www.zoho.com/books/api/v3/opening-balance/#update-opening-balance.
- [Delete] action
-
Endpoint URL address:
/settings/openingbalances.Documentation: https://www.zoho.com/books/api/v3/opening-balance/#delete-opening-balance.
- opening_balance
Field components:
-
Uses template:
ShortText. - Contains the following components: date, total, comments, opening_balance_id, date_formatted, can_show_customer_ob, accounts, total_formatted, can_show_vendor_ob, price_precision.
-
Uses template:
- transactions_summary
Field components:
- An array.
- Contains the following components: entity_type, count, entity_type_formatted.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity_type}}/templates.
The result is paginated.The action has the following user-defined parameters:
- entity_type: Required. Specify the entity_type to list templates for.
- [Update] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/templates/{{=item.template_id}}.
- template_id
A key field. Template: ShortText.
- template_name
Template: ShortText.
- template_type
Template: ShortText.
- entity_type
A key field. Template: ShortText.
- entity_id
A key field. Template: ShortText.
Based on resource template Editors.
- [Update] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/address/{{=item.type}}.
- address
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- zip
Data type: DT_I4
- country
Template: ShortText.
- fax
Template: ShortText.
- phone
Template: ShortText.
- is_one_off_address
Data type: DT_BOOL
- is_update_customer
Data type: DT_BOOL
- is_verified
Data type: DT_BOOL
- entity_type
A key field. Template: ShortText.
- entity_id
A key field. Template: ShortText.
- type
A key field. Template: shortText.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}/{{=parameters.record_id}}/comments.
The result is extracted from:{{=response.comments || response.contact_comments}}.The action has the following user-defined parameters:
- entity: Required. Specify the entity type.
- record_id: Required. Specify record identifier to retrieve comments for.
- [Create] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/comments.
- [Update] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/comments/{{=item.comment_id}}.
- [Delete] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/comments/{{=item.comment_id}}.
The resource includes the fields from the CommentT template.
- entity_type
A key field. Template: ShortText.
- entity_id
A key field. Template: ShortText.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity_type}}/{{=parameters.record_id}}/attachment.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- entity_type: Required. Specify the entity type.
- record_id: Required. Specify record identifier to retrieve comments for.
The following request parameters will be automatically processed:
-
Accept:
*/*
- [Create] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/attachment.The action has the following user-defined parameters:
- totalFiles: Optional. Specify total number of files.
The following request parameters will be automatically processed:
-
attachment:
{{=item.content}} -
totalFiles:
{{=parameters.get('totalFiles')}} -
document_ids:
{{=(item.document_ids) ? item.document_ids : undefined}} -
can_send_in_mail:
{{=(item.can_send_in_mail) ? item.can_send_in_mail : undefined}}
- [Update] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/attachment.The following request parameters will be automatically processed:
-
attachment:
{{=item.content}} -
can_send_in_mail:
{{=(item.can_send_in_mail) ? item.can_send_in_mail : undefined}}
-
attachment:
- [Delete] action
-
Endpoint URL address:
/{{=item.entity_type}}/{{=item.entity_id}}/{{=item.entity_type == 'retainerinvoices' ? '/documents/' + item.document_id : '/attachment'}}.
- record_id
A key field. Template: ShortText.
- document_ids
Template: LongText. A composite field.
- can_send_in_mail
Data type: DT_BOOL
- filename
Template: ShortText.
- content
Data type: DT_IMAGE
- document_id
A key field. Template: ShortText.
- entity_type
A key field. Template: ShortText.
- entity_id
A key field. Template: ShortText.
Based on resource template Report.
- [Read] action
-
The action has the following user-defined parameters:
- usestate: Please specify to get the report for certain time frame.
- has_total
Data type: DT_BOOL
- is_budget_enabled_account
Data type: DT_BOOL
- can_show_row
Data type: DT_BOOL
- values
Field components:
- An array.
- Contains the following components: total_sub_account, total, total_sub_account_formatted, total_formatted.
- is_default_parent
Data type: DT_BOOL
- has_account_code
Data type: DT_BOOL
- align
Template: ShortText.
- can_show_grand_total
Data type: DT_BOOL
- is_drill_down_supported
Data type: DT_BOOL
- has_name
Data type: DT_BOOL
- total_label
Template: ShortText.
- name
Template: ShortText.
- is_starting_level
Data type: DT_BOOL
- has_child
Data type: DT_BOOL
- accounts
Field components:
- An array.
- Contains the following components: is_budget_enabled_account, can_show_row, values, is_default_parent, align, can_show_grand_total, is_drill_down_supported, total_label, depth, name, is_starting_level, has_child, accounts, can_show_footer, depth_indent.
- can_show_footer
Data type: DT_BOOL
Based on resource template Report.
Based on resource template Report.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/landedcostsummary.
The result is extracted from:{{=response.landed_cost_summary}}.The action has the following user-defined parameters:
- filter_by: Please specify to get the report for certain time frame.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- bill_date
Template: ShortText.
- bill_date_formatted
Template: ShortText.
- bill_number
Template: ShortText.
- bill_id
Template: ShortText.
- vendor_id
Template: ShortText.
- vendor_name
Template: ShortText.
- description
Template: ShortText.
- fcy_total
Data type: DT_R8
- fcy_total_formatted
Template: ShortText.
- bcy_total
Data type: DT_R8
- bcy_total_formatted
Template: ShortText.
- unallocated_fcy_amount
Data type: DT_R8
- unallocated_fcy_amount_formatted
Template: ShortText.
- unallocated_bcy_amount
Data type: DT_R8
- unallocated_bcy_amount_formatted
Template: ShortText.
- allocated_fcy_amount
Data type: DT_R8
- allocated_fcy_amount_formatted
Template: ShortText.
- allocated_bcy_amount
Data type: DT_R8
- allocated_bcy_amount_formatted
Template: ShortText.
- allocated_bills
Template: LongText. A composite field.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/inventoryagingsummary.
The result is extracted from:{{=response.inventory_aging_summary}}.The action has the following user-defined parameters:
- interval_type: Required. Please specify to get the report for certain time frame.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- item_id
Template: ShortText.
- item_name
Template: ShortText.
- days_1-3
Template: ShortText.
- days_4-6
Template: ShortText.
- days_7-9
Template: ShortText.
- days_10-12
Template: ShortText.
- days_13-15
Template: ShortText.
- days_above-15
Data type: ShortText
Based on resource template Report.
- invoices
Field components:
- An array.
-
Uses template:
ReportInvoiceT.
- sales_receipt
Field components:
- An array.
-
Uses template:
CustomFieldT.
- invoice
Template: ReportInvoiceT.
- creditnote
Template: ReportCreditNoteT.
Based on resource template Report.
- invoices
Field components:
- An array.
-
Uses template:
ReportInvoiceT.
- invoice
Template: ReportInvoiceT.
- creditnote
Template: ReportCreditNoteT.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/recurringinvoicedetails.
The result is extracted from:{{=response.recurring_invoice_details.recurring_invoices}}.The action has the following user-defined parameters:
- filter_by: Please specify to get the report for certain time frame.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
usestate:
true
- [External]
-
The external fields URL address:
/reports/metadata. The external fields list is extracted from:{{=response.entity_fields}}.- {{=external.field_name}}
Template: {{=ZohoBooks.getFieldTemplate(external.field_data_type)}}.
Based on resource template Report.
- intervals
Field components:
- An array.
-
Uses template:
IntervalT.
- group_list
Field components:
- An array.
-
Uses template:
GroupListT.
- expense
Field components:
-
Uses template:
ShortText. - Contains the following components: receipt_name.
-
Uses template:
- bill
Field components:
-
Uses template:
ShortText. - Contains the following components: type.
-
Uses template:
- total
Data type: DT_R8
- sent
Data type: DT_R8
- overdue
Data type: DT_R8
Based on resource template Report.
- custom_fields
Field components:
- An array.
-
Uses template:
CustomFieldT.
- contact
Field components:
- An array.
-
Uses template:
CustomFieldT.
- bill
Field components:
-
Uses template:
ShortText. - Contains the following components: type.
-
Uses template:
- expense
Field components:
-
Uses template:
ShortText. - Contains the following components: receipt_name=.
-
Uses template:
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=response.fields}}.- custom.{{=external.field_name}}
Template: {{=ZohoBooks.getFieldTemplate(external.data_type)}}. Before setting, the value is processed with
{{=ZohoBooks.getFieldValue(field, value)}}expression.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/expensesbyemployee.
The result is extracted from:{{=response.expenses}}.The action has the following user-defined parameters:
- filter_by: Please specify to get the report for certain time frame.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- user_id
A key field. Template: ShortText.
- email_id
Template: ShortText.
- user_name
Template: ShortText.
- count
Data type: DT_I4
- rcy_currency_id
Template: ShortText.
- rcy_currency_code
Template: ShortText.
- rcy_exchange_rate
Data type: DT_R8
- rcy_amount
Data type: DT_R8
- rcy_amount_formatted
Template: ShortText.
- rcy_amount_with_tax
Data type: DT_R8
- rcy_amount_with_tax_formatted
Template: ShortText.
- amount
Data type: DT_R8
- amount_formatted
Template: ShortText.
- amount_with_tax
Data type: DT_R8
- amount_with_tax_formatted
Template: ShortText.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/{{=parameters.ReportType}}.
The result is extracted from:{{=(response.sales_tax_liabilities) ? response.sales_tax_liabilities : response.report1099}}.The action has the following user-defined parameters:
- ReportType: Required. Please specify the report type.
- filter_by: Optional. Specify only for sales tax reliability report.
- report_type: Optional. Specify only for 1099 reports.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- vendor_id
Template: ShortText.
- name
Template: ShortText.
Template: ShortText.
- tax_id_type
Template: ShortText.
- tax_id_value
Template: ShortText.
- address
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- country
Template: ShortText.
- zip
Template: ShortText.
- box4-federal_it_withheld
Template: ShortText.
- tax_authority_id
Template: ShortText.
- tax_authority_name
Template: ShortText.
- sales_amount
Data type: DT_R8
- sales_with_tax
Data type: DT_R8
- sales
Template: ShortText.
- taxable_amount
Data type: DT_R8
- non_taxable_sales_amount
Data type: DT_R8
- collected_tax_amount
Data type: DT_R8
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/reconciliation.
The result is extracted from:{{=[response.reconciliation_report.reconciliation_summary]}}.The action has the following user-defined parameters:
- from_date: Required. Specify from_date parameter.
- to_date: Required. Specify to_date parameter.
- account_id: Required. Specify the account identifier.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
view:
reconciliation_summary
- reconciliaition_txns_count
Data type: DT_I4
- reconciled_debit_amount
Template: ShortText.
- balance_as_on_todate
Template: ShortText.
- unmatched_books_count
Data type: DT_I4
- unmatched_statementlines_total_as_on_todate
Template: ShortText.
- reconciled_credit_amount
Template: ShortText.
- unreconciliaition_txns_count
Data type: DT_I4
- unreconciled_txns_credit_count
Template: ShortText.
- unreconciled_debit_amount
Template: ShortText.
- unmatched_statement_count
Data type: DT_I4
- matched_and_categorized_count
Data type: DT_I4
- reconciled_total_in_duration
Template: ShortText.
- reconciled_txns_credit_count
Template: ShortText.
- unreconciled_total_in_duration
Template: ShortText.
- balance_as_on_fromdate
Template: ShortText.
- matched_books_total_in_duration
Template: ShortText.
- unmatched_books_total_as_on_todate
Template: ShortText.
- reconciled_txns_debit_count
Template: ShortText.
- unreconciled_txns_debit_count
Template: ShortText.
- unreconciled_credit_amount
Template: ShortText.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/budgetvsactuals.
The result is extracted from:{{=response.budget_details}}.The action has the following user-defined parameters:
- is_flow_new: Optional. Specifiy boolean value.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- [External]
-
The external fields URL address:
/reports/metadata. The external fields list is extracted from:{{=response.entity_fields}}.- {{=external.field_name}}
Template: {{=ZohoBooks.getFieldTemplate(external.field_data_type)}}.
Based on resource template Report.
- invoices
Field components:
- An array.
-
Uses template:
ReportInvoiceT.
- invoice
Template: ReportInvoiceT.
- creditnote
Template: ReportCreditNoteT.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/timesheetdetails.
The result is extracted from:{{=response.time_entries}}.The action has the following user-defined parameters:
- filter_by: Please specify to get the report for certain time frame.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- project_id
A key field. Template: ShortText.
- nonbillable_hours
Template: ShortText.
- billable_hours
Template: ShortText.
- billing_type
Template: ShortText.
- billing_type_formatted
Template: ShortText.
- project_name
Template: ShortText.
- unbilled_hours
Template: ShortText.
- log_time
Template: ShortText.
- time_entry_details
Field components:
- An array.
- Contains the following components: task_name, notes, billed_status, user_name, end_time, begin_time, log_date_formatted, task_id, is_current_user, log_time, billed_status_formatted, timer_started_at, timer_duration_in_seconds, time_entry_id, user_id, log_date, timer_duration_in_minutes, customer_name, customer_id.
- billed_hours
Template: ShortText.
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/projectsummary.
The result is extracted from:{{=response.projects}}.The action has the following user-defined parameters:
- filter_by: Please specify to get the report for certain time frame.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- project_id
A key field. Template: ShortText.
- project_name
Template: ShortText.
- customer_id
Template: ShortText.
- customer_name
Template: ShortText.
- billing_type
Template: ShortText.
- fcy_rate
Data type: DT_R8
- logged_amount
Data type: DT_R8
- billed_amount
Data type: DT_R8
- unbilled_amount
Data type: DT_R8
- billable_amount
Data type: DT_R8
- nonbillable_amount
Data type: DT_R8
- budget_amount
Data type: DT_R8
- budget_hours
Data type: DT_R8
- is_loggedhours_exceeded
Data type: DT_BOOL
Based on resource template Report.
- account
Field components:
-
Uses template:
ShortText. - Contains the following components: account_group, account_type.
-
Uses template:
- accounts_list
Field components:
- An array.
- Contains the following components: account_type, account_type_formatted, account_type_id, debit, debit_formatted, credit, credit_formatted, previous_values.
- opening_balance
Template: BalanceReportT.
- closing_balance
Template: BalanceReportT.
- group_name
Template: ShortText.
- previous_values
Field components:
- An array.
-
Uses template:
PreviousValueT.
- account_transactions
Field components:
- An array.
- Contains the following components: account_transactions, is_account_code_column_enabled, name, account_type_col_span.
- name
Template: ShortText.
- net_debit_total
Data type: DT_R8
- is_collapsed_view
Data type: DT_BOOL
- net_debit_total_sub_account
Data type: DT_R8
- account_type_col_span_list
Template: LongText. A composite field.
- net_credit_total
Data type: DT_R8
- net_credit_total_sub_account
Data type: DT_R8
Based on resource template Report.
- [Read] action
-
Endpoint URL address:
/{{=resource.name}}.
The result is extracted from:{{=response.module_records}}.Documentation: https://www.zoho.com/books/api/v3/custom-modules/#get-record-list-of-a-custom-module.
- [Create] action
-
Endpoint URL address:
/{{=resource.name}}.Documentation: https://www.zoho.com/books/api/v3/custom-modules/#create-custom-modules.
- [Update] action
-
Endpoint URL address:
/{{=resource.name}}/{{=item.module_record_id}}.Documentation: https://www.zoho.com/books/api/v3/custom-modules/#update-custom-module.
- [Delete] action
-
Endpoint URL address:
/{{=resource.name}}/{{=item.module_record_id}}.Documentation: https://www.zoho.com/books/api/v3/custom-modules/#delete-individual-records.
- module_record_id
A key field. Template: ShortText.
- module_api_name
Template: ShortText.
- last_modified_time
Template: DateTime. A read-only field.
- last_modified_time_formatted
Template: DateTime. A read-only field.
- created_time
Template: DateTime. A read-only field.
- created_time_formatted
Template: DateTime. A read-only field.
- created_by_id
Template: ShortText.
- last_modified_by_id
Template: ShortText.
- record_name
Template: ShortText.
- record_name_formatted
Template: ShortText.
- cf_debt_amount
Data type: DT_R8
- cf_debt_amount_formatted
Template: ShortText.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=response.fields}}.- {{=external.field_name}}
Template: {{=ZohoBooks.getFieldTemplate(external.data_type)}}.
The external resource list URL address: /settings/modules.
The external resource list is extracted from: {{=response.modules}}.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response[resource.objects]}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Read single] action
-
The result is extracted from:{{=[response[resource.object]]}}.The action has the following user-defined parameters:
- id: Required. Specify record identifier.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Read] action
-
The result is extracted from:{{=response[resource.objects]}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
Based on resource template Editors.
- [Read] action
-
Endpoint URL address:
/reports/{{=ZohoBooks.UI.getReportType(ZohoBooks.UI.ReportTypeEditor.getValue(parameters, resource))}}.
The result is extracted from:{{=ZohoBooks.getReportData(resource, parameters, response)}}.The action has the following user-defined parameters:
- ReportType: Required. Please specify the report type.
- filter_by: Please specify to get the report for certain time frame.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- [External]
-
The external fields URL address:
/reports/metadata. The external fields list is extracted from:{{=response.entity_fields}}.- {{=external.field_name}}
Template: {{=ZohoBooks.getFieldTemplate(external.field_data_type)}}.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE Before setting, the value is processed with
{{=value && dateFormat(value, 'yyyy-mm-dd')}}expression.- Numeric
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- Integer
Data type: DT_I4
- Id
Data type: DT_I8
- MultiSelect
Template: ShortText. A composite field. The gathered value is processed with
{{=value && value.includes(',') ? value.join(',') : value}}expression.- CustomFieldT
Field components:
-
Uses template:
ShortText. - Contains the following components: field_id, customfield_id, show_in_store, show_in_portal, is_active, index, label, show_on_pdf, edit_on_portal, edit_on_store, api_name, show_in_all_pdf, value_formatted, search_entity, data_type, placeholder, value, is_dependent_field.
-
Uses template:
- ContactPersonT
Field components:
-
Uses template:
ShortText. - Contains the following components: contact_person_id, contact_id, salutation, first_name, last_name, email, phone, mobile, mobile_country_code, mobile_code_formatted, designation, department, skype, fax, photo_url, zcrm_contact_id, is_primary_contact, enable_portal, can_invite, is_sms_enabled_for_cp, is_added_in_portal, is_portal_invitation_accepted.
-
Uses template:
- TagT
Field components:
-
Uses template:
ShortText. - Contains the following components: tag_id, tag_option_id, is_tag_mandatory, tag_name, tag_option_name.
-
Uses template:
- GeneralAddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: attention, address_id, address, street2, state_code, city, state, zip, country, country_code, fax, phone, latitude, longitude.
-
Uses template:
- DocumentT
Field components:
-
Uses template:
ShortText. - Contains the following components: document_id, can_send_in_mail, file_name, attachment_order, source, file_size, source_formatted, uploaded_by, file_type, file_size_formatted, uploaded_on, alter_text.
-
Uses template:
- StatusT
Field components:
-
Uses template:
ShortText. - Contains the following components: status_id, status_code, parent_status, parent_status_formatted, description, display_name, label_name, color_code.
-
Uses template:
- TaxT
Field components:
-
Uses template:
ShortText. - Contains the following components: tax_name, tax_amount, debit_or_credit, tax_account.
-
Uses template:
- ToContactT
Field components:
-
Uses template:
ShortText. - Contains the following components: first_name, selected, phone, email, last_name, salutation, contact_person_id, mobile.
-
Uses template:
- FromEmailT
Field components:
-
Uses template:
ShortText. - Contains the following components: organization_contact_id, user_name, selected, email, is_org_email_id.
-
Uses template:
- CommentT
Field components:
-
Uses template:
ShortText. - Contains the following components: comment_id, contact_id, contact_name, description, commented_by_id, commented_by, date, date_formatted, date_description, time, transaction_id, transaction_type, is_entity_deleted, operation_type, opening_balance_id.
-
Uses template:
- ImportedTransactionT
Field components:
-
Uses template:
ShortText. - Contains the following components: imported_transaction_id, date, amount, payee, description, reference_number, status, account_id.
-
Uses template:
- ContentT
Field components:
-
Uses template:
LongText. - Contains the following components: body, error_list, bcc_mails, bcc_mails_str, subject, gateways_configured, gateways_associated, documents, customer_name, deprecated_placeholders_used, attach_pdf, entity_id, cc_mails_list, emailtemplates, to_contacts, file_name, file_name_without_extension, to_mails_str, cc_mails_str, from_email, from_address, from_emails, customer_id, attachment_name, emailtemplate_documents.
-
Uses template:
- InvoiceT
Field components:
-
Uses template:
ShortText. - Contains the following components: invoice_id, invoice_number, invoice_payment_id, amount_applied, tax_amount_withheld, discount_amount, total, balance, date, due_date, price_precision, apply_date, allow_partial_payments, retainerinvoice_id, retainerinvoice_number, retainerinvoice_total, retainerinvoice_balance, retainerinvoice_date.
-
Uses template:
- LineItemT
Field components:
-
Uses template:
ShortText. - Contains the following components: from_account_id, from_account_name, payment_mode, customer_id, customer_name, vendor_id, vendor_name, sub_total, total, bcy_total, line_item_id, variant_id, item_id, product_id, attribute_name1, warehouse_id, sku, attribute_name2, attribute_name3, attribute_option_name1, debit_or_credit, attribute_option_name2, attribute_option_name3, attribute_option_data1, attribute_option_data2, attribute_option_data3, amount, bcy_amount, acquisition_vat_id, acquisition_vat_name, acquisition_vat_percentage, acquisition_vat_amount, reverse_charge_vat_id, reverse_charge_vat_name, reverse_charge_vat_percentage, reverse_charge_vat_amount, pricebook_id, is_combo_product, name, group_name, description, item_order, bcy_rate, rate, quantity, unit, pricebook_id, header_id, header_name, discount, discounts, tax_id, tax_name, tax_type, tax_treatment_code, debit_or_credit, tax_exemption_id, tax_exemption_type, tax_exemption_code, tax_authority_id, tax_authority_name, tax_percentage, item_total, item_sub_total, product_type, line_item_type, account_id, account_name, item_type, is_invoiced, tags, documents, item_custom_fields, image_name, image_type, image_document_id, document_id, item_custom_fields, purchase_rate, markup_percent, line_item_taxes, salesorder_item_id, cost_amount, quantity_billed, quantity_invoiced, quantity_backordered, quantity_cancelled, time_entry_ids, expense_id, bill_id, expense_receipt_name, bill_item_id, project_name, project_id, acquisition_vat_id, product_type, reverse_charge_vat_id, reverse_charge_tax_id, tax_exemption_code, tax_exemption_id, purchase_request_items, is_landedcost, is_tds_applied, payment_terms_label, is_discount_before_tax, discount_account_id.
-
Uses template:
- PaymentGatewayT
Field components:
-
Uses template:
ShortText. - Contains the following components: configured, additional_field1, gateway_name.
-
Uses template:
- CheckDetailT
Field components:
-
Uses template:
ShortText. - Contains the following components: amount_in_words, check_id, check_number, check_status, memo.
-
Uses template:
- PaymentT
Field components:
-
Uses template:
ShortText. - Contains the following components: payment_id, bill_id, vendor_id, bill_payment_id, payment_number, invoice_id, invoice_payment_id, payment_mode, description, date, reference_number, exchange_rate, amount, tax_amount_withheld, online_transaction_id, is_single_invoice_payment, amount_applied, paid_through, paid_through_account_id, paid_through_account_name, is_single_bill_payment, is_paid_via_print_check, check_details, is_ach_payment, ach_payment_status, ach_gw_transaction_id, filed_in_vat_return_id, filed_in_vat_return_name, filed_in_vat_return_type.
-
Uses template:
- ActionT
- RefundT
Field components:
-
Uses template:
ShortText. - Contains the following components: refund_id, payment_refund_id, payment_id, vendorpayment_refund_id, date, refund_mode, reference_number, payment_number, customer_name, amount_bcy, amount_fcy, amount, exchange_rate, from_account_id, description, creditnote_number, creditnote_refund_id, creditnote_id, filed_in_vat_return_id, filed_in_vat_return_name, filed_in_vat_return_type, to_account_id, to_account_name, vendor_credit_id.
-
Uses template:
- CreditPaymentBillT
Field components:
-
Uses template:
ShortText. - Contains the following components: bill_id, vendor_credit_id, vendor_credit_bill_id, date, bill_number, bills, bill_payment_id, amount_applied, tax_amount_withheld.
-
Uses template:
- TransactionT
Field components:
-
Uses template:
ShortText. - Contains the following components: transaction_id, fcy_credit, entity_type_formatted, reference_number, credit_formatted, debit_formatted, entity_type, date_formatted, fcy_debit_formatted, fcy_credit_formatted, customer_name, customer_id, debit, credit, fcy_debit, debit_or_credit, date, customer_id, payee, transaction_type, amount, status.
-
Uses template:
- InvoiceCreditT
Field components:
-
Uses template:
ShortText. - Contains the following components: invoice_id, creditnote_id, creditnote_invoice_id, date, invoice_number, creditnote_number, credited_amount.
-
Uses template:
- UserT
Field components:
-
Uses template:
ShortText. - Contains the following components: user_id, is_current_user, user_name, email, user_role, role_id, status, rate, budget_hours, budget_hours_in_time, total_hours, billed_hours, un_billed_hours, billable_hours, non_billable_hours, staff_role, staff_status.
-
Uses template:
- ReportInvoiceT
Field components:
-
Uses template:
ShortText. - Contains the following components: invoice_id, status, status_formatted, date, date_formatted, due_date, due_date_formatted, invoice_number, reference_number, customer_name, bcy_total, bcy_total_formatted, bcy_balance, bcy_balance_formatted, salesperson_id, associated_projects, project_names, currency_code, currency_id, customer_id, price_precision, is_emailed, reminders_sent, exchange_rate, type, type_formatted, custom_fields, contact, branch.
-
Uses template:
- ReportCreditNoteT
Field components:
-
Uses template:
ShortText. - Contains the following components: fcy_amount_applied_formatted, amount_applied, amount_applied_formatted, fcy_amount_applied.
-
Uses template:
- IntervalT
Field components:
-
Uses template:
ShortText. - Contains the following components: amount, interval, amount_formatted.
-
Uses template:
- GroupListT
Field components:
-
Uses template:
ShortText. - Contains the following components: age, amount, balance, currency_code, currency_id, date, id, status, transaction_number, vendor_id, vendor_name, sent_formatted, total, intervals, overdue, name, fcy_total_formatted, fcy_total, total_formatted, sent, entity.
-
Uses template:
- BalanceReportT
Field components:
-
Uses template:
ShortText. - Contains the following components: date, fcy_credit, account_credit_balance, name, debit, credit, fcy_debit.
-
Uses template:
- PreviousValueT
Field components:
-
Uses template:
ShortText. - Contains the following components: count, sales_with_tax, sales.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.