Prva stran 
Nazaj 
Naprej 
Novosti 
 
Natisni stranNatisni stran  
e-računi navodila za up...  >  Spletne storitve in int...  >  API Reference  >  PurchaseOrder API

PurchaseOrder API

PurchaseOrderGetGet purchase orders by document number, or by combination of document number and date.
PurchaseOrderGetPDFGet PDF file for purchase orders by document number, or by combination of document number and date.
PurchaseOrderCreateCreate new purchase order.
PurchaseOrderUpdateUpdate existing purchase order.
PurchaseOrderDeleteDelete purchase order.
PurchaseOrderCancelCancel purchase order.
PurchaseOrderListGet list of purchase orders for specified criteria
PurchaseOrderSendByEmailSends document by email to the recipient(s).


PurchaseOrderGet

Get purchase orders by document number, or by combination of document number and date.

Parameters

numberDocument number. Can use sequential document number (example: 8), or formatted number (example: 2011-00008)
dateDocument date
costPositionCost position

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="PurchaseOrderGet">
       <parameter name="number" value="8" />
       <parameter name="date" type="Date" value="2011-01-11" />
</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">
       <PurchaseOrder>
               <number>2011-00008</number>
               <date>2011-01-11</date>
               <deliveryDate>2011-01-15</deliveryDate>
               <deliveryMethod>Test delivery method</deliveryMethod>
               <dueDate>2011-01-30</dueDate>
               <businessYear>2011</businessYear>
               <city>Nova Gorica</city>
               <costPosition>120</costPosition>
               <remarks>Remark on Purchase order</remarks>
               <salesQuoteReference>SQ2010-000001</salesQuoteReference>
               <status>Opened</status>
               <superDiscountPercentage>5.0000</superDiscountPercentage>
               <supplierCity>Maribor</supplierCity>
               <supplierCountry>SI</supplierCountry>
               <supplierName>Test supplier</supplierName>
               <supplierPostalCode>1234</supplierPostalCode>
               <supplierStreet>Test ul. 22</supplierStreet>
               <supplierTaxNumber>SI95985352</supplierTaxNumber>
               <supplierVatRegistration>Registered</supplierVatRegistration>
               <totalAmount>22.430</totalAmount>
               <totalCurrency>EUR</totalCurrency>
               <totalDiscount>1.52</totalDiscount>
               <totalNetAmount>20.48</totalNetAmount>
               <totalVatAmountFlatRate>0.00</totalVatAmountFlatRate>
               <totalVatAmountNormalRate>0.00</totalVatAmountNormalRate>
               <totalVatAmountLowerRate>1.95</totalVatAmountLowerRate>
               <totalVatAmountZeroRate>0.0</totalVatAmountZeroRate>
               <totalVatBaseAmountFlatRate>0.00</totalVatBaseAmountFlatRate>
               <totalVatBaseAmountNormalRate>0.00</totalVatBaseAmountNormalRate>
               <totalVatBaseAmountLowerRate>20.48</totalVatBaseAmountLowerRate>
               <totalVatBaseAmountZeroRate>0.00</totalVatBaseAmountZeroRate>
               <vatTransactionType>0</vatTransactionType>
               <vatOutgoingDocumentVatClause>Registered</vatOutgoingDocumentVatClause>
               <goodsReceiptsRef>2011-00007, 2011-00009, 2011-00010</goodsReceiptsRef> <-- References to goods receipts
               <cancelledDocumentRef>2011-00015</cancelledDocumentRef> <-- Reference to cancelled document
               <Items>
                       <Item>
                               <amount>20.48</amount>
                               <amountWithoutDiscount>22.00</amountWithoutDiscount>
                               <currency>EUR</currency>
                               <description>Transport of goods</description>
                               <discountAmount>1.52</discountAmount>
                               <discountPercentage>2.0000</discountPercentage>
                               <netPrice>11.00000</netPrice>
                               <netPriceInDocumentCurrency>11.00000</netPriceInDocumentCurrency>
                               <position>1</position>
                               <price>12.04500</price>
                               <priceInDocumentCurrency>12.04500</priceInDocumentCurrency>
                               <quantity>2.000000</quantity>
                               <totalDiscountPercentage>6.9000</totalDiscountPercentage>
                               <unit>km</unit>
                               <unit>km</unit>
                               <vatAmount>1.95</vatAmount>
                               <vatPercentage>9.5</vatPercentage>
                       </Item>
               </Items>
       </PurchaseOrder>
</response>

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


PurchaseOrderGetPDF

Get PDF for purchase order 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

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="PurchaseOrderGetPDF">
          <parameter name="number" value="8" />
       <parameter name="date" type="Date" value="2011-01-11" />
</method>
</request>


Response
<response status="ok">
       <number>2012-01293</number>
       <date>2013-01-02</date>
       <pdfFile>JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nJVYS4/bNh...</pdfFile>
</response>

