 |
| |
| |
| |
| |
| |
| |
| |
| |
| | |||||||||||||||
|
| |
| |
| |
| |
| |
| |
| |
| |
| | |||||||||||||||
| SalesQuoteGet | Get sales quotes by document number, or by combination of document number and date. |
| SalesQuoteGetPDF | Get PDF file for sales quotes by document number, or by combination of document number and date. |
| SalesQuoteCreate | Create new sales quote. |
| SalesQuoteUpdate | Update existing Sales quote. |
| SalesQuoteDelete | Delete sales quote. |
| SalesQuoteList | Get list of sales quotes for specified criteria |
| SalesQuoteSendByEmail | Sends document by email to the recipient(s) |
| SalesQuotePaymentRecordAdd | Add payment record on sales quote. |
| SalesQuoteCreateInvoice | Create invoice from sales quote. |
| SalesQuoteAttachmentAdd | Add attachment to sales quote. |
| SalesQuoteAttachmentSetDefault | Add attachment to sales quote and set is as default. |
| SalesQuoteAttachmentGet | Get default attachment of sales quote. |
| SalesQuoteAttachmentList | Get all attachments of sales quote. |
Get sales quotes by document number, or by combination of document number and date.
Parameters
| number | Document number. Can use sequential document number (example: 5), or formatted number (example: 2010-00005) |
| date | Document date |
| costPosition | Cost position |
| businessUnit | Business unit |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteGet">
<parameter name="number" value="5" />
<parameter name="date" type="Date" value="2010-02-22" />
</method>
</request>
Response
HTTP/1.1 200 OK
Server: eurofaktura.cz web server
Date: Tue, 1 March 2010 11:00:05 GMT
Content-Type: text/xml
Content-Length: 328
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<SalesQuote>
<number>5</number>
<status>draft</status>
<date>2010-01-13</date>
<validUntil>2010-02-13</validUntil>
<type>Retail</type>
<costPosition>120</costPosition> <!-- (Optional)
<businessUnit>0001</businessUnit> <!-- (Optional)
<deliveryMethod>Delivery method</deliveryMethod> <!-- (Optional)
<reference>00 2010-00005</reference> <!-- (Optional) generated unique payment identifier - VS(variabilni symbol)
<superDiscountPercentage>2</superDiscountPercentage> <!-- (Optional)
<warehouseCode>1000</warehouseCode> <!-- (Optional)
<orderReference>123</orderReference> <!-- (Optional)
<buyerName>Petr Novak</buyerName> <!-- buyer name
<buyerTaxNumber>02169711</buyerTaxNumber> <!-- buyer tax number
<buyerVatRegistration>None</buyerVatRegistration> <!-- (true, false)
<buyerEMail>petr@novak.cz</buyerEMail> <!-- (Optional)
<buyerStreet>Celní 22</buyerStreet> <!-- (Optional)
<buyerPostalCode>60200</buyerPostalCode> <!-- (Optional)
<buyerCity>Brno</buyerCity> <!-- (Optional)
<buyerCountry>CZ</buyerCountry> <!-- (Optional)
<totalAmount>319.800</totalAmount>
<totalCurrency>CZK</totalCurrency>
<totalDiscount>0.0</totalDiscount>
<totalNetAmount>288.34</totalNetAmount>
<totalVatAmountFlatRate>0.00</totalVatAmountFlatRate>
<totalVatAmountNormalRate>22.18</totalVatAmountNormalRate>
<totalVatAmountLowerRate>9.28</totalVatAmountLowerRate>
<totalVatAmountZeroRate>0.0</totalVatAmountZeroRate>
<totalVatBaseAmountFlatRate>0.00</totalVatBaseAmountFlatRate>
<totalVatBaseAmountNormalRate>100.82</totalVatBaseAmountNormalRate>
<totalVatBaseAmountLowerRate>97.68</totalVatBaseAmountLowerRate>
<totalVatBaseAmountZeroRate>89.84</totalVatBaseAmountZeroRate>
<vatTransactionType>0</vatTransactionType>
<vatOutgoingDocumentVatClause>Registered</vatOutgoingDocumentVatClause>
<remarks>Remark on SalesQuote</remarks>
<salesInvoicesRef>2014-00001, 2014-00002, 2014-00003</salesInvoicesRef> <!-- references to sales invoices
<advanceInvoicesRef>2014-00001, 2014-00002, 2014-00003</advanceInvoicesRef> <!-- references to advance invoices
<deliveryNotesRef>2014-00004, 2014-00005, 2014-00006</deliveryNotesRef> <!-- references to delivery notes
<salesOrdersRef>2014-00001, 2014-00002</salesOrdersRef> <!-- references to sales orders
<introductionText>introduction text</introductionText>
<vatCountryIsoCode>CZ</vatCountryIsoCode>
<warehouseCode>00001</warehouseCode>
<Address> <!-- (Optional) Setting delivery address on document and partner buyer if it doesn't exists
<city>Praha</city>
<country>CZ</country>
<postalCode>10000</postalCode>
<street>Dolní 10</street>
<type>Delivery</type>
</Address>
<Items>
<Item>
<amount>100.82</amount>
<amountWithoutDiscount>100.82</amountWithoutDiscount>
<currency>CZK</currency>
<description>test</description>
<discountAmount>0.0</discountAmount>
<discountPercentage>0.0000</discountPercentage>
<netPrice>100.81967</netPrice>
<netPriceInDocumentCurrency>100.81967</netPriceInDocumentCurrency>
<position>4</position>
<price>123.00000</price>
<priceInDocumentCurrency>123.00000</priceInDocumentCurrency>
<quantity>1.000000</quantity>
<totalDiscountPercentage>0.0000</totalDiscountPercentage>
<unit></unit>
<unit></unit>
<vatAmount>22.18</vatAmount>
<vatPercentage>22.0</vatPercentage>
</Item>
<Item>
<amount>89.84</amount>
<amountWithoutDiscount>89.84</amountWithoutDiscount>
<articleCode>000011</articleCode>
<articleName>Firma test</articleName>
<currency>CZK</currency>
<description>test text</description>
<discountAmount>0.0</discountAmount>
<discountPercentage>0.0000</discountPercentage>
<netPrice>89.83500</netPrice>
<netPriceInDocumentCurrency>89.83500</netPriceInDocumentCurrency>
<position>2</position>
<price>89.83500</price>
<priceInDocumentCurrency>89.83500</priceInDocumentCurrency>
<productCode>000011</productCode>
<productName>Firma test</productName>
<quantity>1.000000</quantity>
<totalDiscountPercentage>0.0000</totalDiscountPercentage>
<unit>-</unit>
<unit>-</unit>
<vatAmount>0.00</vatAmount>
<vatPercentage>0.0</vatPercentage>
</Item>
<Item>
<amount>97.68</amount>
<amountWithoutDiscount>97.68</amountWithoutDiscount>
<articleCode>000013</articleCode>
<articleName>Položka 351</articleName>
<currency>CZK</currency>
<description>není dostupný</description>
<discountAmount>0.0</discountAmount>
<discountPercentage>0.0000</discountPercentage>
<netPrice>48.84018</netPrice>
<netPriceInDocumentCurrency>48.84018</netPriceInDocumentCurrency>
<position>3</position>
<price>53.48000</price>
<priceInDocumentCurrency>53.48000</priceInDocumentCurrency>
<productCode>000013</productCode>
<productName>test položka 3/4" WATTS</productName>
<quantity>2.000000</quantity>
<totalDiscountPercentage>0.0000</totalDiscountPercentage>
<unit>kus</unit>
<unit>kus</unit>
<vatAmount>9.28</vatAmount>
<vatPercentage>9.5</vatPercentage>
</Item>
</Items>
</SalesQuote>
</response>
Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="document could not be found"><error/>
</response>
Get PDF for sales quote by document number, or by combination of document number and date. Response (on OK) returns binary record for PDF file coded with Base64 coding.
Parameters
| number | Document number. Can use sequential document number (example: 2), or formated number (example: 2010-00002) |
| date | Document date |
| costPosition | Cost position |
| businessUnit | Business unit |
| markDocumentAsSent | Marks document as sent. |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteGetPDF">
<parameter name="number" value="2" />
<parameter name="date" type="Date" value="2010-02-22" />
<parameter name="markDocumentAsSent" />
</method>
</request>
Response
<response status="ok">
<number>2</number>
<date>2010-02-22</date>
<pdfFile>JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nJVYS4/bNh...</pdfFile>
</response>
Response (on error)
<response status="error">
<error description="Can not find sales quote for number: 2 and date: 2010-02-22">
</error>
</response>
Create new sales Quote.
Document item can be specified with: productCode, quantity, discountPercentage, or can be specified with: description, currency, quantity, price (retail price including VAT for retail document) or netPrice (gross price without VAT for gross document). Default document type is gross.Additional optional item fields are: discountPercentage, unit, vatPercentage, vatTransactionType, transNoCoefCalcSN, kontrolHlasSectionType and kontrolHlasTransCode.
Supported values for vatTransactionType are:
0 - Taxable transactions of goods and services in Czechia //Dodání zboží/poskytnutí služby v tuzemsku
1 - Zero-rated transaction - supply of goods within the EU //Dodání zboží do jiného členského státu EU
2 - Zero-rated transaction - supply of goods within the EU(fixed assets) //Dodání zboží do jiného členského státu EU - převod majetku
3 - Zero-rated transaction - supply of service in the EU //Poskytnutí služeb v jiném členském státě EU
4 - Zero-rated transaction - exports of goods outside the EU //Vývoz zboží mimo EU
5 - Zero-rated transaction - new vehicle delivery to person not registred for VAT within the EU //Dodání nového doprav. prostředku do jiného člen. státu EU nereg. osobě
20 - Zero-rated transaction - goods delivery within EU (over limit) - foreign VAT calculated //Zasílání zboží do jiného člen. státu EU nad registrační limit (cizí DPH)
7 - Zero-rated transaction - reverse charge (goods supply/assembly the service) //Režim přenesení daňové povinnosti (tuzemsko)
8 - Zero-rated transaction - other taxable transaction with claim of VAT deduction //Ostatní uskutečněná osvobozená plnění s nárokem na odpočet daně
10 - Zero-rated transaction - tripartite supplies of goods within the EU //Dodání zboží formou třístranného obchodu prostřední osobou
11 - Tax amount correction in insolvency proceedings (creditor) //Oprava daně v insolvenčním řízení (věřitel)
12 - VAT exempt transactions without the right of input VAT deduction //Plnění osvobozená od daně bez nároku na odpočet daně
15 - Transactions exempt from VAT - not for VAT records //Nezahrnovat do přiznání DPH
21 - Zero-rated transaction - assembly in the EU //Poskytnutí služeb v EU (cizí DPH) - vyněto z DPH přiznání
100 - Electronic services in other EU member countries (foreign VAT calculated) //Poskytnutí el. služeb v jiném členském státě EU (cizí DPH)
106 - Distance sales of goods to EU consumers (OSS) //Prodej zboží na dálku koncovým zákazníkům v EU (OSS)
107 - Supply of services to EU consumers (OSS) //Poskytnutí služeb koncovým zákazníkům v EU (OSS)
108 - Distance sales of imported goods to EU consumers (IOSS) //Prodej zboží na dálku ze třetích zemí koncovým zákazníkům v EU (IOSS)
109 - Distance sales of goods to domestic consumers (OSS)//Prodej zboží na dálku koncovým zákazníkům v tuzemsku (OSS)
110 - Distance sales of imported goods to domestic consumers (IOSS) //Prodej importovaného zboží ze třetích zemí koncovým zákazníkům v tuzemsku (IOSS)
120 - Supply of services from EU to third country consumers (foreign VAT) //Poskytnutí služeb z EU koncovému spotřebiteli mimo EU (cizí DPH)
 | Before using vat transaction types for OSS and IOSS, you must set up registration for OSS and IOSS in company settings under foreign VAT registrations. |
