SalesInvoice API

Please check the API reference documentation for SalesInvoiceAPI here https://e-racuni.com/obracuni/ApiDocumentation .

SalesInvoiceAPI exposes the functionality of the invoicing GUI to developer. Most of invoice editing features are available via API methods in this category. The API user account needs to own the same privileges as the regular GUI to get access to features via the API.

Below you will find examples on how to use the invoicing API. Some examples are written using JSON request notation, some examples are written in XML and some examples use curl command line tool to illustrate multiple way on how you can use the API.

Please use the API developer panel to generate API request source in a language of your preference. JSON, XML, Linux command line and PHP request source can be automatically generated by the API developer panel tool.

API developer panel is available at:

https://e-racuni.com/obracuni/developer

Creating a simple invoice

Here is a simple example on how to create an invoice with two items using JSON API request. The item price is given as net price excluding VAT which will be added automatically using the general VAT rate.

Creating a fiscalized invoice

In order to issue a fiscalized invoice you need to ensure that you have previously correctly setup and activated a fiscalized business unit and the master settings of the application. Also check the list of payment methods available for invoicing.

Example below shows how to make a fiscalized invoice for a received Stripe payment. The invoice is of type Retail which means that price is meant to be the final price paid by the customer (price including all taxes).

Creating a simple invoice using special vat margin scheme for selling second hand goods

Here is a simple example on how to create an invoice with two items using JSON API request when using using special vat margin scheme for selling second hand goods. First item's vat transaction type is set to 101 which means "Special vat margin calculation for used goods / Posebna ureditev za rabljeno blago", this VAT transaction type has to be used when selling second hand goods and using special VAT margin scheme.

Fiscalization of invoices is completely automatic and is outside of control of the user or the API. Based on tax regulations the application will automatically fiscalize and report all invoices that need fiscalization to the tax office

Creating an invoice for selling products

If you have defined a master list of products and pricing for the products, then you can create invoice simply by specifying product code (SKU) and quantity. See example below:

Be aware that issuing of invoice might fail if the products are not on stock and company settings are set to deny negative stock quantities on the warehouse. Issuing an invoice with stock tracking item will also trigger automatic issuing of delivery note on a warehouse associated with the invoice.

How to create credit note for partial or full refund

Here is a simple example on how to create credit note for partial or full refund of invoice above with two items using JSON API request.

In case of creating full refund credit note, we just use method SalesInvoiceCreateCreditNote and specify parameter for number of invoice, that are we creating refund for:

Partial refund (we refund only amount from second item from simple invoice above). Import is to use "salesInvoiceRef" property, to reference sales invoice for which we are creating credit note for refund:

Printing invoices/Downloading of invoice PDF

Once the invoice is issued you can get the PDF of the invoice by specifying the invoice date and number or by specifying the invoice document ID which is returned in response of the SalesInvoiceCreate API call. Example:

In the example above, the PDF of the invoice will be returned as part of the JSON response with BASE64 encoding. If you want to download PDF more efficiently then you should directly download PDF by setting the method parameter downloadFile to true. Example of API call using curl to directly download PDF from command line:

Notes on API invoicing context

In order to create an invoice you need to either pre-set the user account with the context of the invoice or specify the context via the API call.

Similar to application behavior in the GUI, the API invoicing context is defined by:

fiscal year	you need to specify fiscal year if you are issuing invoices outside of the current fiscal year
business unit	if multiple business units are defined, then the BU of the account will be used, or you need to specify the BU with your API call
cost center/cost position	if cost centers are used the default cost center will be set if not specified by the API call
warehouse	if multiple warehouses are available the default WH of the BU/CC will be used if not specified by the API call. The warehouse determines the type of the invoice regarding pricing, either Retail (B2C) where VAT is included in the price, or Gross (B2B) with pricing excluding VAT.
currency	default FY currency will be used as invoicing currency if not specified by the API call
cashRegisterCode	code (ID) of the cash register of the fiscalized invoice. Cash register assignment must be made for all cash invoices which are subject to fiscalization in Slovenia.
document language	Invoices will be issued in the default language or according to the settings of the cost center, or the client if document language is specified there. Set invoicing language explicitly if you need to override the default settings.
document currency	Invoices will be issued with the default currency valid for the fiscal year, or according to the settings of the cost center, or the client/buyer if document currency is specified there. Set document currency explicitly if you need to override the default settings.

Getting an invoice with SalesInvoiceGet (or POS invoice with POSSalesInvoiceGet)

Get sales invoice or POS sales invoice by document number, or by combination of document number and date. User can select output format which is used for generating the invoice data file. By default, internal format is used as defined by the SalesInvoice API datatype. Please see external documentation for the eSLOG electronic invoice format.

Example request and response in XML

(For internal "XML" format)

(For ESLOG format)

SalesInvoiceGetUPNPDF

Get PDF for sales invoice with UPN payment order by document number, or by combination of document number and date. User can also decide if he wants UPN in top or bottom of pdf document. Response (on OK) returns binary record for PDF file coded with Base64 coding.