ReceivedAdvanceInvoice API
| ReceivedAdvanceInvoiceGet | Get received advance invoice by number. |
| ReceivedAdvanceInvoiceCreate | Create new received advance invoice. |
| ReceivedAdvanceInvoiceUpdate | Update existing received advance invoice. |
| ReceivedAdvanceInvoiceDelete | Delete received advance invoice. |
| ReceivedAdvanceInvoiceList | Get list of received advance invoices for specified criteria. |
| ReceivedAdvanceInvoiceAttachmentAdd | Add attachment to received advance invoice. |
| ReceivedAdvanceInvoiceAttachmentSetDefault | Add attachment to received advance invoice and set is as default. |
| ReceivedAdvanceInvoiceAttachmentGet | Get default attachment of received advance invoice. |
| ReceivedAdvanceInvoiceAttachmentList | Get all attachments of received advance invoice. |
ReceivedAdvanceInvoiceGet
Get received advance invoice by number.
Parameters
| number | Supplier number of received advance invoice. |
| internalNumber | Internal number of received advance invoice. |
| date | Document date. |
| costPosition | Cost position. |
| supplier | Supplier name. |
| documentID | Internal document identificator. In case of using this parameter, no other parameter listed abowe is needed for searching by document. |
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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceGet">
<parameter name="number" value="678/2021" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<ReceivedAdvanceInvoice>
<businessYear>2021</businessYear>
<costPosition>001</costPosition>
<date>2021-01-29</date>
<prepaymentDate>2021-01-21</prepaymentDate>
<documentID>51:4488260</documentID>
<internalNumber>RP9-0003</internalNumber>
<isInsideTheScopeOfVat>true</isInsideTheScopeOfVat>
<methodOfPayment>CreditCard</methodOfPayment>
<number>678/2021</number>
<paymentBankAccountNumber></paymentBankAccountNumber>
<paymentDueDate>2021-02-05</paymentDueDate>
<paymentReference></paymentReference>
<receivalDate>2021-01-29</receivalDate>
<receivedAdvanceInvoiceRef></receivedAdvanceInvoiceRef>
<roundingDifference>0.00</roundingDifference>
<supplier>4 Partner Foreign Company</supplier>
<supplierCode>666000</supplierCode>
<prepaymentAmount>689.000</prepaymentAmount>
<prepaymentCurrency>EUR</prepaymentCurrency>
<Items>
<Item>
<chartAccountNumber>00000</chartAccountNumber>
<costPosition></costPosition>
<description>OSOS</description>
<inputVatTransactionType>2</inputVatTransactionType>
<isInputVatDeductible>true</isInputVatDeductible>
<isInsideTheScopeOfVat>true</isInsideTheScopeOfVat>
<netAmount>689.000</netAmount>
<netAmountInDocumentCurrency>689.000</netAmountInDocumentCurrency>
<position>1</position>
<vatDeductionPercentage>100,00</vatDeductionPercentage>
<vatPercentage>22.0</vatPercentage>
</Item>
</Items>
</ReceivedAdvanceInvoice>
</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, Cannot find received advance invoice for number: 055/11,
</response>
ReceivedAdvanceInvoiceCreate
Create new received advance invoice.
Parameters
| ReceivedAdvanceInvoice | received advance invoice's 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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceCreate">
<parameter name="ReceivedAdvanceInvoice">
<prepaymentAmount>689.000</prepaymentAmount> <!-- (Mandatory) prepayment amount
<prepaymentCurrency>EUR</prepaymentCurrency> <!-- (Mandatory) payment currency
<businessYear>2021</businessYear> <!-- (Mandatory) business year of received advance invoice
<costPosition>001</costPosition> <!-- (Optional/Mandatory) cost center is optional in case mandatory entry is not set in company settings
<date>2021-01-29</date> <!-- (Mandatory) date of received advance invoice
<number>678/2021</number> <!-- (Mandatory) suppliers number of received advance invoice
<paymentDueDate>2021-02-05</paymentDueDate> <!-- (Mandatory) payment due date
<receivalDate>2021-01-29</receivalDate> <!-- (Mandatory) date of receival of document
<prepaymentDate>2021-01-21</prepaymentDate> <!-- (Mandatory) date of prepayment
<isInsideTheScopeOfVat>true</isInsideTheScopeOfVat> <!-- (Optional) settting if received document is inside scope of VAT
<methodOfPayment>CreditCard</methodOfPayment> <!-- (Mandatory) possible values: BankTransfer, Cash, CreditCard, Other
<paymentBankAccountNumber>SI56 0000 1111 2222 333</paymentBankAccountNumber> <!-- Mandatory in case "methodOfPayment" value BankTransfer is used
<paymentReference>SI99</paymentReference> <!-- Mandatory in case "methodOfPayment" value BankTransfer is used
<supplierBookingAccountNumber>26000</supplierBookingAccountNumber> <!-- Mandatory in case "methodOfPayment" value Other is used
<receivedAdvanceInvoiceRef>9384-2021</receivedAdvanceInvoiceRef> <!-- (Optional) received advance invoice reference
<roundingDifference>0.00</roundingDifference> <!-- (Optional)
<supplierDocumentID>55:666</supplierDocumentID> <!-- (Mandatory) If supplier code not specified, use this supplier identificator for referencing supplier on received document
<supplierCode>666000</supplierCode> <!-- (Mandatory) If supplier documentID specified, use this supplier identificator for referencing supplier on received document
<Items>
<Item>
<position>1</position> <!-- (Optional) item position
<chartAccountNumber>00000</chartAccountNumber> <!-- (Mandatory) account number
<costPosition>009</costPosition> <!-- (Optional) cost center code for referencing cost center on item
<description>OSOS</description> <!-- (Mandatory) description
<inputVatTransactionType>2</inputVatTransactionType> <!-- (Mandatory) input VAT transaction type
<isInputVatDeductible>true</isInputVatDeductible> <!-- (Optional) settting if received document items VAT is deducated
<vatDeductionPercentage>100,00</vatDeductionPercentage> <!-- (Mandatory) if abowe option is used. Percentage of VAT that is being deducated must be entered
<isInsideTheScopeOfVat>true</isInsideTheScopeOfVat> <!-- (Optional) settting if received document item is inside scope of VAT. This and abowe option "isInputVatDeductible" exclude each other
<netAmount>689.000</netAmount> <!-- (Mandatory) net amount
<netAmountInDocumentCurrency>689.000</netAmountInDocumentCurrency> <!-- (Optional) net amount id document currency
<vatPercentage>22.0</vatPercentage> <!-- (Optional) if this property is not present, default normal VAT rate is set
</Item>
<Item>
<position>2</position> <!-- (Optional) item position
<productCode>000001</productCode> <!-- (Optional) if item with referenced product is added product code should be present in item definition
<chartAccountNumber>00000</chartAccountNumber> <!-- (Mandatory) account number
<costPosition>009</costPosition> <!-- (Optional) cost center code for referencing cost center on item
<description>OSOS</description> <!-- (Mandatory) description
<inputVatTransactionType>2</inputVatTransactionType> <!-- (Mandatory) input VAT transaction type
<isInputVatDeductible>true</isInputVatDeductible> <!-- (Optional) settting if received document items VAT is deducated
<vatDeductionPercentage>100,00</vatDeductionPercentage> <!-- (Mandatory) if abowe option is used. Percentage of VAT that is being deducated must be entered
<isInsideTheScopeOfVat>true</isInsideTheScopeOfVat> <!-- (Optional) settting if received document item is inside scope of VAT. This and abowe option "isInputVatDeductible" exclude each other
<quantity>1</quantity> <!-- (Mandatory) quantity
<price>100.00</price> <!-- (Optional) product price, if not present, default purchase price of product is taken
<vatPercentage>22.0</vatPercentage> <!-- (Optional) if this property is not present, default normal VAT rate is set
</Item>
</Items>
</parameter>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<number>055/11</number>
<date>2021-01-29</date>
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="received advance invoice for number: 055/11 already exists!><error/> <!-- Possible errors: Access denied. User account does not have sufficient privileges for the given request, Parameter named "number" must be specified., missing mandatory attributes, invalid values, no privileges, Error creating received advance invoice
</response>
ReceivedAdvanceInvoiceUpdate
Update existing received advance invoice.
Parameters
| ReceivedAdvanceInvoice | received advance 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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceUpdate">
<parameter name="ReceivedAdvanceInvoice">
<!-- Parameters are identical to the parameters in ReceivedAdvanceInvoiceCreate api
</parameter>
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<number>055/11</number>
<date>2021-01-29</date>
</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 received advance invoice for number: 055/11, missing mandatory attributes, invalid values, no privileges,
</response>
ReceivedAdvanceInvoiceDelete
Delete received advance invoice.
Parameters
| number | Supplier number of received advance invoice. |
| internalNumber | Internal number of received advance invoice. |
| date | Document date. |
| costPosition | Cost position. |
| supplier | Supplier name. |
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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceDelete">
<parameter name="number" value="055/11" />
</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=""><error/> <! Possible errors: Access denied. User account does not have sufficient privileges for the given request, Parameter named "number" is required, Can not find received advance invoice for number: 055/11, Can not delete. Found 3 received advance invoice with number 055,
</response>
ReceivedAdvanceInvoiceList
Get list of received advance invoices for specified criteria.
Parameters
| number | Suppliers number |
| internalNumber | Internal number |
| dateFrom | The date which is used to select received advance invoices whose date is following it |
| dateTo | The date which is used to select received advance invoices whose date is preceding it |
| receivalDateFrom | The date which is used to select received advance invoices whose date of receival is following it |
| receivalDateTo | The date which is used to select received advance invoices whose date of receival is preceding it |
| prepaymentDateFrom | The date which is used to select received advance invoices whose date of prepayment is following it |
| prepaymentDateTo | The date which is used to select received advance invoices whose date of prepayment is preceding it |
| supplier | Supplier code or name |
| costPosition | Cost position code |
| article | Product code, or product name |
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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceList">
<parameter name="number" value="123456" />
</method>
</request>
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceList">
<parameter name="dateFrom" value="2021-05-01" />
<parameter name="dateTo" value="2021-05-26" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<ReceivedAdvanceInvoice>
<!-- structure of received advance invoice data is the same as in ReceivedAdvanceInvoiceGet
</ReceivedAdvanceInvoice>
<ReceivedAdvanceInvoice>
<!-- structure of received advance invoice data is the same as in ReceivedAdvanceInvoiceGet
</ReceivedAdvanceInvoice>
...
</response>
Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description=""><error/> <!-- Access denied. User account does not have sufficient privileges for the given request, Invalid search keys, invalid values, no privileges,
</response>
ReceivedAdvanceInvoiceAttachmentAdd
Add image/attachment to received 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 /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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceAttachmentAdd">
<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 received 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 received invoice for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>
ReceivedAdvanceInvoiceAttachmentSetDefault
Add attachment to received 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 /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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceAttachmentSetDefault">
<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 received 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 received invoice for number: 2020-00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>
ReceivedAdvanceInvoiceAttachmentGet
Get default attachment of received 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 /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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceAttachmentGet">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<ReceivedAdvanceInvoice>
<Attachments>
<Attachment>
<fileName>att.jpg</fileName>
<contents encoding="BASE64">BASE64</contents>
</Attachment>
</Attachments>
</ReceivedAdvanceInvoice>
</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 received invoice for number: 2020-00001 received invoice does not have attachemnts.
</response>
ReceivedAdvanceInvoiceAttachmentList
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 /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="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedAdvanceInvoiceAttachmentList">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<ReceivedAdvanceInvoice>
<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>
</ReceivedAdvanceInvoice>
</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 received invoice for number: 2020-00001 received invoice does not have attachemnts.
</response>
