Prva stran 
Nazaj 
Naprej 
Novosti 
 Kopiraj povezavo na to stran 
 
Natisni stranNatisni stran  
e-računi navodila za up...  >  Spletne storitve in int...  >  API Reference  >  DebitNote API

DebitNote API

DebitNoteGetGet debit note by document number, or by combination of document number and date.
DebitNoteGetPDFGet PDF file for debit note by document number, or by combination of document number and date.
DebitNoteCreateCreate new debit note.
DebitNoteImportImport debit note issued in other IS.
DebitNoteUpdateUpdate existing debit note.
DebitNoteDeleteDelete debit note.
DebitNoteCancelCancel debit note.
DebitNoteListGet list of debit notes for specified criteria
DebitNoteSendByEmailSends document by email to the recipient(s).
DebitNoteAttachmentAddAdd attachment to debit note.
DebitNoteAttachmentSetDefaultAdd attachment to debit note and set is as default.
DebitNoteAttachmentGetGet default attachment of debit note.
DebitNoteAttachmentListGet all attachments of debit note.

DebitNoteGet

Get debit note by document number, or by combination of document number and date.

Parameters

numberDocument number. Can use sequential document number (example: 2), or formated number (example: 2010-00002)
dateDocument date
costPositionCost position
businessUnitBusiness unit
vatBookVat book
documentIDInternal document identificator. In case of using this parameter, no other parameter listed abowe is needed for searching by document.

Example request and response

(For internal "XML" format)

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteGet">
       <parameter name="number" value="1/2013" />
       <parameter name="date" type="Date" value="2013-02-15" />
</method>
</request>

Response
HTTP/1.1 200 OK
Server: e-racuni.com 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">
       <DebitNote>
               <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>RADOVLJICA</buyerCity>
               <buyerCountry>SI</buyerCountry>
               <buyerName>5 FIVER d.o.o.</buyerName>
               <buyerPostalCode>4240</buyerPostalCode>
               <buyerStreet>ULICA 22</buyerStreet>
               <buyerTaxNumber>75882442</buyerTaxNumber>
               <buyerVatRegistration>None</buyerVatRegistration>
               <city>Beograd</city>
               <costPosition>1</costPosition>
               <cashRegisterCode>0001</cashRegisterCode>  <!-- This property must be set for fiscalization
               <businessUnit>0001</businessUnit>          <!-- This property must be set for fiscalization
               <orderReference>123</orderReference>                    <!-- (Optional)
               <date>2010-02-19</date>
               <dateOfSupplyFrom>2010-02-19</dateOfSupplyFrom>
               <paymentDueDate>2010-03-06</paymentDueDate>
               <invoicePricingType>retail</invoicePricingType>
               <number>2010-00002</number>             <!-- document number optional AUTO numbering
               <vatTransactionType>0</vatTransactionType>
               <vatOutgoingDocumentVatClause>Registered</vatOutgoingDocumentVatClause>
               <status>issuedInvoice</status>
               <totalAmount>90.000</totalAmount>
               <totalCurrency>EUR</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 reference number
               <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>   
               <vatCountryIsoCode>HR</vatCountryIsoCode>
               <Address>                        <!-- (Optional) Setting delivery address on document and partner buyer if it doesn't exists              
                       <city>Celje</city>
                       <country>SI</country>
                       <postalCode>3000</postalCode>
                       <street>Ulica 10</street>
                       <type>Delivery</type>
                       <firstAddressLine>Delivery address</firstAddressLine>
               </Address>
               <Items>
                       <Item>
                               <position>1</position>
                               <amount>75.00</amount>
                               <amountWithoutDiscount>83.33</amountWithoutDiscount>
                               <currency>EUR</currency>
                               <description>Prevoz robe</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>
       </DebitNote>
</response>

Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
       <error description="document could not be found"><error/>
</response>


DebitNoteGetPDF

Get PDF for debit note 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

numberDocument number. Can use sequential document number (example: 2), or formated number (example: 2010-00002)
dateDocument date
costPositionCost position
businessUnitBusiness unit
vatBookVat book
documentIDInternal document identificator. In case of using this parameter, no other parameter listed abowe is needed for searching by document.
markDocumentAsSentMarks document as sent.

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteGetPDF">
       <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 debit note for number: 2 and date: 2010-02-22">
       </error>
</response>


DebitNoteCreate