Response (on error)
<response status="error">
       <error description="Can not find sales invoice for number: 8 and date: 2011-01-11">
       </error>
</response>



PurchaseOrderCreate

Create new purchase order.

Document item can be specified with: productCode, quantity, discountPercentage, or can be specified with: description, currency, quantity, netPrice.Additional optional item fields are: discountPercentage, unit, vatPercentage, vatTransactionType. date Date YYYY-MM-DDunit String OptionalvatTransactionType Enum 0-9 (0 is default) OptionalValues description for vatTransactionType:
0 - Taxable transactions of goods and services in Slovenia,
1 - Zero-rated transaction - exports of goods outside the EU,
2 - Zero-rated transaction - without the right to deduct input VAT,
3 - Zero-rated transaction - with the right to deduct input VAT,
4 - Zero-rated transaction - supply of goods within the EU,
5 - Zero-rated transaction - assembly in the EU,
6 - Zero-rated transaction - tripartite supplies of goods within the EU,
7 - Transactions exempt from VAT - not for VAT records,
8 - Zero-rated transaction - remote sales of goods,
9 - Transactions exempt from VAT with the right of input VAT deduction (transactions outside SLO),
10- Supply of goods and services in SLO, VAT charged by the recipient,
11- Sales of services in the EU, VAT paid by the recipient.

Parameters

PurchaseOrderComplex 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="PurchaseOrderCreate">
        <parameter name="PurchaseOrder">
               <date>2011-01-13</date>                         <!-- (Mandatory) document date
               <city>Nova Gorica</city>                                <!-- (Mandatory)
               <deliveryDate>2011-02-13</deliveryDate>                 <!-- (Optional)
               <dueDate>2011-01-13</dueDate>                   <!-- (Optional)
               <salesQuoteReference>SQ11</salesQuoteReference> <!-- (Optional)
               <costPosition>120</costPosition>                        <!-- (Optional)
               <deliveryMethod>delivery method</deliveryMethod>        <!-- (Optional)
               <superDiscountPercentage>5</superDiscountPercentage> <!-- (Optional)
               <status>Opened</status>                           <!-- (Optional) Possible values: Opened, Draft - default is Opened
               <remarks>Remark on Purchase order</remarks>             <!-- (Optional)
               <orderedByContactPerson>name and surname</orderedByContactPerson>       <!-- (Optional)
               <supplierCode>123456</supplierCode>                     <!-- (Optional). If it is specified supplier parameters bellow are not needed as the supplier data is taken from database. If any parameter bellow is specified it will override master supplier data in document
               <supplierName>Micka Kovac</supplierName>                <!-- (Optional)
               <supplierTaxNumber>02169711</supplierTaxNumber> <!-- (Optional)
               <supplierVatRegistration>none</supplierVatRegistration> <!-- (unkown, none, registered)
               <supplierEMail>micka@kovac.com</supplierEMail>  <!-- (Optional)
               <supplierStreet>Iztokova 22</supplierStreet>            <!-- (Optional)
               <supplierPostalCode>2000</supplierPostalCode>   <!-- (Optional)
               <supplierCity>Maribor</supplierCity>                    <!-- (Optional)
               <supplierCountry>SI</supplierCountry>                   <!-- (Optional) ISO-2 country code
               <vatTransactionType>0</vatTransactionType> <!-- (Optional) default is 0
               <vatOutgoingDocumentVatClause>Registered</vatOutgoingDocumentVatClause> <!-- (Optional) Possible values: Registered, NotRegistered, RegisteredTourismLawPart47, RegisteredTourismLawPart31, RegisteredTourismLawPart47And31
               <documentLanguage>Slovene</documentLanguage> <!-- (Optional) Possible document language: Slovene, English, German, Italian and Croatian
               <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>
                       </Item>
                       <Item>                                          <!-- Item specified for good or service
                               <position>2</position>      <!-- position of item
                               <description>Transport of goods</description>
                               <netPrice>11.00</netPrice>
                               <discountPercentage>2</discountPercentage>      <!-- (Optional)
                               <vatPercentage>8.5</vatPercentage>              <!-- (Optional)
                               <currency>EUR</currency>                        <!-- (Optional)
                               <quantity>10</quantity>                         <!-- (Optional) default 0
                               <unit>km</unit>                         <!-- (Optional)
                               <vatTransactionType>0</vatTransactionType>      <!-- (Optional) default is identical to document property
                       </Item>
               </Items>
       </parameter>
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <number>12/2011</number>                <!-- created document ID or number
       <date>2011-01-13</date>         <!-- document date
</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>



PurchaseOrderUpdate

Update existing purchase order.Data must contain purchase order number to be able to identify document which is to be updated.

Parameters

