POST api/payments

Метод для создания "Оплаты"

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/payments

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

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

URL параметры

Нет

Тело запроса

"Оплата"

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

string

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

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

globally unique identifier

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

string

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

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

string

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

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

string

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

integer

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

Интервал: с 1 по 2
CurrencyId

string

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

Максимальная длина: 3

Минимальная длина: 3
DebtCurrencyId

string

Максимальная длина: 3

Минимальная длина: 3
Sum

decimal number

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

Интервал: с -2147483647 по 2147483646
Notes

string

Длина: от 0 до 500
StatusDescription

string

Длина: от 0 до 1500
DocumentDate

date

Нет
UserId

string

Нет
Image

Collection of byte

Нет
Properties

Collection of CreateEntityPropertyValueModel

Нет

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

{
  "vendorId": "sample string 1",
  "statusId": "bcb551d9-f09d-49c5-b535-9fd86df6fe33",
  "customerId": "sample string 3",
  "relationshipId": "sample string 4",
  "invoiceId": "sample string 5",
  "paymentForm": 6,
  "currencyId": "sample string 7",
  "debtCurrencyId": "sample string 8",
  "sum": 9.0,
  "notes": "sample string 10",
  "statusDescription": "sample string 11",
  "documentDate": "2024-11-22T00:36:57.8513959Z",
  "userId": "sample string 12",
  "image": "QEA=",
  "properties": [
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    },
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

<CreatePaymentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Payments">
  <CurrencyId>sample string 7</CurrencyId>
  <CustomerId>sample string 3</CustomerId>
  <DebtCurrencyId>sample string 8</DebtCurrencyId>
  <DocumentDate>2024-11-22T00:36:57.8513959+00:00</DocumentDate>
  <Image>QEA=</Image>
  <InvoiceId>sample string 5</InvoiceId>
  <Notes>sample string 10</Notes>
  <PaymentForm>6</PaymentForm>
  <Properties xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties.Values">
    <d2p1:CreateEntityPropertyValueModel>
      <d2p1:PropertyId>sample string 1</d2p1:PropertyId>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:CreateEntityPropertyValueModel>
    <d2p1:CreateEntityPropertyValueModel>
      <d2p1:PropertyId>sample string 1</d2p1:PropertyId>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:CreateEntityPropertyValueModel>
  </Properties>
  <RelationshipId>sample string 4</RelationshipId>
  <StatusDescription>sample string 11</StatusDescription>
  <StatusId>bcb551d9-f09d-49c5-b535-9fd86df6fe33</StatusId>
  <Sum>9</Sum>
  <UserId>sample string 12</UserId>
  <VendorId>sample string 1</VendorId>
</CreatePaymentModel>

Sample not available.

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

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

globally unique identifier

Нет

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

{
  "id": "d5fae029-3bcf-4c80-ba47-94977bd5e0be"
}

<ResourceIdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Alt.Api.Models.Response">
  <Id>d5fae029-3bcf-4c80-ba47-94977bd5e0be</Id>
</ResourceIdModel>