Blackbaud FENXT (предварительная версия)
Blackbaud Financial Edge NXT — это комплексное облачное программное решение для бухгалтерского учета, созданное специально для некоммерческих организаций. Используйте соединитель "Платежи" для управления счетами, поставщиками, заказами на покупку и связанными сущностями, найденными в NXT Финансового edge.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Поддержка Blackbaud |
| URL | https://www.blackbaud.com/support |
| Адрес электронной почты | skyapi@blackbaud.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Blackbaud, Inc. |
| Website | https://www.blackbaud.com/products/blackbaud-financial-edge-nxt |
| Политика конфиденциальности | https://www.blackbaud.com/privacy-shield |
| Категории | Продажи и CRM; Продуктивность |
Financial Edge NXT — это комплексное облачное программное обеспечение для бухгалтерского учета, созданное специально для некоммерческих организаций.
Этот соединитель построен на основе API Sky Blackbaud и предоставляет операции для управления счетами, поставщиками, заказами на покупку и связанными сущностями, найденными в Рамках Финансового пограничного NXT.
Дополнительные сведения см. в документации.
Предпосылки
Чтобы использовать этот соединитель, у вас должна быть учетная запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.
Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к вашей среде Blackbaud. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке .
Как получить учетные данные?
Администратор вашей организации отправит вам приглашение в среду NXT финансового edge организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.
Известные проблемы и ограничения
Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет применяться к вашим разрешениям пользователя в среде.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка вложений поставщика |
Выводит список вложений для поставщика. |
| Вывод списка номеров полей в счете 1099 |
Выводит номера поля 1099 для счета. |
| Методы контакта с адресом поставщика списка |
Выводит список методов контакта для адреса поставщика. |
| Обновление адреса поставщика |
Обновляет адрес поставщика. |
| Обновление поставщика |
Обновляет поставщика. |
| Обновление счета |
Обновляет счет. |
| Перечисление адресов поставщика |
Перечисляет адреса для поставщика. |
| Перечисление дистрибутивов по умолчанию поставщика |
Выводит список дистрибутивов по умолчанию для поставщика. |
| Перечисление заказов на покупку |
Выводит список доступных заказов на покупку. |
| Перечисление заметок и действий поставщика |
Выводит заметки и действия для поставщика. |
| Перечисление квитанций |
Выводит список доступных квитанций. |
| Перечисление корректировки счета |
Перечисляет корректировки для счета. |
| Перечисление счетов |
Выводит список доступных счетов. |
| Перечисление элементов строки заказа на покупку |
Выводит список элементов строки для заказа на покупку. |
| Получение заказа на покупку |
Возвращает сведения о заказе на покупку. |
| Получение квитанции |
Возвращает сведения о квитанции. |
| Получение корректировки счета |
Возвращает сведения о корректировке счета. |
| Получение поставщика |
Возвращает сведения о поставщике. |
| Получение сведений о поставщике 1099 |
Получите сведения о поставщике 1099. |
| Получение сведений о счете 1099 |
Возвращает сведения о счете 1099. |
| Получение счета |
Возвращает сведения о счете. |
| Получение элемента строки заказа на покупку |
Возвращает сведения о строке заказа на покупку. |
| Создание адреса поставщика |
Создает новый адрес поставщика. |
| Создание вложения поставщика |
Создает новое вложение поставщика. |
| Создание вложения счета |
Создает новое вложение счета. |
| Создание действия поставщика |
Создает действие поставщика. |
| Создание заказа на покупку |
Создает новый заказ на покупку. |
| Создание заметки поставщика |
Создает заметку о поставщике. |
| Создание метода контакта с адресом поставщика |
Создает новый метод контакта для адреса поставщика. |
| Создание поставщика |
Создает нового поставщика. |
| Создание счета (одно распределение) |
Создает новый счет с одним распределением. |
| Создание элемента строки заказа на покупку |
Создает новый элемент строки заказа на покупку. |
| Создать счет |
Создает новый счет с использованием дистрибутивов по умолчанию от указанного поставщика. |
| Список контактов поставщиков |
Выводит список контактов для поставщика. |
| Список поставщиков |
Выводит список доступных поставщиков. |
| Удаление адреса поставщика |
Удаляет адрес поставщика. |
| Удаление вложения поставщика |
Удаляет вложение поставщика. |
| Удаление корректировки счета |
Удаляет корректировку счета. |
| Удаление кредитной записки |
Удаляет кредитную записку. |
Вывод списка вложений поставщика
Выводит список вложений для поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Вывод списка номеров полей в счете 1099
Выводит номера поля 1099 для счета.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_id | True | integer |
Идентификатор системной записи счета. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Методы контакта с адресом поставщика списка
Выводит список методов контакта для адреса поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Идентификатор адреса
|
address_id | True | integer |
Идентификатор системной записи адреса поставщика. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Обновление адреса поставщика
Обновляет адрес поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Идентификатор адреса
|
address_id | True | integer |
Идентификатор системной записи для обновления адреса поставщика. |
|
Description
|
description | string |
Описание адреса. |
|
|
Страна
|
country | string |
Страна адреса. |
|
|
Линии адресов
|
address_line | string |
Линии улицы или адреса для адреса. Ограничение символов: 150. |
|
|
Город
|
city | string |
Город адреса. |
|
|
Государство
|
state | string |
Штат или провинция (или пригород в NZ) для адреса. |
|
|
Почтовый индекс
|
postal | string |
Почтовый индекс или ZIP-адрес. Ограничение символов: 12. |
|
|
Округ
|
county | string |
Округ адреса. |
|
|
Является ли основной?
|
is_primary | boolean |
Это основной адрес поставщика? |
|
|
Отправка счетов?
|
is_invoices | boolean |
Отправьте счета на этот адрес? |
|
|
Отправка POS?
|
is_pos | boolean |
Отправьте заказы на покупку на этот адрес? |
|
|
Отправить 1099s?
|
issue_1099s | boolean |
Отправьте 1099s на этот адрес? |
|
|
Название контакта
|
title | string |
Заголовок основного контакта. |
|
|
Имя контакта
|
first_name | string |
Имя основного контакта. |
|
|
Контактное имя
|
middle_name | string |
Средний инициал или имя первичного контакта. |
|
|
Фамилия контакта
|
last_name | string |
Фамилия основного контакта. |
|
|
Суффикс контакта
|
suffix | string |
Суффикс первичного контакта. |
|
|
Позиция контакта
|
position | string |
Позиция основного контакта. |
Возвращаемое значение
Созданный адрес поставщика
Обновление поставщика
Обновляет поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика для обновления. |
|
Имя
|
vendor_name | string |
Имя поставщика. Ограничение символов: 60. |
|
|
Тип
|
vendor_type | string |
Тип поставщика. |
|
|
Номер клиента
|
customer_number | string |
Номер клиента поставщика. |
|
|
Состояние
|
vendor_status | string |
Состояние поставщика. |
|
|
Проблема с оператором 1099?
|
issue_1099s | boolean |
Выдача инструкции 1099 для поставщика? |
|
|
Кредитный лимит?
|
has_credit_limit | boolean |
Имеет ли платеж по умолчанию кредитный лимит? |
|
|
Сумма кредитного лимита
|
credit_limit | decimal |
Лимит кредита по умолчанию для оплаты. |
|
|
Условия оплаты
|
payment_terms | string |
Условия оплаты (NET). |
|
|
Учетная запись оплаты
|
account_name | string |
Учетная запись, из которой необходимо платить счета. |
|
|
Метод оплаты
|
payment_method | string |
Метод оплаты. |
|
|
Вариант оплаты
|
payment_option | string |
Вариант оплаты. |
Возвращаемое значение
Созданный поставщик
- Тело
- APApi.CreatedVendor
Обновление счета
Обновляет счет.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_id | True | integer |
Идентификатор системной записи счета для обновления. |
|
Номер счета
|
invoice_number | string |
Номер счета. |
|
|
Дата счета
|
invoice_date | date |
Дата счета (например, "2005-09-18"). |
|
|
Срок
|
due_date | date |
Дата выполнения счета (например, "2005-09-18"). |
|
|
Состояние публикации
|
post_status | string |
Состояние записи для счета. |
|
|
Дата публикации
|
post_date | date |
Дата окончания счета (например, "2005-09-18"). |
|
|
Сумма
|
amount | decimal |
Сумма счета. |
|
|
Description
|
description | string |
Описание счета. |
|
|
Состояние утверждения
|
status | string |
Состояние утверждения для счета. |
|
|
Распространение скидок?
|
distribute_discounts | boolean |
Распространение скидок в счета-счетах расходов? |
|
|
Метод оплаты
|
payment_method | string |
Метод оплаты счета. |
|
|
Повторная отправка в
|
address_id | integer |
Повторное получение адреса для счета. |
|
|
Оплата из
|
paid_from | string |
Банк, с которого оплачивается счет. |
|
|
Идентификатор учетной записи карты
|
credit_card_account_id | integer |
Системный идентификатор учетной записи кредитной карты, из которой оплачивается счет. |
|
|
Идентификатор карточки
|
credit_card_id | integer |
Системный идентификатор кредитной карты, из которой оплачивается счет. |
|
|
Удерживайте платеж?
|
hold_payment | boolean |
Удерживайте платеж по этому счету? |
|
|
Отдельный платеж?
|
create_separate_payment | boolean |
Всегда создавайте отдельный платеж для этого счета? |
Возвращаемое значение
Созданный счет
- Тело
- APApi.CreatedInvoice
Перечисление адресов поставщика
Перечисляет адреса для поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Перечисление дистрибутивов по умолчанию поставщика
Выводит список дистрибутивов по умолчанию для поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию равно 100. Максимальное значение — 500. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Дистрибутивы
Перечисление заказов на покупку
Выводит список доступных заказов на покупку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Дата
|
from_date | date-time |
Отфильтруйте результаты для заказов на покупку, датированные или после указанной даты. |
|
|
Дата
|
to_date | date-time |
Отфильтруйте результаты по заказам на покупку, датированные или до указанной даты. |
|
|
Тип
|
type | string |
Тип заказа на покупку. |
|
|
Поиск текста
|
search_text | string |
Поиск текста, соответствующего имени поставщика или номера заказа на покупку. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию равно 100. Максимальное значение — 500. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Перечисление заметок и действий поставщика
Выводит заметки и действия для поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Перечисление квитанций
Выводит список доступных квитанций.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор заказа на покупку
|
purchase_order_id | integer |
Отфильтруйте результаты по квитанциям, связанным с указанным заказом на покупку. |
|
|
Получено
|
received_by | string |
Отфильтруйте результаты до квитанций, полученных указанным пользователем. |
|
|
Дата
|
from_date | date-time |
Отфильтруйте результаты до квитанций, датированные указанной датой или после указанной даты. |
|
|
Дата
|
to_date | date-time |
Отфильтруйте результаты до квитанций, датированные указанной датой или до указанной даты. |
|
|
Имя поставщика
|
vendor_name | string |
Поиск текста, соответствующего имени поставщика. |
|
|
Поиск текста
|
search_text | string |
Поиск текста в соответствии с описанием квитанции, номером квитанции, датой получения, номером заказа на покупку или номером счета. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию равно 100. Максимальное значение — 500. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Перечисление корректировки счета
Перечисляет корректировки для счета.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_id | True | integer |
Идентификатор системной записи счета. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Перечисление счетов
Выводит список доступных счетов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Дата
|
from_date | date-time |
Отфильтруйте результаты по счетам, датированному или после указанной даты. |
|
|
Дата
|
to_date | date-time |
Отфильтруйте результаты по счетам, датированные указанной датой или до указанной даты. |
|
|
Имя поставщика
|
vendor_name | string |
Поиск текста, соответствующего имени поставщика. |
|
|
Состояние
|
invoice_status | string |
Состояние счета. |
|
|
Состояние публикации
|
post_status | string |
Состояние записи счета. |
|
|
Метод оплаты
|
payment_method | string |
Метод оплаты счета. |
|
|
Поиск текста
|
search_text | string |
Найдите текст, соответствующий имени поставщика, номеру счета, описанию или номеру заказа на покупку. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию равно 100. Максимальное значение — 500. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты по счетам, добавленным или после указанной даты. |
|
|
Кем добавлено
|
added_by | string |
Отфильтруйте результаты по счетам, добавленным указанным пользователем. |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты по счетам, измененным или после указанной даты. |
|
|
Изменено пользователем
|
last_modified_by | string |
Отфильтруйте результаты до счетов, которые были изменены указанным пользователем. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Перечисление элементов строки заказа на покупку
Выводит список элементов строки для заказа на покупку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор заказа на покупку
|
purchase_order_id | True | integer |
Системный идентификатор заказа на покупку. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию равно 100. Максимальное значение — 500. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Получение заказа на покупку
Возвращает сведения о заказе на покупку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
purchase_order_id | True | integer |
Системный идентификатор заказа на покупку. |
Возвращаемое значение
Заказ на покупку
Получение квитанции
Возвращает сведения о квитанции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор квитанции
|
receipt_id | True | integer |
Системный идентификатор записи квитанции. |
Возвращаемое значение
Получение
- Тело
- APApi.ReceiptDetail
Получение корректировки счета
Возвращает сведения о корректировке счета.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_id | True | integer |
Идентификатор системной записи счета. |
|
Идентификатор корректировки
|
adjustment_id | True | integer |
Идентификатор системной записи корректировки счета. |
Возвращаемое значение
Корректировка счета
Получение поставщика
Возвращает сведения о поставщике.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
Возвращаемое значение
Поставщик
- Тело
- APApi.VendorDetail
Получение сведений о поставщике 1099
Получите сведения о поставщике 1099.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
Возвращаемое значение
Сведения 1099
Получение сведений о счете 1099
Возвращает сведения о счете 1099.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_id | True | integer |
Идентификатор системной записи счета. |
Возвращаемое значение
Форма 1099
- Тело
- APApi.Form1099
Получение счета
Возвращает сведения о счете.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_id | True | integer |
Идентификатор системной записи счета. |
Возвращаемое значение
Invoice
- Тело
- APApi.InvoiceDetail
Получение элемента строки заказа на покупку
Возвращает сведения о строке заказа на покупку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор заказа на покупку
|
purchase_order_id | True | integer |
Системный идентификатор заказа на покупку. |
|
Идентификатор элемента строки
|
line_item_id | True | integer |
Идентификатор системной записи элемента строки. |
Возвращаемое значение
Позиция
- Тело
- APApi.LineItemDetail
Создание адреса поставщика
Создает новый адрес поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Description
|
description | True | string |
Описание адреса. |
|
Страна
|
country | string |
Страна адреса. |
|
|
Линии адресов
|
address_line | string |
Линии улицы или адреса для адреса. Ограничение символов: 150. |
|
|
Город
|
city | string |
Город адреса. |
|
|
Государство
|
state | string |
Штат или провинция (или пригород в NZ) для адреса. |
|
|
Почтовый индекс
|
postal | string |
Почтовый индекс или ZIP-адрес. Ограничение символов: 12. |
|
|
Округ
|
county | string |
Округ адреса. |
|
|
Является ли основной?
|
is_primary | boolean |
Это основной адрес поставщика? |
|
|
Отправка счетов?
|
is_invoices | boolean |
Отправьте счета на этот адрес? |
|
|
Отправка POS?
|
is_pos | boolean |
Отправьте заказы на покупку на этот адрес? |
|
|
Отправить 1099s?
|
issue_1099s | boolean |
Отправьте 1099s на этот адрес? |
|
|
Название контакта
|
title | string |
Заголовок основного контакта. |
|
|
Имя контакта
|
first_name | string |
Имя основного контакта. |
|
|
Контактное имя
|
middle_name | string |
Средний инициал или имя первичного контакта. |
|
|
Фамилия контакта
|
last_name | string |
Фамилия основного контакта. |
|
|
Суффикс контакта
|
suffix | string |
Суффикс первичного контакта. |
|
|
Позиция контакта
|
position | string |
Позиция основного контакта. |
Возвращаемое значение
Созданный адрес поставщика
Создание вложения поставщика
Создает новое вложение поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
parent_id | True | integer |
Идентификатор системной записи поставщика. |
|
Тип
|
type | True | string |
Тип вложения. |
|
Имя
|
name | True | string |
Имя вложения. Ограничение символов: 150. |
|
Тип вложения
|
media_type | True | string |
Определяемая пользователем категория этого вложения. Доступные значения — это записи в таблице "Тип носителя" для родительской записи. Использование типов значений, определенных в /mediaTypes |
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и игнорируется для физических вложений. |
|
|
Содержимое файла
|
file | binary |
Двоичное содержимое вложения файла. Это необходимо для физических вложений и игнорируется для вложений ссылок. |
|
|
Имя файла
|
file_name | string |
Имя файла для вложения. Это необходимо для физических вложений и игнорируется для вложений ссылок. |
Возвращаемое значение
Созданное вложение поставщика
Создание вложения счета
Создает новое вложение счета.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
parent_id | True | integer |
Идентификатор системной записи счета. |
|
Тип
|
type | True | string |
Тип вложения. |
|
Имя
|
name | True | string |
Имя вложения. Ограничение символов: 150. |
|
Тип вложения
|
media_type | True | string |
Определяемая пользователем категория этого вложения. Доступные значения — это записи в таблице "Тип носителя" для родительской записи. Использование типов значений, определенных в /mediaTypes |
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и игнорируется для физических вложений. |
|
|
Содержимое файла
|
file | binary |
Двоичное содержимое вложения файла. Это необходимо для физических вложений и игнорируется для вложений ссылок. |
|
|
Имя файла
|
file_name | string |
Имя файла для вложения. Это необходимо для физических вложений и игнорируется для вложений ссылок. |
Возвращаемое значение
Созданное вложение счета
Создание действия поставщика
Создает действие поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Тип
|
type | True | string |
Тип действия. |
|
Date
|
date | True | date |
Дата действия (например, '2005-09-18'). |
|
Description
|
description | string |
Описание действия. Ограничение символов: 255. |
|
|
Кому назначено:
|
assign_to | True | string |
Пользователь, которому будет назначено действие. |
|
Завершено?
|
is_complete | boolean |
Завершено ли действие? |
|
|
Дата завершения
|
completed_date | date |
Дата завершения действия (например, "2005-09-18"). |
Возвращаемое значение
Действие созданного поставщика
Создание заказа на покупку
Создает новый заказ на покупку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Тип
|
type | True | string |
Тип заказа на покупку. |
|
Номер заказа
|
order_number | True | integer |
Номер заказа на покупку. |
|
Дата заказа
|
order_date | True | date |
Дата заказа (например, '2005-09-18'). |
|
Состояние
|
order_status | True | string |
Состояние заказа на покупку. |
|
Заказ из
|
order_from_contact_id | True | integer |
Идентификатор контакта поставщика для заказа на покупку. |
|
Отправка через
|
ship_via | True | string |
Метод доставки заказа на покупку. |
|
Кармашек для часов
|
fob | string |
Груз на борту заказа на покупку. |
|
|
Terms
|
terms | True | string |
Срок заказа на покупку. |
|
Покупатель
|
buyer | string |
Покупатель заказа на покупку. |
|
|
Отдел
|
department | string |
Отдел заказа на покупку. |
|
|
Подтверждение
|
ordered_by | string |
Упорядочение заказа на покупку. |
|
|
Отправка в
|
ship_to_address_id | integer |
Идентификатор корабля для адреса заказа на покупку. |
|
|
Действительно до
|
expiration_date | date-time |
Дата окончания срока действия заказа на покупку (требуется для заказов на покупку одеяла). |
|
|
Внимание
|
attention | string |
Сотрудник для внимания заказа на покупку. |
|
|
Comments
|
comments | string |
Комментарии заказа на покупку. |
Возвращаемое значение
Созданный заказ на покупку
Создание заметки поставщика
Создает заметку о поставщике.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Тип
|
type | True | string |
Тип заметки. |
|
Date
|
date | True | date |
Дата заметки (например, '2005-09-18'). |
|
Description
|
description | string |
Описание заметки. Ограничение символов: 255. |
|
|
Замечание
|
content | string |
Текст заметки. |
Возвращаемое значение
Заметка о созданном поставщике
Создание метода контакта с адресом поставщика
Создает новый метод контакта для адреса поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Идентификатор адреса
|
address_id | True | integer |
Идентификатор системной записи адреса поставщика. |
|
Тип контакта
|
contact_type | string |
Тип метода контакта. |
|
|
Контактные данные
|
contact_info | True | string |
Контактные данные (адрес электронной почты, номер телефона и т. д.) для этого метода. |
Возвращаемое значение
Метод контакта с адресом поставщика
Создание поставщика
Создает нового поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
vendor_name | True | string |
Имя поставщика. Ограничение символов: 60. |
|
Тип
|
vendor_type | string |
Тип поставщика. |
|
|
Идентификатор поставщика
|
ui_defined_id | string |
Определяемый пользователем идентификатор поставщика. |
|
|
Номер налогового идентификатора
|
tax_id_number | string |
Номер налогового идентификатора поставщика. |
|
|
Номер клиента
|
customer_number | string |
Номер клиента поставщика. |
|
|
Состояние
|
vendor_status | string |
Состояние поставщика. |
|
|
Проблема с оператором 1099?
|
issue_1099s | boolean |
Выдача инструкции 1099 для поставщика? |
|
|
Описание адреса
|
description | True | string |
Описание адреса. |
|
Адресная страна
|
country | string |
Страна адреса. |
|
|
Линии адресов
|
address_line | string |
Линии улицы или адреса для адреса. Ограничение символов: 150. |
|
|
Адрес города
|
city | string |
Город адреса. |
|
|
Состояние адреса
|
state | string |
Штат или провинция (или пригород в NZ) для адреса. |
|
|
Почтовый индекс адреса
|
postal | string |
Почтовый индекс или ZIP-адрес. Ограничение символов: 12. |
|
|
Адрес округа
|
county | string |
Округ адреса. |
|
|
Адрес является основным?
|
is_primary | boolean |
Это основной адрес поставщика? |
|
|
Отправка счетов?
|
is_invoices | boolean |
Отправьте счета на этот адрес? |
|
|
Отправка POS?
|
is_pos | boolean |
Отправьте заказы на покупку на этот адрес? |
|
|
Отправить 1099s?
|
is_1099 | boolean |
Отправьте 1099s на этот адрес? |
|
|
Название контакта
|
title | string |
Заголовок основного контакта. |
|
|
Имя контакта
|
first_name | string |
Имя основного контакта. |
|
|
Контактное имя
|
middle_name | string |
Средний инициал или имя первичного контакта. |
|
|
Фамилия контакта
|
last_name | string |
Фамилия основного контакта. |
|
|
Суффикс контакта
|
suffix | string |
Суффикс первичного контакта. |
|
|
Позиция контакта
|
position | string |
Позиция основного контакта. |
|
|
Кредитный лимит?
|
has_credit_limit | boolean |
Имеет ли платеж по умолчанию кредитный лимит? |
|
|
Сумма кредитного лимита
|
credit_limit | decimal |
Лимит кредита по умолчанию для оплаты. |
|
|
Условия оплаты
|
payment_terms | string |
Условия оплаты (NET). |
|
|
Учетная запись оплаты
|
account_name | string |
Учетная запись, из которой необходимо платить счета. |
|
|
Метод оплаты
|
payment_method | string |
Метод оплаты. |
|
|
Вариант оплаты
|
payment_option | string |
Вариант оплаты. |
|
|
Ветвь GST
|
gst_branch | string |
Идентификатор ветви GST для этого поставщика (применимо только для версий AU). |
|
|
Идентификатор типа налога GST
|
gst_tax_type_id | integer |
Идентификатор типа налога GST для поставщика (применимо только для версий ЦС и AU). |
|
|
Идентификатор кода действия PSB
|
psb_activity_code_id | integer |
Идентификатор кода действия PSB для поставщика (применимо только для версий ЦС). |
Возвращаемое значение
Созданный поставщик
- Тело
- APApi.CreatedVendor
Создание счета (одно распределение)
Создает новый счет с одним распределением.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Создаваемый счет. |
Возвращаемое значение
Созданный счет
- Тело
- APApi.CreatedInvoice
Создание элемента строки заказа на покупку
Создает новый элемент строки заказа на покупку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор заказа на покупку
|
purchase_order_id | True | integer |
Системный идентификатор заказа на покупку. |
|
Тип
|
type | True | string |
Тип элемента строки. В настоящее время поддерживаются только обычные элементы строки. |
|
Description
|
description | string |
Описание элемента строки. |
|
|
Единица измерения
|
unit_of_measure | string |
Единица измерения. |
|
|
Количество
|
quantity_ordered | True | decimal |
Упорядоченное количество. |
|
Затраты на единицу
|
unit_cost | True | decimal |
Затраты на единицу элемента строки. |
|
Расширенная стоимость
|
extended_cost | True | decimal |
Расширенная стоимость элемента строки. |
|
Номер части поставщика
|
vendor_part_number | string |
Номер части поставщика элемента строки. |
|
|
Код продукта
|
product_id | True | integer |
Идентификатор продукта для элемента строки. |
|
Отдел
|
department | string |
Отдел для элемента строки. |
|
|
Запрошено
|
requested_by | string |
Сотрудник, запрашивающий элемент строки. |
|
|
Доставка в
|
deliver_to | string |
Сотрудник, который будет доставлен в пункт строки. |
|
|
Состояние публикации
|
post_status | True | string |
Состояние записи для элемента строки. |
|
Дата публикации
|
post_date | date |
Дата публикации элемента строки (например, '2005-09-18'). |
|
|
Внутренние заметки
|
notes | string |
Внутренние заметки элемента строки. |
|
|
Внешние заметки
|
comments | string |
Внешние заметки для элемента строки. |
Создать счет
Создает новый счет с использованием дистрибутивов по умолчанию от указанного поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Номер счета
|
invoice_number | True | string |
Номер счета. |
|
Дата счета
|
invoice_date | True | date |
Дата счета (например, "2005-09-18"). |
|
Срок
|
due_date | True | date |
Дата выполнения счета (например, "2005-09-18"). |
|
Состояние публикации
|
post_status | True | string |
Состояние записи для счета. |
|
Дата публикации
|
post_date | True | date |
Дата окончания счета (например, "2005-09-18"). |
|
Сумма
|
amount | True | decimal |
Сумма счета. |
|
Description
|
description | True | string |
Описание счета. |
|
Состояние утверждения
|
approval_status | True | string |
Состояние утверждения для счета. |
|
Кредитная учетная запись
|
credit_account_number | True | string |
Номер кредитной учетной записи, используемый при создании дистрибутивов. |
|
Распространение скидок?
|
distribute_discounts | boolean |
Распространение скидок в счета-счетах расходов? |
|
|
Метод оплаты
|
payment_method | True | string |
Метод оплаты счета. |
|
Повторная отправка в
|
address_id | True | integer |
Повторное получение адреса для счета. |
|
Оплата из
|
paid_from | string |
Банк, с которого оплачивается счет. |
|
|
Идентификатор учетной записи карты
|
credit_card_account_id | integer |
Системный идентификатор учетной записи кредитной карты, из которой оплачивается счет. |
|
|
Идентификатор карточки
|
credit_card_id | integer |
Системный идентификатор кредитной карты, из которой оплачивается счет. |
|
|
Удерживайте платеж?
|
hold_payment | boolean |
Удерживайте платеж по этому счету? |
|
|
Отдельный платеж?
|
create_separate_payment | boolean |
Всегда создавайте отдельный платеж для этого счета? |
|
|
номер поля
|
number | True | string |
Номер поля. |
|
государство
|
state | string |
Состояние номера поля. |
|
|
количество
|
amount | True | decimal |
Номер поля. |
Возвращаемое значение
Созданный счет
- Тело
- APApi.CreatedInvoice
Список контактов поставщиков
Выводит список контактов для поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Список поставщиков
Выводит список доступных поставщиков.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Состояние
|
status | string |
Состояние поставщика. |
|
|
Имя поставщика
|
vendor_name | string |
Поиск текста, соответствующего имени поставщика. |
|
|
Идентификатор поставщика
|
ui_vendor_id | string |
Видимый пользователем идентификатор поставщика. |
|
|
Номер клиента
|
customer_number | string |
Номер клиента для поставщика. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию равно 100. Максимальное значение — 500. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты для поставщиков, добавленных или после указанной даты. |
|
|
Кем добавлено
|
added_by | string |
Отфильтруйте результаты для поставщиков, добавленных указанным пользователем. |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты для поставщиков, измененных по указанной дате или после нее. |
|
|
Изменено пользователем
|
last_modified_by | string |
Отфильтруйте результаты для поставщиков, которые последний раз изменили указанный пользователь. |
Возвращаемое значение
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
Удаление адреса поставщика
Удаляет адрес поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Идентификатор адреса
|
address_id | True | integer |
Идентификатор системной записи для удаления адреса поставщика. |
Удаление вложения поставщика
Удаляет вложение поставщика.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | True | integer |
Идентификатор системной записи поставщика. |
|
Идентификатор вложения
|
attachment_id | True | integer |
Идентификатор системной записи для удаления вложения поставщика. |
Удаление корректировки счета
Удаляет корректировку счета.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер счета
|
invoice_id | True | integer |
Идентификатор системной записи счета. |
|
Идентификатор корректировки
|
adjustment_id | True | integer |
Идентификатор системной записи для удаления корректировки счета. |
Удаление кредитной записки
Удаляет кредитную записку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кредитных memo
|
credit_memo_id | True | integer |
Идентификатор системной записи кредитной memo. |
Определения
APApi.AddressContactMethod
Метод контакта с адресом
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
contact_method_id | integer |
Идентификатор системной записи метода контакта адреса. |
|
type
|
contact_type | string |
Тип метода контакта. |
|
сведения
|
contact_info | string |
Сведения о методе контакта. |
APApi.AttachmentSummary
Attachment
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор системной записи вложения. |
|
Тип
|
type | string |
Тип вложения. |
|
Имя
|
name | string |
Имя вложения. |
|
URL
|
url | string |
URL-адрес для вложения. Применимо только для вложений ссылок. |
|
Тип вложения
|
media_type | string |
Определяемая пользователем категория этого вложения. |
|
date_attached
|
date_attached | date-time |
Дата добавления вложения. |
APApi.AttachmentSummaryCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.AttachmentSummary |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.CreatedInvoice
Созданный счет
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного счета. |
APApi.CreatedInvoiceAttachment
Созданное вложение счета
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного вложения. |
APApi.CreatedPurchaseOrder
Созданный заказ на покупку
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного заказа на покупку. |
APApi.CreatedVendor
Созданный поставщик
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного поставщика. |
APApi.CreatedVendorAction
Действие созданного поставщика
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного действия поставщика. |
APApi.CreatedVendorAddress
Созданный адрес поставщика
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного адреса поставщика. |
APApi.CreatedVendorAddressContactMethod
Метод контакта с адресом поставщика
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного метода контакта с адресом поставщика. |
APApi.CreatedVendorAttachment
Созданное вложение поставщика
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданного вложения. |
APApi.CreatedVendorNote
Заметка о созданном поставщике
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
record_id | integer |
Идентификатор только что созданной заметки поставщика. |
APApi.CustomField
Объект, содержащий сведения о настраиваемом поле.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
field_name | string |
Имя настраиваемого поля. |
|
type
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
value
|
value | string |
Значение настраиваемого поля. |
|
требуется?
|
is_required | boolean |
Требуется ли настраиваемое поле? |
|
date
|
date | date-time |
Дата настраиваемого поля. |
|
Комментарий
|
comments | string |
Комментарий к пользовательскому полю. |
APApi.DefaultDistribution
Распределение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
distribution_id | integer |
Идентификатор распространения. |
|
Тип
|
type_code | string |
Тип транзакции записи журнала для распределения. |
|
Номер учетной записи
|
account_number | string |
Номер учетной записи для распределения. |
|
Процент
|
percent | decimal |
Процент записи журнала распространения. |
|
Split
|
default_distribution_splits | array of APApi.DefaultDistributionSplit |
Список разделений для распределения по умолчанию. |
|
Настраиваемое поле
|
custom_fields | array of APApi.CustomField |
Список настраиваемых полей для распространения. |
APApi.DefaultDistributionCollection
Дистрибутивы
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.DefaultDistribution |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.DefaultDistributionSplit
Split
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
distribution_split_id | integer |
Идентификатор разделения распределения. |
|
percent
|
percent | decimal |
Процент записи журнала распространения. |
|
project
|
ui_project_id | string |
Видимый пользователем идентификатор проекта для разделения распределения. |
|
Class
|
account_class | string |
Класс учетной записи для разделения распределения. |
|
transaction_code_values
|
transaction_code_values | array of APApi.TransactionCodeValue |
Значения кода транзакции распространителя. |
APApi.Distribution
Объект, содержащий сведения о распределении.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
distribution_id | integer |
Идентификатор распространения. |
|
type
|
type_code | string |
Тип транзакции записи журнала для распределения. |
|
номер учетной записи
|
account_number | string |
Номер учетной записи для распределения. |
|
количество
|
amount | decimal |
Объем записи журнала рассылки. |
|
описание
|
description | string |
Описание распределения. |
|
split
|
distribution_splits | array of APApi.DistributionSplit |
Список разбиений для распределения. |
|
настраиваемое поле
|
custom_fields | array of APApi.CustomField |
Список настраиваемых полей для распространения. |
APApi.DistributionSplit
split
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
distribution_split_id | integer |
Идентификатор разделения распределения. |
|
количество
|
amount | decimal |
Объем записи журнала рассылки. |
|
project
|
ui_project_id | string |
Видимый пользователем идентификатор проекта для разделения распределения. |
|
класс
|
account_class | string |
Класс учетной записи для разделения распределения. |
|
transaction_code_values
|
transaction_code_values | array of APApi.TransactionCodeValue |
Значения кода транзакции распространителя. |
APApi.Form1099
Форма 1099
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сумма
|
amount | decimal |
Сумма, распределенная по 1099 году. |
|
Исключенная сумма
|
excluded_amount | decimal |
Сумма, исключенная из 1099 года. |
APApi.InvoiceAdjustmentDetail
Корректировка счета
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
adjustment_id | integer |
Идентификатор корректировки счета. |
|
Date
|
adjustment_date | date-time |
Дата корректировки счета. |
|
Состояние публикации
|
post_status | string |
Состояние записи для корректировки счета. |
|
Дата публикации
|
post_date | date-time |
Дата публикации для корректировки счета. |
|
Причина
|
reason | string |
Причина корректировки счета. |
|
Примечания.
|
notes | string |
Заметки о корректировке счета. |
|
count
|
adjustment_distributions.count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
adjustment_distributions.value | array of APApi.Distribution |
Список рассылки для корректировки счета. |
APApi.InvoiceAdjustmentSummary
Корректировка счета
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
adjustment_id | integer |
Идентификатор корректировки счета. |
|
Date
|
adjustment_date | date-time |
Дата корректировки счета. |
|
Состояние публикации
|
post_status | string |
Состояние записи для корректировки счета. |
|
Дата публикации
|
post_date | date-time |
Дата публикации для корректировки счета. |
|
Причина
|
reason | string |
Причина корректировки счета. |
|
Примечания.
|
notes | string |
Заметки о корректировке счета. |
APApi.InvoiceAdjustmentSummaryCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.InvoiceAdjustmentSummary |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.InvoiceDetail
Invoice
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
invoice_id | integer |
Идентификатор системной записи счета. |
|
Идентификатор поставщика
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Номер счета
|
invoice_number | string |
Номер счета. |
|
Дата счета
|
invoice_date | date-time |
Дата счета. |
|
Срок
|
due_date | date |
Дата выполнения счета (например, "2005-09-18"). |
|
Состояние публикации
|
post_status | string |
Состояние записи счета. |
|
Дата публикации
|
post_date | date |
Дата окончания счета (например, "2005-09-18"). |
|
Сумма
|
amount | decimal |
Сумма счета. |
|
Всего оплачено
|
total_paid | decimal |
Общая сумма, выплачиваемая по счету. |
|
Сальдо
|
balance | decimal |
Текущий баланс по счету. |
|
Сумма счета до уплаты налогов
|
invoice_amount_before_tax | decimal |
Сумма счета до уплаты налогов (применимо только для версий ЦС и AU). |
|
Включить налог?
|
include_tax | boolean |
Включите налог на этот счет (применимо только для версий ЦС и AU)? |
|
Сумма налога
|
tax_amount | decimal |
Сумма налога для счета (применимо только для версий ЦС и AU). |
|
Распределение налогов
|
tax_distribution | array of APApi.RebateDistribution |
Распределение налогов для счета (применимо только для версий AU). |
|
Идентификатор типа налога GST
|
gst_tax_type_id | integer |
Идентификатор типа налога GST для счета (применимо только для версий ЦС и AU). |
|
Сумма скидки GST
|
gst_rebate_amount | decimal |
Сумма скидки GST для счета (применимо только для версий ЦС). |
|
Распределение откатов GST
|
gst_rebate_distribution | array of APApi.RebateDistribution |
Распределение скидки GST для счета (применимо только для версий ЦС). |
|
Идентификатор кода действия PSB
|
psb_activity_code_id | integer |
Идентификатор кода действия PSB для счета (применимо только для версий ЦС). |
|
Сумма скидки по ТС
|
pst_rebate_amount | decimal |
Сумма скидки PST для счета (применимо только для версий ЦС). |
|
Распределение откатов по ТС
|
pst_rebate_distribution | array of APApi.RebateDistribution |
Распределение откатов PST для счета (применимо только для версий ЦС). |
|
Description
|
description | string |
Описание счета. |
|
Состояние утверждения
|
status | string |
Состояние утверждения для счета. |
|
Распространение скидок?
|
distribute_discounts | boolean |
Распространение скидок в счета-счетах расходов? |
|
Номер заказа на покупку
|
purchase_order_number | string |
Номер заказа на покупку, связанный с счетом. |
|
Метод оплаты
|
invoice_payment_detail.payment_method | string |
Метод оплаты счета. |
|
Идентификатор адреса
|
invoice_payment_detail.remit_to.address_id | integer |
Системный идентификатор записи для повторной отправки для счета. |
|
описание
|
invoice_payment_detail.remit_to.description | string |
Описание адреса. |
|
country
|
invoice_payment_detail.remit_to.country | string |
Страна адреса. |
|
линии адресов
|
invoice_payment_detail.remit_to.address_line | string |
Линии улицы или адреса для адреса. |
|
city
|
invoice_payment_detail.remit_to.city | string |
Город адреса. |
|
государство
|
invoice_payment_detail.remit_to.state | string |
Штат или провинция (или пригород в NZ) для адреса. |
|
почтовый индекс
|
invoice_payment_detail.remit_to.postal | string |
Почтовый индекс или ZIP-адрес. |
|
графство
|
invoice_payment_detail.remit_to.county | string |
Округ адреса. |
|
имя контакта
|
invoice_payment_detail.remit_to.contact_name | string |
Полное имя контакта для адреса. |
|
Оплата из
|
invoice_payment_detail.paid_from | string |
Банк, с которого оплачивается счет. |
|
Идентификатор учетной записи карты
|
invoice_payment_detail.credit_card_account_id | integer |
Системный идентификатор учетной записи кредитной карты, из которой оплачивается счет. |
|
Имя учетной записи карты
|
invoice_payment_detail.credit_card_account_name | string |
Имя учетной записи кредитной карты, из которой оплачивается счет. |
|
Идентификатор карточки
|
invoice_payment_detail.credit_card_id | integer |
Системный идентификатор кредитной карты, из которой оплачивается счет. |
|
Имя карточки
|
invoice_payment_detail.credit_card_name | string |
Имя кредитной карты, из которой был оплачен счет. |
|
Удерживайте платеж?
|
invoice_payment_detail.hold_payment | boolean |
Удерживайте платеж по этому счету? |
|
Отдельный платеж?
|
invoice_payment_detail.create_separate_payment | boolean |
Всегда создавайте отдельный платеж для этого счета? |
|
Уплата
|
invoice_payment_detail.payments | array of APApi.InvoicePaymentSummary |
Список платежей по счету. |
|
Распределение
|
distributions | array of APApi.Distribution |
Список рассылки для счета. |
|
Настраиваемое поле
|
custom_fields | array of APApi.CustomField |
Список настраиваемых полей для счета. |
|
Дата добавления
|
date_added | date-time |
Дата создания счета. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего счет. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения счета. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил счет. |
APApi.InvoicePaymentSummary
Объект, содержащий сводную информацию о платеже за счет.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор транзакции
|
br_transaction_id | integer |
Идентификатор транзакции для оплаты. |
|
номер транзакции
|
transaction_number | string |
Номер транзакции для этого платежа. |
|
date
|
payment_date | date-time |
Дата этого платежа (например, "2005-09-18"). |
|
статус
|
payment_status | string |
Состояние оплаты. |
|
количество
|
amount | decimal |
Сумма платежа. |
|
идентификатор проверки
|
checks_7_id | integer |
Идентификатор проверки из Financial Edge 7. |
APApi.InvoiceSummary
Invoice
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
invoice_id | integer |
Идентификатор системной записи счета. |
|
Идентификатор поставщика
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Состояние поставщика
|
vendor_status | string |
Состояние поставщика. |
|
Номер счета
|
invoice_number | string |
Номер счета. |
|
Дата счета
|
invoice_date | date-time |
Дата счета. |
|
Description
|
description | string |
Описание счета. |
|
Сумма
|
amount | decimal |
Сумма счета. |
|
Сумма к оплате
|
amount_due | decimal |
Сумма по-прежнему должна быть выставлена по счету. |
|
Сальдо
|
balance | decimal |
Текущий баланс по счету. |
|
Состояние
|
status | string |
Состояние счета. |
|
Состояние публикации
|
post_status | string |
Состояние записи счета. |
|
Метод оплаты
|
payment_method | string |
Метод оплаты счета. |
|
Возраст
|
age | string |
Возраст счета. |
|
Должно ли прошлое?
|
is_past_due | boolean |
Является ли счет прошлым? |
|
Номер заказа на покупку
|
purchase_order_number | string |
Номер заказа на покупку, связанный с счетом. |
|
Тип налога GST
|
gst_tax_type | string |
Тип налога для счета (применимо только для версий ЦС и AU). |
|
Дата добавления
|
date_added | date-time |
Дата создания счета. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего счет. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения счета. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил счет. |
APApi.InvoiceSummaryCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.InvoiceSummary |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.Invoice1099BoxNumber
Номер поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Номер поля
|
number | string |
Номер поля. |
|
Государство
|
state | string |
Состояние номера поля. |
|
Процент
|
percent | decimal |
Число поля. |
|
Сумма
|
amount | decimal |
Номер поля. |
APApi.Invoice1099BoxNumberCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
results
|
results | array of APApi.Invoice1099BoxNumber |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.LineItemDetail
Позиция
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор поставщика
|
vendor_id | integer |
Идентификатор поставщика для элемента строки заказа на покупку. |
|
Имя поставщика
|
vendor_name | string |
Имя поставщика для элемента строки заказа на покупку. |
|
Номер заказа
|
order_number | integer |
Номер заказа на покупку. |
|
Идентификатор
|
line_item_id | integer |
Идентификатор элемента строки. |
|
Номер строки
|
line_number | integer |
Число элементов строки. |
|
Тип
|
type | string |
Тип элемента строки. |
|
Код продукта
|
product_id | integer |
Идентификатор продукта элемента строки. |
|
Код продукта
|
product_code | string |
Код продукта элемента строки. |
|
Номер части поставщика
|
vendor_part_number | string |
Номер части поставщика элемента строки. |
|
Description
|
description | string |
Описание элемента строки. |
|
Единица измерения
|
unit_of_measure | string |
Единица измерения элемента строки. |
|
Упорядоченное количество
|
quantity_ordered | decimal |
Количество упорядоченных элементов строки. |
|
Полученное количество
|
quantity_received | decimal |
Количество, полученное из элемента строки. |
|
Отклонено количество
|
quantity_rejected | decimal |
Количество отклонено элемента строки. |
|
Количество отменено
|
quantity_cancelled | decimal |
Количество отменено элемента строки. |
|
Затраты на единицу
|
unit_cost | decimal |
Единица стоимости элемента строки. |
|
Расширенная стоимость
|
extended_cost | decimal |
Расширенная стоимость элемента строки. |
|
Состояние публикации
|
post_status | string |
Состояние записи элемента строки. |
|
Дата публикации
|
post_date | date-time |
Дата публикации элемента строки. |
|
Comments
|
comments | string |
Комментарии элемента строки. |
|
Состояние
|
status | string |
Состояние получения элемента строки. |
|
Отдел
|
department | string |
Отдел элемента строки. |
|
Доставка в
|
deliver_to | string |
Сотрудник, который будет доставлен в пункт строки. |
|
Распределение
|
distributions | array of APApi.Distribution |
Список дистрибутивов для элемента строки. |
|
Дата добавления
|
date_added | date-time |
Дата добавления элемента строки. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, который добавил элемент строки. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения элемента строки. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил элемент строки. |
APApi.LineItemSummary
Позиция
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
line_item_id | integer |
Идентификатор элемента строки. |
|
Номер строки
|
line_number | integer |
Число элементов строки. |
|
Тип
|
type | string |
Тип элемента строки. |
|
Код продукта
|
product_id | integer |
Идентификатор продукта элемента строки. |
|
Код продукта
|
product_code | string |
Код продукта элемента строки. |
|
Номер части поставщика
|
vendor_part_number | string |
Номер части поставщика элемента строки. |
|
Description
|
description | string |
Описание элемента строки. |
|
Единица измерения
|
unit_of_measure | string |
Единица измерения элемента строки. |
|
Упорядоченное количество
|
quantity_ordered | decimal |
Количество упорядоченных элементов строки. |
|
Полученное количество
|
quantity_received | decimal |
Количество, полученное из элемента строки. |
|
Отклонено количество
|
quantity_rejected | decimal |
Количество отклонено элемента строки. |
|
Количество отменено
|
quantity_cancelled | decimal |
Количество отменено элемента строки. |
|
Затраты на единицу
|
unit_cost | decimal |
Единица стоимости элемента строки. |
|
Расширенная стоимость
|
extended_cost | decimal |
Расширенная стоимость элемента строки. |
|
Состояние публикации
|
post_status | string |
Состояние записи элемента строки. |
|
Дата публикации
|
post_date | date-time |
Дата публикации элемента строки. |
|
Comments
|
comments | string |
Комментарии элемента строки. |
|
Состояние
|
status | string |
Состояние получения элемента строки. |
|
Отдел
|
department | string |
Отдел элемента строки. |
|
Доставка в
|
deliver_to | string |
Сотрудник, который будет доставлен в пункт строки. |
|
Дата добавления
|
date_added | date-time |
Дата добавления элемента строки. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, который добавил элемент строки. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения элемента строки. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил элемент строки. |
APApi.LineItemSummaryCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.LineItemSummary |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.PurchaseOrderDetail
Заказ на покупку
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
purchase_order_id | integer |
Системный идентификатор заказа на покупку. |
|
Идентификатор поставщика
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Тип
|
type | string |
Тип заказа на покупку. |
|
Номер заказа
|
order_number | integer |
Номер заказа на покупку. |
|
Дата заказа
|
order_date | date-time |
Дата заказа на покупку. |
|
Состояние
|
order_status | string |
Состояние заказа на покупку. |
|
Заказ по идентификатору контакта
|
ordered_from_contact_id | integer |
Идентификатор контакта для заказа на покупку. |
|
Отправка через
|
ship_via | string |
Метод доставки заказа на покупку. |
|
Кармашек для часов
|
fob | string |
Груз на борту заказа на покупку. |
|
Terms
|
terms | string |
Условия заказа на покупку. |
|
Покупатель
|
buyer | string |
Покупатель заказа на покупку. |
|
Отдел
|
department | string |
Отдел заказа на покупку. |
|
Подтверждение
|
ordered_by | string |
Упорядочение заказа на покупку. |
|
Отправка в
|
ship_to_address | string |
Корабль для адреса заказа на покупку. |
|
Внимание
|
attention | string |
Сотрудник для внимания заказа на покупку. |
|
Comments
|
comments | string |
Комментарии заказа на покупку. |
|
Total
|
order_total | decimal |
Общая сумма заказа на покупку. |
|
Итого с получением
|
receipted_total | decimal |
Итоговая сумма заказа на покупку. |
|
Дата добавления
|
date_added | date-time |
Дата создания заказа на покупку. |
|
Настраиваемое поле
|
custom_fields | array of APApi.CustomField |
Список настраиваемых полей для заказа на покупку. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего заказ на покупку. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения заказа на покупку. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который в последний раз изменил заказ на покупку. |
APApi.PurchaseOrderSummary
Заказ на покупку
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
purchase_order_id | integer |
Системный идентификатор заказа на покупку. |
|
Идентификатор поставщика
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Тип
|
type | string |
Тип заказа на покупку. |
|
Номер заказа
|
order_number | integer |
Номер заказа на покупку. |
|
Дата заказа
|
order_date | date-time |
Дата заказа на покупку. |
|
Состояние
|
order_status | string |
Состояние заказа на покупку. |
|
Total
|
order_total | decimal |
Общая сумма заказа на покупку. |
|
Итого с получением
|
receipted_total | decimal |
Итоговая сумма заказа на покупку. |
|
Terms
|
terms | string |
Условия заказа на покупку. |
|
Дата добавления
|
date_added | date-time |
Дата создания заказа на покупку. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего заказ на покупку. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения заказа на покупку. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который в последний раз изменил заказ на покупку. |
APApi.PurchaseOrderSummaryCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.PurchaseOrderSummary |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.RebateDistribution
Объект, содержащий сведения о распределении.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
distribution_id | integer |
Идентификатор распространения. |
|
идентификатор налоговой сущности
|
tax_entity_id | string |
Идентификатор налоговой сущности. |
|
type
|
type_code | string |
Тип транзакции записи журнала для распределения. |
|
номер учетной записи
|
account_number | string |
Номер учетной записи для распределения. |
|
количество
|
amount | decimal |
Объем записи журнала рассылки. |
|
описание
|
description | string |
Описание распределения. |
|
split
|
distribution_splits | array of APApi.DistributionSplit |
Список разбиений для распределения. |
|
настраиваемое поле
|
custom_fields | array of APApi.CustomField |
Список настраиваемых полей для распространения. |
APApi.ReceiptDetail
Получение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
receipt_id | integer |
Системный идентификатор записи квитанции. |
|
Номер квитанции
|
receipt_number | integer |
Номер квитанции. |
|
Получено
|
received_by | string |
Получатель квитанции. |
|
Дата прихода
|
receipt_date | date-time |
Дата получения. |
|
Description
|
description | string |
Описание квитанции. |
|
Общее количество квитанций
|
receipt_total | decimal |
Общая сумма квитанции. |
|
Идентификатор поставщика
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Идентификатор заказа на покупку
|
purchase_order_id | integer |
Системный идентификатор заказа на покупку, связанный с квитанцией. |
|
Номер заказа на покупку
|
purchase_order_number | string |
Номер заказа на покупку, связанный с квитанцией. |
|
Номер счета
|
invoice_id | integer |
Системный идентификатор счета, связанного с квитанцией. |
|
Номер счета
|
invoice_number | string |
Номер счета, связанный с квитанцией. |
|
Дата добавления
|
date_added | date-time |
Дата создания квитанции. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего квитанцию. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения квитанции. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил квитанцию. |
APApi.ReceiptSummary
Получение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
receipt_id | integer |
Системный идентификатор записи квитанции. |
|
Номер квитанции
|
receipt_number | integer |
Номер квитанции. |
|
Получено
|
received_by | string |
Получатель квитанции. |
|
Дата прихода
|
receipt_date | date-time |
Дата получения. |
|
Description
|
description | string |
Описание квитанции. |
|
Общее количество квитанций
|
receipt_total | decimal |
Общая сумма квитанции. |
|
Идентификатор поставщика
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Идентификатор заказа на покупку
|
purchase_order_id | integer |
Системный идентификатор заказа на покупку, связанный с квитанцией. |
|
Номер заказа на покупку
|
purchase_order_number | string |
Номер заказа на покупку, связанный с квитанцией. |
|
Номер счета
|
invoice_id | integer |
Системный идентификатор счета, связанного с квитанцией. |
|
Номер счета
|
invoice_number | string |
Номер счета, связанный с квитанцией. |
|
Дата добавления
|
date_added | date-time |
Дата создания квитанции. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего квитанцию. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения квитанции. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил квитанцию. |
APApi.ReceiptSummaryCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.ReceiptSummary |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.TransactionCodeValue
Значение кода транзакции
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор значения кода транзакции. |
|
Ценность
|
name | string |
Имя кода транзакции. |
|
Ценность
|
value | string |
Значение кода транзакции. |
|
Неактивный?
|
inactive | boolean |
Неактивно ли значение кода транзакции? |
APApi.Vendor1099Information
Сведения 1099
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
default_box_numbers
|
default_box_numbers | array of APApi.VendorDefaultBoxNumber |
Номера полей по умолчанию для поставщика. |
APApi.VendorAddress
Адрес поставщика
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
address_id | integer |
Идентификатор адреса. |
|
Description
|
description | string |
Описание адреса. |
|
Страна
|
country | string |
Страна адреса. |
|
Линии адресов
|
address_line | string |
Линии улицы или адреса для адреса. |
|
Город
|
city | string |
Город адреса. |
|
Государство
|
state | string |
Штат или провинция (или пригород в NZ) для адреса. |
|
Почтовый индекс
|
postal | string |
Почтовый индекс или ZIP-адрес. |
|
Округ
|
county | string |
Округ адреса. |
|
Является ли основной?
|
is_primary | boolean |
Это основной адрес поставщика? |
|
Отправка счетов?
|
is_invoices | boolean |
Отправьте счета на этот адрес? |
|
Отправка POS?
|
is_pos | boolean |
Отправьте заказы на покупку на этот адрес? |
|
Отправить 1099s?
|
is_1099 | boolean |
Отправьте 1099s на этот адрес? |
|
Имя получателя оплаты
|
payee_name | string |
Имя получателя. |
|
Название контакта
|
title | string |
Заголовок основного контакта. |
|
Имя контакта
|
first_name | string |
Имя основного контакта. |
|
Контактное имя
|
middle_name | string |
Средний инициал или имя первичного контакта. |
|
Фамилия контакта
|
last_name | string |
Фамилия основного контакта. |
|
Суффикс контакта
|
suffix | string |
Суффикс первичного контакта. |
|
Позиция контакта
|
position | string |
Позиция основного контакта. |
|
Метод Contact
|
address_contact_methods | array of APApi.AddressContactMethod |
Список методов контакта для адреса. |
APApi.VendorAddressCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
results
|
results | array of APApi.VendorAddress |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.VendorAddressContactMethod
Метод контакта с адресом поставщика
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
contact_method_id | integer |
Идентификатор метода контакта адреса. |
|
Тип контакта
|
contact_type | string |
Тип контакта. |
|
Контактные данные
|
contact_info | string |
Контактные данные. |
APApi.VendorAddressContactMethodCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
results
|
results | array of APApi.VendorAddressContactMethod |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.VendorContact
Контакт
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
vendor_contact_id | integer |
Идентификатор системной записи контакта. |
|
Имя
|
contact_display_name | string |
Отображаемое имя контакта. |
|
Описание адреса
|
address_description | string |
Описание адреса для контакта. |
|
Address
|
address_line | string |
Адресные строки для контакта. |
APApi.VendorContactCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.VendorContact |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.VendorDefaultBoxNumber
Номер поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Номер поля
|
number | string |
Номер поля. |
|
Состояние отчетов
|
state | string |
Состояние отчета для номера поля. |
|
Процент
|
percent | decimal |
Процент для номера поля. |
APApi.VendorDetail
Поставщик
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Идентификатор поставщика
|
ui_defined_id | string |
Определяемый пользователем идентификатор поставщика. |
|
Номер налогового идентификатора
|
tax_id_number | string |
Номер налогового идентификатора поставщика. |
|
Идентификатор кода действия PSB
|
psb_activity_code_id | integer |
Идентификатор кода действия PSB для поставщика (применимо только для версий ЦС). |
|
Код действия PSB
|
psb_activity_code | string |
Код действия PSB для поставщика (применимо только для версий ЦС). |
|
Описание кода действия PSB
|
psb_activity_code_desc | string |
Описание кода действия PSB для поставщика (применимо только для версий ЦС). |
|
Тип налога GST
|
gst_tax_type | string |
Тип налога GST для поставщика (применимо только для версий ЦС и AU). |
|
Описание типа налога GST
|
gst_tax_type_desc | string |
Описание типа налога GST для поставщика (применимо только для версий ЦС и AU). |
|
Ветвь GST
|
gst_branch | string |
Ветвь поставщика (применимо только для версий AU). |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Тип
|
vendor_type | string |
Тип поставщика. |
|
Номер клиента
|
customer_number | string |
Номер клиента поставщика. |
|
Состояние
|
vendor_status | string |
Состояние поставщика. |
|
Проблема с оператором 1099?
|
issue_1099s | boolean |
Выдача инструкции 1099 для поставщика? |
|
Баланс из-за
|
balance_due | decimal |
Баланс для поставщика. |
|
Address
|
addresses | array of APApi.VendorAddress |
Список адресов для поставщика. |
|
Настраиваемое поле
|
custom_fields | array of APApi.CustomField |
Список настраиваемых полей для поставщика. |
|
По умолчанию для оплаты
|
vendor_payment_default | APApi.VendorPaymentDefault |
По умолчанию платеж поставщика. |
|
Дата добавления
|
date_added | date-time |
Дата создания поставщика. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего поставщика. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения поставщика. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил поставщика. |
APApi.VendorNoteAction
Примечание/действие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
note_action_id | integer |
Идентификатор системной записи заметки или действия. |
|
Тип записи
|
note_type | string |
Тип записи (примечание или действие). |
|
Тип
|
type | string |
Тип заметки или действия. |
|
Date
|
date | date-time |
Дата заметки или действия. |
|
Description
|
description | string |
Описание заметки или действия. |
|
Замечание
|
content | string |
Содержимое заметки. |
|
Кому назначено:
|
assign_to | string |
Пользователь, которому назначено действие. |
|
Завершено?
|
is_complete | boolean |
Завершено ли действие? |
|
Дата завершения
|
completed_date | date-time |
Дата завершения действия. |
APApi.VendorNoteActionCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
results
|
results | array of APApi.VendorNoteAction |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
APApi.VendorPaymentDefault
По умолчанию платеж поставщика.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
кредитный лимит?
|
has_credit_limit | boolean |
Имеет ли платеж по умолчанию кредитный лимит? |
|
сумма кредитного лимита
|
credit_limit | decimal |
Лимит кредита по умолчанию для оплаты. |
|
Условия
|
payment_terms | string |
Условия оплаты (NET). |
|
имя учетной записи
|
account_name | string |
Учетная запись, из которой необходимо платить счета. |
|
method
|
payment_method | string |
Метод оплаты. |
|
Опция
|
payment_option | string |
Вариант оплаты. |
APApi.VendorSummary
Поставщик
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
vendor_id | integer |
Идентификатор системной записи поставщика. |
|
Идентификатор поставщика
|
ui_defined_id | string |
Определяемый пользователем идентификатор поставщика. |
|
Имя
|
vendor_name | string |
Имя поставщика. |
|
Номер клиента
|
customer_number | string |
Номер клиента поставщика. |
|
Состояние
|
vendor_status | string |
Состояние поставщика. |
|
Проблема с оператором 1099?
|
issue_1099s | boolean |
Выдача инструкции 1099 для поставщика? |
|
Баланс из-за
|
balance_due | decimal |
Баланс для поставщика. |
|
Метод оплаты
|
payment_method | string |
Метод оплаты по умолчанию для поставщика. |
|
Идентификатор
|
primary_address.address_id | integer |
Идентификатор системной записи адреса. |
|
описание
|
primary_address.description | string |
Описание адреса. |
|
country
|
primary_address.country | string |
Страна адреса. |
|
обводы
|
primary_address.address_line | string |
Линии улицы или адреса для адреса. |
|
city
|
primary_address.city | string |
Город адреса. |
|
государство
|
primary_address.state | string |
Штат или провинция (или пригород в NZ) для адреса. |
|
почтовый индекс
|
primary_address.postal | string |
Почтовый индекс или ZIP-адрес. |
|
графство
|
primary_address.county | string |
Округ адреса. |
|
является основным?
|
primary_address.is_primary | boolean |
Это основной адрес поставщика? |
|
отправка счетов?
|
primary_address.is_invoices | boolean |
Отправьте счета на этот адрес? |
|
отправить POs?
|
primary_address.is_pos | boolean |
Отправьте заказы на покупку на этот адрес? |
|
отправить 1099s?
|
primary_address.is_1099 | boolean |
Отправьте 1099s на этот адрес? |
|
Название контакта
|
primary_address.title | string |
Заголовок основного контакта. |
|
имя контакта
|
primary_address.first_name | string |
Имя основного контакта. |
|
контактное имя
|
primary_address.middle_name | string |
Средний инициал или имя первичного контакта. |
|
фамилия контакта
|
primary_address.last_name | string |
Фамилия основного контакта. |
|
суффикс контакта
|
primary_address.suffix | string |
Суффикс первичного контакта. |
|
положение контакта
|
primary_address.position | string |
Позиция основного контакта. |
|
address_contact_methods
|
primary_address.address_contact_methods | array of APApi.AddressContactMethod |
Список методов контакта для адреса. |
|
По умолчанию для оплаты
|
payment_defaults | APApi.VendorPaymentDefault |
По умолчанию платеж поставщика. |
|
Дата добавления
|
date_added | date-time |
Дата создания поставщика. |
|
Кем добавлено
|
added_by | string |
Имя пользователя, создавшего поставщика. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения поставщика. |
|
Изменено пользователем
|
modified_by | string |
Имя пользователя, который последний раз изменил поставщика. |
APApi.VendorSummaryCollection
Получение данных сразу становится неуправляемым. Сущность коллекции помогает возвращать блоки с разбивкой на страницы больших наборов данных. Эта сущность включает полезные метаданные и свойства для разбивки на страницы и итерации данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. |
|
value
|
value | array of APApi.VendorSummary |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |