POST api/invoices

Метод для создания "Накладной"

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

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

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

URL параметры

Нет

Тело запроса

"Накладная"

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

string

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

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

string

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

globally unique identifier

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

string

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

integer

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

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

string

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

date

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

time interval

Нет
DeliveryTimeTill

time interval

Нет
Sums

Collection of CreateMultiCurrencySumModel

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

Collection of CreateMultiCurrencySumModel

Нет
PaymentDate

date

Нет
Notes

string

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

string

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

Collection of CreateInvoicePositionModel

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

Collection of CreateEntityPropertyValueModel

Нет
DocumentDate

date

Нет
UserId

string

Нет
IsExchange

boolean

Нет

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

{
  "vendorId": "sample string 1",
  "number": "sample string 2",
  "statusId": "3571b5f3-2c45-4834-9340-e9ad4a84e612",
  "orderId": "sample string 4",
  "customerId": "sample string 5",
  "relationshipId": "sample string 6",
  "tradeOutletId": "sample string 7",
  "warehouseId": "sample string 8",
  "paymentTypeId": "sample string 9",
  "paymentForm": 10,
  "deliveryTypeId": "sample string 11",
  "deliveryDate": "2024-11-21T20:08:25.9178638Z",
  "deliveryTimeFrom": "00:00:00.1234567",
  "deliveryTimeTill": "00:00:00.1234567",
  "sums": [
    {
      "currencyId": "sample string 1",
      "sum": 2.0
    },
    {
      "currencyId": "sample string 1",
      "sum": 2.0
    }
  ],
  "debts": [
    {
      "currencyId": "sample string 1",
      "sum": 2.0
    },
    {
      "currencyId": "sample string 1",
      "sum": 2.0
    }
  ],
  "paymentDate": "2024-11-21T20:08:25.9178638Z",
  "notes": "sample string 13",
  "statusDescription": "sample string 14",
  "positions": [
    {
      "productId": "sample string 1",
      "currencyId": "sample string 2",
      "quantity": 3.1,
      "price": 4.0,
      "sum": 5.0,
      "packagingId": "sample string 6"
    },
    {
      "productId": "sample string 1",
      "currencyId": "sample string 2",
      "quantity": 3.1,
      "price": 4.0,
      "sum": 5.0,
      "packagingId": "sample string 6"
    }
  ],
  "properties": [
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    },
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "documentDate": "2024-11-21T20:08:25.9178638Z",
  "userId": "sample string 15",
  "isExchange": true
}

<CreateInvoiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Invoices">
  <CustomerId>sample string 5</CustomerId>
  <Debts 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>
  </Debts>
  <DeliveryDate>2024-11-21T20:08:25.9178638+00:00</DeliveryDate>
  <DeliveryTimeFrom>PT0.1234567S</DeliveryTimeFrom>
  <DeliveryTimeTill>PT0.1234567S</DeliveryTimeTill>
  <DeliveryTypeId>sample string 11</DeliveryTypeId>
  <DocumentDate>2024-11-21T20:08:25.9178638+00:00</DocumentDate>
  <IsExchange>true</IsExchange>
  <Notes>sample string 13</Notes>
  <Number>sample string 2</Number>
  <OrderId>sample string 4</OrderId>
  <PaymentDate>2024-11-21T20:08:25.9178638+00:00</PaymentDate>
  <PaymentForm>10</PaymentForm>
  <PaymentTypeId>sample string 9</PaymentTypeId>
  <Positions xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Invoices.Positions">
    <d2p1:CreateInvoicePositionModel>
      <d2p1:CurrencyId>sample string 2</d2p1:CurrencyId>
      <d2p1:PackagingId>sample string 6</d2p1:PackagingId>
      <d2p1:Price>4</d2p1:Price>
      <d2p1:ProductId>sample string 1</d2p1:ProductId>
      <d2p1:Quantity>3.1</d2p1:Quantity>
      <d2p1:Sum>5</d2p1:Sum>
    </d2p1:CreateInvoicePositionModel>
    <d2p1:CreateInvoicePositionModel>
      <d2p1:CurrencyId>sample string 2</d2p1:CurrencyId>
      <d2p1:PackagingId>sample string 6</d2p1:PackagingId>
      <d2p1:Price>4</d2p1:Price>
      <d2p1:ProductId>sample string 1</d2p1:ProductId>
      <d2p1:Quantity>3.1</d2p1:Quantity>
      <d2p1:Sum>5</d2p1:Sum>
    </d2p1:CreateInvoicePositionModel>
  </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>
  <RelationshipId>sample string 6</RelationshipId>
  <StatusDescription>sample string 14</StatusDescription>
  <StatusId>3571b5f3-2c45-4834-9340-e9ad4a84e612</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 7</TradeOutletId>
  <UserId>sample string 15</UserId>
  <VendorId>sample string 1</VendorId>
  <WarehouseId>sample string 8</WarehouseId>
</CreateInvoiceModel>

Sample not available.

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

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

globally unique identifier

Нет

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

{
  "id": "f066916a-dbe2-496b-b505-082087be3663"
}

<ResourceIdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Alt.Api.Models.Response">
  <Id>f066916a-dbe2-496b-b505-082087be3663</Id>
</ResourceIdModel>