Zoho Invoice Basic (независимый издатель) (предварительная версия)
Настройте и создайте профессиональные счета и получите оплату за трудную работу. Zoho Invoice — это программное обеспечение для управления счетами в Интернете для малого бизнеса, которое легко использовать и полностью бесплатно, навсегда.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Трой Тейлор |
| URL | https://www.troystaylor.com |
| Адрес электронной почты | troy@troystaylor.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Трой Тейлор |
| Веб-сайт | https://www.zoho.com/us/invoice/ |
| Политика конфиденциальности | https://www.zoho.com/privacy.html |
| Категории | Финансировать; Продажи и CRM |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Идентификатор организации Zoho | струна | Идентификатор организации Zoho для этого API | True |
| Идентификатор клиента | струна | Идентификатор клиента для этого API | True |
| Секрет клиента | securestring | Секрет клиента для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Обновление контакта |
Обновляет существующий контакт. |
| Обновление счета |
Обновите существующий счет. Чтобы удалить элемент строки, просто удалите его из списка line_items. |
| Получение контакта |
Получение сведений о существующем контакте. |
| Получение контактов |
Получение списка всех контактов с разбивкой на страницы. |
| Получение счета |
Получение сведений о счете |
| Получение счетов |
Получение списка счетов с разбивкой на страницы. |
| Создание контакта |
Создает новый контакт. |
| Создать счет |
Создает счет для клиента. |
| Удаление контакта |
Удаляет существующий контакт. |
| Удаление счета |
Удаляет существующий счет. Счета, которые имеют платежную или кредитную заметку, не могут быть удалены. |
Обновление контакта
Обновляет существующий контакт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contact_id | True | string |
Идентификатор контакта. |
|
Имя контактного лица
|
contact_name | True | string |
Имя контакта. |
|
Название компании
|
company_name | string |
Название компании. |
|
|
Условия оплаты
|
payment_terms | integer |
Условия оплаты. |
|
|
Идентификатор валюты
|
currency_id | string |
Идентификатор валюты. |
|
|
Веб-сайт
|
website | string |
Веб-сайт. |
|
|
Ценность
|
value | string |
Значение настраиваемого поля. |
|
|
Index
|
index | integer |
Номер индекса. |
|
|
Этикетка
|
label | string |
Метка. |
|
|
Внимание
|
attention | string |
Имя внимания. |
|
|
Address
|
address | string |
Адрес. |
|
|
Адрес 2
|
street2 | string |
Адрес 2. |
|
|
Государство
|
state_code | string |
Сокращение состояния. |
|
|
Город
|
city | string |
Город. |
|
|
Государство
|
state | string |
Государство. |
|
|
Zip-архив
|
zip | string |
Почтовый индекс. |
|
|
Страна
|
country | string |
Страна. |
|
|
Факс
|
fax | string |
Номер факса. |
|
|
Телефон
|
phone | string |
Номер телефона. |
|
|
Внимание
|
attention | string |
Имя внимания. |
|
|
Address
|
address | string |
Адрес. |
|
|
Адрес 2
|
street2 | string |
Адрес 2. |
|
|
Государство
|
state_code | string |
Сокращение состояния. |
|
|
Город
|
city | string |
Город. |
|
|
Государство
|
state | string |
Государство. |
|
|
Zip-архив
|
zip | string |
Почтовый индекс. |
|
|
Страна
|
country | string |
Страна. |
|
|
Факс
|
fax | string |
Номер факса. |
|
|
Телефон
|
phone | string |
Номер телефона. |
|
|
Приветствие
|
salutation | string |
Приветствие. |
|
|
Имя (Первое имя)
|
first_name | string |
Первое имя. |
|
|
Фамилия
|
last_name | string |
Фамилия. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Телефон
|
phone | string |
Номер телефона. |
|
|
мобильное устройство
|
mobile | string |
Номер мобильного телефона. |
|
|
Основной контакт
|
is_primary_contact | boolean |
Является ли основным контактом. |
|
|
Идентификатор шаблона счета
|
invoice_template_id | string |
Идентификатор шаблона счета. |
|
|
Имя шаблона счета
|
invoice_template_name | string |
Имя шаблона счета. |
|
|
Оценка идентификатора шаблона
|
estimate_template_id | string |
Идентификатор шаблона оценки. |
|
|
Оценка имени шаблона
|
estimate_template_name | string |
Имя шаблона оценки. |
|
|
Идентификатор шаблона кредитных заметок
|
creditnote_template_id | string |
Идентификатор шаблона кредитной заметки. |
|
|
Имя шаблона кредитных заметок
|
creditnote_template_name | string |
Имя шаблона кредитной заметки. |
|
|
Идентификатор шаблона электронной почты счета
|
invoice_email_template_id | string |
Идентификатор шаблона электронной почты счета. |
|
|
Имя шаблона электронной почты счета
|
invoice_email_template_name | string |
Имя шаблона электронной почты счета. |
|
|
Оценка идентификатора шаблона электронной почты
|
estimate_email_template_id | string |
Оценка идентификатора шаблона электронной почты. |
|
|
Оценка имени шаблона электронной почты
|
estimate_email_template_name | string |
Имя шаблона электронной почты оценки. |
|
|
Идентификатор шаблона электронной почты с кредитными заметками
|
creditnote_email_template_id | string |
Идентификатор шаблона электронной почты для кредитной заметки. |
|
|
Имя шаблона электронной почты с кредитными заметками
|
creditnote_email_template_name | string |
Имя шаблона электронной почты с кредитными заметками. |
|
|
Код языка
|
language_code | string |
Код языка. |
|
|
Примечания.
|
notes | string |
Заметки. |
|
|
Регистрация НДС
|
vat_reg_no | string |
Номер регистрации НДС. |
|
|
Регистрация налогов
|
tax_reg_no | string |
Номер налоговой регистрации. |
|
|
Код страны
|
country_code | string |
Код страны. |
|
|
Обработка НДС
|
vat_treatment | string |
Тип обработки НДС. |
|
|
Налоговое лечение
|
tax_treatment | string |
Тип налогового лечения. |
|
|
Налоговый режим
|
tax_regime | string |
Налоговый режим. |
|
|
Юридическое имя
|
legal_name | string |
Юридическое имя. |
|
|
Зарегистрированы TDS
|
is_tds_registered | boolean |
Зарегистрировано ли TDS. |
|
|
Место контакта
|
place_of_contact | string |
Место контакта. |
|
|
GST-номер
|
gst_no | string |
Номер GST. |
|
|
Обработка GST
|
gst_treatment | string |
Тип лечения GST. |
|
|
Название налогового органа
|
tax_authority_name | string |
Имя налогового органа. |
|
|
Кодекс об освобождении от налогов
|
tax_exemption_code | string |
Кодекс об освобождении от налогов. |
|
|
Исключение AvaTax
|
avatax_exempt_no | string |
Номер исключения AvaTax. |
|
|
Код использования AvaTax
|
avatax_use_code | string |
Код AvaTax используется. |
|
|
Идентификатор освобождения от налогов
|
tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
|
Идентификатор налогового органа
|
tax_authority_id | string |
Идентификатор налогового органа. |
|
|
Идентификатор налогоплательщика
|
tax_id | string |
Идентификатор налога. |
|
|
Идентификатор налога TDS
|
tds_tax_id | string |
Идентификатор налога TDS. |
|
|
Является налогооблагаемым
|
is_taxable | boolean |
Является ли налогооблагаемым. |
|
|
Фейсбук
|
string |
Имя пользователя Facebook. |
||
|
Твиттер
|
string |
Дескриптор Twitter. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
Код контактного лица
|
contact.contact_id | string |
Идентификатор контакта. |
|
Имя контактного лица
|
contact.contact_name | string |
Имя контакта. |
|
Название компании
|
contact.company_name | string |
Название компании. |
|
Имеет транзакцию
|
contact.has_transaction | boolean |
Имеет ли транзакцию. |
|
Тип контакта
|
contact.contact_type | string |
Тип контакта. |
|
Является налогооблагаемым
|
contact.is_taxable | boolean |
Является ли налогооблагаемым. |
|
Идентификатор налогоплательщика
|
contact.tax_id | string |
Идентификатор налога. |
|
Идентификатор налога TDS
|
contact.tds_tax_id | string |
Идентификатор налога TDS. |
|
Имя налога
|
contact.tax_name | string |
Имя налога. |
|
Процент налогов
|
contact.tax_percentage | integer |
Процент налога. |
|
Идентификатор налогового органа
|
contact.tax_authority_id | string |
Идентификатор налогового органа. |
|
Идентификатор освобождения от налогов
|
contact.tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
Название налогового органа
|
contact.tax_authority_name | string |
Имя налогового органа. |
|
Кодекс об освобождении от налогов
|
contact.tax_exemption_code | string |
Кодекс об освобождении от налогов. |
|
Место контакта
|
contact.place_of_contact | string |
Место контакта. |
|
GST-номер
|
contact.gst_no | string |
Номер GST. |
|
Обработка НДС
|
contact.vat_treatment | string |
Обработка НДС. |
|
Налоговое лечение
|
contact.tax_treatment | string |
Налоговое лечение. |
|
Налоговый режим
|
contact.tax_regime | string |
Налоговый режим. |
|
Юридическое имя
|
contact.legal_name | string |
Юридическое имя. |
|
Зарегистрированы TDS
|
contact.is_tds_registered | boolean |
Зарегистрирован ли TSD. |
|
Обработка GST
|
contact.gst_treatment | string |
Лечение GST. |
|
Связан с Zoho CRM
|
contact.is_linked_with_zohocrm | boolean |
Связана ли с Zoho CRM. |
|
Веб-сайт
|
contact.website | string |
Веб-сайт. |
|
Первичный идентификатор контакта
|
contact.primary_contact_id | string |
Основной идентификатор контакта. |
|
Условия оплаты
|
contact.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
contact.payment_terms_label | string |
Метка условий оплаты. |
|
Идентификатор валюты
|
contact.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
contact.currency_code | string |
Код валюты. |
|
Обозначение денежной единицы
|
contact.currency_symbol | string |
Символ валюты. |
|
Код языка
|
contact.language_code | string |
Код языка. |
|
Сумма непогашенной задолженности
|
contact.outstanding_receivable_amount | double |
Сумма непогашенной задолженности. |
|
Сумма невыплаченной задолженности BCY
|
contact.outstanding_receivable_amount_bcy | double |
Сумма задолженности ПО BCY. |
|
Неиспользуемая сумма задолженности
|
contact.unused_credits_receivable_amount | double |
Сумма неиспользуемой задолженности. |
|
Неиспользуемая сумма задолженности на сумму BCY
|
contact.unused_credits_receivable_amount_bcy | double |
Сумма задолженности неиспользуемых кредитов BCY. |
|
Состояние
|
contact.status | string |
Состояние. |
|
Включено напоминание о платеже
|
contact.payment_reminder_enabled | boolean |
Включена ли напоминание о платеже. |
|
Настраиваемое поле
|
contact.custom_fields | array of object | |
|
Ценность
|
contact.custom_fields.value | string |
Значение настраиваемого поля. |
|
Index
|
contact.custom_fields.index | integer |
Номер индекса. |
|
Этикетка
|
contact.custom_fields.label | string |
Метка. |
|
Внимание
|
contact.billing_address.attention | string |
Имя внимания. |
|
Address
|
contact.billing_address.address | string |
Адрес. |
|
Улица
|
contact.billing_address.street2 | string |
Адрес улицы. |
|
Код региона
|
contact.billing_address.state_code | string |
Код состояния. |
|
Город
|
contact.billing_address.city | string |
Город. |
|
Государство
|
contact.billing_address.state | string |
Государство. |
|
Zip-архив
|
contact.billing_address.zip | string |
Почтовый индекс. |
|
Страна
|
contact.billing_address.country | string |
Страна. |
|
Факс
|
contact.billing_address.fax | string |
Номер факса. |
|
Телефон
|
contact.billing_address.phone | string |
Номер телефона. |
|
Внимание
|
contact.shipping_address.attention | string |
Имя внимания. |
|
Address
|
contact.shipping_address.address | string |
Адрес. |
|
Улица
|
contact.shipping_address.street2 | string |
Адрес улицы. |
|
Код региона
|
contact.shipping_address.state_code | string |
Код состояния. |
|
Город
|
contact.shipping_address.city | string |
Город. |
|
Государство
|
contact.shipping_address.state | string |
Государство. |
|
Zip-архив
|
contact.shipping_address.zip | string |
Почтовый индекс. |
|
Страна
|
contact.shipping_address.country | string |
Страна. |
|
Факс
|
contact.shipping_address.fax | string |
Номер факса. |
|
Телефон
|
contact.shipping_address.phone | string |
Номер телефона. |
|
Фейсбук
|
contact.facebook | string |
Учетная запись Facebook. |
|
Твиттер
|
contact.twitter | string |
Дескриптор Twitter. |
|
Контактные лица
|
contact.contact_persons | array of object | |
|
Приветствие
|
contact.contact_persons.salutation | string |
Приветствие. |
|
Имя (Первое имя)
|
contact.contact_persons.first_name | string |
Первое имя. |
|
Фамилия
|
contact.contact_persons.last_name | string |
Фамилия. |
|
Адрес электронной почты
|
contact.contact_persons.email | string |
Адрес электронной почты. |
|
Телефон
|
contact.contact_persons.phone | string |
Номер телефона. |
|
мобильное устройство
|
contact.contact_persons.mobile | string |
Номер мобильного телефона. |
|
Основной контакт
|
contact.contact_persons.is_primary_contact | boolean |
Является ли основным контактом. |
|
Идентификатор шаблона счета
|
contact.default_templates.invoice_template_id | string |
Идентификатор шаблона счета. |
|
Имя шаблона счета
|
contact.default_templates.invoice_template_name | string |
Имя шаблона счета. |
|
Оценка идентификатора шаблона
|
contact.default_templates.estimate_template_id | string |
Идентификатор шаблона оценки. |
|
Оценка имени шаблона
|
contact.default_templates.estimate_template_name | string |
Имя шаблона оценки. |
|
Идентификатор шаблона кредитных заметок
|
contact.default_templates.creditnote_template_id | string |
Идентификатор шаблона кредитной заметки. |
|
Имя шаблона кредитных заметок
|
contact.default_templates.creditnote_template_name | string |
Имя шаблона кредитной заметки. |
|
Идентификатор шаблона электронной почты счета
|
contact.default_templates.invoice_email_template_id | string |
Идентификатор шаблона электронной почты счета. |
|
Имя шаблона электронной почты счета
|
contact.default_templates.invoice_email_template_name | string |
Имя шаблона электронной почты счета. |
|
Оценка идентификатора шаблона электронной почты
|
contact.default_templates.estimate_email_template_id | string |
Оценка идентификатора шаблона электронной почты. |
|
Оценка имени шаблона электронной почты
|
contact.default_templates.estimate_email_template_name | string |
Имя шаблона электронной почты оценки. |
|
Идентификатор шаблона электронной почты с кредитными заметками
|
contact.default_templates.creditnote_email_template_id | string |
Идентификатор шаблона электронной почты для кредитной заметки. |
|
Имя шаблона электронной почты с кредитными заметками
|
contact.default_templates.creditnote_email_template_name | string |
Имя шаблона электронной почты с кредитными заметками. |
|
Примечания.
|
contact.notes | string |
Заметки. |
|
Время создания
|
contact.created_time | string |
Время создания. |
|
время последнего изменения;
|
contact.last_modified_time | string |
Время последнего изменения. |
Обновление счета
Обновите существующий счет. Чтобы удалить элемент строки, просто удалите его из списка line_items.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор счета
|
invoice_id | True | string |
Идентификатор счета. |
|
Идентификатор клиента
|
customer_id | string |
Идентификатор клиента. |
|
|
Контактное лицо
|
contact_persons | array of integer |
Контактный человек. |
|
|
Номер счета
|
invoice_number | string |
Номер счета. |
|
|
Ссылочный номер
|
reference_number | string |
Номер ссылки. |
|
|
Место поставки
|
place_of_supply | string |
Место поставки. |
|
|
Обработка ндс
|
vat_treatment | string |
Обработка НДС. |
|
|
Обработка GST
|
gst_treatment | string |
Лечение GST. |
|
|
Налоговое лечение
|
tax_treatment | string |
Налоговое лечение. |
|
|
Использование CFI
|
cfdi_usage | string |
Использование CFI. |
|
|
GST-номер
|
gst_no | string |
Номер GST. |
|
|
ИД шаблона
|
template_id | string |
Идентификатор шаблона. |
|
|
Date
|
date | string |
Дата. |
|
|
Условия оплаты
|
payment_terms | integer |
Условия оплаты. |
|
|
Метка условий оплаты
|
payment_terms_label | string |
Метка условий оплаты. |
|
|
Срок
|
due_date | string |
Дата выполнения. |
|
|
Discount
|
discount | float |
Скидка. |
|
|
Скидка перед налогом
|
is_discount_before_tax | boolean |
Есть ли скидка перед налогом. |
|
|
Тип скидки
|
discount_type | string |
Тип скидки. |
|
|
Инклюзивный налог
|
is_inclusive_tax | boolean |
Независимо от того, включен ли налог. |
|
|
Курс
|
exchange_rate | float |
Обменный курс. |
|
|
Идентификатор повторяющегося счета
|
recurring_invoice_id | string |
Идентификатор повторяющегося счета. |
|
|
Идентификатор оценки по счету
|
invoiced_estimate_id | string |
Идентификатор оценки по счету. |
|
|
Имя продавца
|
salesperson_name | string |
Имя продавца. |
|
|
Этикетка
|
label | string |
Метка. |
|
|
Ценность
|
value | float |
Значение. |
|
|
Код проекта
|
project_id | string |
Идентификатор проекта. |
|
|
Идентификатор
|
item_id | string |
Идентификатор элемента. |
|
|
Код проекта
|
project_id | string |
Идентификатор проекта. |
|
|
Идентификаторы записи времени
|
time_entry_ids | array of integer |
Идентификаторы записи времени. |
|
|
Идентификатор затрат
|
expense_id | string |
Идентификатор расходов. |
|
|
Имя
|
name | string |
Имя. |
|
|
Тип продукта
|
product_type | string |
Тип продукта. |
|
|
HSN или SAC
|
hsn_or_sac | integer |
Номер HSN или SAC. |
|
|
Код ключа элемента SAT
|
sat_item_key_code | integer |
Код ключа элемента SAT. |
|
|
Код ключа единицы
|
unitkey_code | string |
Код ключа единицы. |
|
|
Description
|
description | string |
Описание. |
|
|
Заказ
|
item_order | integer |
Порядок элементов. |
|
|
Ставка
|
rate | float |
Частота. |
|
|
Количество
|
quantity | double |
Количество. |
|
|
Единица
|
unit | string |
Единица. |
|
|
Discount
|
discount | float |
Скидка. |
|
|
Идентификатор налогоплательщика
|
tax_id | string |
Идентификатор налога. |
|
|
Идентификатор налога TDS
|
tds_tax_id | string |
Идентификатор налога TDS. |
|
|
Идентификатор освобождения от налогов
|
tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
|
Код использования AvaTax
|
avatax_use_code | string |
Код AvaTax используется. |
|
|
Исключение AvaTax
|
avatax_exempt_no | string |
Номер исключения AvaTax. |
|
|
Имя налога
|
tax_name | string |
Имя налога. |
|
|
Тип налога
|
tax_type | string |
Тип налога. |
|
|
Процент налогов
|
tax_percentage | float |
Процент налога. |
|
|
Total
|
item_total | float |
Итог элемента. |
|
|
Сконфигурированный
|
configured | boolean |
Настроено ли значение. |
|
|
Дополнительное поле
|
additional_field1 | string |
Дополнительное поле. |
|
|
Имя
|
gateway_name | string |
Имя. |
|
|
Разрешить частичные платежи
|
allow_partial_payments | boolean |
Следует ли разрешать частичные платежи. |
|
|
Настраиваемый текст
|
custom_body | string |
Настраиваемый текст. |
|
|
Настраиваемый субъект
|
custom_subject | string |
Пользовательская тема. |
|
|
Примечания.
|
notes | string |
Заметки. |
|
|
Terms
|
terms | string |
Термины. |
|
|
Плата за доставку
|
shipping_charge | float |
Плата за доставку. |
|
|
Корректировка
|
adjustment | float |
Корректировка. |
|
|
Описание корректировки
|
adjustment_description | string |
Описание корректировки. |
|
|
Причина
|
reason | string |
Причина. |
|
|
Идентификатор налогового органа
|
tax_authority_id | string |
Идентификатор налогового органа. |
|
|
Идентификатор освобождения от налогов
|
tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
|
Код использования AvaTax
|
avatax_use_code | string |
Код AvaTax используется. |
|
|
Налоговый кодекс AvaTax
|
avatax_tax_code | string |
Налоговый код AvaTax. |
|
|
Номер исключения AvaTax
|
avatax_exempt_no | string |
Номер исключения AvaTax. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
Идентификатор
|
invoice.invoice_id | string |
Идентификатор счета. |
|
Оплата ACH, инициированная
|
invoice.ach_payment_initiated | boolean |
Была ли инициирована оплата ACH. |
|
Number
|
invoice.invoice_number | string |
Номер счета. |
|
Предварительная GST
|
invoice.is_pre_gst | boolean |
Указывает, является ли предварительная GST. |
|
Место поставки
|
invoice.place_of_supply | string |
Место поставки. |
|
GST-номер
|
invoice.gst_no | string |
Номер GST. |
|
Обработка GST
|
invoice.gst_treatment | string |
Лечение GST. |
|
Налоговое лечение
|
invoice.tax_treatment | string |
Налоговое лечение. |
|
Использование CFI
|
invoice.cfdi_usage | string |
Использование CFI. |
|
Обработка НДС
|
invoice.vat_treatment | string |
Обработка НДС. |
|
Регистрация НДС
|
invoice.vat_reg_no | string |
Номер регистрации НДС. |
|
Date
|
invoice.date | string |
Дата. |
|
Состояние
|
invoice.status | string |
Состояние. |
|
Условия оплаты
|
invoice.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
invoice.payment_terms_label | string |
Метка условий оплаты. |
|
Срок
|
invoice.due_date | string |
Дата выполнения. |
|
Ожидаемая дата оплаты
|
invoice.payment_expected_date | string |
Ожидаемая дата оплаты. |
|
Дата последнего платежа
|
invoice.last_payment_date | string |
Дата последнего платежа. |
|
Ссылочный номер
|
invoice.reference_number | string |
Номер ссылки. |
|
Идентификатор клиента
|
invoice.customer_id | string |
Идентификатор клиента. |
|
Имя клиента
|
invoice.customer_name | string |
Имя клиента. |
|
Контактные лица
|
invoice.contact_persons | array of string |
Контактные лица. |
|
Идентификатор валюты
|
invoice.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
invoice.currency_code | string |
Код валюты. |
|
Курс
|
invoice.exchange_rate | double |
Обменный курс. |
|
Discount
|
invoice.discount | double |
Скидка. |
|
Скидка перед налогом
|
invoice.is_discount_before_tax | boolean |
Есть ли скидка перед налогом. |
|
Тип скидки
|
invoice.discount_type | string |
Тип скидки. |
|
Инклюзивный налог
|
invoice.is_inclusive_tax | boolean |
Независимо от того, включен ли налог. |
|
Идентификатор повторяющегося счета
|
invoice.recurring_invoice_id | string |
Идентификатор повторяющегося счета. |
|
Просмотр по клиенту
|
invoice.is_viewed_by_client | boolean |
Проверяется ли клиент. |
|
Имеет вложение
|
invoice.has_attachment | boolean |
Имеет ли вложение. |
|
Время просмотра клиента
|
invoice.client_viewed_time | string |
Время просмотра клиента. |
|
Элемент строки
|
invoice.line_items | array of object | |
|
Идентификатор
|
invoice.line_items.line_item_id | string |
Идентификатор элемента строки. |
|
Идентификатор
|
invoice.line_items.item_id | string |
Идентификатор элемента. |
|
Код проекта
|
invoice.line_items.project_id | string |
Идентификатор проекта. |
|
Имя проекта
|
invoice.line_items.project_name | string |
Имя проекта. |
|
Тип элемента
|
invoice.line_items.item_type | string |
Тип элемента. |
|
Тип продукта
|
invoice.line_items.product_type | string |
Тип продукта. |
|
time_entry_ids
|
invoice.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
Идентификатор затрат
|
invoice.line_items.expense_id | string |
Идентификатор расходов. |
|
Имя квитанции о расходах
|
invoice.line_items.expense_receipt_name | string |
Имя квитанции о расходах. |
|
Имя
|
invoice.line_items.name | string |
Имя. |
|
Description
|
invoice.line_items.description | string |
Описание. |
|
Порядок элементов
|
invoice.line_items.item_order | integer |
Порядок элементов. |
|
Частота BCY
|
invoice.line_items.bcy_rate | double |
Частота BCY. |
|
Ставка
|
invoice.line_items.rate | double |
Частота. |
|
Количество
|
invoice.line_items.quantity | double |
Количество. |
|
Единица
|
invoice.line_items.unit | string |
Единица. |
|
Сумма скидки
|
invoice.line_items.discount_amount | double |
Сумма скидки. |
|
Discount
|
invoice.line_items.discount | double |
Скидка. |
|
Идентификатор
|
invoice.line_items.tax_id | string |
Идентификатор налога. |
|
Идентификатор налога TDS
|
invoice.line_items.tds_tax_id | string |
Идентификатор налога TDS. |
|
Имя
|
invoice.line_items.tax_name | string |
Имя налога. |
|
Тип налога
|
invoice.line_items.tax_type | string |
Тип налога. |
|
Процент налогов
|
invoice.line_items.tax_percentage | double |
Процент налога. |
|
Всего элементов
|
invoice.line_items.item_total | double |
Итог элемента. |
|
Код ключа элемента SAT
|
invoice.line_items.sat_item_key_code | integer |
Код ключа элемента SAT. |
|
Код ключа единицы
|
invoice.line_items.unitkey_code | string |
Код ключа единицы. |
|
Плата за доставку
|
invoice.shipping_charge | double |
Плата за доставку. |
|
Корректировка
|
invoice.adjustment | double |
Корректировка. |
|
Описание корректировки
|
invoice.adjustment_description | string |
Описание корректировки. |
|
Промежуточный итог
|
invoice.sub_total | double |
Промежуточный итог. |
|
Общий объем налогов
|
invoice.tax_total | double |
Общая сумма налога. |
|
Total
|
invoice.total | double |
Общее число. |
|
Налоги
|
invoice.taxes | array of object | |
|
Имя
|
invoice.taxes.tax_name | string |
Имя налога. |
|
Сумма
|
invoice.taxes.tax_amount | double |
Сумма налога. |
|
Включено напоминание о платеже
|
invoice.payment_reminder_enabled | boolean |
Включена ли напоминание о платеже. |
|
Оплата выполнена
|
invoice.payment_made | double |
Платеж выполнен. |
|
Примененные кредиты
|
invoice.credits_applied | double |
Примененные кредиты. |
|
Удержанная сумма налога
|
invoice.tax_amount_withheld | double |
Сумма налога удерживается. |
|
Баланс
|
invoice.balance | double |
Баланс. |
|
Списание суммы
|
invoice.write_off_amount | double |
Сумма списания. |
|
Разрешить частичные платежи
|
invoice.allow_partial_payments | boolean |
Следует ли разрешать частичные платежи. |
|
Точность цены
|
invoice.price_precision | integer |
Точность цены. |
|
Gateway
|
invoice.payment_options.payment_gateways | array of object | |
|
Сконфигурированный
|
invoice.payment_options.payment_gateways.configured | boolean |
Настроено ли значение. |
|
Дополнительное поле
|
invoice.payment_options.payment_gateways.additional_field1 | string |
Дополнительное поле. |
|
Имя
|
invoice.payment_options.payment_gateways.gateway_name | string |
Имя шлюза. |
|
Сообщение электронной почты
|
invoice.is_emailed | boolean |
Было ли отправлено сообщение электронной почты. |
|
Отправленные напоминания
|
invoice.reminders_sent | integer |
Количество отправленных напоминаний. |
|
Дата отправки последнего напоминания
|
invoice.last_reminder_sent_date | string |
Дата отправки последнего напоминания. |
|
Address
|
invoice.billing_address.address | string |
Адрес. |
|
Город
|
invoice.billing_address.city | string |
Город. |
|
Государство
|
invoice.billing_address.state | string |
Государство. |
|
Zip-архив
|
invoice.billing_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoice.billing_address.country | string |
Страна. |
|
Факс
|
invoice.billing_address.fax | string |
Номер факса. |
|
Address
|
invoice.shipping_address.address | string |
Адрес. |
|
Город
|
invoice.shipping_address.city | string |
Город. |
|
Государство
|
invoice.shipping_address.state | string |
Государство. |
|
Zip-архив
|
invoice.shipping_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoice.shipping_address.country | string |
Страна. |
|
Факс
|
invoice.shipping_address.fax | string |
Номер факса. |
|
Примечания.
|
invoice.notes | string |
Заметки. |
|
Terms
|
invoice.terms | string |
Термины. |
|
Настраиваемое поле
|
invoice.custom_fields | array of object | |
|
Идентификатор
|
invoice.custom_fields.customfield_id | string |
Идентификатор настраиваемого поля. |
|
Тип данных
|
invoice.custom_fields.data_type | string |
Тип данных. |
|
Index
|
invoice.custom_fields.index | integer |
Номер индекса. |
|
Этикетка
|
invoice.custom_fields.label | string |
Метка. |
|
Показать в ФОРМАТЕ PDF
|
invoice.custom_fields.show_on_pdf | boolean |
Указывает, следует ли отображать в ФОРМАТЕ PDF. |
|
Отображение во всех PDF-файлах
|
invoice.custom_fields.show_in_all_pdf | boolean |
Следует ли отображать во всех PDF-файлах. |
|
Ценность
|
invoice.custom_fields.value | double |
Значение настраиваемого поля. |
|
ИД шаблона
|
invoice.template_id | string |
Идентификатор шаблона. |
|
Имя шаблона
|
invoice.template_name | string |
Имя шаблона. |
|
Время создания
|
invoice.created_time | string |
Время создания. |
|
время последнего изменения;
|
invoice.last_modified_time | string |
Время последнего изменения. |
|
Имя вложения
|
invoice.attachment_name | string |
Имя вложения. |
|
Возможность отправки почты
|
invoice.can_send_in_mail | boolean |
Может ли отправить почту. |
|
Идентификатор продавца
|
invoice.salesperson_id | string |
Идентификатор продавца. |
|
Имя продавца
|
invoice.salesperson_name | string |
Имя продавца. |
|
URL
|
invoice.invoice_url | string |
URL-адрес счета. |
Получение контакта
Получение сведений о существующем контакте.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contact_id | True | string |
Идентификатор контакта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
Код контактного лица
|
contact.contact_id | string |
Идентификатор контакта. |
|
Имя контактного лица
|
contact.contact_name | string |
Имя контакта. |
|
Название компании
|
contact.company_name | string |
Название компании. |
|
Имеет транзакцию
|
contact.has_transaction | boolean |
Имеет ли транзакцию. |
|
Тип контакта
|
contact.contact_type | string |
Тип контакта. |
|
Является налогооблагаемым
|
contact.is_taxable | boolean |
Является ли налогооблагаемым. |
|
Идентификатор налогоплательщика
|
contact.tax_id | string |
Идентификатор налога. |
|
Имя налога
|
contact.tax_name | string |
Имя налога. |
|
Процент налогов
|
contact.tax_percentage | integer |
Процент налога. |
|
Идентификатор налогового органа
|
contact.tax_authority_id | string |
Идентификатор налогового органа. |
|
Идентификатор освобождения от налогов
|
contact.tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
Название налогового органа
|
contact.tax_authority_name | string |
Имя налогового органа. |
|
Кодекс об освобождении от налогов
|
contact.tax_exemption_code | string |
Кодекс об освобождении от налогов. |
|
Место контакта
|
contact.place_of_contact | string |
Место контакта. |
|
GST-номер
|
contact.gst_no | string |
Номер GST. |
|
Обработка НДС
|
contact.vat_treatment | string |
Обработка НДС. |
|
Обработка GST
|
contact.gst_treatment | string |
Лечение GST. |
|
Связан с Zoho CRM
|
contact.is_linked_with_zohocrm | boolean |
Связана ли с Zoho CRM. |
|
Веб-сайт
|
contact.website | string |
Веб-сайт. |
|
Первичный идентификатор контакта
|
contact.primary_contact_id | string |
Основной идентификатор контакта. |
|
Условия оплаты
|
contact.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
contact.payment_terms_label | string |
Метка условий оплаты. |
|
Идентификатор валюты
|
contact.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
contact.currency_code | string |
Код валюты. |
|
Обозначение денежной единицы
|
contact.currency_symbol | string |
Символ валюты. |
|
Сумма непогашенной задолженности
|
contact.outstanding_receivable_amount | double |
Сумма непогашенной задолженности. |
|
Сумма невыплаченной задолженности BCY
|
contact.outstanding_receivable_amount_bcy | double |
Сумма задолженности ПО BCY. |
|
Неиспользуемая сумма задолженности
|
contact.unused_credits_receivable_amount | double |
Сумма неиспользуемой задолженности. |
|
Неиспользуемая сумма задолженности на сумму BCY
|
contact.unused_credits_receivable_amount_bcy | double |
Сумма задолженности неиспользуемых кредитов BCY. |
|
Состояние
|
contact.status | string |
Состояние. |
|
Фейсбук
|
contact.facebook | string |
Учетная запись Facebook. |
|
Твиттер
|
contact.twitter | string |
Дескриптор Twitter. |
|
Включено напоминание о платеже
|
contact.payment_reminder_enabled | boolean |
Включена ли напоминание о платеже. |
|
Настраиваемое поле
|
contact.custom_fields | array of object | |
|
Ценность
|
contact.custom_fields.value | string |
Значение настраиваемого поля. |
|
Index
|
contact.custom_fields.index | integer |
Номер индекса. |
|
Этикетка
|
contact.custom_fields.label | string |
Метка. |
|
Внимание
|
contact.billing_address.attention | string |
Имя внимания. |
|
Address
|
contact.billing_address.address | string |
Адрес. |
|
Улица
|
contact.billing_address.street2 | string |
Адрес улицы. |
|
Код региона
|
contact.billing_address.state_code | string |
Код состояния. |
|
Город
|
contact.billing_address.city | string |
Город. |
|
Государство
|
contact.billing_address.state | string |
Государство. |
|
Zip-архив
|
contact.billing_address.zip | string |
Почтовый индекс. |
|
Страна
|
contact.billing_address.country | string |
Страна. |
|
Факс
|
contact.billing_address.fax | string |
Номер факса. |
|
Телефон
|
contact.billing_address.phone | string |
Номер телефона. |
|
Внимание
|
contact.shipping_address.attention | string |
Имя внимания. |
|
Address
|
contact.shipping_address.address | string |
Адрес. |
|
Улица
|
contact.shipping_address.street2 | string |
Адрес улицы. |
|
Код региона
|
contact.shipping_address.state_code | string |
Код состояния. |
|
Город
|
contact.shipping_address.city | string |
Город. |
|
Государство
|
contact.shipping_address.state | string |
Государство. |
|
Zip-архив
|
contact.shipping_address.zip | string |
Почтовый индекс. |
|
Страна
|
contact.shipping_address.country | string |
Страна. |
|
Факс
|
contact.shipping_address.fax | string |
Номер факса. |
|
Телефон
|
contact.shipping_address.phone | string |
Номер телефона. |
|
Контактные лица
|
contact.contact_persons | array of object | |
|
Приветствие
|
contact.contact_persons.salutation | string |
Приветствие. |
|
Имя (Первое имя)
|
contact.contact_persons.first_name | string |
Первое имя. |
|
Фамилия
|
contact.contact_persons.last_name | string |
Фамилия. |
|
Адрес электронной почты
|
contact.contact_persons.email | string |
Адрес электронной почты. |
|
Телефон
|
contact.contact_persons.phone | string |
Номер телефона. |
|
мобильное устройство
|
contact.contact_persons.mobile | string |
Номер мобильного телефона. |
|
Основной контакт
|
contact.contact_persons.is_primary_contact | boolean |
Является ли основным контактом. |
|
Идентификатор шаблона счета
|
contact.default_templates.invoice_template_id | string |
Идентификатор шаблона счета. |
|
Имя шаблона счета
|
contact.default_templates.invoice_template_name | string |
Имя шаблона счета. |
|
Оценка идентификатора шаблона
|
contact.default_templates.estimate_template_id | string |
Идентификатор шаблона оценки. |
|
Оценка имени шаблона
|
contact.default_templates.estimate_template_name | string |
Имя шаблона оценки. |
|
Идентификатор шаблона кредитных заметок
|
contact.default_templates.creditnote_template_id | string |
Идентификатор шаблона кредитной заметки. |
|
Имя шаблона кредитных заметок
|
contact.default_templates.creditnote_template_name | string |
Имя шаблона кредитной заметки. |
|
Идентификатор шаблона электронной почты счета
|
contact.default_templates.invoice_email_template_id | string |
Идентификатор шаблона электронной почты счета. |
|
Имя шаблона электронной почты счета
|
contact.default_templates.invoice_email_template_name | string |
Имя шаблона электронной почты счета. |
|
Оценка идентификатора шаблона электронной почты
|
contact.default_templates.estimate_email_template_id | string |
Оценка идентификатора шаблона электронной почты. |
|
Оценка имени шаблона электронной почты
|
contact.default_templates.estimate_email_template_name | string |
Имя шаблона электронной почты оценки. |
|
Идентификатор шаблона электронной почты с кредитными заметками
|
contact.default_templates.creditnote_email_template_id | string |
Идентификатор шаблона электронной почты для кредитной заметки. |
|
Имя шаблона электронной почты с кредитными заметками
|
contact.default_templates.creditnote_email_template_name | string |
Имя шаблона электронной почты с кредитными заметками. |
|
Примечания.
|
contact.notes | string |
Заметки. |
|
Время создания
|
contact.created_time | string |
Время создания. |
|
время последнего изменения;
|
contact.last_modified_time | string |
Время последнего изменения. |
Получение контактов
Получение списка всех контактов с разбивкой на страницы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя контактного лица
|
contact_name | string |
Имя контакта. |
|
|
Идентификатор компании
|
company_name | string |
Идентификатор компании. |
|
|
Имя (Первое имя)
|
first_name | string |
Первое имя. |
|
|
Последнее имя
|
last_name | string |
Фамилия. |
|
|
Address
|
address | string |
Адрес. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Телефон
|
phone | string |
Адрес телефона. |
|
|
Фильтрация по
|
filter_by | string |
Фильтр по. |
|
|
Поиск текста
|
search_text | string |
Текст для поиска. |
|
|
Сортировка столбца
|
sort_column | string |
Столбец сортировки. |
|
|
Идентификатор контакта Zoho CRM
|
zcrm_contact_id | integer |
Идентификатор контакта Zoho CRM. |
|
|
Идентификатор учетной записи Zoho CRM
|
zcrm_account_id | integer |
Идентификатор учетной записи Zoho CRM. |
|
|
Страница
|
page | integer |
Номер страницы. |
|
|
На страницу
|
per_page | integer |
Номер страницы. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
контакт
|
contact | array of object | |
|
Код контактного лица
|
contact.contact_id | string |
Идентификатор контакта. |
|
Имя контактного лица
|
contact.contact_name | string |
Имя контакта. |
|
Название компании
|
contact.company_name | string |
Название компании. |
|
Тип контакта
|
contact.contact_type | string |
Тип контакта. |
|
Условия оплаты
|
contact.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
contact.payment_terms_label | string |
Метка условий оплаты. |
|
Идентификатор валюты
|
contact.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
contact.currency_code | string |
Код валюты. |
|
Сумма непогашенной задолженности
|
contact.outstanding_receivable_amount | double |
Сумма непогашенной задолженности. |
|
Неиспользуемая сумма задолженности
|
contact.unused_credits_receivable_amount | double |
Сумма неиспользуемой задолженности. |
|
Состояние
|
contact.status | string |
Состояние. |
|
Время создания
|
contact.created_time | string |
Время создания. |
|
время последнего изменения;
|
contact.last_modified_time | string |
Время последнего изменения. |
Получение счета
Получение сведений о счете
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор счета
|
invoice_id | True | string |
Идентификатор счета. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
Идентификатор
|
invoice.invoice_id | string |
Идентификатор счета. |
|
Оплата ACH, инициированная
|
invoice.ach_payment_initiated | boolean |
Была ли инициирована оплата ACH. |
|
Number
|
invoice.invoice_number | string |
Номер счета. |
|
Предварительная GST
|
invoice.is_pre_gst | boolean |
Указывает, является ли предварительная GST. |
|
Место поставки
|
invoice.place_of_supply | string |
Место поставки. |
|
GST-номер
|
invoice.gst_no | string |
Номер GST. |
|
Обработка GST
|
invoice.gst_treatment | string |
Лечение GST. |
|
Налоговое лечение
|
invoice.tax_treatment | string |
Налоговое лечение. |
|
Использование CFI
|
invoice.cfdi_usage | string |
Использование CFI. |
|
Обработка НДС
|
invoice.vat_treatment | string |
Обработка НДС. |
|
Регистрация НДС
|
invoice.vat_reg_no | string |
Номер регистрации НДС. |
|
Date
|
invoice.date | string |
Дата. |
|
Состояние
|
invoice.status | string |
Состояние. |
|
Условия оплаты
|
invoice.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
invoice.payment_terms_label | string |
Метка условий оплаты. |
|
Срок
|
invoice.due_date | string |
Дата выполнения. |
|
Ожидаемая дата оплаты
|
invoice.payment_expected_date | string |
Ожидаемая дата оплаты. |
|
Дата последнего платежа
|
invoice.last_payment_date | string |
Дата последнего платежа. |
|
Ссылочный номер
|
invoice.reference_number | string |
Номер ссылки. |
|
Идентификатор клиента
|
invoice.customer_id | string |
Идентификатор клиента. |
|
Имя клиента
|
invoice.customer_name | string |
Имя клиента. |
|
Контактные лица
|
invoice.contact_persons | array of string |
Контактные лица. |
|
Идентификатор валюты
|
invoice.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
invoice.currency_code | string |
Код валюты. |
|
Курс
|
invoice.exchange_rate | double |
Обменный курс. |
|
Discount
|
invoice.discount | double |
Скидка. |
|
Скидка перед налогом
|
invoice.is_discount_before_tax | boolean |
Есть ли скидка перед налогом. |
|
Тип скидки
|
invoice.discount_type | string |
Тип скидки. |
|
Инклюзивный налог
|
invoice.is_inclusive_tax | boolean |
Независимо от того, включен ли налог. |
|
Идентификатор повторяющегося счета
|
invoice.recurring_invoice_id | string |
Идентификатор повторяющегося счета. |
|
Просмотр по клиенту
|
invoice.is_viewed_by_client | boolean |
Проверяется ли клиент. |
|
Имеет вложение
|
invoice.has_attachment | boolean |
Имеет ли вложение. |
|
Время просмотра клиента
|
invoice.client_viewed_time | string |
Время просмотра клиента. |
|
Элемент строки
|
invoice.line_items | array of object | |
|
Идентификатор
|
invoice.line_items.line_item_id | string |
Идентификатор элемента строки. |
|
Идентификатор
|
invoice.line_items.item_id | string |
Идентификатор элемента. |
|
Код проекта
|
invoice.line_items.project_id | string |
Идентификатор проекта. |
|
Имя проекта
|
invoice.line_items.project_name | string |
Имя проекта. |
|
Тип элемента
|
invoice.line_items.item_type | string |
Тип элемента. |
|
Тип продукта
|
invoice.line_items.product_type | string |
Тип продукта. |
|
time_entry_ids
|
invoice.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
Идентификатор затрат
|
invoice.line_items.expense_id | string |
Идентификатор расходов. |
|
Имя квитанции о расходах
|
invoice.line_items.expense_receipt_name | string |
Имя квитанции о расходах. |
|
Имя
|
invoice.line_items.name | string |
Имя. |
|
Description
|
invoice.line_items.description | string |
Описание. |
|
Порядок элементов
|
invoice.line_items.item_order | integer |
Порядок элементов. |
|
Частота BCY
|
invoice.line_items.bcy_rate | double |
Частота BCY. |
|
Ставка
|
invoice.line_items.rate | double |
Частота. |
|
Количество
|
invoice.line_items.quantity | double |
Количество. |
|
Единица
|
invoice.line_items.unit | string |
Единица. |
|
Сумма скидки
|
invoice.line_items.discount_amount | double |
Сумма скидки. |
|
Discount
|
invoice.line_items.discount | double |
Скидка. |
|
Идентификатор
|
invoice.line_items.tax_id | string |
Идентификатор налога. |
|
Идентификатор налога TDS
|
invoice.line_items.tds_tax_id | string |
Идентификатор налога TDS. |
|
Имя
|
invoice.line_items.tax_name | string |
Имя налога. |
|
Тип налога
|
invoice.line_items.tax_type | string |
Тип налога. |
|
Процент налогов
|
invoice.line_items.tax_percentage | double |
Процент налога. |
|
Всего элементов
|
invoice.line_items.item_total | double |
Итог элемента. |
|
Код ключа элемента SAT
|
invoice.line_items.sat_item_key_code | integer |
Код ключа элемента SAT. |
|
Код ключа единицы
|
invoice.line_items.unitkey_code | string |
Код ключа единицы. |
|
Плата за доставку
|
invoice.shipping_charge | double |
Плата за доставку. |
|
Корректировка
|
invoice.adjustment | double |
Корректировка. |
|
Описание корректировки
|
invoice.adjustment_description | string |
Описание корректировки. |
|
Промежуточный итог
|
invoice.sub_total | double |
Промежуточный итог. |
|
Общий объем налогов
|
invoice.tax_total | double |
Общая сумма налога. |
|
Total
|
invoice.total | double |
Общее число. |
|
Налоги
|
invoice.taxes | array of object | |
|
Имя
|
invoice.taxes.tax_name | string |
Имя налога. |
|
Сумма
|
invoice.taxes.tax_amount | double |
Сумма налога. |
|
Включено напоминание о платеже
|
invoice.payment_reminder_enabled | boolean |
Включена ли напоминание о платеже. |
|
Оплата выполнена
|
invoice.payment_made | double |
Платеж выполнен. |
|
Примененные кредиты
|
invoice.credits_applied | double |
Примененные кредиты. |
|
Удержанная сумма налога
|
invoice.tax_amount_withheld | double |
Сумма налога удерживается. |
|
Баланс
|
invoice.balance | double |
Баланс. |
|
Списание суммы
|
invoice.write_off_amount | double |
Сумма списания. |
|
Разрешить частичные платежи
|
invoice.allow_partial_payments | boolean |
Следует ли разрешать частичные платежи. |
|
Точность цены
|
invoice.price_precision | integer |
Точность цены. |
|
Gateway
|
invoice.payment_options.payment_gateways | array of object | |
|
Сконфигурированный
|
invoice.payment_options.payment_gateways.configured | boolean |
Настроено ли значение. |
|
Дополнительное поле
|
invoice.payment_options.payment_gateways.additional_field1 | string |
Дополнительное поле. |
|
Имя
|
invoice.payment_options.payment_gateways.gateway_name | string |
Имя шлюза. |
|
Сообщение электронной почты
|
invoice.is_emailed | boolean |
Было ли отправлено сообщение электронной почты. |
|
Отправленные напоминания
|
invoice.reminders_sent | integer |
Количество отправленных напоминаний. |
|
Дата отправки последнего напоминания
|
invoice.last_reminder_sent_date | string |
Дата отправки последнего напоминания. |
|
Address
|
invoice.billing_address.address | string |
Адрес. |
|
Город
|
invoice.billing_address.city | string |
Город. |
|
Государство
|
invoice.billing_address.state | string |
Государство. |
|
Zip-архив
|
invoice.billing_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoice.billing_address.country | string |
Страна. |
|
Факс
|
invoice.billing_address.fax | string |
Номер факса. |
|
Address
|
invoice.shipping_address.address | string |
Адрес. |
|
Город
|
invoice.shipping_address.city | string |
Город. |
|
Государство
|
invoice.shipping_address.state | string |
Государство. |
|
Zip-архив
|
invoice.shipping_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoice.shipping_address.country | string |
Страна. |
|
Факс
|
invoice.shipping_address.fax | string |
Номер факса. |
|
Примечания.
|
invoice.notes | string |
Заметки. |
|
Terms
|
invoice.terms | string |
Термины. |
|
Настраиваемое поле
|
invoice.custom_fields | array of object | |
|
Идентификатор
|
invoice.custom_fields.customfield_id | string |
Идентификатор настраиваемого поля. |
|
Тип данных
|
invoice.custom_fields.data_type | string |
Тип данных. |
|
Index
|
invoice.custom_fields.index | integer |
Номер индекса. |
|
Этикетка
|
invoice.custom_fields.label | string |
Метка. |
|
Показать в ФОРМАТЕ PDF
|
invoice.custom_fields.show_on_pdf | boolean |
Указывает, следует ли отображать в ФОРМАТЕ PDF. |
|
Отображение во всех PDF-файлах
|
invoice.custom_fields.show_in_all_pdf | boolean |
Следует ли отображать во всех PDF-файлах. |
|
Ценность
|
invoice.custom_fields.value | double |
Значение настраиваемого поля. |
|
ИД шаблона
|
invoice.template_id | string |
Идентификатор шаблона. |
|
Имя шаблона
|
invoice.template_name | string |
Имя шаблона. |
|
Время создания
|
invoice.created_time | string |
Время создания. |
|
время последнего изменения;
|
invoice.last_modified_time | string |
Время последнего изменения. |
|
Имя вложения
|
invoice.attachment_name | string |
Имя вложения. |
|
Возможность отправки почты
|
invoice.can_send_in_mail | boolean |
Может ли отправить почту. |
|
Идентификатор продавца
|
invoice.salesperson_id | string |
Идентификатор продавца. |
|
Имя продавца
|
invoice.salesperson_name | string |
Имя продавца. |
|
URL
|
invoice.invoice_url | string |
URL-адрес счета. |
Получение счетов
Получение списка счетов с разбивкой на страницы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_number | string |
Номер счета. |
|
|
Имя элемента
|
item_name | string |
Имя элемента. |
|
|
Идентификатор элемента
|
item_id | string |
Идентификатор элемента. |
|
|
Описание элемента
|
item_description | string |
Описание элемента. |
|
|
Ссылочный номер
|
reference_number | string |
Номер ссылки. |
|
|
Имя клиента
|
customer_name | string |
Имя клиента. |
|
|
Идентификатор повторяющегося счета
|
recurring_invoice_id | string |
Идентификатор повторяющегося счета. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Total
|
total | string |
Общее число. |
|
|
Баланс
|
balance | string |
Баланс. |
|
|
Настраиваемое поле
|
custom_field | string |
Настраиваемое поле. |
|
|
Date
|
date | string |
Дата. |
|
|
Срок
|
due_date | string |
Дата выполнения. |
|
|
Состояние
|
status | string |
Состояние. |
|
|
Пользовательский идентификатор
|
customer_id | string |
Пользовательский идентификатор. |
|
|
Фильтрация по
|
filter_by | string |
Фильтр по. |
|
|
Поиск текста
|
search_text | string |
Текст для поиска. |
|
|
Сортировка столбца
|
sort_column | string |
Столбец сортировки. |
|
|
Зохо CRM Потенциальный идентификатор
|
zcrm_potential_id | string |
Потенциальный идентификатор Zoho CRM. |
|
|
Страница
|
page | integer |
Номер страницы. |
|
|
На страницу
|
per_page | integer |
Номер страницы. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
invoices
|
invoices | array of object | |
|
Идентификатор
|
invoices.invoice_id | string |
Идентификатор счета. |
|
Оплата ACH, инициированная
|
invoices.ach_payment_initiated | boolean |
Была ли инициирована оплата ACH. |
|
Number
|
invoices.invoice_number | string |
Номер счета. |
|
Предварительная GST
|
invoices.is_pre_gst | boolean |
Указывает, является ли предварительная GST. |
|
Место поставки
|
invoices.place_of_supply | string |
Место поставки. |
|
GST-номер
|
invoices.gst_no | string |
Номер GST. |
|
Обработка GST
|
invoices.gst_treatment | string |
Лечение GST. |
|
Налоговое лечение
|
invoices.tax_treatment | string |
Налоговое лечение. |
|
Использование CFI
|
invoices.cfdi_usage | string |
Использование CFI. |
|
Обработка НДС
|
invoices.vat_treatment | string |
Обработка НДС. |
|
Регистрация НДС
|
invoices.vat_reg_no | string |
Номер регистрации НДС. |
|
Date
|
invoices.date | string |
Дата. |
|
Состояние
|
invoices.status | string |
Состояние. |
|
Условия оплаты
|
invoices.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
invoices.payment_terms_label | string |
Метка условий оплаты. |
|
Срок
|
invoices.due_date | string |
Дата выполнения. |
|
Ожидаемая дата оплаты
|
invoices.payment_expected_date | string |
Ожидаемая дата оплаты. |
|
Дата последнего платежа
|
invoices.last_payment_date | string |
Дата последнего платежа. |
|
Ссылочный номер
|
invoices.reference_number | string |
Номер ссылки. |
|
Идентификатор клиента
|
invoices.customer_id | string |
Идентификатор клиента. |
|
Имя клиента
|
invoices.customer_name | string |
Имя клиента. |
|
Контактные лица
|
invoices.contact_persons | array of string |
Контактные лица. |
|
Идентификатор валюты
|
invoices.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
invoices.currency_code | string |
Код валюты. |
|
Курс
|
invoices.exchange_rate | double |
Обменный курс. |
|
Discount
|
invoices.discount | double |
Скидка. |
|
Скидка перед налогом
|
invoices.is_discount_before_tax | boolean |
Есть ли скидка перед налогом. |
|
Тип скидки
|
invoices.discount_type | string |
Тип скидки. |
|
Инклюзивный налог
|
invoices.is_inclusive_tax | boolean |
Независимо от того, включен ли налог. |
|
Идентификатор повторяющегося счета
|
invoices.recurring_invoice_id | string |
Идентификатор повторяющегося счета. |
|
Просмотр по клиенту
|
invoices.is_viewed_by_client | boolean |
Проверяется ли клиент. |
|
Имеет вложение
|
invoices.has_attachment | boolean |
Имеет ли вложение. |
|
Время просмотра клиента
|
invoices.client_viewed_time | string |
Время просмотра клиента. |
|
Элемент строки
|
invoices.line_items | array of object | |
|
Идентификатор
|
invoices.line_items.line_item_id | string |
Идентификатор элемента строки. |
|
Идентификатор
|
invoices.line_items.item_id | string |
Идентификатор элемента. |
|
Код проекта
|
invoices.line_items.project_id | string |
Идентификатор проекта. |
|
Имя проекта
|
invoices.line_items.project_name | string |
Имя проекта. |
|
Тип элемента
|
invoices.line_items.item_type | string |
Тип элемента. |
|
Тип продукта
|
invoices.line_items.product_type | string |
Тип продукта. |
|
time_entry_ids
|
invoices.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
Идентификатор затрат
|
invoices.line_items.expense_id | string |
Идентификатор расходов. |
|
Имя квитанции о расходах
|
invoices.line_items.expense_receipt_name | string |
Имя квитанции о расходах. |
|
Имя
|
invoices.line_items.name | string |
Имя. |
|
Description
|
invoices.line_items.description | string |
Описание. |
|
Порядок элементов
|
invoices.line_items.item_order | integer |
Порядок элементов. |
|
Частота BCY
|
invoices.line_items.bcy_rate | double |
Частота BCY. |
|
Ставка
|
invoices.line_items.rate | double |
Частота. |
|
Количество
|
invoices.line_items.quantity | double |
Количество. |
|
Единица
|
invoices.line_items.unit | string |
Единица. |
|
Сумма скидки
|
invoices.line_items.discount_amount | double |
Сумма скидки. |
|
Discount
|
invoices.line_items.discount | double |
Скидка. |
|
Идентификатор
|
invoices.line_items.tax_id | string |
Идентификатор налога. |
|
Идентификатор налога TDS
|
invoices.line_items.tds_tax_id | string |
Идентификатор налога TDS. |
|
Имя
|
invoices.line_items.tax_name | string |
Имя налога. |
|
Тип налога
|
invoices.line_items.tax_type | string |
Тип налога. |
|
Процент налогов
|
invoices.line_items.tax_percentage | double |
Процент налога. |
|
Всего элементов
|
invoices.line_items.item_total | double |
Итог элемента. |
|
Код ключа элемента SAT
|
invoices.line_items.sat_item_key_code | integer |
Код ключа элемента SAT. |
|
Код ключа единицы
|
invoices.line_items.unitkey_code | string |
Код ключа единицы. |
|
Плата за доставку
|
invoices.shipping_charge | double |
Плата за доставку. |
|
Корректировка
|
invoices.adjustment | double |
Корректировка. |
|
Описание корректировки
|
invoices.adjustment_description | string |
Описание корректировки. |
|
Промежуточный итог
|
invoices.sub_total | double |
Промежуточный итог. |
|
Общий объем налогов
|
invoices.tax_total | double |
Общая сумма налога. |
|
Total
|
invoices.total | double |
Общее число. |
|
Налоги
|
invoices.taxes | array of object | |
|
Имя
|
invoices.taxes.tax_name | string |
Имя налога. |
|
Сумма
|
invoices.taxes.tax_amount | double |
Сумма налога. |
|
Включено напоминание о платеже
|
invoices.payment_reminder_enabled | boolean |
Включена ли напоминание о платеже. |
|
Оплата выполнена
|
invoices.payment_made | double |
Платеж выполнен. |
|
Примененные кредиты
|
invoices.credits_applied | double |
Примененные кредиты. |
|
Удержанная сумма налога
|
invoices.tax_amount_withheld | double |
Сумма налога удерживается. |
|
Баланс
|
invoices.balance | double |
Баланс. |
|
Списание суммы
|
invoices.write_off_amount | double |
Сумма списания. |
|
Разрешить частичные платежи
|
invoices.allow_partial_payments | boolean |
Следует ли разрешать частичные платежи. |
|
Точность цены
|
invoices.price_precision | integer |
Точность цены. |
|
Gateway
|
invoices.payment_options.payment_gateways | array of object | |
|
Сконфигурированный
|
invoices.payment_options.payment_gateways.configured | boolean |
Настроено ли значение. |
|
Дополнительное поле
|
invoices.payment_options.payment_gateways.additional_field1 | string |
Дополнительное поле. |
|
Имя
|
invoices.payment_options.payment_gateways.gateway_name | string |
Имя шлюза. |
|
Сообщение электронной почты
|
invoices.is_emailed | boolean |
Было ли отправлено сообщение электронной почты. |
|
Отправленные напоминания
|
invoices.reminders_sent | integer |
Количество отправленных напоминаний. |
|
Дата отправки последнего напоминания
|
invoices.last_reminder_sent_date | string |
Дата отправки последнего напоминания. |
|
Address
|
invoices.billing_address.address | string |
Адрес. |
|
Город
|
invoices.billing_address.city | string |
Город. |
|
Государство
|
invoices.billing_address.state | string |
Государство. |
|
Zip-архив
|
invoices.billing_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoices.billing_address.country | string |
Страна. |
|
Факс
|
invoices.billing_address.fax | string |
Номер факса. |
|
Address
|
invoices.shipping_address.address | string |
Адрес. |
|
Город
|
invoices.shipping_address.city | string |
Город. |
|
Государство
|
invoices.shipping_address.state | string |
Государство. |
|
Zip-архив
|
invoices.shipping_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoices.shipping_address.country | string |
Страна. |
|
Факс
|
invoices.shipping_address.fax | string |
Номер факса. |
|
Примечания.
|
invoices.notes | string |
Заметки. |
|
Terms
|
invoices.terms | string |
Термины. |
|
Настраиваемое поле
|
invoices.custom_fields | array of object | |
|
Идентификатор
|
invoices.custom_fields.customfield_id | string |
Идентификатор настраиваемого поля. |
|
Тип данных
|
invoices.custom_fields.data_type | string |
Тип данных. |
|
Index
|
invoices.custom_fields.index | integer |
Номер индекса. |
|
Этикетка
|
invoices.custom_fields.label | string |
Метка. |
|
Показать в ФОРМАТЕ PDF
|
invoices.custom_fields.show_on_pdf | boolean |
Указывает, следует ли отображать в ФОРМАТЕ PDF. |
|
Отображение во всех PDF-файлах
|
invoices.custom_fields.show_in_all_pdf | boolean |
Следует ли отображать во всех PDF-файлах. |
|
Ценность
|
invoices.custom_fields.value | double |
Значение настраиваемого поля. |
|
ИД шаблона
|
invoices.template_id | string |
Идентификатор шаблона. |
|
Имя шаблона
|
invoices.template_name | string |
Имя шаблона. |
|
Время создания
|
invoices.created_time | string |
Время создания. |
|
время последнего изменения;
|
invoices.last_modified_time | string |
Время последнего изменения. |
|
Имя вложения
|
invoices.attachment_name | string |
Имя вложения. |
|
Возможность отправки почты
|
invoices.can_send_in_mail | boolean |
Может ли отправить почту. |
|
Идентификатор продавца
|
invoices.salesperson_id | string |
Идентификатор продавца. |
|
Имя продавца
|
invoices.salesperson_name | string |
Имя продавца. |
|
URL
|
invoices.invoice_url | string |
URL-адрес счета. |
Создание контакта
Создает новый контакт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя контактного лица
|
contact_name | True | string |
Имя контакта. |
|
Название компании
|
company_name | string |
Название компании. |
|
|
Условия оплаты
|
payment_terms | integer |
Условия оплаты. |
|
|
Идентификатор валюты
|
currency_id | string |
Идентификатор валюты. |
|
|
Веб-сайт
|
website | string |
Веб-сайт. |
|
|
Ценность
|
value | string |
Значение настраиваемого поля. |
|
|
Index
|
index | integer |
Номер индекса. |
|
|
Внимание
|
attention | string |
Имя внимания. |
|
|
Address
|
address | string |
Адрес. |
|
|
Адрес 2
|
street2 | string |
Адрес 2. |
|
|
Государство
|
state_code | string |
Сокращение состояния. |
|
|
Город
|
city | string |
Город. |
|
|
Государство
|
state | string |
Государство. |
|
|
Zip-архив
|
zip | string |
Почтовый индекс. |
|
|
Страна
|
country | string |
Страна. |
|
|
Факс
|
fax | string |
Номер факса. |
|
|
Телефон
|
phone | string |
Номер телефона. |
|
|
Внимание
|
attention | string |
Имя внимания. |
|
|
Address
|
address | string |
Адрес. |
|
|
Адрес 2
|
street2 | string |
Адрес 2. |
|
|
Государство
|
state_code | string |
Сокращение состояния. |
|
|
Город
|
city | string |
Город. |
|
|
Государство
|
state | string |
Государство. |
|
|
Zip-архив
|
zip | string |
Почтовый индекс. |
|
|
Страна
|
country | string |
Страна. |
|
|
Факс
|
fax | string |
Номер факса. |
|
|
Телефон
|
phone | string |
Номер телефона. |
|
|
Приветствие
|
salutation | string |
Приветствие. |
|
|
Имя (Первое имя)
|
first_name | string |
Первое имя. |
|
|
Фамилия
|
last_name | string |
Фамилия. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Телефон
|
phone | string |
Номер телефона. |
|
|
мобильное устройство
|
mobile | string |
Номер мобильного телефона. |
|
|
Основной контакт
|
is_primary_contact | boolean |
Является ли основным контактом. |
|
|
Идентификатор шаблона счета
|
invoice_template_id | string |
Идентификатор шаблона счета. |
|
|
Имя шаблона счета
|
invoice_template_name | string |
Имя шаблона счета. |
|
|
Оценка идентификатора шаблона
|
estimate_template_id | string |
Идентификатор шаблона оценки. |
|
|
Оценка имени шаблона
|
estimate_template_name | string |
Имя шаблона оценки. |
|
|
Идентификатор шаблона кредитных заметок
|
creditnote_template_id | string |
Идентификатор шаблона кредитной заметки. |
|
|
Имя шаблона кредитных заметок
|
creditnote_template_name | string |
Имя шаблона кредитной заметки. |
|
|
Идентификатор шаблона электронной почты счета
|
invoice_email_template_id | string |
Идентификатор шаблона электронной почты счета. |
|
|
Имя шаблона электронной почты счета
|
invoice_email_template_name | string |
Имя шаблона электронной почты счета. |
|
|
Оценка идентификатора шаблона электронной почты
|
estimate_email_template_id | string |
Оценка идентификатора шаблона электронной почты. |
|
|
Оценка имени шаблона электронной почты
|
estimate_email_template_name | string |
Имя шаблона электронной почты оценки. |
|
|
Идентификатор шаблона электронной почты с кредитными заметками
|
creditnote_email_template_id | string |
Идентификатор шаблона электронной почты для кредитной заметки. |
|
|
Имя шаблона электронной почты с кредитными заметками
|
creditnote_email_template_name | string |
Имя шаблона электронной почты с кредитными заметками. |
|
|
Код языка
|
language_code | string |
Код языка. |
|
|
Примечания.
|
notes | string |
Заметки. |
|
|
Регистрация НДС
|
vat_reg_no | string |
Номер регистрации НДС. |
|
|
Регистрация налогов
|
tax_reg_no | string |
Номер налоговой регистрации. |
|
|
Код страны
|
country_code | string |
Код страны. |
|
|
Обработка НДС
|
vat_treatment | string |
Тип обработки НДС. |
|
|
Налоговое лечение
|
tax_treatment | string |
Тип налогового лечения. |
|
|
Налоговый режим
|
tax_regime | string |
Налоговый режим. |
|
|
Юридическое имя
|
legal_name | string |
Юридическое имя. |
|
|
Зарегистрированы TDS
|
is_tds_registered | boolean |
Зарегистрировано ли TDS. |
|
|
Место контакта
|
place_of_contact | string |
Место контакта. |
|
|
GST-номер
|
gst_no | string |
Номер GST. |
|
|
Обработка GST
|
gst_treatment | string |
Тип лечения GST. |
|
|
Название налогового органа
|
tax_authority_name | string |
Имя налогового органа. |
|
|
Кодекс об освобождении от налогов
|
tax_exemption_code | string |
Кодекс об освобождении от налогов. |
|
|
Исключение AvaTax
|
avatax_exempt_no | string |
Номер исключения AvaTax. |
|
|
Код использования AvaTax
|
avatax_use_code | string |
Код AvaTax используется. |
|
|
Идентификатор освобождения от налогов
|
tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
|
Идентификатор налогового органа
|
tax_authority_id | string |
Идентификатор налогового органа. |
|
|
Идентификатор налогоплательщика
|
tax_id | string |
Идентификатор налога. |
|
|
Идентификатор налога TDS
|
tds_tax_id | string |
Идентификатор налога TDS. |
|
|
Является налогооблагаемым
|
is_taxable | boolean |
Является ли налогооблагаемым. |
|
|
Фейсбук
|
string |
Имя пользователя Facebook. |
||
|
Твиттер
|
string |
Дескриптор Twitter. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
Код контактного лица
|
contact.contact_id | string |
Идентификатор контакта. |
|
Имя контактного лица
|
contact.contact_name | string |
Имя контакта. |
|
Название компании
|
contact.company_name | string |
Название компании. |
|
Имеет транзакцию
|
contact.has_transaction | boolean |
Имеет ли транзакцию. |
|
Тип контакта
|
contact.contact_type | string |
Тип контакта. |
|
Является налогооблагаемым
|
contact.is_taxable | boolean |
Является ли налогооблагаемым. |
|
Идентификатор налогоплательщика
|
contact.tax_id | string |
Идентификатор налога. |
|
Идентификатор налога TDS
|
contact.tds_tax_id | string |
Идентификатор налога TDS. |
|
Имя налога
|
contact.tax_name | string |
Имя налога. |
|
Процент налогов
|
contact.tax_percentage | integer |
Процент налога. |
|
Идентификатор налогового органа
|
contact.tax_authority_id | string |
Идентификатор налогового органа. |
|
Идентификатор освобождения от налогов
|
contact.tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
Название налогового органа
|
contact.tax_authority_name | string |
Имя налогового органа. |
|
Кодекс об освобождении от налогов
|
contact.tax_exemption_code | string |
Кодекс об освобождении от налогов. |
|
Место контакта
|
contact.place_of_contact | string |
Место контакта. |
|
GST-номер
|
contact.gst_no | string |
Номер GST. |
|
Обработка НДС
|
contact.vat_treatment | string |
Обработка НДС. |
|
Налоговое лечение
|
contact.tax_treatment | string |
Налоговое лечение. |
|
Налоговый режим
|
contact.tax_regime | string |
Налоговый режим. |
|
Юридическое имя
|
contact.legal_name | string |
Юридическое имя. |
|
Зарегистрированы TDS
|
contact.is_tds_registered | boolean |
Зарегистрирован ли TSD. |
|
Обработка GST
|
contact.gst_treatment | string |
Лечение GST. |
|
Связан с Zoho CRM
|
contact.is_linked_with_zohocrm | boolean |
Связана ли с Zoho CRM. |
|
Веб-сайт
|
contact.website | string |
Веб-сайт. |
|
Первичный идентификатор контакта
|
contact.primary_contact_id | string |
Основной идентификатор контакта. |
|
Условия оплаты
|
contact.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
contact.payment_terms_label | string |
Метка условий оплаты. |
|
Идентификатор валюты
|
contact.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
contact.currency_code | string |
Код валюты. |
|
Обозначение денежной единицы
|
contact.currency_symbol | string |
Символ валюты. |
|
Код языка
|
contact.language_code | string |
Код языка. |
|
Сумма непогашенной задолженности
|
contact.outstanding_receivable_amount | double |
Сумма непогашенной задолженности. |
|
Сумма невыплаченной задолженности BCY
|
contact.outstanding_receivable_amount_bcy | double |
Сумма задолженности ПО BCY. |
|
Неиспользуемая сумма задолженности
|
contact.unused_credits_receivable_amount | double |
Сумма неиспользуемой задолженности. |
|
Неиспользуемая сумма задолженности на сумму BCY
|
contact.unused_credits_receivable_amount_bcy | double |
Сумма задолженности неиспользуемых кредитов BCY. |
|
Состояние
|
contact.status | string |
Состояние. |
|
Включено напоминание о платеже
|
contact.payment_reminder_enabled | boolean |
Включена ли напоминание о платеже. |
|
Настраиваемое поле
|
contact.custom_fields | array of object | |
|
Ценность
|
contact.custom_fields.value | string |
Значение настраиваемого поля. |
|
Index
|
contact.custom_fields.index | integer |
Номер индекса. |
|
Этикетка
|
contact.custom_fields.label | string |
Метка. |
|
Внимание
|
contact.billing_address.attention | string |
Имя внимания. |
|
Address
|
contact.billing_address.address | string |
Адрес. |
|
Улица
|
contact.billing_address.street2 | string |
Адрес улицы. |
|
Код региона
|
contact.billing_address.state_code | string |
Код состояния. |
|
Город
|
contact.billing_address.city | string |
Город. |
|
Государство
|
contact.billing_address.state | string |
Государство. |
|
Zip-архив
|
contact.billing_address.zip | string |
Почтовый индекс. |
|
Страна
|
contact.billing_address.country | string |
Страна. |
|
Факс
|
contact.billing_address.fax | string |
Номер факса. |
|
Телефон
|
contact.billing_address.phone | string |
Номер телефона. |
|
Внимание
|
contact.shipping_address.attention | string |
Имя внимания. |
|
Address
|
contact.shipping_address.address | string |
Адрес. |
|
Улица
|
contact.shipping_address.street2 | string |
Адрес улицы. |
|
Код региона
|
contact.shipping_address.state_code | string |
Код состояния. |
|
Город
|
contact.shipping_address.city | string |
Город. |
|
Государство
|
contact.shipping_address.state | string |
Государство. |
|
Zip-архив
|
contact.shipping_address.zip | string |
Почтовый индекс. |
|
Страна
|
contact.shipping_address.country | string |
Страна. |
|
Факс
|
contact.shipping_address.fax | string |
Номер факса. |
|
Телефон
|
contact.shipping_address.phone | string |
Номер телефона. |
|
Фейсбук
|
contact.facebook | string |
Учетная запись Facebook. |
|
Твиттер
|
contact.twitter | string |
Дескриптор Twitter. |
|
Контактные лица
|
contact.contact_persons | array of object | |
|
Приветствие
|
contact.contact_persons.salutation | string |
Приветствие. |
|
Имя (Первое имя)
|
contact.contact_persons.first_name | string |
Первое имя. |
|
Фамилия
|
contact.contact_persons.last_name | string |
Фамилия. |
|
Адрес электронной почты
|
contact.contact_persons.email | string |
Адрес электронной почты. |
|
Телефон
|
contact.contact_persons.phone | string |
Номер телефона. |
|
мобильное устройство
|
contact.contact_persons.mobile | string |
Номер мобильного телефона. |
|
Основной контакт
|
contact.contact_persons.is_primary_contact | boolean |
Является ли основным контактом. |
|
Идентификатор шаблона счета
|
contact.default_templates.invoice_template_id | string |
Идентификатор шаблона счета. |
|
Имя шаблона счета
|
contact.default_templates.invoice_template_name | string |
Имя шаблона счета. |
|
Оценка идентификатора шаблона
|
contact.default_templates.estimate_template_id | string |
Идентификатор шаблона оценки. |
|
Оценка имени шаблона
|
contact.default_templates.estimate_template_name | string |
Имя шаблона оценки. |
|
Идентификатор шаблона кредитных заметок
|
contact.default_templates.creditnote_template_id | string |
Идентификатор шаблона кредитной заметки. |
|
Имя шаблона кредитных заметок
|
contact.default_templates.creditnote_template_name | string |
Имя шаблона кредитной заметки. |
|
Идентификатор шаблона электронной почты счета
|
contact.default_templates.invoice_email_template_id | string |
Идентификатор шаблона электронной почты счета. |
|
Имя шаблона электронной почты счета
|
contact.default_templates.invoice_email_template_name | string |
Имя шаблона электронной почты счета. |
|
Оценка идентификатора шаблона электронной почты
|
contact.default_templates.estimate_email_template_id | string |
Оценка идентификатора шаблона электронной почты. |
|
Оценка имени шаблона электронной почты
|
contact.default_templates.estimate_email_template_name | string |
Имя шаблона электронной почты оценки. |
|
Идентификатор шаблона электронной почты с кредитными заметками
|
contact.default_templates.creditnote_email_template_id | string |
Идентификатор шаблона электронной почты для кредитной заметки. |
|
Имя шаблона электронной почты с кредитными заметками
|
contact.default_templates.creditnote_email_template_name | string |
Имя шаблона электронной почты с кредитными заметками. |
|
Примечания.
|
contact.notes | string |
Заметки. |
|
Время создания
|
contact.created_time | string |
Время создания. |
|
время последнего изменения;
|
contact.last_modified_time | string |
Время последнего изменения. |
Создать счет
Создает счет для клиента.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Отправка
|
send | boolean |
Следует ли отправлять счет. |
|
|
Игнорировать автоматическое создание чисел
|
ignore_auto_number_generation | boolean |
Следует ли игнорировать автоматическое создание чисел. |
|
|
Идентификатор клиента
|
customer_id | string |
Идентификатор клиента. |
|
|
Контактное лицо
|
contact_persons | array of integer |
Контактный человек. |
|
|
Номер счета
|
invoice_number | string |
Номер счета. |
|
|
Ссылочный номер
|
reference_number | string |
Номер ссылки. |
|
|
Место поставки
|
place_of_supply | string |
Место поставки. |
|
|
Обработка ндс
|
vat_treatment | string |
Обработка НДС. |
|
|
Обработка GST
|
gst_treatment | string |
Лечение GST. |
|
|
Налоговое лечение
|
tax_treatment | string |
Налоговое лечение. |
|
|
Использование CFI
|
cfdi_usage | string |
Использование CFI. |
|
|
GST-номер
|
gst_no | string |
Номер GST. |
|
|
ИД шаблона
|
template_id | string |
Идентификатор шаблона. |
|
|
Date
|
date | string |
Дата. |
|
|
Условия оплаты
|
payment_terms | integer |
Условия оплаты. |
|
|
Метка условий оплаты
|
payment_terms_label | string |
Метка условий оплаты. |
|
|
Срок
|
due_date | string |
Дата выполнения. |
|
|
Discount
|
discount | float |
Скидка. |
|
|
Скидка перед налогом
|
is_discount_before_tax | boolean |
Есть ли скидка перед налогом. |
|
|
Тип скидки
|
discount_type | string |
Тип скидки. |
|
|
Инклюзивный налог
|
is_inclusive_tax | boolean |
Независимо от того, включен ли налог. |
|
|
Курс
|
exchange_rate | float |
Обменный курс. |
|
|
Идентификатор повторяющегося счета
|
recurring_invoice_id | string |
Идентификатор повторяющегося счета. |
|
|
Идентификатор оценки по счету
|
invoiced_estimate_id | string |
Идентификатор оценки по счету. |
|
|
Имя продавца
|
salesperson_name | string |
Имя продавца. |
|
|
Этикетка
|
label | string |
Метка. |
|
|
Ценность
|
value | float |
Значение. |
|
|
Код проекта
|
project_id | string |
Идентификатор проекта. |
|
|
Идентификатор
|
item_id | string |
Идентификатор элемента. |
|
|
Код проекта
|
project_id | string |
Идентификатор проекта. |
|
|
Идентификаторы записи времени
|
time_entry_ids | array of integer |
Идентификаторы записи времени. |
|
|
Идентификатор затрат
|
expense_id | string |
Идентификатор расходов. |
|
|
Имя
|
name | string |
Имя. |
|
|
Тип продукта
|
product_type | string |
Тип продукта. |
|
|
HSN или SAC
|
hsn_or_sac | integer |
Номер HSN или SAC. |
|
|
Код ключа элемента SAT
|
sat_item_key_code | integer |
Код ключа элемента SAT. |
|
|
Код ключа единицы
|
unitkey_code | string |
Код ключа единицы. |
|
|
Description
|
description | string |
Описание. |
|
|
Заказ
|
item_order | integer |
Порядок элементов. |
|
|
Ставка
|
rate | float |
Частота. |
|
|
Количество
|
quantity | double |
Количество. |
|
|
Единица
|
unit | string |
Единица. |
|
|
Discount
|
discount | float |
Скидка. |
|
|
Идентификатор налогоплательщика
|
tax_id | string |
Идентификатор налога. |
|
|
Идентификатор налога TDS
|
tds_tax_id | string |
Идентификатор налога TDS. |
|
|
Идентификатор освобождения от налогов
|
tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
|
Код использования AvaTax
|
avatax_use_code | string |
Код AvaTax используется. |
|
|
Исключение AvaTax
|
avatax_exempt_no | string |
Номер исключения AvaTax. |
|
|
Имя налога
|
tax_name | string |
Имя налога. |
|
|
Тип налога
|
tax_type | string |
Тип налога. |
|
|
Процент налогов
|
tax_percentage | float |
Процент налога. |
|
|
Total
|
item_total | float |
Итог элемента. |
|
|
Сконфигурированный
|
configured | boolean |
Настроено ли значение. |
|
|
Дополнительное поле
|
additional_field1 | string |
Дополнительное поле. |
|
|
Имя
|
gateway_name | string |
Имя. |
|
|
Разрешить частичные платежи
|
allow_partial_payments | boolean |
Следует ли разрешать частичные платежи. |
|
|
Настраиваемый текст
|
custom_body | string |
Настраиваемый текст. |
|
|
Настраиваемый субъект
|
custom_subject | string |
Пользовательская тема. |
|
|
Примечания.
|
notes | string |
Заметки. |
|
|
Terms
|
terms | string |
Термины. |
|
|
Плата за доставку
|
shipping_charge | float |
Плата за доставку. |
|
|
Корректировка
|
adjustment | float |
Корректировка. |
|
|
Описание корректировки
|
adjustment_description | string |
Описание корректировки. |
|
|
Причина
|
reason | string |
Причина. |
|
|
Идентификатор налогового органа
|
tax_authority_id | string |
Идентификатор налогового органа. |
|
|
Идентификатор освобождения от налогов
|
tax_exemption_id | string |
Идентификатор освобождения от налогов. |
|
|
Код использования AvaTax
|
avatax_use_code | string |
Код AvaTax используется. |
|
|
Налоговый кодекс AvaTax
|
avatax_tax_code | string |
Налоговый код AvaTax. |
|
|
Номер исключения AvaTax
|
avatax_exempt_no | string |
Номер исключения AvaTax. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
|
Идентификатор
|
invoice.invoice_id | string |
Идентификатор счета. |
|
Оплата ACH, инициированная
|
invoice.ach_payment_initiated | boolean |
Была ли инициирована оплата ACH. |
|
Number
|
invoice.invoice_number | string |
Номер счета. |
|
Предварительная GST
|
invoice.is_pre_gst | boolean |
Указывает, является ли предварительная GST. |
|
Место поставки
|
invoice.place_of_supply | string |
Место поставки. |
|
GST-номер
|
invoice.gst_no | string |
Номер GST. |
|
Обработка GST
|
invoice.gst_treatment | string |
Лечение GST. |
|
Налоговое лечение
|
invoice.tax_treatment | string |
Налоговое лечение. |
|
Использование CFI
|
invoice.cfdi_usage | string |
Использование CFI. |
|
Обработка НДС
|
invoice.vat_treatment | string |
Обработка НДС. |
|
Регистрация НДС
|
invoice.vat_reg_no | string |
Номер регистрации НДС. |
|
Date
|
invoice.date | string |
Дата. |
|
Состояние
|
invoice.status | string |
Состояние. |
|
Условия оплаты
|
invoice.payment_terms | integer |
Условия оплаты. |
|
Метка условий оплаты
|
invoice.payment_terms_label | string |
Метка условий оплаты. |
|
Срок
|
invoice.due_date | string |
Дата выполнения. |
|
Ожидаемая дата оплаты
|
invoice.payment_expected_date | string |
Ожидаемая дата оплаты. |
|
Дата последнего платежа
|
invoice.last_payment_date | string |
Дата последнего платежа. |
|
Ссылочный номер
|
invoice.reference_number | string |
Номер ссылки. |
|
Идентификатор клиента
|
invoice.customer_id | string |
Идентификатор клиента. |
|
Имя клиента
|
invoice.customer_name | string |
Имя клиента. |
|
Контактные лица
|
invoice.contact_persons | array of string |
Контактные лица. |
|
Идентификатор валюты
|
invoice.currency_id | string |
Идентификатор валюты. |
|
Код Валюты
|
invoice.currency_code | string |
Код валюты. |
|
Курс
|
invoice.exchange_rate | double |
Обменный курс. |
|
Discount
|
invoice.discount | double |
Скидка. |
|
Скидка перед налогом
|
invoice.is_discount_before_tax | boolean |
Есть ли скидка перед налогом. |
|
Тип скидки
|
invoice.discount_type | string |
Тип скидки. |
|
Инклюзивный налог
|
invoice.is_inclusive_tax | boolean |
Независимо от того, включен ли налог. |
|
Идентификатор повторяющегося счета
|
invoice.recurring_invoice_id | string |
Идентификатор повторяющегося счета. |
|
Просмотр по клиенту
|
invoice.is_viewed_by_client | boolean |
Проверяется ли клиент. |
|
Имеет вложение
|
invoice.has_attachment | boolean |
Имеет ли вложение. |
|
Время просмотра клиента
|
invoice.client_viewed_time | string |
Время просмотра клиента. |
|
Элемент строки
|
invoice.line_items | array of object | |
|
Идентификатор
|
invoice.line_items.line_item_id | string |
Идентификатор элемента строки. |
|
Идентификатор
|
invoice.line_items.item_id | string |
Идентификатор элемента. |
|
Код проекта
|
invoice.line_items.project_id | string |
Идентификатор проекта. |
|
Имя проекта
|
invoice.line_items.project_name | string |
Имя проекта. |
|
Тип элемента
|
invoice.line_items.item_type | string |
Тип элемента. |
|
Тип продукта
|
invoice.line_items.product_type | string |
Тип продукта. |
|
time_entry_ids
|
invoice.line_items.time_entry_ids | array of integer |
time_entry_ids |
|
Идентификатор затрат
|
invoice.line_items.expense_id | string |
Идентификатор расходов. |
|
Имя квитанции о расходах
|
invoice.line_items.expense_receipt_name | string |
Имя квитанции о расходах. |
|
Имя
|
invoice.line_items.name | string |
Имя. |
|
Description
|
invoice.line_items.description | string |
Описание. |
|
Порядок элементов
|
invoice.line_items.item_order | integer |
Порядок элементов. |
|
Частота BCY
|
invoice.line_items.bcy_rate | double |
Частота BCY. |
|
Ставка
|
invoice.line_items.rate | double |
Частота. |
|
Количество
|
invoice.line_items.quantity | double |
Количество. |
|
Единица
|
invoice.line_items.unit | string |
Единица. |
|
Сумма скидки
|
invoice.line_items.discount_amount | double |
Сумма скидки. |
|
Discount
|
invoice.line_items.discount | double |
Скидка. |
|
Идентификатор
|
invoice.line_items.tax_id | string |
Идентификатор налога. |
|
Идентификатор налога TDS
|
invoice.line_items.tds_tax_id | string |
Идентификатор налога TDS. |
|
Имя
|
invoice.line_items.tax_name | string |
Имя налога. |
|
Тип налога
|
invoice.line_items.tax_type | string |
Тип налога. |
|
Процент налогов
|
invoice.line_items.tax_percentage | double |
Процент налога. |
|
Всего элементов
|
invoice.line_items.item_total | double |
Итог элемента. |
|
Код ключа элемента SAT
|
invoice.line_items.sat_item_key_code | integer |
Код ключа элемента SAT. |
|
Код ключа единицы
|
invoice.line_items.unitkey_code | string |
Код ключа единицы. |
|
Плата за доставку
|
invoice.shipping_charge | double |
Плата за доставку. |
|
Корректировка
|
invoice.adjustment | double |
Корректировка. |
|
Описание корректировки
|
invoice.adjustment_description | string |
Описание корректировки. |
|
Промежуточный итог
|
invoice.sub_total | double |
Промежуточный итог. |
|
Общий объем налогов
|
invoice.tax_total | double |
Общая сумма налога. |
|
Total
|
invoice.total | double |
Общее число. |
|
Налоги
|
invoice.taxes | array of object | |
|
Имя
|
invoice.taxes.tax_name | string |
Имя налога. |
|
Сумма
|
invoice.taxes.tax_amount | double |
Сумма налога. |
|
Включено напоминание о платеже
|
invoice.payment_reminder_enabled | boolean |
Включена ли напоминание о платеже. |
|
Оплата выполнена
|
invoice.payment_made | double |
Платеж выполнен. |
|
Примененные кредиты
|
invoice.credits_applied | double |
Примененные кредиты. |
|
Удержанная сумма налога
|
invoice.tax_amount_withheld | double |
Сумма налога удерживается. |
|
Баланс
|
invoice.balance | double |
Баланс. |
|
Списание суммы
|
invoice.write_off_amount | double |
Сумма списания. |
|
Разрешить частичные платежи
|
invoice.allow_partial_payments | boolean |
Следует ли разрешать частичные платежи. |
|
Точность цены
|
invoice.price_precision | integer |
Точность цены. |
|
Gateway
|
invoice.payment_options.payment_gateways | array of object | |
|
Сконфигурированный
|
invoice.payment_options.payment_gateways.configured | boolean |
Настроено ли значение. |
|
Дополнительное поле
|
invoice.payment_options.payment_gateways.additional_field1 | string |
Дополнительное поле. |
|
Имя
|
invoice.payment_options.payment_gateways.gateway_name | string |
Имя шлюза. |
|
Сообщение электронной почты
|
invoice.is_emailed | boolean |
Было ли отправлено сообщение электронной почты. |
|
Отправленные напоминания
|
invoice.reminders_sent | integer |
Количество отправленных напоминаний. |
|
Дата отправки последнего напоминания
|
invoice.last_reminder_sent_date | string |
Дата отправки последнего напоминания. |
|
Address
|
invoice.billing_address.address | string |
Адрес. |
|
Город
|
invoice.billing_address.city | string |
Город. |
|
Государство
|
invoice.billing_address.state | string |
Государство. |
|
Zip-архив
|
invoice.billing_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoice.billing_address.country | string |
Страна. |
|
Факс
|
invoice.billing_address.fax | string |
Номер факса. |
|
Address
|
invoice.shipping_address.address | string |
Адрес. |
|
Город
|
invoice.shipping_address.city | string |
Город. |
|
Государство
|
invoice.shipping_address.state | string |
Государство. |
|
Zip-архив
|
invoice.shipping_address.zip | string |
Почтовый индекс. |
|
Страна
|
invoice.shipping_address.country | string |
Страна. |
|
Факс
|
invoice.shipping_address.fax | string |
Номер факса. |
|
Примечания.
|
invoice.notes | string |
Заметки. |
|
Terms
|
invoice.terms | string |
Термины. |
|
Настраиваемое поле
|
invoice.custom_fields | array of object | |
|
Идентификатор
|
invoice.custom_fields.customfield_id | string |
Идентификатор настраиваемого поля. |
|
Тип данных
|
invoice.custom_fields.data_type | string |
Тип данных. |
|
Index
|
invoice.custom_fields.index | integer |
Номер индекса. |
|
Этикетка
|
invoice.custom_fields.label | string |
Метка. |
|
Показать в ФОРМАТЕ PDF
|
invoice.custom_fields.show_on_pdf | boolean |
Указывает, следует ли отображать в ФОРМАТЕ PDF. |
|
Отображение во всех PDF-файлах
|
invoice.custom_fields.show_in_all_pdf | boolean |
Следует ли отображать во всех PDF-файлах. |
|
Ценность
|
invoice.custom_fields.value | double |
Значение настраиваемого поля. |
|
ИД шаблона
|
invoice.template_id | string |
Идентификатор шаблона. |
|
Имя шаблона
|
invoice.template_name | string |
Имя шаблона. |
|
Время создания
|
invoice.created_time | string |
Время создания. |
|
время последнего изменения;
|
invoice.last_modified_time | string |
Время последнего изменения. |
|
Имя вложения
|
invoice.attachment_name | string |
Имя вложения. |
|
Возможность отправки почты
|
invoice.can_send_in_mail | boolean |
Может ли отправить почту. |
|
Идентификатор продавца
|
invoice.salesperson_id | string |
Идентификатор продавца. |
|
Имя продавца
|
invoice.salesperson_name | string |
Имя продавца. |
|
URL
|
invoice.invoice_url | string |
URL-адрес счета. |
Удаление контакта
Удаляет существующий контакт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contact_id | True | string |
Идентификатор контакта. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |
Удаление счета
Удаляет существующий счет. Счета, которые имеют платежную или кредитную заметку, не могут быть удалены.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор счета
|
invoice_id | True | string |
Идентификатор счета. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
code | integer |
Код состояния. |
|
Сообщение о состоянии
|
message | string |
Сообщение о состоянии. |