Create new debit note.

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. Supported values for vatTransactionType are:
0 - Taxable transactions of goods and services in Slovenia //Obdavčen promet blaga in storitev v Sloveniji
1 - Zero-rated transaction - exports of goods outside the EU //Oproščen promet - izvoz blaga izven EU
2 - Zero-rated transaction - without the right to deduct input VAT //Oproščen promet - brez pravice do odbitka vstopnega DDV
3 - Zero-rated transaction - with the right to deduct input VAT //Oproščen promet - s pravico do odbitka vstopnega DDV
4 - Zero-rated transaction - supply of goods within the EU //Oproščen promet - dobava blaga znotraj EU
5 - Zero-rated transaction - assembly in the EU //Oproščen promet - montaža v EU (obračun tujega DDV)
6 - Zero-rated transaction - tripartite supplies of goods within the EU //Oproščen promet - tristranske dobave blaga znotraj EU
7 - Transactions exempt from VAT - not for VAT records //Neobdavčen promet - ne gre v DDV evidence
8 - Zero-rated transaction - remote sales of goods //Oproščen promet - prodaja blaga na daljavo (obračun tujega DDV)
9 - Transactions exempt from VAT with the right of input VAT deduction (transactions outside SLO) //Neobdavčljiv promet s pravico do odbitka vstopnega DDV (prometi izven SLO)
10- Supply of goods and services in SLO, VAT charged by the recipient //Dobava blaga in storitev v SLO, DDV obračuna prejemnik (76.a člen)
11- Sales of services in the EU, VAT paid by the recipient //Oproščen promet - storitve v EU, od katerih plača DDV prejemnik
100- Sales of electronic services taxed in other EU country //
101- Special vat margin calculation for used goods//Posebna ureditev za rabljeno blago
102- Special vat margin calculation for used goods - tax free //Posebna ureditev za rabljeno blago - oproščen promet
103- Vat free transaction - supply of goods in EU by call-of-stock arrangement //Oproščen promet - dobava blaga znotraj EU po skladiščenju na odpoklic
104- Vat free transaction - supply of goods in EU by customs procedure 42 and 63 //Oproščen promet - dobava blaga znotraj EU po carinskih postopkih 42 in 63
105- Not subject to VAT – supply of goods outside EU //Neobdavčen promet - dobava blaga zunaj Unije (tretje države)
106- Distance sales of goods to EU consumers (OSS) //Prodaja blaga na daljavo končnim potrošnikom v EU (OSS)
107- Supply of services to EU consumers (OSS) //Prodaja storitev končnim potrošnikom v EU (OSS)
109- Distance sales of goods to domestic consumers (OSS) //Prodaja blaga na daljavo končnim potrošnikom v SLO (OSS)
108- Distance sales of imported goods to EU consumers (IOSS) //Prodaja na daljavo iz tretjih držav uvoženega blaga končnim potrošnikom v EU (IOSS)
110- Distance sales of imported goods to domestic consumers (IOSS)//Prodaja na daljavo iz tretjih držav uvoženega blaga končnim potrošnikom v SLO (IOSS)
120- Supply of services from EU to third country consumers (foreign VAT) //Izvoz storitev iz EU končnim potrošnikom v državi izven EU (obračun tujega DDV)
Number of debit note which is created from this web service is automatically set if parameter status is set to "issuedInvoice".

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.

Parameters

