POST api/PrePaymentApi/CreateNumber

Create new prepayment, returns new prepayment number.

Request Information

URI Parameters

None.

Body Parameters

Includes address and prepayment information.

Name	Description	Type	Additional information
OrderId	Order Id	string	None.
Domain	Domain (My shopify domain)	string	None.
Address	Address for voucher.	CustomAddress	Required
DeliveryAddress	Address data for delivery address.	CustomAddress	None.
AdditionalFields	Additional fields, can be used to set values of fields not contained in this DTO.	Collection of AdditionalField	None.
VoucherLine	Collection of article voucher lines.	Collection of CustomArticleVoucherLine	Required
OrderNumber	Voucher's order number.	string	Required
OrderBalance	Total balance ordered.	decimal number	Required Data type: Currency
VoucherDate	Voucher date, as short date format: yyyy-MM-dd	date	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": "sample string 1",
  "Domain": "sample string 2",
  "Address": {
    "AddressAddition1": "sample string 1",
    "AddressAddition2": "sample string 2",
    "AddressAddition3": "sample string 3",
    "Birthday": "sample string 4",
    "CustomerIdShop": 5,
    "LanguageCode": "sample string 6",
    "CompanyName": "sample string 7",
    "AddressNumber": "sample string 8",
    "Title": "sample string 9",
    "LastName": "sample string 10",
    "FAO": "sample string 11",
    "Street": "sample string 12",
    "FirstName": "sample string 13",
    "Postcode": "sample string 14",
    "Place": "sample string 15",
    "Country": "sample string 16",
    "PhoneBusiness": "sample string 17",
    "PhoneHome": "sample string 18",
    "FaxNumber": "sample string 19",
    "Salutation": "sample string 20",
    "PhoneMobile": "sample string 21",
    "Notes": "sample string 22",
    "PostOfficeBox": "sample string 23",
    "Email": "sample string 24",
    "Homepage": "sample string 25",
    "DateModified": "2025-10-21T13:13:15.636289+02:00",
    "Id": 26
  },
  "DeliveryAddress": {
    "AddressAddition1": "sample string 1",
    "AddressAddition2": "sample string 2",
    "AddressAddition3": "sample string 3",
    "Birthday": "sample string 4",
    "CustomerIdShop": 5,
    "LanguageCode": "sample string 6",
    "CompanyName": "sample string 7",
    "AddressNumber": "sample string 8",
    "Title": "sample string 9",
    "LastName": "sample string 10",
    "FAO": "sample string 11",
    "Street": "sample string 12",
    "FirstName": "sample string 13",
    "Postcode": "sample string 14",
    "Place": "sample string 15",
    "Country": "sample string 16",
    "PhoneBusiness": "sample string 17",
    "PhoneHome": "sample string 18",
    "FaxNumber": "sample string 19",
    "Salutation": "sample string 20",
    "PhoneMobile": "sample string 21",
    "Notes": "sample string 22",
    "PostOfficeBox": "sample string 23",
    "Email": "sample string 24",
    "Homepage": "sample string 25",
    "DateModified": "2025-10-21T13:13:15.636289+02:00",
    "Id": 26
  },
  "AdditionalFields": [
    {
      "Field": 1,
      "Value": "sample string 2"
    },
    {
      "Field": 1,
      "Value": "sample string 2"
    }
  ],
  "VoucherLine": [
    {
      "DescriptionUnit": "sample string 1",
      "Number": "sample string 2",
      "Name": "sample string 3",
      "Quantity": 4.0,
      "Text": "sample string 5",
      "Price": 1.0,
      "DiscountPercent": 6.0,
      "VatCode": "sample string 7",
      "AdditionalFields": [
        {
          "Field": 1,
          "Value": "sample string 2"
        },
        {
          "Field": 1,
          "Value": "sample string 2"
        }
      ]
    },
    {
      "DescriptionUnit": "sample string 1",
      "Number": "sample string 2",
      "Name": "sample string 3",
      "Quantity": 4.0,
      "Text": "sample string 5",
      "Price": 1.0,
      "DiscountPercent": 6.0,
      "VatCode": "sample string 7",
      "AdditionalFields": [
        {
          "Field": 1,
          "Value": "sample string 2"
        },
        {
          "Field": 1,
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "OrderNumber": "sample string 3",
  "OrderBalance": 4.0,
  "VoucherDate": "2025-10-21"
}

application/xml, text/xml

Sample:

<PrePaymentContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Api">
  <AdditionalFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Extended">
    <d2p1:AdditionalField>
      <d2p1:Field>1</d2p1:Field>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:AdditionalField>
    <d2p1:AdditionalField>
      <d2p1:Field>1</d2p1:Field>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:AdditionalField>
  </AdditionalFields>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models">
    <AddressNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 8</AddressNumber>
    <Country xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 16</Country>
    <DateModified xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">2025-10-21T13:13:15.636289+02:00</DateModified>
    <Email xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 24</Email>
    <FAO xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 11</FAO>
    <FaxNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 19</FaxNumber>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 13</FirstName>
    <Homepage xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 25</Homepage>
    <Id xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">26</Id>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 10</LastName>
    <Notes xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 22</Notes>
    <PhoneBusiness xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 17</PhoneBusiness>
    <PhoneHome xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 18</PhoneHome>
    <PhoneMobile xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 21</PhoneMobile>
    <Place xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 15</Place>
    <PostOfficeBox xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 23</PostOfficeBox>
    <Postcode xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 14</Postcode>
    <Salutation xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 20</Salutation>
    <Street xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 12</Street>
    <Title xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 9</Title>
    <d2p1:AddressAddition1>sample string 1</d2p1:AddressAddition1>
    <d2p1:AddressAddition2>sample string 2</d2p1:AddressAddition2>
    <d2p1:AddressAddition3>sample string 3</d2p1:AddressAddition3>
    <d2p1:Birthday>sample string 4</d2p1:Birthday>
    <d2p1:CompanyName>sample string 7</d2p1:CompanyName>
    <d2p1:CustomerIdShop>5</d2p1:CustomerIdShop>
    <d2p1:LanguageCode>sample string 6</d2p1:LanguageCode>
  </Address>
  <DeliveryAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models">
    <AddressNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 8</AddressNumber>
    <Country xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 16</Country>
    <DateModified xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">2025-10-21T13:13:15.636289+02:00</DateModified>
    <Email xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 24</Email>
    <FAO xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 11</FAO>
    <FaxNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 19</FaxNumber>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 13</FirstName>
    <Homepage xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 25</Homepage>
    <Id xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">26</Id>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 10</LastName>
    <Notes xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 22</Notes>
    <PhoneBusiness xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 17</PhoneBusiness>
    <PhoneHome xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 18</PhoneHome>
    <PhoneMobile xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 21</PhoneMobile>
    <Place xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 15</Place>
    <PostOfficeBox xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 23</PostOfficeBox>
    <Postcode xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 14</Postcode>
    <Salutation xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 20</Salutation>
    <Street xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 12</Street>
    <Title xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 9</Title>
    <d2p1:AddressAddition1>sample string 1</d2p1:AddressAddition1>
    <d2p1:AddressAddition2>sample string 2</d2p1:AddressAddition2>
    <d2p1:AddressAddition3>sample string 3</d2p1:AddressAddition3>
    <d2p1:Birthday>sample string 4</d2p1:Birthday>
    <d2p1:CompanyName>sample string 7</d2p1:CompanyName>
    <d2p1:CustomerIdShop>5</d2p1:CustomerIdShop>
    <d2p1:LanguageCode>sample string 6</d2p1:LanguageCode>
  </DeliveryAddress>
  <OrderBalance>4</OrderBalance>
  <OrderNumber>sample string 3</OrderNumber>
  <VoucherDate>2025-10-21T13:13:15.636289+02:00</VoucherDate>
  <VoucherLine xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.VoucherLines">
    <d2p1:CustomArticleVoucherLine>
      <d2p1:AdditionalFields xmlns:d4p1="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Extended">
        <d4p1:AdditionalField>
          <d4p1:Field>1</d4p1:Field>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:AdditionalField>
        <d4p1:AdditionalField>
          <d4p1:Field>1</d4p1:Field>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:AdditionalField>
      </d2p1:AdditionalFields>
      <d2p1:DiscountPercent>6</d2p1:DiscountPercent>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:Text>sample string 5</d2p1:Text>
      <d2p1:VatCode>sample string 7</d2p1:VatCode>
      <d2p1:DescriptionUnit>sample string 1</d2p1:DescriptionUnit>
    </d2p1:CustomArticleVoucherLine>
    <d2p1:CustomArticleVoucherLine>
      <d2p1:AdditionalFields xmlns:d4p1="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Extended">
        <d4p1:AdditionalField>
          <d4p1:Field>1</d4p1:Field>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:AdditionalField>
        <d4p1:AdditionalField>
          <d4p1:Field>1</d4p1:Field>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:AdditionalField>
      </d2p1:AdditionalFields>
      <d2p1:DiscountPercent>6</d2p1:DiscountPercent>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:Text>sample string 5</d2p1:Text>
      <d2p1:VatCode>sample string 7</d2p1:VatCode>
      <d2p1:DescriptionUnit>sample string 1</d2p1:DescriptionUnit>
    </d2p1:CustomArticleVoucherLine>
  </VoucherLine>
  <Domain>sample string 2</Domain>
  <OrderId>sample string 1</OrderId>
</PrePaymentContainer>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PrePaymentContainer'.

Response Information

Resource Description

Number of new prepayment.

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>