PurchaseOrderComplex 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="PurchaseOrderUpdate">
       <!--  Parameter is similar to the parameter in PurchaseOrderCreate api
        <parameter name="PurchaseOrder">
               <number>12</number>                                     <!-- document number is mandatory in UPDATE (Can use sequential document number (example: 12), or formatted number (example: 12/2011))
               <date>2011-01-13</date>                         <!-- document date
               <city>Nova Gorica</city>
               <deliveryDate>2011-02-13</deliveryDate>                 <!-- (Optional)
               <dueDate>2011-01-13</dueDate>                   <!-- (Optional)
               <salesQuoteReference>SQ11</salesQuoteReference> <!-- (Optional)
               <costPosition>120</costPosition>                        <!-- (Optional)
               <deliveryMethod>delivery method</deliveryMethod>        <!-- (Optional)
               <superDiscountPercentage>5</superDiscountPercentage> <!-- (Optional)
               <remarks>Remark on Purchase order</remarks>             <!-- (Optional)
               <orderedByContactPerson>name and surname</orderedByContactPerson>       <!-- (Optional)
               <supplierCode>123456</supplierCode>                     <!-- (Optional). If it is specified supplier parameters bellow are not needed as the supplier data is taken from database. If any parameter bellow is specified it will override master supplier data in document
               <supplierName>Micka Kovac</supplierName>                <!-- (Optional)
               <supplierTaxNumber>02169711</supplierTaxNumber> <!-- (Optional)
               <supplierVatRegistration>true</supplierVatRegistration> <!-- (true, false)
               <supplierEMail>micka@kovac.com</supplierEMail>  <!-- (Optional)
               <supplierStreet>Iztokova 22</supplierStreet>            <!-- (Optional)
               <supplierPostalCode>2000</supplierPostalCode>   <!-- (Optional)
               <supplierCity>Maribor</supplierCity>                    <!-- (Optional)
               <supplierCountry>SI</supplierCountry>                   <!-- (Optional) ISO-2 country code
               <vatTransactionType>0</vatTransactionType>              <!-- (Optional) default is 0
               <Items>
                       <Item>                                          <!-- item specified with ref to product
                               <productCode>020</productCode>  <!-- product code
                               <quantity>100</quantity>
                               <discountPercentage>10</discountPercentage>
                       </Item>
                       <Item>                                          <!-- Item specified for good or service
                               <description>Transport of goods</description>
                               <netPrice>11.00</netPrice>
                               <discountPercentage>2</discountPercentage>      <!-- (Optional)
                               <vatPercentage>8.5</vatPercentage>              <!-- (Optional)
                               <currency>EUR</currency>                        <!-- (Optional)
                               <quantity>10</quantity>                         <!-- (Optional) default 0
                               <unit>km</unit>                         <!-- (Optional)
                               <vatTransactionType>0</vatTransactionType>      <!-- (Optional) default is identical to document property
                       </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>12/2011</number>                <!-- updated document ID or number
</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>


PurchaseOrderDelete

Delete purchase order. Must specify parameter/s (number, number+date) to identify document for deleting.

Parameters

numberDocument number
dateDocument date
costPositionCost position

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="PurchaseOrderDelete">
       <parameter name="number" value="8/2011" />
       <parameter name="date" type="Date" value="2011-01-13" />
</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="no privileges"><error/>     <!-- document could not be found, no privileges, …
</response>


PurchaseOrderCancel

Cancel purchace order. Must specify parameter/s (number, number+date) to identify document for canceling.

Parameters

numberDocument number
dateDocument date
costPositionCost position
statusStatus of cancelation document (draft, issuedInvoice). By Default status is issuedInvoice.

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="PurchaseOrderCancel">
       <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: 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 purchace order 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 purchace order for number
Can not cancel. Found X purchace orders
Found X purchace orders X. You can only cancel one purchace order at a time
Can not cancel purchace order X


PurchaseOrderList

Get list of purchase orders for criteria which is specified by API parameters.

Parameters

numberDocument number
dateFromThe date which is used to select purchase orders whose date is following it.
dateToThe date which is used to select purchase orders whose date is preceding it
supplierSupplier name
costPositionCost position code
totalAmountTotal amount of the sales order
totalCurrencyCurrency used in sales order
statusPossible values:
  • Draft 
  • Opened 
  • PartlyDelivered 
  • Completed 
  • Cancelled 

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="PurchaseOrderList">
       <parameter name="dateFrom" type="Date" value="2011-01-01" />
        <parameter name="dateTo" type="Date" value="2011-01-31" />
       <parameter name="totalAmount" value= 22.220 />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<PurchaseOrders>                        
       <PurchaseOrder>
                <!-- structure of elements is the same as in PurchaseOrderGet
       </PurchaseOrder>
       ...
</SalesOrders>
</response>


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


PurchaseOrderSendByEmail

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)

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="PurchaseOrderSendByEmail">
       <parameter name="number" value="8/2011" />
       <parameter name="date" type="Date" value="2011-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.: Purchase order nr. 0008/2011"/>
       <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>

Reference na stran

---
Zadnja sprememba 22.05.2018 14:06:39
© E-RAČUNI d.o.o. 2003-2018