 |
| |
| |
| |
| |
| |
| |
| |
| |
| | |||||||||||||||
|
| |
| |
| |
| |
| |
| |
| |
| |
| | |||||||||||||||
| AdvanceInvoiceGet | Get advance invoice by document number, or by combination of document number and date. |
| AdvanceInvoiceGetPDF | Get PDF file for advance invoice by document number, or by combination of document number and date. |
| AdvanceInvoiceCreate | Create new advance invoice. |
| AdvanceInvoiceImport | Import advance invoice issued in other IS. |
| AdvanceInvoiceUpdate | Update existing advance invoice. |
| AdvanceInvoiceDelete | Delete advance invoice. |
| AdvanceInvoiceCancel | Cancel advance invoice. |
| AdvanceInvoiceList | Get list of advance invoices for specified criteria |
| AdvanceInvoiceSendByEmail | Sends document by email to the recipient(s). |
| AdvanceInvoiceAttachmentAdd | Add attachment to advance invoice. |
| AdvanceInvoiceAttachmentSetDefault | Add attachment to advance invoice and set is as default. |
| AdvanceInvoiceAttachmentGet | Get default attachment of advance invoice. |
| AdvanceInvoiceAttachmentList | Get all attachments of advance invoice. |
Get advance invoice by document number, or by combination of document number and date.
Parameters
| number | Document number. Can use sequential document number (example: 2), or formated number (example: 2010-00002) |
| date | Document date |
| costPosition | Cost centre code |
| businessUnit | Business unit |
| vatBook | Vat book |
Example request and response
(For internal "XML" format)
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="AdvanceInvoiceGet">
<parameter name="number" value="1/2013" />
<parameter name="date" type="Date" value="2013-02-15" />
</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">
<AdvanceInvoice>
<businessYear>2010</businessYear>
<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
<buyerCity>Olomouc</buyerCity>
<buyerCountry>CZ</buyerCountry>
<buyerName>5 FIVER s.r.o.</buyerName>
<buyerPostalCode>77900</buyerPostalCode>
<buyerStreet>Polní 22</buyerStreet>
<buyerTaxNumber>75882442</buyerTaxNumber>
<buyerVatRegistration>None</buyerVatRegistration>
<city>Praha</city>
<costPosition>1</costPosition>
<cashRegisterCode>0001</cashRegisterCode> <!-- This property must be set for fiscalization
<businessUnit>0001</businessUnit> <!-- This property must be set for fiscalization
<date>2010-02-19</date>
<dateOfSupplyFrom>2010-02-19</dateOfSupplyFrom>
<prepaymentDate>2010-03-06</prepaymentDate>
<invoicePricingType>retail</invoicePricingType>
<vatTransactionType>0</vatTransactionType>
<vatOutgoingDocumentVatClause>Registered</vatOutgoingDocumentVatClause>
<status>issuedInvoice</status>
<totalAmount>90.000</totalAmount>
<totalCurrency>CZK</totalCurrency>
<totalDiscount>8.33</totalDiscount>
<totalNetAmount>75.00</totalNetAmount>
<totalVatAmountFlatRate>0.00</totalVatAmountFlatRate>
<totalVatAmountNormalRate>0.00</totalVatAmountNormalRate>
<totalVatAmountLowerRate>0.00</totalVatAmountLowerRate>
<totalVatAmountZeroRate>0.0</totalVatAmountZeroRate>
<totalVatBaseAmountFlatRate>0.00</totalVatBaseAmountFlatRate>
<totalVatBaseAmountNormalRate>0.00</totalVatBaseAmountNormalRate>
<totalVatBaseAmountLowerRate>0.00</totalVatBaseAmountLowerRate>
<totalVatBaseAmountZeroRate>1.55</totalVatBaseAmountZeroRate>
<reference>05 11290</reference> <!-- generated unique payment identifier - VS(variabilni symbol)
<salesInvoicesRef>2014-00001, 2014-00002, 2014-00003</salesInvoicesRef> <!-- references to sales invoices
<deliveryNotesRef>2014-00004, 2014-00005, 2014-00006</deliveryNotesRef> <!-- references to delivery notes
<creditNotesRef>2014-00004</creditNotesRef> <!-- references to credit notes
<cancelledDocumentRef>2012-00015</cancelledDocumentRef> <-- Reference to cancelled document
<eor>34facd65-622b-745d-a541-30ab1f9d3ac1</eor> <!-- generated by FURS
<zoi>a7e5f55e1dbb48b799268e1a6d8618a3</zoi> <!-- generated when issuing document if it is for fiscalization
<fiscalNumber>1</fiscalNumber> <!-- fiscal sequential number for fiscal numbering of document
<introductionText>introduction text</introductionText>
<Address>
<city>Brno</city>
<country>CZ</country>
<postalCode>60200</postalCode>
<street>Polní 10</street>
<type>Delivery</type>
</Address>
<Items>
<Item>
<position>1</position>
<amount>75.00</amount>
<amountWithoutDiscount>83.33</amountWithoutDiscount>
<currency>CZK</currency>
<description>Test položka</description>
<discountAmount>8.33</discountAmount>
<discountPercentage>10.0000</discountPercentage>
<netPrice>83.33333</netPrice>
<netPriceInDocumentCurrency>83.33333</netPriceInDocumentCurrency>
<quantity>1.000</quantity>
<price>100.00000</price>
<priceInDocumentCurrency>100.00000</priceInDocumentCurrency>
<vatAmount>15.00</vatAmount>
<vatPercentage>20.0</vatPercentage>
<vatTransactionType>0</vatTransactionType>
<costPosition>1</costPosition>
</Item>
</Items>
</AdvanceInvoice>
</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 advance invoice 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 centre code |
| businessUnit | Business unit |
| vatBook | Vat book |
| 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="AdvanceInvoiceGetPDF">
<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 advance invoice for number: 2 and date: 2010-02-22">
</error>
</response>
Create new advance invoice.
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,
1 - Zero-rated transaction - supply of goods within the EU,
2 - Zero-rated transaction - supply of goods within the EU(fixed assets),
3 - Zero-rated transaction - supply of service in the EU,
4 - Zero-rated transaction - exports of goods outside the EU,
5 - Zero-rated transaction - new vehicle delivery to person not registred for VAT within the EU,
20 - Zero-rated transaction - goods delivery within EU (over limit) - foreign VAT calculated,
7 - Zero-rated transaction - reverse charge (goods supply/assembly the service),
8 - Zero-rated transaction - other taxable transaction with claim of VAT deduction,
10 - Zero-rated transaction - tripartite supplies of goods within the EU,
11 - Tax amount correction in insolvency proceedings (creditor),
12 - VAT exempt transactions without the right of input VAT deduction,
15 - Transactions exempt from VAT - not for VAT records,
21 - Zero-rated transaction - assembly in the EU (foreign VAT calculated),
100 - Sales of electronic services in other EU member countries (foreign VAT calculated)
Status of advance invoice which is created from this web service is automatically set to "issuedInvoice" if parameter number is specified in parameter list, or if it's status is explicitelly set to issuedInvoice. For such cases (if invoice is created as issued), service will automatically generate delivery note for contained products to reduce their quantity on stock.
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
| AdvanceInvoice | 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="AdvanceInvoiceCreate">
<parameter name="AdvanceInvoice">
<date>2010-01-13</date> <!-- document date
<dateOfSupplyFrom>2010-02-19</dateOfSupplyFrom>
<prepaymentDate>2010-03-06</prepaymentDate>
<city>Brno</city>
<customerContactPerson></customerContactPerson> <!-- (Optional)
<type>retail</type> <!-- (Optional) Type of pricing - default is "gross"
<status>issuedInvoice</status> <!-- (Optional) Possible values: issuedInvoice, draft - default is issuedInvoice
<isReccurringInvoice>false</isReccurringInvoice>
<vatTransactionType>0</vatTransactionType> <!-- (Optional) default is 0
<vatOutgoingDocumentVatClause>Registered</vatOutgoingDocumentVatClause> <!-- (Optional) Possible values: Registered, NotRegistered,RegisteredForEUSuppliesOnly
<costPosition>120</costPosition> <!-- (Optional) Cost centre code
<cashRegisterCode>0001</cashRegisterCode> <!-- Mandatory for fiscalization
<businessUnit>0001</businessUnit> <!-- Mandatory for fiscalization
<deliveryMethod>Delivery method</deliveryMethod> <!-- (Optional)
<superDiscountPercentage>5</superDiscountPercentage> <!-- (Optional)
<remarks>Remark on Advance invoice</remarks> <!-- (Optional)
<introductionText>introduction text</introductionText> <!-- (Optional)
<buyerCode>123456</buyerCode> <!-- (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
<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) ISO-2 country code
<methodOfPayment>bankTransfer</methodOfPayment> <!-- Possible ways of payment: unknown, bankTransfer, cash, cheques, eurocardMastercard, visa, karanta, amex, diners, activa, ba, cashOnDelivery, moneta, directDebit
<documentLanguage>Czech</documentLanguage> <!-- (Optional) Possible document language: Slovene, English, German, Italian and Croatian
<printingTemplate>Předloha2</printingTemplate> <!-- (Optional) Setting printing template for document, posible values is code of uploaded templates in web app
<salesInvoiceRef>2014-00001</salesInvoiceRef> <!-- (Optional) Setting reference to advance invoice
<salesQuoteRef>2014-00001</salesQuoteRef> <!-- (Optional) Setting reference to sales quote
<salesOrderRef>2014-00001</salesOrderRef> <!-- (Optional) Setting reference to sales order
<Address> <!-- (Optional) Setting delivery address on document and partner buyer if it doesn't exists
<city>Brno</city>
<country>CZ</country>
<postalCode>60200</postalCode>
<street>Polní 10</street>
<type>Delivery</type>
</Address>
<Items>
<Item> <!-- item specified with ref to product
<position>1</position> <!-- position of item
<productCode>020</productCode> <!-- product code
<quantity>100</quantity>
<discountPercentage>10</discountPercentage>
<vatTransactionType>0</vatTransactionType> <!-- (Optional) default is 0
<costPosition>1</costPosition>
</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 0
<unit>km</unit> <!-- (Optional)
<vatTransactionType>0</vatTransactionType> <!-- (Optional) default is 0
<costPosition>1</costPosition>
</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>2/2013</number> <!-- created document ID or number
<date>2013-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>
Import advance invoice issued in other IS. Parameter 'importType' can be used to specify type of import. If parameter is not specified, "createOrUpdate" is used as default. For updating advance invoices with this api call, advance invoices's data must contain code as unique identifier.
Parameters
| importType | Flag for the type of import
|
| AdvanceInvoice | Advance invoice data in xml substructure. |
| dataFormat | In case some other data format is used for import, this parameter should be used. If this parameter is not included in XML, import from default data format is used.
|
| base64data | This parameter is mandatory in case using dataFormat "POHODA". Content of this parameter should be Pohoda XML encoded into base64 string. |
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="AdvanceInvoiceImport">
<parameter name="importType" value="createOrUpdate" />
<parameter name="AdvanceInvoice">
<!-- structure of elements is the same as in AdvanceInvoiceCreate only tag <number> is mandatory here
<parameter/>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<number>0001-1206-2014</number>
<date>2013-06-12</date>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Property <number> is required."><error/> <!-- missing number …
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Advance invoice for number: 0001-1206-2013 already exists!"></error> <!-- Advance invoice for number already exists …
</response>
(Using POHODA data format)
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="AdvanceInvoiceImport">
<parameter name="importType" value="createOrUpdate" />
<parameter name="dataFormat" value="POHODA" />
<parameter name="base64data">JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+Cn...
<!-- Pohoda XML encoded into base64 string
<parameter/>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<number>0001-1206-2014</number>
<date>2021-06-12</date>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Parameter <base64data>: cannot parse contents"></error> <!-- Error when decoding XML from base64 string
</response>
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Error parsing XML file due to invalid syntax"></error> <!-- Error when parsing XML
</response>
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Document can not be overwritten because it is already posted."></error> <!-- There are several different error messages possible.
</response>
Update existing advance invoice.Data must contain advance invoice number to be able to identify document which is to be updated.
Parameters
| AdvanceInvoice | 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="AdvanceInvoiceUpdate">
<parameter name="AdvanceInvoice">
<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 SalesInvoiceCreate 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>2/2013</number> <!-- updated document ID or number
<date>2013-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 advance invoice. Must specify parameter/s (number, number+date) to identify document for deleting. It is possible to delete only last advance invoice.
Parameters
| number | Document number |
| date | Document date |
| costPosition | Cost centre code |
| businessUnit | Business unit |
| vatBook | Vat book |
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="AdvanceInvoiceDelete">
<parameter name="number" value="12/2009" />
<parameter name="date" type="Date" value="2016-01-13" />
</method>
</request>
Response
HTTP/1.1 200 OK
Server: eurofaktura.cz web server
Date: Tue, 1 March 2016 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>
Cancel advance invoice. Must specify parameter/s (number, number+date) to identify document for canceling.
Parameters
| number | Document number |
| date | Document date |
| costPosition | Cost centre code |
| businessUnit | Business unit |
| vatBook | Vat book |
| status | Status of cancelation document (draft, issuedInvoice). By Default status is issuedInvoice. |
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="AdvanceInvoiceCancel">
<parameter name="number" value="2013-00014" />
<parameter name="date" type="Date" value="2013-03-26" />
<parameter name="status" value="draft" />
</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="Access denied. User account does not have sufficient privileges for the given request"><error/> <!-- document could not be found, no privileges, …
</response>
Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Can not cancel advance invoice for arguments number: 2013-00014 date: 2013-03-26"><error/> <!-- document could not be canceled, …
</response>
Possible error messages:
Access denied. User account does not have sufficient privileges for the given request
Parameter named "number" is required
Can not find advance invoice for number
Can not cancel. Found X advance invoices
Found X advance invoices X. You can only cancel one advance invoice at a time
Can not cancel advance invoice X
Get list of advance invoices 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, prepaymentDateFrom/prepaymentDateTo or dateOfSupplyFrom/dateOfSupplyUntil.
Parameters
| number | Document number |
| dateFrom | The date which is used to select advance invoices whose date is following it |
| dateTo | The date which is used to select advance invoices whose date is preceding it |
| prepaymentDateFrom | The date which is used to select advance invoices whose date of prepayment is following it |
| prepaymentDateTo | The date which is used to select advance invoices whose date of prepayment is preceding it |
| dateOfSupplyFrom | The date which is used to select advance invoices whose date of supply/performance is following it |
| dateOfSupplyUntil | The date which is used to select advance invoices whose date of supply/performance is preceding it |
| deliveryAddress | Delivery address of the buyer |
| buyer | Buyer code, or buyer name |
| costPosition | Cost centre code |
| totalAmount | Total amount of the advance invoices |
| totalCurrency | Currency used in advance invoice |
| article | Product code, or product name |
| status | Possible values: Draft, IssuedInvoice, NotBooked, Booked, CanceledCreditInvoice, OpenedClaim, ClosedClaim, OpenedDueClaim, DocumentSentAlready, DocumentNotYetSent, DocumentSentByEMail, DocumentNotSentByEMail, CancellationDocument, CancelledDocument, HasOpenAmountForSalesInvoice, HasNoOpenAmountForSalesInvoice, AccountingEntryOrImportedInvoice, DocumentNotSentOrPrinted, NotCancellationOrCancelledDocument, VatReportDone, VatReportOpen |
| 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="AdvanceInvoiceList">
<parameter name="status" value="issuedInvoice" />
<parameter name="dateFrom" type="Date" value="2010-02-19" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<AdvanceInvoices>
<AdvanceInvoice>
<!-- structure of elements is the same as in AdvanceInvoiceGet
</AdvanceInvoice>
...
</AdvanceInvoices>
</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="AdvanceInvoiceSendByEmail">
<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 invoice 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 image/attachment to advance invoice.
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="AdvanceInvoiceAttachmentAdd">
<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 advance invoice 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 advance invoice for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>
Add attachment to advance invoice 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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="AdvanceInvoiceAttachmentSetDefault">
<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 advance invoice 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 advance invoice for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>
Get default attachment of advance invoice.
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="AdvanceInvoiceAttachmentGet">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<AdvanceInvoice>
<Attachments>
<Attachment>
<fileName>att.jpg</fileName>
<contents encoding="BASE64">BASE64</contents>
</Attachment>
</Attachments>
</AdvanceInvoice>
</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 advance invoice for number: 2020-00001 advance invoice 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.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="AdvanceInvoiceAttachmentList">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<AdvanceInvoice>
<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>
</AdvanceInvoice>
</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 advance invoice for number: 2020-00001 advance invoice does not have attachemnts.
</response>