DebitNoteComplex parameter with data tags

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteCreate">
<parameter name="DebitNote">            
               <date>2010-01-13</date>                         <!-- document date
               <dateOfSupplyFrom>2010-02-19</dateOfSupplyFrom>
               <paymentDueDate>2010-03-06</paymentDueDate>             
               <city>Beograd</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, RegisteredTourismLawPart47, RegisteredTourismLawPart31, RegisteredTourismLawPart47And31
               <costPosition>120</costPosition>                        <!-- (Optional)
               <cashRegisterCode>0001</cashRegisterCode>                <!-- Mandatory for fiscalization
               <businessUnit>0001</businessUnit>                        <!-- Mandatory for fiscalization
               <deliveryMethod>Delivery method</deliveryMethod>        <!-- (Optional)
               <superDiscountPercentage>5</superDiscountPercentage> <!-- (Optional)
               <remarks>Remark on Sales 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>Micka Kovac</buyerName>              
               <buyerTaxNumber>02169711</buyerTaxNumber>       <!-- (Optional)
               <buyerVatRegistration>None</buyerVatRegistration>       <!-- (Unkown, None, Registered)
               <buyerEMail>micka@kovac.com</buyerEMail>                <!-- (Optional)
               <buyerStreet>Iztokova 22</buyerStreet>                  <!-- (Optional)
               <buyerPostalCode>2000</buyerPostalCode>                 <!-- (Optional)
               <buyerCity>Maribor</buyerCity>                  <!-- (Optional)
               <buyerCountry>SI</buyerCountry>                         <!-- (Optional) ISO-2 country code
               <documentLanguage>Slovene</documentLanguage> <!-- (Optional) Possible document language: Slovene, English, German, Croatian, Italian, Hungarian, Czech, Slovak, Serbian, Polish and Bulgarian
               <printingTemplate>Predloga2</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 sales invoice
               <vatCountryIsoCode>HR</vatCountryIsoCode> <!-- Mandatory if using vatTransactionTypes: 100, 8 and 5 and it determines that VAT procentages for specified country has to be taken
               <Address>                        <!-- (Optional) Setting delivery address on document and partner buyer if it doesn't exists              
                       <city>Celje</city>
                       <country>SI</country>
                       <postalCode>3000</postalCode>
                       <street>Ulica 10</street>
                       <type>Delivery</type>
                       <firstAddressLine>Delivery address</firstAddressLine>
               </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. Foreign VAT transaction types (100, 8 and 5) can only be set on document level.
                               <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>      <!-- price (retail price including VAT for retail document) or netPrice (gross price without VAT for gross document). Default document type is "gross" so use <netPrice> tag in this case or <price> tag in case of document type "retail"
                               <discountPercentage>2</discountPercentage>      <!-- (Optional)
                               <vatPercentage>10</vatPercentage>               <!-- (Optional)
                               <currency>EUR</currency>                        <!-- (Optional)
                               <quantity>10</quantity>                         <!-- (Optional) default 0
                               <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.
                               <costPosition>1</costPosition>
                       </Item>
                       ...
               </Items>
       </parameter>
</method>
</request>

Response
HTTP/1.1 200 OK
Server: e-racuni.com 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>


DebitNoteImport

Import Debit note 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 Debit notes with this api call, Debit notes's data must contain code as unique identifier.

Parameters

importTypeFlag for the type of import
DebitNoteSales invoice data in xml substructure.

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteImport">
               <parameter name="importType" value="createOrUpdate" />
               <parameter name="DebitNote">
                    <!-- structure of elements is the same as in DebitNoteCreate 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="Debit note for number: 0001-1206-2013 already exists!"></error>  <!-- Debit note for number already exists  
</response>


DebitNoteUpdate

Update existing debit note.Data must contain debit note number to be able to identify document which is to be updated.

Parameters

DebitNoteComplex parameter with data tags

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteUpdate">
<parameter name="DebitNote">
         <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: e-racuni.com 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>


DebitNoteDelete

Delete debit note. Must specify parameter/s (number, number+date) to identify document for deleting. It is possible to delete only last debit note.

Parameters

numberDocument number
dateDocument date
costPositionCost position
businessUnitBusiness unit
vatBookVat book

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteDelete">
       <parameter name="number" value="12/2009" />
       <parameter name="date" type="Date" value="2016-01-13" />
</method>
</request>

Response
HTTP/1.1 200 OK
Server: e-racuni.com 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>



DebitNoteCancel

Cancel debit note. Must specify parameter/s (number, number+date) to identify document for cancelling.

Parameters

numberDocument number
dateDocument date
costPositionCost position
businessUnitBusiness unit
vatBookVat book
statusStatus of cancelation document (draft, issuedInvoice). By Default status is issuedInvoice.
cancellationDocNumberNumber of cancellation document (mandatory and works only for imported documents).

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteCancel">
       <parameter name="number" value="2013-00014" />
       <parameter name="cancellationDocNumber" value="2013-00014" />  <!-- Works only when canceling imported documents where this number is mandatory
       <parameter name="date" type="Date" value="2013-03-26" />
       <parameter name="status" value="draft" />
</method>
</request>

Response
HTTP/1.1 200 OK
Server: e-racuni.com 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 debit note 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 debit note for number
Can not cancel. Found X debit notes
Found X debit notes X. You can only cancel one debit note at a time
Can not cancel debit note X



DebitNoteList

Get list of debit notes 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, paymentDueDateFrom/paymentDueDateTo or dateOfSupplyFrom/dateOfSupplyUntil.

Parameters

