POST api/RateVoucherApi/CreateNumber
Create new rate voucher, returns new voucher number.
Request Information
URI Parameters
None.
Body Parameters
Includes address and rate voucher information.
RateVoucherContainerName | Description | Type | Additional information |
---|---|---|---|
RateCount |
Rate count of rate voucher. |
integer |
Required |
RateBalance |
Balance of single rate. |
decimal number |
Required Data type: Currency |
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:
{ "RateCount": 1, "RateBalance": 2.0, "Address": { "Birthday": "sample string 1", "CustomerIdShop": 2, "LanguageCode": "sample string 3", "CompanyName": "sample string 4", "AddressNumber": "sample string 5", "Title": "sample string 6", "LastName": "sample string 7", "FAO": "sample string 8", "Street": "sample string 9", "FirstName": "sample string 10", "Postcode": "sample string 11", "Place": "sample string 12", "Country": "sample string 13", "PhoneBusiness": "sample string 14", "PhoneHome": "sample string 15", "FaxNumber": "sample string 16", "Salutation": "sample string 17", "PhoneMobile": "sample string 18", "Notes": "sample string 19", "PostOfficeBox": "sample string 20", "Email": "sample string 21", "Homepage": "sample string 22", "DateModified": "2024-10-03T18:12:51.8302848+02:00", "Id": 23 }, "DeliveryAddress": { "Birthday": "sample string 1", "CustomerIdShop": 2, "LanguageCode": "sample string 3", "CompanyName": "sample string 4", "AddressNumber": "sample string 5", "Title": "sample string 6", "LastName": "sample string 7", "FAO": "sample string 8", "Street": "sample string 9", "FirstName": "sample string 10", "Postcode": "sample string 11", "Place": "sample string 12", "Country": "sample string 13", "PhoneBusiness": "sample string 14", "PhoneHome": "sample string 15", "FaxNumber": "sample string 16", "Salutation": "sample string 17", "PhoneMobile": "sample string 18", "Notes": "sample string 19", "PostOfficeBox": "sample string 20", "Email": "sample string 21", "Homepage": "sample string 22", "DateModified": "2024-10-03T18:12:51.8302848+02:00", "Id": 23 }, "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": "2024-10-03" }
application/xml, text/xml
Sample:
<RateVoucherContainer 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 5</AddressNumber> <Country xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 13</Country> <DateModified xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">2024-10-03T18:12:51.8302848+02:00</DateModified> <Email xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 21</Email> <FAO xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 8</FAO> <FaxNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 16</FaxNumber> <FirstName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 10</FirstName> <Homepage xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 22</Homepage> <Id xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">23</Id> <LastName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 7</LastName> <Notes xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 19</Notes> <PhoneBusiness xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 14</PhoneBusiness> <PhoneHome xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 15</PhoneHome> <PhoneMobile xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 18</PhoneMobile> <Place xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 12</Place> <PostOfficeBox xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 20</PostOfficeBox> <Postcode xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 11</Postcode> <Salutation xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 17</Salutation> <Street xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 9</Street> <Title xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 6</Title> <d2p1:Birthday>sample string 1</d2p1:Birthday> <d2p1:CompanyName>sample string 4</d2p1:CompanyName> <d2p1:CustomerIdShop>2</d2p1:CustomerIdShop> <d2p1:LanguageCode>sample string 3</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 5</AddressNumber> <Country xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 13</Country> <DateModified xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">2024-10-03T18:12:51.8302848+02:00</DateModified> <Email xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 21</Email> <FAO xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 8</FAO> <FaxNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 16</FaxNumber> <FirstName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 10</FirstName> <Homepage xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 22</Homepage> <Id xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">23</Id> <LastName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 7</LastName> <Notes xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 19</Notes> <PhoneBusiness xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 14</PhoneBusiness> <PhoneHome xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 15</PhoneHome> <PhoneMobile xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 18</PhoneMobile> <Place xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 12</Place> <PostOfficeBox xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 20</PostOfficeBox> <Postcode xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 11</Postcode> <Salutation xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 17</Salutation> <Street xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 9</Street> <Title xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 6</Title> <d2p1:Birthday>sample string 1</d2p1:Birthday> <d2p1:CompanyName>sample string 4</d2p1:CompanyName> <d2p1:CustomerIdShop>2</d2p1:CustomerIdShop> <d2p1:LanguageCode>sample string 3</d2p1:LanguageCode> </DeliveryAddress> <OrderBalance>4</OrderBalance> <OrderNumber>sample string 3</OrderNumber> <VoucherDate>2024-10-03T18:12:51.8302848+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> <RateBalance>2</RateBalance> <RateCount>1</RateCount> </RateVoucherContainer>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Voucher number of created voucher.
stringResponse 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>