POST api/customers/{id}/documents

Метод для создания "Документа клиента"

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/customers/{id}/documents

  Для этого метода требуется авторизация

Информация о запросе

URL параметры

НазваниеОписаниеТип данныхДополнительная информация
id

Уникальный идентификатор "Клиента"

 string

Required

Тело запроса

"Документ"

CreateDocumentModel
НазваниеОписаниеТип данныхДополнительная информация
VendorId

string

Длина: от 1 до 100

Соответствует регулярному выражению: ^[a-zA-Zа-яА-Я0-9_-]+$
Number

string

Обязательное поле

Длина: от 1 до 20
Name

string

Обязательное поле

Длина: от 1 до 100
TypeId

globally unique identifier

Обязательное поле
DocumentDate

date

Нет
DateFrom

date

Нет
DateTill

date

Нет
Sum

decimal number

Нет
Content

Collection of byte

Нет
Active

boolean

Нет

Форматы запросов

{
  "vendorId": "sample string 1",
  "number": "sample string 2",
  "name": "sample string 3",
  "typeId": "b87a695c-fb1e-45a4-b9ea-40eb46af1a5f",
  "documentDate": "2024-10-06T19:19:47.0865388Z",
  "dateFrom": "2024-10-06T19:19:47.0865388Z",
  "dateTill": "2024-10-06T19:19:47.0865388Z",
  "sum": 1.0,
  "content": "QEA=",
  "active": true
}

<CreateDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents">
  <Active>true</Active>
  <Content>QEA=</Content>
  <DateFrom>2024-10-06T19:19:47.0865388+00:00</DateFrom>
  <DateTill>2024-10-06T19:19:47.0865388+00:00</DateTill>
  <DocumentDate>2024-10-06T19:19:47.0865388+00:00</DocumentDate>
  <Name>sample string 3</Name>
  <Number>sample string 2</Number>
  <Sum>1</Sum>
  <TypeId>b87a695c-fb1e-45a4-b9ea-40eb46af1a5f</TypeId>
  <VendorId>sample string 1</VendorId>
</CreateDocumentModel>

Sample not available.

Информация об ответе

ResourceIdModel
НазваниеОписаниеТип данныхДополнительная информация
Id

globally unique identifier

Нет

Форматы ответа

{
  "id": "2c3687b2-d4fe-41b1-be1a-f97651c4d92f"
}

<ResourceIdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Alt.Api.Models.Response">
  <Id>2c3687b2-d4fe-41b1-be1a-f97651c4d92f</Id>
</ResourceIdModel>