numberDocument number
dateFromThe date which is used to select debit notes whose date is following it
dateToThe date which is used to select debit notes whose date is preceding it
paymentDueDateFromThe date which is used to select debit notes whose payment due date is following it
paymentDueDateToThe date which is used to select debit notes whose payment due date is preceding it
dateOfSupplyFromThe date which is used to select debit notes whose date of supply/performance is following it
dateOfSupplyUntilThe date which is used to select debit notes whose date of supply/performance is preceding it
deliveryAddressDelivery address of the buyer
buyerBuyer code, or buyer name
costPositionCost position code
totalAmountTotal amount of the debit notes
totalCurrencyCurrency used in debit note
articleProduct code, or product name
statusPossible values: Draft, IssuedInvoice, NotBooked, Booked, CanceledCreditInvoice, OpenedClaim, ClosedClaim, OpenedDueClaim, DocumentSentAlready, DocumentNotYetSent, DocumentSentByEMail, DocumentNotSentByEMail, CancellationDocument, CancelledDocument, AccountingEntryOrImportedInvoice, DocumentNotSentOrPrinted, NotCancellationOrCancelledDocument, VatReportDone, VatReportOpen
issuerIssuer of document, search is done by username

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteList">
               <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" >
<DebitNotes>                    
       <DebitNote>
                <!-- structure of elements is the same as in DebitNoteGet
       </DebitNote>
       ...
</DebitNotes>
</response>


Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
       <error description=""><error/>          <!-- no privileges,  
</response>


DebitNoteSendByEmail

Sends document by email to the recipient(s).

Parameters

numberDocument number
dateDocument date (optional additional document identification)
senderEmail sender (Optional)
recipientComma delimited list of recipient(s) emails
ccCC email (Optional)
bccBCC email (Optional)
subjectMail subject (Optional)
messageMessage text (Optional)
useHtmlMessageSend message text as HTML (Optional)

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteSendByEmail">
       <parameter name="number" value="12/2009" />
       <parameter name="date" type="Date" value="2010-01-13" />
       <parameter name="sender" value="micka@kovac.com"/>
       <parameter name="recipient" value="zoran@kovac.com,zlatko@kovac.com"/>
       <parameter name="cc" value=""/>
       <parameter name="bcc" value=""/>
       <parameter name="subject" value="TEST d.o.o.: Sales invoice nr. 0002/2010"/>
       <parameter name="message" value="Message text"/>
        <parameter name="useHtmlMessage" value="true"/>
</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>


DebitNoteAttachmentAdd

Add image/attachment to debit note.

Parameters

numberDocument number. Can use sequential document number (example: 2), or formated number (example: 2016-00002)
dateDocument date
costPositionCost position/cost center
businessUnitBusiness unit

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteAttachmentAdd">
       <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 debit note 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 debit note for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>


DebitNoteAttachmentSetDefault

Add attachment to debit note and set is as default.

Parameters

numberDocument number. Can use sequential document number (example: 2), or formated number (example: 2016-00002)
dateDocument date
costPositionCost position/cost center
businessUnitBusiness unit

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteAttachmentSetDefault">
       <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 debit note 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 debit note for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>


DebitNoteAttachmentGet

Get default attachment of debit note.

Parameters

numberDocument number. Can use sequential document number (example: 2), or formated number (example: 2016-00002)
dateDocument date
costPositionCost position/cost center
businessUnitBusiness unit

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteAttachmentGet">
       <parameter name="number" type="String" value="2020-00001" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <DebitNote>
               <Attachments>
                       <Attachment>
                               <fileName>att.jpg</fileName>
                               <contents encoding="BASE64">BASE64</contents>
                       </Attachment>
               </Attachments>
       </DebitNote>
</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 debit note for number: 2020-00001 Debit note does not have attachemnts.
</response>


DebitNoteAttachmentList

Get all images/attachments of article.

Parameters

numberDocument number. Can use sequential document number (example: 2), or formated number (example: 2016-00002)
dateDocument date
costPositionCost position/cost center
businessUnitBusiness unit

Example request and response

POST /WebServicesSI/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="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DebitNoteAttachmentList">
       <parameter name="number" type="String" value="2020-00001" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <DebitNote>
               <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>
       </DebitNote>
</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 debit note for number: 2020-00001 Debit note does not have attachemnts.
</response>

Reference na stran

---
Zadnja sprememba 09.12.2021 11:57:27
© E-RAČUNI d.o.o. 2003-2022