Общие методы

Данные методы работают со всеми типами документов

Содержание:

Поиск документов пользователя
Перенос документов в папку «Архив» или «Корзина» либо восстановление из них

Поиск документов пользователя

Позволяет получить и отфильтровать список документов пользователя.

Можно указывать в теле запроса фильтры, например, по типу и/или нахождению документа в определенном разделе (например, во «Входящих»). По умолчанию документы из папок «Черновики», «Архив», и «Корзина» не возвращаются (для их получения нужно передать соответствующие параметры).

Поиск по документам

post

/gw/tokugawa/v1/common_api/documents/search

Развернуть все Свернуть все

body

{...}

limit: integer

>=1 and <= 100

updated_at__lt: date-time

filters:{...}

query: string

type: enum

[СЧФ, СЧФДОППродавец, СЧФДОППокупатель, ДОППродавец, ДОППокупатель, КорСЧФ, КорСЧФДИСПродавец, КорСЧФДИСПокупатель, КорДИСПродавец, КорДИСПокупатель, ИзвещениеОПолучении, ПодтверждениеОператораОбОтправке, ПодтверждениеОператораОПолучении, УведомлениеОбУточнении, ЗапросНаАннулирование, заказ, заявка (к договору), заявка, поручение экспедитору, договор, акт, заказ услуги по оформлению пропусков в г. москва, договор-заявка, заказ (договор-заявка), заказ (табличный вид), заявка к договору (табличный вид), счет, счет-фактура, УПД (счет-фактура), уведомление об отказе от исполнения, уведомление о расторжении в двустороннем порядке, акт о срыве, уведомление о составлении акта о непредъявлении груза для перевозки, уведомление о составлении акта о непредъявлении транспортного средства под погрузку, доверенность, информационное письмо, другой, акт сверки, доп. соглашение (к договору), накладная, товарная накладная, транспортная накладная, товарно-транспортная накладная, поздравительная открытка, unknown]

An enumeration.

status: enum

[AWAITING_CONFIRMATION_SIGN, WAITING_FOR_REVOKE, CORRECTION_REQUESTED, AWAITING_DECISION, REVOKED, EDO_DONE, APPROVED, DECLINED, SIGNED, NEW_EDITION, CANCELLED, DRAFT]

An enumeration.

contragent_ati_code: string

edo_user: string

ID участника ЭДО(текущего пользователя)

number: string

Номер документа

date_from: date

date_to: date

direction: enum

[incoming, outgoing]

An enumeration.

is_deleted: boolean

is_archived: boolean

is_template: boolean

}

CURL

Копировать

Пример ответа

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"total":0,

"total_remaining":0,

"result":[...]

{...}

"id":"string",

"is_riak":false,

"direction":"incoming",

"number":"string",

"date":"1970-01-01",

"type":"УПД. Счет-фактура",

"status":"string",

"is_read":false,

"updated_at":"1970-01-01T00:00:00.000Z",

"contragent":{...},

"ati_code":"string",

"name":"string"

"comments":{...},

"count":0,

"tail":{...}

"name":"string",

"text":"string",

"timestamp":"1970-01-01T00:00:00.000Z"

}

"flags":[...],

"string"

"highlight":"failure",

"signs":{...},

"user":{...},

"title":"string",

"valid_from":"string",

"valid_until":"string"

"contragent":{...}

"title":"string",

"valid_from":"string",

"valid_until":"string"

}

"template_name":"string"

}

]

}

{...}

total*: integer

total_remaining*: integer

result*:[{...}]

id*: string

is_riak: boolean

direction*: enum

[incoming, outgoing]

An enumeration.

number: string

date: date

type*: enum

[УПД. Счет-фактура, УПД. Счет-фактура и акт, УПД. Акт, УКД. Корректировочный счет-фактура, УКД. Корректировочный счет-фактура и акт, УКД. Корректировочный акт, заказ, заявка (к договору), заявка, поручение экспедитору, договор, акт, заказ услуги по оформлению пропусков в г. москва, договор-заявка, заказ (договор-заявка), заказ (табличный вид), заявка к договору (табличный вид), счет, счет-фактура, УПД (счет-фактура), уведомление об отказе от исполнения, уведомление о расторжении в двустороннем порядке, акт о срыве, уведомление о составлении акта о непредъявлении груза для перевозки, уведомление о составлении акта о непредъявлении транспортного средства под погрузку, доверенность, информационное письмо, другой, акт сверки, доп. соглашение (к договору), накладная, товарная накладная, транспортная накладная, товарно-транспортная накладная, поздравительная открытка, unknown]

An enumeration.

status*: string

is_read*: boolean

updated_at*: date-time

contragent:{...}

ati_code*: string

name*: string

}

comments*:{...}

count*: integer

Количество комментариев

tail:{...}

name*: string

text*: string

timestamp*: date-time

}

flags*: [string]

highlight: enum

[failure, success, ]

An enumeration.

signs*:{...}

user:{...}

title*: string

valid_from*: string

valid_until*: string

}

contragent:{...}

title*: string

valid_from*: string

valid_until*: string

}

template_name: string

}]

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Перенос документов в папку «Архив» или «Корзина» либо восстановление из них

Переносит указанный документ в указанную папку либо восставливает из нее. Может принимать несколько документов за раз.

«Action» может принимать значения «trash», «archive», «restore_from_trash» или «restore_from_archive». При невозможности выполнения действия возвращается id документа(-ов), по которым действие не произведено.

Перемещение документов

post

/gw/tokugawa/v1/common_api/documents/{action}

action

string

                    
                      Развернуть все
                      
                      Свернуть все
                      
body

                        array
                      
                      [
  "string"
]

        [string]

CURL

Копировать

Пример ответа

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

[...]

"string"

]

[string]

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...