POST api/refunds

Метод для создания "Возврата"

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

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

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

URL параметры

Нет

Тело запроса

"Возврат"

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

string

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

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

string

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

globally unique identifier

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

string

Нет
StatusDescription

string

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

string

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

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

string

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

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

string

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

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

string

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

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

integer

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

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

string

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

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

string

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

Collection of CreateRefundPositionModel

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

Collection of CreateMultiCurrencySumModel

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

date

Нет
UserId

string

Нет
IsExchange

boolean

Нет
Properties

Collection of CreateEntityPropertyValueModel

Нет

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

{
  "vendorId": "sample string 1",
  "number": "sample string 2",
  "statusId": "a33f0f05-48dd-4ea4-b18b-72f5c22e7982",
  "refundReasonId": "sample string 4",
  "statusDescription": "sample string 5",
  "customerId": "sample string 6",
  "relationshipId": "sample string 7",
  "tradeOutletId": "sample string 8",
  "warehouseId": "sample string 9",
  "paymentForm": 10,
  "paymentTypeId": "sample string 11",
  "notes": "sample string 12",
  "positions": [
    {
      "productId": "sample string 1",
      "currencyId": "sample string 2",
      "priceCategoryId": "sample string 3",
      "quantity": 4.1,
      "price": 5.0,
      "sum": 6.0,
      "comment": "sample string 7",
      "packagingId": "sample string 8"
    },
    {
      "productId": "sample string 1",
      "currencyId": "sample string 2",
      "priceCategoryId": "sample string 3",
      "quantity": 4.1,
      "price": 5.0,
      "sum": 6.0,
      "comment": "sample string 7",
      "packagingId": "sample string 8"
    }
  ],
  "sums": [
    {
      "currencyId": "sample string 1",
      "sum": 2.0
    },
    {
      "currencyId": "sample string 1",
      "sum": 2.0
    }
  ],
  "documentDate": "2025-11-03T21:55:20.8317057Z",
  "userId": "sample string 13",
  "isExchange": true,
  "properties": [
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    },
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

<CreateRefundModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Refunds">
  <CustomerId>sample string 6</CustomerId>
  <DocumentDate>2025-11-03T21:55:20.8317057+00:00</DocumentDate>
  <IsExchange>true</IsExchange>
  <Notes>sample string 12</Notes>
  <Number>sample string 2</Number>
  <PaymentForm>10</PaymentForm>
  <PaymentTypeId>sample string 11</PaymentTypeId>
  <Positions>
    <CreateRefundPositionModel>
      <Comment>sample string 7</Comment>
      <CurrencyId>sample string 2</CurrencyId>
      <PackagingId>sample string 8</PackagingId>
      <Price>5</Price>
      <PriceCategoryId>sample string 3</PriceCategoryId>
      <ProductId>sample string 1</ProductId>
      <Quantity>4.1</Quantity>
      <Sum>6</Sum>
    </CreateRefundPositionModel>
    <CreateRefundPositionModel>
      <Comment>sample string 7</Comment>
      <CurrencyId>sample string 2</CurrencyId>
      <PackagingId>sample string 8</PackagingId>
      <Price>5</Price>
      <PriceCategoryId>sample string 3</PriceCategoryId>
      <ProductId>sample string 1</ProductId>
      <Quantity>4.1</Quantity>
      <Sum>6</Sum>
    </CreateRefundPositionModel>
  </Positions>
  <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>
  <RefundReasonId>sample string 4</RefundReasonId>
  <RelationshipId>sample string 7</RelationshipId>
  <StatusDescription>sample string 5</StatusDescription>
  <StatusId>a33f0f05-48dd-4ea4-b18b-72f5c22e7982</StatusId>
  <Sums xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Miscellaneous.MultiCurrency">
    <d2p1:CreateMultiCurrencySumModel>
      <d2p1:CurrencyId>sample string 1</d2p1:CurrencyId>
      <d2p1:Sum>2</d2p1:Sum>
    </d2p1:CreateMultiCurrencySumModel>
    <d2p1:CreateMultiCurrencySumModel>
      <d2p1:CurrencyId>sample string 1</d2p1:CurrencyId>
      <d2p1:Sum>2</d2p1:Sum>
    </d2p1:CreateMultiCurrencySumModel>
  </Sums>
  <TradeOutletId>sample string 8</TradeOutletId>
  <UserId>sample string 13</UserId>
  <VendorId>sample string 1</VendorId>
  <WarehouseId>sample string 9</WarehouseId>
</CreateRefundModel>

Sample not available.

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

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

globally unique identifier

Нет

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

{
  "id": "deafb779-3505-46f3-9b4d-f6963867a75e"
}

<ResourceIdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Alt.Api.Models.Response">
  <Id>deafb779-3505-46f3-9b4d-f6963867a75e</Id>
</ResourceIdModel>