POST api/ProformaInvoice/AddProformaInvoice
Request Information
URI Parameters
None.
Body Parameters
ProformaInvoiceHeader| Name | Description | Type | Additional information |
|---|---|---|---|
| ProformaInvoiceYear | integer |
None. |
|
| ProformaInvoiceBook | string |
None. |
|
| CustomerID | string |
None. |
|
| CustomerPayerID | string |
None. |
|
| DeliveryTitle1 | string |
None. |
|
| DeliveryTitle2 | string |
None. |
|
| DeliveryTitle3 | string |
None. |
|
| DeliveryAddress | string |
None. |
|
| DeliveryHouseNo | string |
None. |
|
| DeliveryPostalCode | string |
None. |
|
| DeliveryCity | string |
None. |
|
| DeliveryCountry | string |
None. |
|
| InvoiceDate | date |
None. |
|
| DeliveryDateFrom | date |
None. |
|
| DeliveryDateTo | date |
None. |
|
| DueDate | date |
None. |
|
| CurrencyID | string |
None. |
|
| ExchangeRateDate | date |
None. |
|
| Document | string |
None. |
|
| Comment | string |
None. |
|
| DocumentHeaderDescription | string |
None. |
|
| DocumentFooterDescription | string |
None. |
|
| LanguageID | string |
None. |
|
| VATCalculated | string |
None. |
|
| VATInvoiceType | string |
None. |
|
| PriceListID | string |
None. |
|
| RebatePercentage | decimal number |
None. |
|
| RebatePercentage2 | decimal number |
None. |
|
| RebatePercentage3 | decimal number |
None. |
|
| RebatePercentage4 | decimal number |
None. |
|
| RebatePercentage5 | decimal number |
None. |
|
| RebateAmountAmount | decimal number |
None. |
|
| CostCenterID | string |
None. |
|
| CostUnitID | string |
None. |
|
| WorkOrderID | string |
None. |
|
| ClerkID | string |
None. |
|
| AnalyticID | string |
None. |
|
| PayerCostCenterID | string |
None. |
|
| AccountingBookGroupID | string |
None. |
|
| ApplicationName | string |
None. |
|
| LinkToDocument | string |
None. |
|
| AccountingDescription | string |
None. |
|
| DeliveryType | string |
None. |
|
| ParityCode | string |
None. |
|
| PaymentCodeID | string |
None. |
|
| ParityPlace | string |
None. |
|
| DocumentSalesType | string |
None. |
|
| Analytic_AN1_ID | string |
None. |
|
| Analytic_AN2_ID | string |
None. |
|
| Analytic_AN3_ID | string |
None. |
|
| DateVD | string |
None. |
|
| CodeVD | string |
None. |
|
| CodeVR | string |
None. |
|
| DiscountGroupID | string |
None. |
|
| AnnexID | string |
None. |
|
| FolderID | string |
None. |
|
| PaymentReferenceExternal | string |
None. |
|
| DeliveryPlace | string |
None. |
|
| LeadTime | integer |
None. |
|
| OrderBook | string |
None. |
|
| OrderNumber | string |
None. |
|
| OrderYear | string |
None. |
|
| VATTaxCategory | string |
None. |
|
| PaymentMethod | string |
None. |
|
| LocationID | string |
None. |
|
| DeliveryLocationAddress | string |
None. |
|
| ProformaInvoiceLines | ProformaInvoiceLines |
None. |
Request Formats
application/xml, text/xml
Sample:
<ProformaInvoiceHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ProformaInvoiceYear>1</ProformaInvoiceYear>
<ProformaInvoiceBook>sample string 2</ProformaInvoiceBook>
<CustomerID>sample string 3</CustomerID>
<CustomerPayerID>sample string 4</CustomerPayerID>
<DeliveryTitle1>sample string 5</DeliveryTitle1>
<DeliveryTitle2>sample string 6</DeliveryTitle2>
<DeliveryTitle3>sample string 7</DeliveryTitle3>
<DeliveryAddress>sample string 8</DeliveryAddress>
<DeliveryHouseNo>sample string 9</DeliveryHouseNo>
<DeliveryPostalCode>sample string 10</DeliveryPostalCode>
<DeliveryCity>sample string 11</DeliveryCity>
<DeliveryCountry>sample string 12</DeliveryCountry>
<InvoiceDate>2025-11-03T08:05:27.4994033+01:00</InvoiceDate>
<DeliveryDateFrom>2025-11-03T08:05:27.4994033+01:00</DeliveryDateFrom>
<DeliveryDateTo>2025-11-03T08:05:27.4994033+01:00</DeliveryDateTo>
<DueDate>2025-11-03T08:05:27.4994033+01:00</DueDate>
<CurrencyID>sample string 13</CurrencyID>
<ExchangeRateDate>2025-11-03T08:05:27.4994033+01:00</ExchangeRateDate>
<Document>sample string 14</Document>
<Comment>sample string 15</Comment>
<DocumentHeaderDescription>sample string 16</DocumentHeaderDescription>
<DocumentFooterDescription>sample string 17</DocumentFooterDescription>
<LanguageID>sample string 18</LanguageID>
<VATCalculated>sample string 19</VATCalculated>
<VATInvoiceType>sample string 20</VATInvoiceType>
<PriceListID>sample string 21</PriceListID>
<RebatePercentage>1</RebatePercentage>
<RebatePercentage2>1</RebatePercentage2>
<RebatePercentage3>1</RebatePercentage3>
<RebatePercentage4>1</RebatePercentage4>
<RebatePercentage5>1</RebatePercentage5>
<RebateAmountAmount>1</RebateAmountAmount>
<CostCenterID>sample string 22</CostCenterID>
<CostUnitID>sample string 23</CostUnitID>
<WorkOrderID>sample string 24</WorkOrderID>
<ClerkID>sample string 25</ClerkID>
<AnalyticID>sample string 26</AnalyticID>
<PayerCostCenterID>sample string 27</PayerCostCenterID>
<AccountingBookGroupID>sample string 28</AccountingBookGroupID>
<ApplicationName>sample string 29</ApplicationName>
<LinkToDocument>sample string 30</LinkToDocument>
<AccountingDescription>sample string 31</AccountingDescription>
<DeliveryType>sample string 32</DeliveryType>
<ParityCode>sample string 33</ParityCode>
<PaymentCodeID>sample string 34</PaymentCodeID>
<ParityPlace>sample string 35</ParityPlace>
<DocumentSalesType>sample string 36</DocumentSalesType>
<Analytic_AN1_ID>sample string 37</Analytic_AN1_ID>
<Analytic_AN2_ID>sample string 38</Analytic_AN2_ID>
<Analytic_AN3_ID>sample string 39</Analytic_AN3_ID>
<DateVD>sample string 40</DateVD>
<CodeVD>sample string 41</CodeVD>
<CodeVR>sample string 42</CodeVR>
<DiscountGroupID>sample string 43</DiscountGroupID>
<AnnexID>sample string 44</AnnexID>
<FolderID>sample string 45</FolderID>
<PaymentReferenceExternal>sample string 46</PaymentReferenceExternal>
<DeliveryPlace>sample string 47</DeliveryPlace>
<LeadTime>48</LeadTime>
<OrderBook>sample string 49</OrderBook>
<OrderNumber>sample string 50</OrderNumber>
<OrderYear>sample string 51</OrderYear>
<VATTaxCategory>sample string 52</VATTaxCategory>
<PaymentMethod>sample string 53</PaymentMethod>
<LocationID>sample string 54</LocationID>
<DeliveryLocationAddress>sample string 55</DeliveryLocationAddress>
<ProformaInvoiceLines>
<ProformaInvoiceLine>
<LineNumber>1</LineNumber>
<ItemID>sample string 2</ItemID>
<ItemIDType>sample string 3</ItemIDType>
<Quantity>1</Quantity>
<Price>1</Price>
<Series>sample string 4</Series>
<ItemTitle1>sample string 5</ItemTitle1>
<ItemTitle2>sample string 6</ItemTitle2>
<UnitOfMeasurment>sample string 7</UnitOfMeasurment>
<ItemDescription>sample string 8</ItemDescription>
<VATRateID>sample string 9</VATRateID>
<Note>sample string 10</Note>
<DiscountPercentage>1</DiscountPercentage>
<DiscountPercentage2>1</DiscountPercentage2>
<DiscountPercentage3>1</DiscountPercentage3>
<DiscountPercentage4>1</DiscountPercentage4>
<DiscountPercentage5>1</DiscountPercentage5>
<DiscountAmountAmount>1</DiscountAmountAmount>
<CostCenterID>sample string 11</CostCenterID>
<CostUnitID>sample string 12</CostUnitID>
<WorkOrderID>sample string 13</WorkOrderID>
<ClerkID>sample string 14</ClerkID>
<AnalyticID>sample string 15</AnalyticID>
<Analytic_AN1_ID>sample string 16</Analytic_AN1_ID>
<Analytic_AN2_ID>sample string 17</Analytic_AN2_ID>
<Analytic_AN3_ID>sample string 18</Analytic_AN3_ID>
<PayerCostCenterID>sample string 19</PayerCostCenterID>
<VATRateDescription>sample string 20</VATRateDescription>
<VATCalculated>sample string 21</VATCalculated>
<VATInvoiceType>sample string 22</VATInvoiceType>
<Reference>sample string 23</Reference>
<TextLine>true</TextLine>
<PriceIncludeVAT>true</PriceIncludeVAT>
<LeadTime>24</LeadTime>
<VATTaxCategory>sample string 25</VATTaxCategory>
</ProformaInvoiceLine>
<ProformaInvoiceLine>
<LineNumber>1</LineNumber>
<ItemID>sample string 2</ItemID>
<ItemIDType>sample string 3</ItemIDType>
<Quantity>1</Quantity>
<Price>1</Price>
<Series>sample string 4</Series>
<ItemTitle1>sample string 5</ItemTitle1>
<ItemTitle2>sample string 6</ItemTitle2>
<UnitOfMeasurment>sample string 7</UnitOfMeasurment>
<ItemDescription>sample string 8</ItemDescription>
<VATRateID>sample string 9</VATRateID>
<Note>sample string 10</Note>
<DiscountPercentage>1</DiscountPercentage>
<DiscountPercentage2>1</DiscountPercentage2>
<DiscountPercentage3>1</DiscountPercentage3>
<DiscountPercentage4>1</DiscountPercentage4>
<DiscountPercentage5>1</DiscountPercentage5>
<DiscountAmountAmount>1</DiscountAmountAmount>
<CostCenterID>sample string 11</CostCenterID>
<CostUnitID>sample string 12</CostUnitID>
<WorkOrderID>sample string 13</WorkOrderID>
<ClerkID>sample string 14</ClerkID>
<AnalyticID>sample string 15</AnalyticID>
<Analytic_AN1_ID>sample string 16</Analytic_AN1_ID>
<Analytic_AN2_ID>sample string 17</Analytic_AN2_ID>
<Analytic_AN3_ID>sample string 18</Analytic_AN3_ID>
<PayerCostCenterID>sample string 19</PayerCostCenterID>
<VATRateDescription>sample string 20</VATRateDescription>
<VATCalculated>sample string 21</VATCalculated>
<VATInvoiceType>sample string 22</VATInvoiceType>
<Reference>sample string 23</Reference>
<TextLine>true</TextLine>
<PriceIncludeVAT>true</PriceIncludeVAT>
<LeadTime>24</LeadTime>
<VATTaxCategory>sample string 25</VATTaxCategory>
</ProformaInvoiceLine>
</ProformaInvoiceLines>
</ProformaInvoiceHeader>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Keys | Collection of EntityKeyField |
None. |
|
| ResultCode | ExternalResultCode |
None. |
|
| Errors | Collection of Error |
None. |
Response Formats
application/xml, text/xml
Sample:
<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Keys>
<Key>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Key>
<Key>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Key>
</Keys>
<ResultCode>None</ResultCode>
<Errors>
<Error>
<Level>Warning</Level>
<Message>sample string 1</Message>
</Error>
<Error>
<Level>Warning</Level>
<Message>sample string 1</Message>
</Error>
</Errors>
</CreateResult>