Schemas
Copy Page
zb to vb
organizations
Create an organization
List organizations
Update an organization
Get an organization
estimates
Create an Estimate
List estimates
Update an Estimate
Get an estimate
Delete an Estimate
Update custom field in existing estimates
Mark an estimate as sent
Mark an estimate as accepted
Mark an estimate as declined
Submit an estimate for approval
Approve an estimate.
Email an estimate
Get estimate email content
Email multiple estimates
Bulk export estimates
Bulk print estimates
Update billing address
Update shipping address
List estimate template
Update estimate template
List estimate comments & history
Add Comments
Update comment
Delete a comment
contacts
update an Estimate using a custom field's unique value
Create a Contact
List Contacts
Update a contact using a custom field's unique value
Update a Contact
Get Contact
Delete a Contact
Mark as Active
Mark as Inactive
Enable Portal Access
Enable Payment Reminders
Disable Payment Reminders
Email Statement
Get Statement Mail Content
Email Contact
List Comments
Get Contact Addresses
Add Additional Address
Edit Additional Address
Delete Additional Address
List Refunds
Track 1099
Untrack 1099
Get Unused Retainer Payments
contact-persons
Create a contact person
Update a contact person
Delete a contact person
List contact persons
Get a contact person
Mark as primary contact person
sales-order
Create a sales order
List sales orders
Update a sales order using a custom field's unique value
Update a sales order
Get a sales order
Delete a sales order
Update custom field in existing salesorders
Mark a sales order as open
Mark a sales order as void
Update a sales order sub status
Email a sales order
Get sales order email content
Submit a sales order for approval
Approve a sales order.
Bulk export sales orders
Bulk print sales orders
Update billing address
Update shipping address
List sales order templates
Update sales order template
Get a sales order attachment
Add attachment to a sales order
Update attachment preference
Delete an attachment
List sales order comments & history
Add comment
Update comment
Delete a comment
sales-receipt
Create a sales receipt
List sales receipts
Update a sales receipt
Get a sales receipt
Delete a sales receipt
Email a sales receipt
customer-debit-notes
Create a customer debit note
List customer debit notes
Update a customer debit note
Get a customer debit note
Delete a customer debit note
invoices
Update an invoice
Get an invoice
Delete an invoice
Mark an invoice as sent
Void an invoice
Mark as draft
Email multiple invoices
Create an instant invoice
Associate invoices with sales order
Submit an invoice for approval
Approve an invoice.
Get invoice email content
Email an invoice
Remind Customer
Get payment reminder mail content
Bulk invoice reminder
Bulk export Invoices
Bulk print invoices
Disable payment reminder
Enable payment reminder
Write off invoice
Cancel write off
Update billing address
Update shipping address
List invoice templates
Update invoice template
List invoice payments
List credits applied
Apply credits
Delete a payment
Delete applied credit
Get last attached attachment
Add attachment to an invoice
Update attachment preference
Delete last attached attachment
Retrieve Invoice Document
Delete Invoice attachment
Delete the expense receipt
Update custom field in existing invoices
List invoice comments & history
Add comment
Update comment
Delete a comment
Generate payment link
recurring-invoices
Create a Recurring Invoice
List all Recurring Invoice
Update a recurring invoice using a custom field's unique value
Update Recurring Invoice
Get a Recurring Invoice
Delete a Recurring Invoice
Stop a Recurring Invoice
Resume a Recurring Invoice
Update Recurring Invoice template
List Recurring Invoice History
credit-notes
Create a credit note
List all Credit Notes
Update a credit note using a custom field's unique value
Update a credit note
Get a credit note
Delete a credit note
Email a credit note
Get email content
Void a Credit Note
Convert Credit Note to Draft.
Convert to Open
Submit a credit note for approval
Approve a credit note.
Email history
Update billing address
Update Shipping address
List credit note template
Update a credit note template
List invoices credited
Credit to an invoice
Delete invoices credited
List credit note comments & history
Add a comment
Delete a Comment
List credit note refunds
List refunds of a credit note
Refund credit note
Get credit note refund
Update credit note refund
Delete credit note refund
customer-payments
Create a payment
List Customer Payments
Bulk delete Customer payments
Update a payment using a custom field's unique value
Update a payment
Retrieve a payment
Delete a payment
List refunds of a customer payment
Refund an excess customer payment
Update custom field in existing customerpayments
Details of a refund
Update a refund
Delete a Refund
recurring-expenses
Create a recurring expense
List recurring expenses
Update an recurring expense using a custom field's unique value
Update a recurring expense
Get a recurring expense
Delete a recurring expense
Stop a recurring expense
Resume a recurring Expense
List child expenses created
List recurring expense history
expenses
Create an Expense
List Expenses
Update an expense using a custom field's unique value
Update an Expense
Get an Expense
Delete an Expense
List expense History & Comments
List employees
Create an employee
Get an employee
Delete an employee
Get an expense receipt
Add receipt to an expense.
Delete a receipt
Add attachment to an expense
retainer-invoices
Create a retainerinvoice
List a retainer invoices
update a retainerinvoice
Get a retainer invoice
Delete a retainer invoice
Mark a retainer invoice as sent
Update retainer invoice template
Void a retainer invoice
Mark as draft
Submit a retainer invoice for approval
Approve a retainer invoice.
Email a retainer invoice
Get retainer invoice email content
Update billing address
List retainer invoice templates
Get a retainer invoice attachment
Add attachment to a retainer invoice
Delete an attachment
List retainer invoice comments & history
Add comment
Delete a comment
Update comment
purchase-order
Create a purchase order
List purchase orders
Update a purchase order using a custom field's unique value
Update a purchase order
Get a purchase order
Delete purchase order
Update custom field in existing purchaseorders
Mark a purchase order as open
Mark as billed
Cancel a purchase order
Submit a purchase order for approval
Approve a purchase order
Email a purchase order
Get purchase order email content
Update billing address
List purchase order templates
Update purchase order template
Get a purchase order attachment
Add attachment to a purchase order
Update attachment preference
Delete an attachment
List purchase order comments & history
Add comment
Update comment
Delete a comment
Reject Purchase Order
bills
Create a bill
List bills
Update a bill using a custom field's unique value
Update a bill
Get a bill
Delete a bill
Update custom field in existing bills
Void a bill
Mark a bill as open
Submit a bill for approval
Approve a bill
Update billing address
List bill payments
Apply credits
Delete a payment
Get a bill attachment
Add attachment to a bill
Delete an attachment
List bill comments & history
Add comment
Delete a comment
Convert PO to Bill
recurring-bills
Create a recurring bill
List recurring bills
Update a recurring bill using a custom field's unique value
Update a recurring bill
Get a recurring bill
Delete a recurring bill
Stop a recurring bill
Resume a recurring Bill
List recurring bill history
vendor-credits
Create a vendor credit
List vendor credits
Update vendor credit
Get vendor credit
Delete vendor credit
Convert to open
Void vendor credit
Submit a Vendor credit for approval
Approve a Vendor credit
List bills credited
Apply credits to a bill
Delete bills credited
Refund a vendor credit
List refunds of a vendor credit
Update vendor credit refund
Get vendor credit refund
Delete vendor credit refund
List vendor credit refunds
Add a comment
List vendor credit comments & history
Delete a comment
vendor-payments
Create a vendor payment
List vendor payments
Update an vendor payment using a custom field's unique value
Bulk delete vendor payments
Update a vendor payment
Get a vendor payment
Delete a vendor payment
List refunds of a vendor payment
Refund an excess vendor payment
Details of a refund
Update a refund
Delete a refund
Email a vendor payment
Get vendor payment email content
custom-modules
Get Record List of a Custom Module
Bulk Update Custom Module
Create Custom Modules
Delete Custom Modules
Get Individual Record Details
Update Custom Module
Delete individual records
bank-accounts
Create a bank account
List view of accounts
Update bank account
Get account details
Delete an account
Deactivate account.
Activate account
Import a Bank/Credit Card Statement
Get last imported statement
Delete last imported statement
bank-transactions
Create a transaction for an account
Get transactions list
Update a transaction
Get transaction
Delete a transaction
Get matching transactions
Match a transaction
Unmatch a matched transaction
Exclude a transaction
Restore a transaction
Categorize an uncategorized transaction
Categorize as expense
Uncategorize a categorized transaction
Categorize a vendor payment
Categorize as customer payment
Categorize as credit note refunds
Categorize as vendor credit refunds
Categorize as Customer Payment refund
Categorize as Vendor Payment refund
bank-rules
Get Rules List
Create a rule
Get a rule
Update a rule
Delete a rule
chart-of-accounts
Create an account
List chart of accounts
Update an account
Get an account
Delete an account
Mark an account as active
Mark an account as inactive
List of transactions for an account
Delete a transaction
journals
Create a journal
Get journal list
Update a journal
Get journal
Delete a journal
Mark a journal as published
Add attachment to a journal
Add comment
Delete a comment
fixed-assets
Create a fixed asset
Get fixed asset list
Update a fixed asset
Get fixed asset
Delete a fixed asset
Get fixed asset history
Get fixed asset's forecast depreciation
Mark fixed asset as active
Cancel fixed asset
Mark fixed asset as draft
Write off fixed asset
Sell fixed asset
Add a comment
Delete a comment
Create a fixed asset type
Get fixed asset type list
Update a fixed asset type
Delete a fixed asset type
base-currency-adjustment
Create a base currency adjustment
List base currency adjustment
Get a base currency adjustment
Delete a base currency adjustment
List account details for base currency adjustment
projects
Create a project
List projects
Update a project using a custom field's unique value
Update project
Get a project
Delete project
Activate project
Inactivate a project
Clone project
Assign users
List Users
Invite user
Update user
Get a Project User
Delete user
Post comment
List comments
Delete comment
List invoices
tasks
Add a task
List tasks
Update a task
Get a task
Delete Task
time-entries
Log time entries
List time entries.
Delete time entries
Update time entry
Get a time entry
Delete time entry
Start timer
Stop timer
Get timer
users
Create a user
List Users
Update a user
Get an user details
Delete a user
Get current user
Invite a user
Mark user as active
Mark user as inactive
items
Create an Item
List items
Update an item using a custom field's unique value
Update an item
Get an item
Delete an item
Update custom field in existing items
Mark as active
Mark as inactive
locations
Enable Locations
Create a location
List all locations
Update location
Delete a location
Mark as Active
Mark as Inactive
Mark as Primary
currency
Create a Currency
List Currencies
Update a Currency
Get a Currency
Delete a currency
List exchange rates
Create an exchange rate
Get an exchange rate.
Update an exchange rate
Delete an exchage rate
taxes
Create a tax
List taxes
Update a tax
Get a tax
Delete a tax
Get a tax group
Update a tax group
Delete a tax group
Create a tax group
Create a tax authority [US and CA Edition only]
List tax authorities [US Edition only]
Update a tax authority [US and CA Edition only]
Get a tax authority [US and CA Edition only]
Delete a tax authority [US and CA Edition only]
Create a tax exemption [US Edition only]
List tax exemptions [US Edition only]
Update a tax exemption [US Edition only]
Get a tax exemption [US Edition only]
Delete a tax exemption [US Edition only]
opening-balance
Create opening balance
Update opening balance
Get opening balance
Delete opening balance
integration
Import a customer using the CRM account ID
Import a customer using CRM contact ID
Import a vendor using the CRM vendor ID
Import an item using the CRM product ID
Schemas
Schemas
gendoc-attributes-schema
organization-response
email
organization_id
is_logo_uploaded
name
contact_name
user_role
user_status
is_default_org
plan_type
tax_group_enabled
zi_migration_status
plan_name
plan_period
language_code
fiscal_year_start_month
account_created_date
account_created_date_formatted
time_zone
is_org_active
currency_id
currency_code
currency_symbol
currency_format
price_precision
portal_name
street_address1
street_address2
city
state
country
zip
date_format
field_separator
industry_type
industry_size
unverified_email
is_transaction_available
show_org_address_as_one_field
links
company_id_label
company_id_value
tax_id_label
tax_id_value
org_address
remit_to_address
phone
fax
website
index
value
label
companyid_label
companyid_value
taxid_label
taxid_value
projects
address
organizations
organization
custom_fields
create-an-organization-request
create-an-organization-response
list-organizations-response
update-an-organization-request
update-an-organization-response
get-an-organization-response
estimate-response
show_comment_to_clients
commented_by_id
comment_type
commented_by
item_id
line_item_id
rate
unit
quantity
description
date_description
is_primary_contact
contact_person_name
first_name
contact_person_email
last_name
salutation
contact_person_id
mobile
is_email_enabled
is_sms_enabled
is_whatsapp_enabled
communication_preference
contact_persons_associated
contact_persons_associated_payload
time
operation_type
transaction_id
transaction_type
last_modified_time
has_attachment
is_viewed_by_client
client_viewed_time
comment_id
template_type
file_name
from_emails
user_name
place_of_supply
gst_treatment
gst_no
product_type
hsn_or_sac
sat_item_key_code
unitkey_code
is_pre_gst
to_contacts
project_id
project_name
email_template_id
error_list
emailtemplates
selected
estimate_ids
body
subject
cc_mail_ids
to_mail_ids
mail_documents
send_from_org_email_id
attachments
ignore_auto_number_generation
custom_subject
custom_body
tax_id
tds_tax_id
tax_authority_id
tax_exemption_id
accept_retainer
retainer_percentage
avatax_use_code
avatax_exempt_no
vat_treatment
tax_treatment
is_reverse_charge_applied
tax_treatment_code
send
template_id
template_name
print
accept
notes
terms
custom_fields_update
show_on_pdf
billing_address
shipping_address
taxes
tax_amount
shipping_charge
adjustment
adjustment_description
sub_total
tax_total
exchange_rate
location_id
location_name
line_items
item_order
bcy_rate
discount_amount
is_discount_before_tax
discount_type
is_inclusive_tax
discount
tax_name
tax_type
tax_percentage
item_total
salesperson_id
salesperson_name
created_time
accepted_date
declined_date
expiry_date
estimates
page_context
page
per_page
has_more_page
sort_order
sort_column
estimate_id
estimate_number
reference_number
customer_name
total
customer_id
item_name
applied_filter
item_description
custom_field
report_name
status
date
filter_by
search_text
project
create-an-estimate-request
create-an-estimate-response
list-estimates-response
update-an-estimate-request
update-an-estimate-customfield-response
update-an-estimate-response
get-an-estimate-response
delete-an-estimate-response
mark-an-estimate-as-sent-response
mark-an-estimate-as-accepted-response
mark-an-estimate-as-declined-response
submit-an-estimate-for-approval-response
approve-an-estimate-response
email-an-estimate-request
email-an-estimate-response
get-estimate-email-content-response
email-multiple-estimates-response
bulk-export-estimates-response
bulk-print-estimates-response
update-billing-address-request
update-billing-address-response
update-shipping-address-request
update-shipping-address-response
list-estimate-template-response
update-estimate-template-response
list-estimate-comments-and-history-response
add-comments-request
add-comments-response
update-comment-request
update-comment-response
delete-a-comment-response
contact-response
contacts
creditnote_refunds
creditnote_refund_id
creditnote_id
refund_mode
creditnote_number
amount_bcy
amount_fcy
is_entity_deleted
credit_limit
tag_id
tag_option_id
is_tag_mandatory
tag_name
tag_option_name
tags
customer_sub_type
send_customer_statement
data
enable_portal
is_portal_enabled
department
designation
skype
track_1099
tax_id_type
invoice_template_id
estimate_template_id
creditnote_template_id
invoice_email_template_id
estimate_email_template_id
creditnote_email_template_id
contact_id
address_id
contact_type
payment_terms
payment_terms_label
facebook
twitter
invoice_template_name
estimate_template_name
creditnote_template_name
invoice_email_template_name
estimate_email_template_name
creditnote_email_template_name
has_transaction
is_linked_with_zohocrm
primary_contact_id
pricebook_id
contact_number
outstanding_receivable_amount
outstanding_receivable_amount_bcy
unused_credits_receivable_amount
unused_credits_receivable_amount_bcy
payment_reminder_enabled
owner_id
company_name
statement_template_id
payment_remittance_email_template_id
bill_template_id
is_taxable
tax_regime
legal_name
is_tds_registered
country_code
vat_reg_no
tax_reg_no
tax_exemption_certificate_number
purchaseorder_template_id
salesorder_template_id
retainerinvoice_template_id
paymentthankyou_template_id
retainerinvoice_paymentthankyou_template_id
purchaseorder_email_template_id
salesorder_email_template_id
retainerinvoice_email_template_id
paymentthankyou_email_template_id
retainerinvoice_paymentthankyou_email_template_id
place_of_contact
tax_authority_name
tax_exemption_code
end_date
start_date
multipart_or_formdata
opening_balance_amount
opening_balances
attention
street2
state_code
address_info
contact_persons
default_templates
contact_comments
create-a-contact-request
create-a-contact-response
list-contacts-response
update-a-contact-request
update-a-contact-response
get-contact-response
delete-a-contact-response
mark-as-active-response
mark-as-inactive-response
enable-portal-access-request
enable-portal-access-response
enable-payment-reminders-response
disable-payment-reminders-response
email-statement-request
email-statement-response
get-statement-mail-content-response
email-contact-request
email-contact-response
list-comments-response
get-contact-addresses-response
add-additional-address-request
add-additional-address-response
edit-additional-address-request
edit-additional-address-response
delete-additional-address-response
list-refunds-response
track-1099-response
untrack-1099-response
get-unused-retainer-payments-response
contact_person-response
is_added_in_portal
create-a-contact-person-request
create-a-contact-person-response
update-a-contact-person-request
update-a-contact-person-response
delete-a-contact-person-response
list-contact-persons-response
get-a-contact-person-response
mark-as-primary-contact-person-response
salesorder-response
salesorder_number
is_update_customer
shipment_date
avatax_use_code_desc
avatax_use_code_id
update-an-salesorder-customfield-response
avatax_tax_code
notes_default
terms_default
delivery_method
pricebook_name
is_invoiced
sku
stock_on_hand
customfield_id
item_custom_fields
salesorder_id
delivery_method_id
sub_statuses
is_emailed
is_one_off_address
attachment_name
can_send_in_mail
send_attachment
bcc_mail_ids
salesorder_ids
templates
preview
documents
zcrm_potential_id
zcrm_potential_name
discount_applied_on_amount
page_width
page_height
orientation
created_by_id
bcc_mails
bcc_mails_str
entity_id
cc_mails_list
organization_contact_id
is_org_email_id
file_name_without_extension
to_mails_str
cc_mails_str
from_email
from_address
emailtemplate_documents
entity_level
salesorder
salesorders
comment
comments
totalFiles
doc
billing_address_id
shipping_address_id
crm_owner_id
crm_custom_reference_id
shipment_days
bcy_total
is_avalara_sync_failed
tax_source
product_exemption_id
product_exemption_code
avatax_tax_code_id
avatax_tax_code_desc
item_total_inclusive_of_tax
image_id
image_name
image_type
from_address_id
invoice_id
toprint
is_verified
inline
document_ids
merchant_id
merchant_name
reason
customview_id
attachment
create-a-sales-order-request
create-a-sales-order-response
list-sales-orders-response
update-a-sales-order-request
update-a-sales-order-response
get-a-sales-order-response
delete-a-sales-order-response
mark-a-sales-order-as-open-response
mark-a-sales-order-as-void-request
mark-a-sales-order-as-void-response
email-a-sales-order-request
email-a-sales-order-response
get-sales-order-email-content-response
submit-a-sales-order-for-approval-response
approve-a-sales-order-response
bulk-export-sales-orders-response
bulk-print-sales-orders-response
list-sales-order-templates-response
update-sales-order-template-response
get-a-sales-order-attachment-response
add-attachment-to-a-sales-order-response
update-attachment-preference-response
delete-an-attachment-response
list-sales-order-comments-and-history-response
add-comment-request
add-comment-response
salesreceipt-response
create-a-sales-receipt-request
create-a-sales-receipt-response
update-a-sales-receipt-request
update-a-sales-receipt-response
list-sales-receipts-response
get-a-sales-receipt-response
delete-a-sales-receipt-response
email-a-sales-receipt-request
email-a-sales-receipt-response
invoice-response
cfdi_usage
cfdi_reference_type
reference_invoice_id
item_type
online_transaction_id
credits
creditnotes_invoice_id
creditnotes_number
credited_date
amount_applied
payments
payment_id
payment_number
invoice_payment_id
payment_mode
amount
is_single_invoice_payment
gateways_configured
deprecated_placeholders_used
invoice_ids
invoiced_estimate_id
salesorder_order_status
total_formatted
sub_total_formatted
invoice_url
gateways_associated
attach_pdf
reminders_sent
last_reminder_sent_date
payment_made
credits_applied
tax_amount_withheld
write_off_amount
account_id
allow_partial_payments
configured
additional_field1
time_entry_ids
expense_id
bill_id
bill_item_id
expense_receipt_name
salesorder_item_id
recurring_invoice_id
response_option
invoices
invoice_number
due_date
due_days
balance
payment_expected_date
last_payment_date
ach_payment_initiated
schedule_time
invoice_payments
apply_creditnotes
gateway_name
payment_gateways
payment_options
header_name
header_id
create-an-invoice-request
payment-link-response
create-an-instant-invoice-response
create-an-invoice-response
map-invoice-with-salesorder-response
list-invoices-response
map-invoice-with-salesorder-request
update-an-invoice-request
update-an-invoice-response
update-an-invoice-customfield-response
get-an-invoice-response
delete-an-invoice-response
mark-an-invoice-as-sent-response
void-an-invoice-response
mark-as-draft-response
email-an-invoice-request
email-an-invoice-response
email-invoices-request
email-invoices-response
submit-an-invoice-for-approval-response
approve-an-invoice-response
get-invoice-email-content-response
remind-customer-request
remind-customer-response
get-payment-reminder-mail-content-response
bulk-invoice-reminder-response
bulk-export-invoices-response
bulk-print-invoices-response
disable-payment-reminder-response
enable-payment-reminder-response
write-off-invoice-response
cancel-write-off-response
list-invoice-templates-response
update-invoice-template-response
list-invoice-payments-response
list-credits-applied-response
apply-credits-request
apply-credits-response
delete-a-payment-response
delete-applied-credit-response
get-an-invoice-attachment-response
add-attachment-to-an-invoice-response
delete-the-expense-receipt-response
list-invoice-comments-and-history-response
create-a-comment-request
update-a-comment-request
get-invoice-document-response
delete-invoice-document-response
recurring_invoice-response
recurrence_name
customer_email
customer_mobile_phone
customer_phone
paid_invoices_total
unpaid_invoices_balance
photo_url
last_sent_date
next_invoice_date
recurrence_frequency
repeat_every
type
account_name
price
comment_description
updated_time
data_type
recurring_invoice_items
create-a-recurring-invoice-request
create-a-recurring-invoice-response
list-all-recurring-invoice-response
update-recurring-invoice-request
update-recurring-invoice-response
get-a-recurring-invoice-response
delete-a-recurring-invoice-response
stop-a-recurring-invoice-request
stop-a-recurring-invoice-response
resume-a-recurring-invoice-request
resume-a-recurring-invoice-response
update-recurring-invoice-template-request
update-recurring-invoice-template-response
list-recurring-invoice-history-response
creditnote-response
serial_numbers
from_account_id
is_draft
payment_form
code
invoice_item_id
from
from_mail_id_alias
to_mail_ids_alias
cc_mail_ids_alias
subject_alias
body_alias
creditnote_invoice_id
credited_amount
mailhistory_id
template-id
create-a-credit-note-request
create-a-credit-note-response
list-all-credit-notes-response
update-a-credit-note-request
update-a-credit-note-response
get-a-credit-note-response
delete-a-credit-note-response
email-a-credit-note-request
email-a-credit-note-response
get-email-content-response
void-a-credit-note-response
convert-credit-note-to-draft-response
convert-to-open-response
submit-a-credit-note-for-approval-response
approve-a-credit-note-response
email-history-response
list-credit-note-template-response
update-a-credit-note-template-response
list-invoices-credited-response
credit-to-an-invoice-request
credit-to-an-invoice-response
delete-invoices-credited-response
list-credit-note-comments-and-history-response
add-a-comment-request
add-a-comment-response
list-credit-note-refunds-response
list-refunds-of-a-credit-note-response
refund-credit-note-request
refund-credit-note-response
get-credit-note-refund-response
update-credit-note-refund-request
update-credit-note-refund-response
delete-credit-note-refund-response
create-a-customer-debit-note-request
update-a-customer-debit-note-request
create-a-customer-debit-note-response
update-a-customer-debit-note-response
get-a-customer-debit-note-response
list-customer-debit-notes-response
delete-a-customer-debit-note-response
debit_note
reference_invoice_data
line_item
reference_invoice_type
reference_invoice_number
reference_invoice_status
reference_invoice_amount
debit_note_number
payment-response
amount_refunded
autotransaction
autotransaction_id
payment_gateway
gateway_transaction_id
gateway_error_message
card_id
last_four_digits
expiry_month
expiry_year
invoice_amount
balance_amount
bank_charges
update-an-customerpayment-customfield-response
payment_refund_id
bcy_amount
retainerinvoice_id
create-a-payment-request
create-a-payment-response
list-customer-payments-response
update-a-payment-request
update-a-payment-response
retrieve-a-payment-response
list-refunds-of-a-customer-payment-response
refund-an-excess-customer-payment-request
refund-an-excess-customer-payment-response
details-of-a-refund-response
update-a-refund-request
update-a-refund-response
delete-a-refund-response
bulk-delete-customer-payments-response
recurring_expense-response
recurring_expense_id
last_created_date
next_expense_date
source_of_supply
destination_of_supply
reverse_charge_tax_id
reverse_charge_tax_name
reverse_charge_tax_percentage
reverse_charge_tax_amount
destination_of_supply_state
acquisition_vat_total
reverse_charge_vat_total
paid_through_account_id
is_billable
acquisition_vat_id
reverse_charge_vat_id
expense_type
is_personal
vendor_name
paid_through_account_name
acquisition_vat_summary
reverse_charge_vat_summary
create-a-recurring-expense-request
create-a-recurring-expense-response
list-recurring-expenses-response
update-a-recurring-expense-request
update-a-recurring-expense-response
get-a-recurring-expense-response
delete-a-recurring-expense-response
stop-a-recurring-expense-response
resume-a-recurring-expense-response
list-child-expenses-created-response
list-recurring-expense-history-response
expense-response
is_itemized_expense
trip_id
trip_number
receipt
vendor_id
bcy_total_without_tax
total_without_tax
expense_receipt_type
expense_item_id
mileage_type
start_reading
end_reading
distance
mileage_unit
mileage_rate
employee_id
vehicle_type
can_reclaim_vat_on_mileage
fuel_type
engine_capacity_range
delete_receipt
tax
create-an-expense-request
create-an-expense-response
list-expenses-response
update-an-expense-request
update-an-expense-response
get-an-expense-response
delete-an-expense-response
list-expense-history-and-comments-response
list-employees-request
list-employees-response
create-an-employee-request
create-an-employee-response
get-an-employee-response
delete-an-employee-response
get-an-expense-receipt-response
add-receipt-to-an-expense-response
delete-a-receipt-response
add-attachment-to-an-expense-request
add-attachment-to-an-expense-response
retainerinvoice-response
retainerinvoice_number
project_or_estimate_name
payment_drawn
is_client_review_settings_enabled
unused_amount
retainerinvoice_total
retainerinvoice_balance
retainerinvoice_date
payment_refunds
html_string
is_payment_drawn_details_required
create-a-retainerinvoice-request
create-a-retainerinvoice-response
list-a-retainer-invoices-response
update-a-retainerinvoice-request
update-a-retainerinvoice-response
get-a-retainer-invoice-response
delete-a-retainer-invoice-response
mark-a-retainer-invoice-as-sent-response
update-retainer-invoice-template-response
void-a-retainer-invoice-response
submit-a-retainer-invoice-for-approval-response
approve-a-retainer-invoice-response
email-a-retainer-invoice-request
email-a-retainer-invoice-response
get-retainer-invoice-email-content-request
get-retainer-invoice-email-content-response
list-retainer-invoice-templates-response
list-retainer-payments-response
delete-a-retainer-payment-response
get-a-retainer-invoice-attachment-request
get-a-retainer-invoice-attachment-response
add-attachment-to-a-retainer-invoice-request
add-attachment-to-a-retainer-invoice-response
list-retainer-invoice-comments-and-history-response
purchaseorder_number
discount_account_id
ship_via
acquisition_vat_name
acquisition_vat_percentage
acquisition_vat_amount
reverse_charge_vat_name
reverse_charge_vat_percentage
reverse_charge_vat_amount
delivery_date
delivery_org_address_id
delivery_customer_id
document_id
organization_address_id
is_verifiable
address1
address2
is_valid
is_primary
purchaseorder_id
expected_delivery_date
ship_via_id
can_mark_as_bill
can_mark_as_unbill
update-an-purchaseorder-customfield-response
delivery_address
purchaseorder
create-a-purchase-order-request
create-a-purchase-order-response
list-purchase-orders-response
update-a-purchase-order-request
update-a-purchase-order-response
get-a-purchase-order-response
delete-purchase-order-response
mark-a-purchase-order-as-open-response
mark-as-billed-response
cancel-a-purchase-order-response
submit-a-purchase-order-for-approval-response
approve-a-purchase-order-response
email-a-purchase-order-request
email-a-purchase-order-response
get-purchase-order-email-content-response
list-purchase-order-templates-response
update-purchase-order-template-response
get-a-purchase-order-attachment-response
add-attachment-to-a-purchase-order-response
list-purchase-order-comments-and-history-response
reject_purchase_order
bill_number
permit_number
image_document_id
is_tds_applied
filed_in_vat_return_id
filed_in_vat_return_name
filed_in_vat_return_type
is_abn_quoted
abn
custom_field_id
update-an-bill-customfield-response
purchaseorder_ids
unused_credits_payable_amount
recurring_bill_id
due_by_days
due_in_days
is_item_level_tax_calc
vendor_credits_applied
is_line_item_invoiced
purchaseorders
vendor_credit_id
vendor_credit_bill_id
vendor_credit_number
vendor_credits
reference_id
open_purchaseorders_count
purchaseorder_item_id
bill_payment_id
is_single_bill_payment
paid_through
purchaseorder_date
purchaseorder_status
is_paid_via_print_check
check_number
check_status
check_details
is_ach_payment
ach_payment_status
ach_gw_transaction_id
bill
bill_payments
apply_vendor_credits
approver_id
order
approvers
create-a-bill-request
create-a-bill-response
list-bills-response
update-a-bill-request
update-a-bill-response
get-a-bill-response
delete-a-bill-response
void-a-bill-response
mark-a-bill-as-open-response
submit-a-bill-for-approval-response
approve-a-bill-response
list-bill-payments-response
get-a-bill-attachment-response
add-attachment-to-a-bill-response
convert-po-to-bill-response
list-bill-comments-and-history-response
recurring_bill
create-a-recurring-bill-request
create-a-recurring-bill-response
list-recurring-bills-response
update-a-recurring-bill-request
update-a-recurring-bill-response
get-a-recurring-bill-response
delete-a-recurring-bill-response
stop-a-recurring-bill-response
resume-a-recurring-bill-response
list-recurring-bill-history-response
vendor_credit-response
bills
apply_to_bills
total_credits_used
total_refunded_amount
bills_credited
vendor_credit_refund_id
imported_transaction_id
payee
imported_transactions
vendor_credit_refunds
vendor_credit_refund
vendor_credit
create-a-vendor-credit-request
create-a-vendor-credit-response
list-vendor-credits-response
update-vendor-credit-request
update-vendor-credit-response
get-vendor-credit-response
delete-vendor-credit-response
void-vendor-credit-response
submit-a-vendor-credit-for-approval-response
approve-a-vendor-credit-response
list-bills-credited-response
apply-credits-to-a-bill-request
apply-credits-to-a-bill-response
delete-bills-credited-response
refund-a-vendor-credit-request
refund-a-vendor-credit-response
list-refunds-of-a-vendor-credit-response
update-vendor-credit-refund-request
update-vendor-credit-refund-response
get-vendor-credit-refund-response
delete-vendor-credit-refund-response
list-vendor-credit-refunds-response
list-vendor-credit-comments-and-history-response
vendorpayment_refund_id
vendorpayment_id
vendorpayment_number
to_account_id
tax_account_name
paid_through_account_type
check_id
memo
amount_in_words
bcy_balance
vendorpayment_refunds
to_account_name
bill_numbers
vendorpayment
vendorpayments
vendorpayment_refund
fetchTaxInfo
fetchstatementlineinfo
is_bill_payment_id
create-a-vendor-payment-request
create-a-vendor-payment-response
list-vendor-payments-response
update-a-vendor-payment-request
update-a-vendor-payment-response
get-a-vendor-payment-response
delete-a-vendor-payment-response
list-refunds-of-a-vendor-payment-response
refund-an-excess-vendor-payment-request
refund-an-excess-vendor-payment-response
bulk-delete-vendor-payments-response
email-a-vendor-payment-request
email-a-vendor-payment-response
get-vendor-payment-email-content-response
module_record-response
record_name
shared_to
record_id
module_api_name
last_modified_by_id
last_modified_time_formatted
created_time_formatted
record_name_formatted
date_formatted
shared_type
can_submit
approvers_list
can_approve
module_name
module_record_id
module_record_ids
field_id
is_active
is_mandatory
api_name
data_type_formatted
value_formatted
pii_type
max_length
help_text
module_plural_name
cf_debt_amount
cf_debt_amount_formatted
id
text
is_current_user
module_record_hash
module_fields
module_record
module_record_module_put
module_record_get
users
get-record-list-of-a-custom-module-response
bulk-update-custom-module-request
bulk-update-custom-module-response
create-custom-modules-request
create-custom-modules-response
delete-custom-modules-response
get-individual-record-details-response
update-custom-module-request
update-custom-module-response
delete-individual-records-response
as_of_date
account_code
account_type
uncategorized_transactions
total_unprinted_checks
bank_name
bank_balance
account_number
routing_number
is_primary_account
is_paypal_account
paypal_type
paypal_email_address
statement_id
from_date
to_date
source
debit_or_credit
bankaccounts
is_feeds_subscribed
is_feeds_active
refresh_status_code
feeds_last_refresh_date
service_id
is_system_account
is_show_warning_for_feeds_refresh
bankaccount
transactions
statement
create-a-bank-account-request
create-a-bank-account-response
list-view-of-accounts-response
update-bank-account-request
update-bank-account-response
get-account-details-response
delete-an-account-response
deactivate-account-response
activate-account-response
import-a-bankcredit-card-statement-request
import-a-bankcredit-card-statement-response
get-last-imported-statement-response
delete-last-imported-statement-response
offset_account_name
is_offsetaccount_matched
is_rule_exist
rule_details
from_account_name
from_account_tags
to_account_tags
contact
transaction_number
is_best_match
matching_documents
file_type
file_size
file_size_formatted
entity_number
relevance
scanned_amount
scanned_receipt_date
transactions_to_be_matched
banktransaction
transaction_status
user_id
date_after
date_before
amount_start
amount_end
show_all_transactions
line_id
vehicle_id
zp_project_id
zp_project_name
zp_client_id
create-a-transaction-for-an-account-request
create-a-transaction-for-an-account-response
get-transactions-list-response
update-a-transaction-request
update-a-transaction-response
get-transaction-response
delete-a-transaction-response
get-matching-transactions-response
match-a-transaction-request
match-a-transaction-response
unmatch-a-matched-transaction-response
exclude-a-transaction-response
restore-a-transaction-response
categorize-an-uncategorized-transaction-request
categorize-an-uncategorized-transaction-response
categorize-as-expense-request
categorize-as-expense-response
uncategorize-a-categorized-transaction-response
categorize-a-vendor-payment-request
categorize-a-vendor-payment-response
categorize-as-customer-payment-request
categorize-as-customer-payment-response
categorize-as-credit-note-refunds-request
categorize-as-credit-note-refunds-response
categorize-as-vendor-credit-refunds-request
categorize-as-vendor-credit-refunds-response
categorize-as-customer-payment-refund-request
categorize-as-customer-payment-refund-response
categorize-as-vendor-payment-refund-request
categorize-as-vendor-payment-refund-response
rules-response
rule_id
rule_name
rule_order
apply_to
criteria_type
record_as
criteria_id
field
comparator
criterion
rule
target_account_id
get-rules-list-response
create-a-rule-request
create-a-rule-response
get-a-rule-response
update-a-rule-request
update-a-rule-response
delete-a-rule-response
can_show_in_ze
parent_account_id
bank_account_number
include_in_vat_return
show_on_dashboard
showbalance
is_user_created
is_standalone_account
is_involved_in_transaction
parent_account_name
depth
is_child_present
child_count
categorized_transaction_id
transaction_date
entry_number
reconcile_status
debit_amount
closing_balance
credit_amount
chart_of_account
current_balance
transaction_source
create-an-account-request
create-an-account-response
list-chart-of-accounts-response
update-an-account-request
update-an-account-response
get-an-account-response
mark-an-account-as-active-response
mark-an-account-as-inactive-response
list-of-transactions-for-an-account-response
journal_date
tax_account
journal_id
line_item_total
journal_type
tax_exemption_type
is_bas_adjustment
entity_type
journal
create-a-journal-request
create-a-journal-response
get-journal-list-response
update-a-journal-request
update-a-journal-response
get-journal-response
delete-a-journal-response
mark-a-journal-as-published-response
add-attachment-to-a-journal-response
asset_name
fixed_asset_type_id
asset_account_id
expense_account_id
depreciation_account_id
depreciation_method
depreciation_frequency
depreciation_percentage
total_life
salvage_value
depreciation_start_date
asset_cost
computation_type
warranty_expiry_date
asset_purchase_date
serial_no
dep_start_value
fixed_asset_id
asset_number
asset_number_prefix
asset_number_suffix
fixed_asset_type_name
current_asset_value
accumulated_dep_value
last_depreciation_date
asset_account_name
expense_account_name
depreciation_account_name
associated_transactions
valuation_id
valuation_date
depreciated_value
current_value
accumulated_value
is_journal_posted
fixed_asset
asset_history
asset_forcast
fixed_asset_type_param
fixed_asset_type
create-a-fixed-asset-request
create-a-fixed-asset-response
get-fixed-asset-list-response
update-a-fixed-asset-request
update-a-fixed-asset-response
get-fixed-asset-response
delete-a-fixed-asset-response
get-fixed-asset-history-response
get-fixed-asset-forecast-response
update-fixed-asset-status
write-off-fixed-asset-request
write-off-fixed-asset-response
sell-fixed-asset-request
sell-fixed-asset-response
delete-comment-response
create-a-fixed-asset-type-request
create-a-fixed-asset-type-response
get-fixed-asset-type-list-response
update-a-fixed-asset-type-request
update-a-fixed-asset-type-response
delete-a-fixed-asset-type-response
adjustment_date
account_ids
base_currency_adjustment_id
fcy_balance
adjusted_balance
gain_or_loss
gl_specific_type
accounts
create-a-base-currency-adjustment-request
create-a-base-currency-adjustment-response
list-base-currency-adjustment-response
get-a-base-currency-adjustment-response
delete-a-base-currency-adjustment-response
list-account-details-for-base-currency-adjustment-response
project-response
billing_type
budget_type
total_hours
billable_hours
non_billable_hours
billed_hours
un_billed_hours
cost_rate
task_id
task_name
budget_hours
budget_amount
cost_budget_amount
tasks
total_amount
billed_amount
un_billed_amount
billable_amount
non_billable_amount
is_recurrence_associated
recurring_invoices
show_in_dashboard
task_custom_fields
create-a-project-request
create-a-project-response
list-projects-response
update-project-request
update-project-response
get-a-project-response
delete-project-response
activate-project-response
inactivate-a-project-response
clone-project-request
clone-project-response
assign-users-request
assign-users-response
list-users-response
invite-user-request
invite-user-response
update-user-request
update-user-response
get-a-user-response
delete-user-response
post-comment-request
post-comment-response
task-response
log_time
add-a-task-request
add-a-task-response
list-tasks-request
list-tasks-response
update-a-task-request
update-a-task-response
get-a-task-request
get-a-task-response
delete-task-request
delete-task-response
time_entry-response
time_entry_id
log_date
begin_time
end_time
billed_status
start_timer
timer_started_at
timer_duration_in_minutes
cost_amount
timer_started_at_utc_time
timer_duration_in_seconds
timesheet_custom_fields
log-time-entries-request
log-time-entries-response
list-time-entries-response
delete-time-entries-request
delete-time-entries-response
update-time-entry-request
update-time-entry-response
get-a-time-entry-response
delete-time-entry-response
start-timer-response
stop-timer-response
get-timer-response
role_id
is_selected
email_ids
is_customer_segmented
is_vendor_segmented
user_type
is_employee
create-a-user-request
create-a-user-response
update-a-user-request
update-a-user-response
delete-a-user-response
get-current-user-response
invite-a-user-response
mark-user-as-active-response
mark-user-as-inactive-response
item-response
purchase_tax_rule_id
sales_tax_rule_id
tax_precentage
purchase_tax_exemption_id
purchase_description
purchase_rate
purchase_account_id
inventory_account_id
reorder_level
initial_stock
initial_stock_rate
tax_specification
item_tax_preferences
location_stock_on_hand
location_available_stock
location_actual_available_stock
locations
create-an-item-request
create-an-item-response
list-items-response
update-an-item-request
update-an-item-customfield-response
update-an-item-response
get-an-item-response
delete-an-item-response
parent_location_id
tax_settings_id
autonumbergenerationgroup_id
associated_series_ids
user_ids
is_all_users_selected
enable-location-response
create-a-location-request
create-a-location-response
list-all-location-response
update-location-request
update-location-response
delete-a-location-response
mark-as-primary-response
currency_name
is_base_currency
exchange_rate_id
effective_date
is_current_date
currency
create-a-currency-request
create-a-currency-response
list-currencies-response
update-a-currency-request
update-a-currency-response
get-a-currency-response
delete-a-currency-response
list-exchange-rates-response
create-an-exchange-rate-request
create-an-exchange-rate-response
get-an-exchange-rate-response
update-an-exchange-rate-request
update-an-exchange-rate-response
delete-an-exchage-rate-response
tax-response
purchase_tax_expense_account_id
tax_factor
tax_account_id
output_tax_account_name
purchase_tax_account_name
purchase_tax_account_id
tds_payable_account_id
tax_account_tracking
tax_group_id
tax_group_name
tax_group_percentage
is_value_added
tax_specific_type
is_default_tax
registration_number
registration_number_label
tax_authority
is_editable
update_recurring_invoice
update_recurring_expense
update_draft_invoice
update_recurring_bills
update_draft_so
update_subscription
update_project
create-a-tax-request
create-a-tax-response
list-taxes-response
update-a-tax-request
update-a-tax-response
get-a-tax-response
delete-a-tax-response
get-a-tax-group-response
update-a-tax-group-request
update-a-tax-group-response
delete-a-tax-group-response
create-a-tax-group-request
create-a-tax-group-response
create-a-tax-authority-us-and-ca-edition-only-request
create-a-tax-authority-us-and-ca-edition-only-response
list-tax-authorities-us-edition-only-response
update-a-tax-authority-us-and-ca-edition-only-request
update-a-tax-authority-us-and-ca-edition-only-response
get-a-tax-authority-us-and-ca-edition-only-response
delete-a-tax-authority-us-and-ca-edition-only-response
create-a-tax-exemption-us-edition-only-request
create-a-tax-exemption-us-edition-only-response
list-tax-exemptions-us-edition-only-response
update-a-tax-exemption-us-edition-only-request
update-a-tax-exemption-us-edition-only-response
get-a-tax-exemption-us-edition-only-response
delete-a-tax-exemption-us-edition-only-response
opening_balance_id
acount_split_id
opening_balance
create-opening-balance-request
create-opening-balance-response
update-opening-balance-request
update-opening-balance-response
get-opening-balance-response
delete-opening-balance-response
product_data
import-a-customer-using-the-crm-account-id-response
import-a-customer-using-crm-contact-id-response
import-a-vendor-using-the-crm-vendor-id-response
import-an-item-using-the-crm-product-id-response
Schemas
Copy Page
journal_type
Type of the Journal. Allowed values:
Cash
and
Both
.
"both"