Supported values for transNoCoefCalcSN are "1 or 0" and stated if transaction is not included to the coefficient calculation.
Supported values for kontrolHlasSectionType are:
1 - Transaction has no impact on control report sections,
2 - Section A1,
3 - Section A3,
4 - Section A4 (regular),
5 - Section A4 (travel services),
6 - Section A4 (used goods),
7 - Section A4/A5 automatic choose (based on amount and EuVAT ID on document),
8 - Section A5
Supported values for kontrolHlasTransCode are:
2 - 1
3 - 1a
4 - 3
5 - 3a
6 - 4
7 - 4a
8 - 5
9 - 6
10 - 7
11 - 11
12 - 12
13 - 13
14 - 14
15 - 15
16 - 16
17 - 17
18 - 18
19 - 19
20 - 20
21 - 21}}
Parameters
| SalesQuote | Complex parameter with data tags |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteCreate">
<parameter name="SalesQuote">
<date>2010-01-13</date> <!-- document date
<validUntil>2010-02-13</validUntil> <!-- document valid until
<type>Retail</type> <!-- type of pricing optional (default gross)
<status>issued</status> <!-- (Optional) Possible values: issued, draft - default is issued
<costPosition>120</costPosition> <!-- (Optional)
<deliveryMethod>Delivery method</deliveryMethod> <!-- (Optional)
<reference>00 2010-00005</reference> <!-- (Optional) generated unique payment identifier - VS(variabilni symbol)
<superDiscountPercentage>5</superDiscountPercentage> <!-- (Optional)
<warehouseCode>1000</warehouseCode> <!-- (Optional)
<orderReference>123</orderReference> <!-- (Optional)
<buyerCode>123456</buyerCode> <!-- (Optional). If buyer code is specified, other buyer parameters bellow are not needed as the buyer data is taken from database. If any additional parameter is specified, it will override master buyer data in document
<buyerDocumentID>60:123456</buyerDocumentID> <!-- (Optional). If it is specified buyer parameters bellow are not needed as the buyer data is taken from database. If any parameter bellow is sepcified it will override master buyer data in document
<buyerName>Petr Novak</buyerName>
<buyerTaxNumber>02169711</buyerTaxNumber> <!-- (Optional)
<buyerVatRegistration>None</buyerVatRegistration> <!-- (Unkown, None, Registered)
<buyerEMail>petr@novak.cz</buyerEMail> <!-- (Optional)
<buyerStreet>Celní 22</buyerStreet> <!-- (Optional)
<buyerPostalCode>60200</buyerPostalCode> <!-- (Optional)
<buyerCity>Brno</buyerCity> <!-- (Optional)
<buyerCountry>CZ</buyerCountry> <!-- (Optional)
<remarks>Remark on SalesQuote</remarks> <!-- (Optional)
<introductionText>introduction text</introductionText> <!-- (Optional)
<vatTransactionType>0</vatTransactionType> <!-- (Optional) default is 0
<vatOutgoingDocumentVatClause>Registered</vatOutgoingDocumentVatClause> <!-- (Optional) Possible values: Registered, NotRegistered, RegisteredTourismLawPart47, RegisteredTourismLawPart31, RegisteredTourismLawPart47And31 <!-- (Optional)
<methodOfPayment>bankTransfer</methodOfPayment> <!-- Possible ways of payment: unknown, bankTransfer, cash, cheques, eurocardMastercard, visa, karanta, amex, diners, activa, ba, cashOnDelivery, moneta, directDebit, PayPal
<documentLanguage>Czech</documentLanguage> <!-- (Optional) Possible document language: Slovene, English, German, Italian and Croatian
<printingTemplate>Predloga2</printingTemplate> <!-- (Optional) Setting printing template for document, posible values is code of uploaded templates in web app
<vatCountryIsoCode>HR</vatCountryIsoCode> <!-- Mandatory if using vatTransactionTypes: 100, 8 and 5 and it determines that VAT procentages for specified country has to be taken
<warehouseCode>00001</warehouseCode> <!-- Mandatory, if not set in XML default warehouse is set
<Address> <!-- (Optional) Setting delivery address on document and partner buyer if it doesn't exists
<city>Ostrava</city>
<country>CZ</country>
<postalCode>77900</postalCode>
<street>Dolní 10</street>
<type>Delivery</type>
</Address>
<Items>
<Item> <!-- item specified with ref to product
<position>1</position> <!-- position of item
<productCode>020</productCode> <!-- internal product code
<quantity>100</quantity>
<discountPercentage>10</discountPercentage>
<vatTransactionType>0</vatTransactionType> <!-- (Optional) default is 0. Foreign VAT transaction types (100, 8 and 5) can only be set on document level.
</Item>
<Item> <!-- Item specified for good or service
<position>2</position> <!-- position of item
<description>Transport of goods</description>
<price>11.00</price>
<discountPercentage>2</discountPercentage> <!-- (Optional)
<vatPercentage>10</vatPercentage> <!-- (Optional)
<currency>CZK</currency> <!-- (Optional)
<quantity>10</quantity> <!-- (Optional) default 1
<unit>km</unit> <!-- (Optional)
<vatTransactionType>0</vatTransactionType> <!-- (Optional) default is 0. Foreign VAT transaction types (100, 8 and 5) can only be set on document level.
</Item>
...
</Items>
</parameter>
</method>
</request>
Response
HTTP/1.1 200 OK
Server: eurofaktura.cz web server
Date: Tue, 1 March 2010 11:00:05 GMT
Content-Type: text/xml
Content-Length: 328
<?xml version="1.0" encoding="utf-8"?>
response status="ok" >
<number>2010-00005</number> <!-- created document ID or number
<date>2010-01-13</date> <!-- date of document
</response>
Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- missing mandatory attributes, invalid values, no privileges,
</response>
Update existing Sales quote.Data must contain sales invoice number to be able to identify document which is to be updated.
Parameters
| SalesQuote | Complex parameter with data tags |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteUpdate">
<parameter name="SalesQuote">
<number>12</number> <!-- document number is mandatory in UPDATE (Can use sequential document number (example: 12), or formatted number (example: 12/2011))
<!-- Parameters are identical to the parameters in SalesQuoteCreate api
...
</parameter>
</method>
</request>
Response
HTTP/1.1 200 OK
Server: eurofaktura.cz web server
Date: Tue, 1 March 2010 11:00:05 GMT
Content-Type: text/xml
Content-Length: 328
<?xml version="1.0" encoding="utf-8"?>
response status="ok" >
<number>2010-00005</number>
<date>2010-01-13</date> <!-- date of document
</response>
Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- missing mandatory attributes, invalid values, no privileges,
</response>
Delete sales quote. Must specify parameter/s (number, number+date) to identify document for deleting.
Parameters
| number | Document number |
| date | Document date |
| costPosition | Cost position |
| businessUnit | Business unit |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteDelete">
<parameter name="number" value="2010-00002" />
<parameter name="date" type="Date" value="2010-02-22" />
</method>
</request>
Response
HTTP/1.1 200 OK
Server: eurofaktura.cz web server
Date: Tue, 1 March 2010 11:00:05 GMT
Content-Type: text/xml
Content-Length: 328
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
</response>
Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="no privileges"><error/> <!-- document could not be found, no privileges,
</response>
Get list of sales quotes for criteria which is specified by API parameters. Mixing different types of dates in search criteria is not supported - date parameters can be combined only as follows: dateFrom/dateTo or validUntilFrom/validUntilTo.
Parameters
| number | Document number |
| dateFrom | The date which is used to select sales orders whose date is following it |
| dateTo | The date which is used to select sales orders whose date is preceding it |
| validUntilFrom | The date which is used to select sales quotes whose validUntil is following it |
| validUntilTo | The date which is used to select sales quotes whose validUntil is preceding it |
| dateOfPaymentFrom | The date which is used to select sales orders whose date of payment (date from payment record on document) is following it. |
| dateOfPaymentTo | The date which is used to select sales orders whose date of payment (date from payment record on document) is preceding it. |
| deliveryAddress | Delivery address of the buyer |
| buyer | Buyer code, or buyer name |
| costPosition | Cost position code |
| totalAmount | Total amount of the sales quote |
| totalCurrency | Currency used in sales quote |
| article | Product code, or product name |
| status | Possible values:
|
| issuer | Issuer of document, search is done by username |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteList">
<parameter name="number" value="000002" />
<parameter name="dateFrom" type="Date" value="2009-11-01" />
<parameter name="dateTo" type="Date" value="2010-01-11" />
<parameter name="deliveryAddress" value="Dolní" />
<parameter name="totalAmount" type="Decimal" value="1000" />
<parameter name="status" value="Draft" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<SalesQuotes>
<SalesQuote>
<!-- structure of elements is the same as in SalesQuoteGet
</SalesQuote>
...
</SalesQuotes>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- no privileges,
</response>
Sends document by email to the recipient(s).
Parameters
| number | Document number |
| date | Document date (optional additional document identification) |
| sender | Email sender (Optional) |
| recipient | Comma delimited list of recipient(s) emails |
| cc | CC email (Optional) |
| bcc | BCC email (Optional) |
| subject | Mail subject (Optional) |
| message | Message text (Optional) |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteSendByEmail">
<parameter name="number" value="12/2009" />
<parameter name="date" type="Date" value="2010-01-13" />
<parameter name="sender" value="petr@novak.cz"/>
<parameter name="recipient" value="pavel@novak.cz,ondrej@novak.cz"/>
<parameter name="cc" value=""/>
<parameter name="bcc" value=""/>
<parameter name="subject" value="TEST s.r.o.: Sales quote nr. 0002/2010"/>
<parameter name="message" value="Message text"/>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="no privileges"><error/> <!-- document could not be found, no privileges, mail sending failed
</response>
Add payment record on sales quote.
Parameters
| number | Document number |
| date | Document date (optional additional document identification) |
| costPosition | Cost position |
| businessUnit | Business unit |
| paymentDate | Payment date |
| paymentAmount | Payment amount |
| paymentMethodForInvoice | Payment method for sales quote
|
| paymentRemark | Payment remark (optional) |
| paymentCurrency | Payment currency (optional) |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuotePaymentRecordAdd">
<parameter name="number" value="2014-00013"/>
<parameter name="date" type="Date" value="2014-05-15"/>
<parameter name="paymentDate" type="Date" value="2014-05-20"/>
<parameter name="paymentAmount" value="50"/>
<parameter name="paymentMethodForInvoice" value="Cash"/>
<parameter name="paymentRemark" value="Payment record on sales quote 2014-05-15"/>
<parameter name="paymentCurrency" value="EUR"/>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Payment method Test is not supported"><error/> <!-- wrong payment method chosen
</response>
Create sales invoice from sales quote.
Parameters
| number | Document number. Can use sequential document number (example: 2), or formated number (example: 2016-00002) |
| date | Document date |
| costPosition | Cost position/cost center |
| businessUnit | Business unit |
| status | Status for created invoice (issuedInvoice or draft). |
| warehouseCode | Warehouse that will be set on created invoice, default it is taken from sales quote. |
| cashRegisterCode | Cashbook ID. |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteCreateInvoice">
<parameter name="number" value="0005/2021"/>
<parameter name="status" value="issuedInvoice"/>
<parameter name="cashRegisterCode" value="001"/>
<parameter name="warehouseCode" value="908"/>
</method>
</request>
Response
HTTP/1.1 200 OK
Server: eurofaktura.cz web server
Date: Tue, 1 March 2010 11:00:05 GMT
Content-Type: text/xml
Content-Length: 328
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<number>2010-00005</number> <!-- created document number
<date>2010-01-13</date> <!-- date of document
<documentID>123.21421</documentID> <!-- created document ID
<message>Succesfuly created sales invoice from sales order</message>
</response>
Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="no privileges"><error/> <!-- document could not be found, no privileges,
</response>
Add image/attachment to sales quote.
Parameters
| number | Document number. Can use sequential document number (example: 2), or formated number (example: 2016-00002) |
| date | Document date |
| costPosition | Cost position/cost center |
| businessUnit | Business unit |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteAttachmentAdd">
<parameter name="number" type="String" value="2020-00001" />
<parameter name="attachment">
<contents encoding="BASE64">BASE64...</contents>
<fileName>att.jpg</fileName>
</parameter>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<message>Successfully added attachment att.jpg to sales quote 2020-00001.</message>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- Possible errors: Access denied. User account does not have sufficient privileges for the given request, Parameter named <number> is required, Can not find sales quote for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>
Add attachment to sales quote and set is as default.
Parameters
| number | Document number. Can use sequential document number (example: 2), or formated number (example: 2016-00002) |
| date | Document date |
| costPosition | Cost position/cost center |
| businessUnit | Business unit |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteAttachmentSetDefault">
<parameter name="number" type="String" value="2020-00001" />
<parameter name="attachment">
<contents encoding="BASE64">BASE64...</contents>
<fileName>att.jpg</fileName>
</parameter>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<message>Successfully added attachment att.jpg to sales quote 2020-00001.</message>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- Possible errors: Access denied. User account does not have sufficient privileges for the given request, Parameter named <number> is required, Can not find sales quote for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>
Get default attachment of sales quote.
Parameters
| number | Document number. Can use sequential document number (example: 2), or formated number (example: 2016-00002) |
| date | Document date |
| costPosition | Cost position/cost center |
| businessUnit | Business unit |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteAttachmentGet">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<SalesQuote>
<Attachments>
<Attachment>
<fileName>att.jpg</fileName>
<contents encoding="BASE64">BASE64</contents>
</Attachment>
</Attachments>
</SalesQuote>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- Possible errors: Access denied. User account does not have sufficient privileges for the given request, Parameter named <number> is required, Can not find sales quote for number: 2020-00001 Sales quote does not have attachemnts.
</response>
Get all images/attachments of article.
Parameters
| number | Document number. Can use sequential document number (example: 2), or formated number (example: 2016-00002) |
| date | Document date |
| costPosition | Cost position/cost center |
| businessUnit | Business unit |
Example request and response
POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.com
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="SalesQuoteAttachmentList">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<SalesQuote>
<Attachments>
<Attachment>
<fileName>att1.jpg</fileName>
<contents encoding="BASE64">1BASE64</contents>
</Attachment>
<Attachment>
<fileName>att2.jpg</fileName>
<contents encoding="BASE64">2BASE64</contents>
</Attachment>
<Attachment>
<fileName>att3.jpg</fileName>
<contents encoding="BASE64">3BASE64</contents>
</Attachment>
</Attachments>
</SalesQuote>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- Possible errors: Access denied. User account does not have sufficient privileges for the given request, Parameter named <number> is required, Can not find sales quote for number: 2020-00001 Sales quote does not have attachemnts.
</response>
