Счета и товары¶
Примечание
Данный функционал является платным. Уточните стоимость у своего менеджера или напишите нам на info@megaplan.ru.
Счета¶
Карточка счета¶
URI: /BumsInvoiceApiV01/Invoice/card.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID счета |
RequestedFields |
array |
Запрашиваемые поля ( меняет набор полей по умолчанию ) |
ExtraFields |
array |
Дополнительные поля ( дополняют набор полей по умолчанию ) |
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID счета |
Name |
string |
Имя счета |
Number |
integer |
Номер счета |
Date |
datetime |
Дата создания счета |
ActualPaymentDate |
datetime |
Дата оплаты счета |
Status |
object (Id, Name) |
Статус |
Sum |
array( Value, Currency) |
Сумма (значение и валюта) |
Recipient |
object (Id, Name) |
Получатель (объект типа «Плательщик») |
Payer |
object (Id, Name) |
Плательщик (объект типа «Плательщик») |
Consignee |
object (Id, Name) |
Грузополучатель (объект типа «Плательщик») |
InvoiceRows |
array |
Строки счета |
Удаление счета¶
URI: /BumsInvoiceApiV01/Invoice/delete.api|xml
Входные параметры¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор счета |
Список счетов¶
URI: /BumsInvoiceApiV01/Invoice/list.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
FilterFields |
array |
Массив для фильтрации в формате поле => значение |
RequestedFields |
array |
Запрашиваемые поля ( меняет набор полей по умолчанию ) |
ExtraFields |
array |
Дополнительные поля ( дополняют набор полей по умолчанию ) |
Limit |
integer |
Сколько выбрать объектов (LIMIT) |
Offset |
integer |
Начиная с какого выбирать объекты (OFFSET) |
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID счета |
Name |
string |
Наименование счета |
Number |
integer |
Номер счета |
Date |
datetime |
Дата создания счета |
Status |
object (Id, Name) |
Статус |
Sum |
array( Value, Currency) |
Сумма (значение и валюта) |
Recipient |
object (Id, Name) |
Получатель |
Payer |
object (Id, Name) |
Плательщик |
Consignee |
object (Id, Name) |
Грузополучатель |
Поля доступные для фильтрации (параметр FilterFields)¶
Поле |
Тип |
Описание |
|---|---|---|
Number |
string |
Номер |
Recipient |
object (Id, Name) |
Получатель |
Payer |
object (Id, Name) |
Плательщик |
Consignee |
object (Id, Name) |
Грузополучатель |
Date |
date |
Дата документа |
Comment |
string |
Комментарий к оплате |
Status |
object (Id, Name) |
Статус |
Sum |
money |
Сумма |
TimeCreated |
datetime |
Дата создания |
TimeUpdated |
datetime |
Дата изменения |
Deadline |
date |
Срок оплаты счёта |
Conditions |
string |
Условия |
PaymentOrderNumber |
string |
Основание платежа |
SumWithoutDiscount |
money |
Сумма без скидки |
Discount |
money |
Скидка |
Trade |
integer |
Id сделки |
Создание/изменение счета¶
URI: /BumsInvoiceApiV01/Invoice/save.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID счета |
Model[Recipient] |
integer |
ID получателя |
Model[Payer] |
integer |
ID плательщика |
Model[Consignee] |
integer |
ID грузополучателя |
Model[Date] |
datetime |
Дата создания счета |
Model[Deadline] |
datetime |
Срок оплаты счета |
Model[PaymentOrderNumber] |
string |
Основание платежа |
Model[Comment] |
string |
Комментарий |
Model[Conditions] |
string |
Условия |
Model[Status] |
integer |
Статус счета (1 - Черновик, 2 - Выставлен, 3 - Оплачен, 4 - Отказ) |
Deal |
integer |
Id сделки, к которой относится счет |
Выходные данные¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор счета |
Удаление позиции счета¶
URI: /BumsInvoiceApiV01/InvoiceRow/delete.api|xml
Входные параметры¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор строки счета |
Создание/изменение позиции счета¶
URI: /BumsInvoiceApiV01/InvoiceRow/save.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID строки счета |
Model[Invoice] |
integer |
ID счета |
Model[Unit] |
integer |
ID единицы измерения |
Model[Quantity] |
float |
Количество |
Model[OrderPos] |
integer |
Номер позиции в счете |
Model[Name] |
string |
Наименование позиции |
Model[Offer] |
integer |
ID товара |
Model[Description] |
string |
Описание |
Model[DiscountValue] |
float |
Скидка |
Model[DiscountType] |
integer |
Тип скидки |
Model[Tax] |
integer |
ID налога |
Model[Description] |
string |
Описание |
Model[Price] |
float |
Цена: значение |
** Валюта и курс автоматически выбираются из счёта
Выходные данные¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор позиции счета |
Товары¶
Удаление товара¶
URI: /BumsInvoiceApiV01/Offer/delete.api|xml
Входные параметры¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор товара |
Список товаров¶
URI: /BumsInvoiceApiV01/Offer/list.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Limit |
integer |
Количество выбираемых товаров |
Offset |
integer |
Порядковый номер, начиная с которого осуществляется выборка |
FilterFields |
array |
Массив вида <название поля> => <значение> |
RequestedFields |
array |
Набор требуемых полей, по умолчанию возвращаются поля „Id“, „Name“, „Price“, „Article“ |
ExtraFields |
array |
Набор полей, которые требуется вернуть дополнительно к набору по умолчанию. |
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор товара |
Name |
string |
Наименование товара |
Price |
float |
Цена |
Article |
string |
Артикул |
Создание/изменение товара¶
URI: /BumsInvoiceApiV01/Offer/save.api|xml
Входные параметры¶
Имя поля |
Тип |
Описание |
Примечание |
|---|---|---|---|
Id |
integer |
Идентификатор товара |
Если ID не не указан, то будет создан новый товар |
Model[Name] |
string |
Наименование товара |
|
Model[Count] |
float |
Количество |
|
Model[Price] |
object |
Цена |
|
Model[Price].Value |
float |
Цена: значение |
|
Model[Price].Currency |
integer |
Цена: ID валюты |
|
Model[Price].CurrencyAbbreviation |
integer |
Цена: код валюты в справочнике |
Используется, если не указан ID валюты. Если не указан ни ID валюты, ни код - будет использована валюта по умолчанию. |
Model[Price].Rate |
float |
Цена: курс валюты |
Если не указан - будет использован текущий курс валюты в системе. |
Model[Unit] |
integer |
ID единицы измерения |
|
Model[Tax] |
integer |
ID налога |
|
Model[Article] |
string |
Артикул товара |
Выходные данные¶
Имя поля |
Тип |
Описание |
|---|---|---|
offer |
array |
|
offer.Id |
integer |
Идентификатор товара |
offer.Name |
string |
Наименование товара |
offer.Class |
… |
… |
offer.Count |
float |
Количество |
offer.Price |
object |
Цена |
offer.Price.Value |
float |
Цена: значение |
offer.Price.Currency |
integer |
Цена: ID валюты |
offer.Price.CurrencyAbbreviation |
integer |
Цена: код валюты в справочнике |
offer.Price.Rate |
float |
Цена: курс валюты |
offer.Unit |
object |
Единица измерения |
offer.Unit.Id |
integer |
Единица измерения: ID |
offer.Unit.Name |
string |
Единица измерения: название |
offer.Tax |
object |
Налог |
offer.Tax.Id |
integer |
Налог: ID |
offer.Tax.Name |
string |
Налог: название |
offer.Article |
string |
Артикул товара |