ReceivedCreditNote API
| ReceivedCreditNoteGet | Get received credit note by number. |
| ReceivedCreditNoteCreate | Create new received credit note. |
| ReceivedCreditNoteUpdate | Update existing received credit note. |
| ReceivedCreditNoteDelete | Delete received credit note. |
| ReceivedCreditNoteList | Get list of received credit notes for specified criteria. |
| ReceivedCreditNoteAttachmentAdd | Add attachment to received credit note invoice. |
| ReceivedCreditNoteAttachmentSetDefault | Add attachment to received credit note invoice and set is as default. |
| ReceivedCreditNoteAttachmentGet | Get default attachment of received credit note invoice. |
| ReceivedCreditNoteAttachmentList | Get all attachments of received credit note invoice. |
ReceivedCreditNoteGet
Get received credit note by number.
Parameters
| number | Supplier number of received credit note. |
| internalNumber | Internal number of received credit note. |
| 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="ReceivedCreditNoteGet">
<parameter name="number" value="678/2021" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<ReceivedCreditNote>
<amountWithVAT>689.000</amountWithVAT>
<businessYear>2021</businessYear>
<costPosition>001</costPosition>
<date>2021-01-29</date>
<dateOfSupplyFrom>2021-01-21</dateOfSupplyFrom>
<documentID>51:4488260</documentID>
<internalNumber>RP9-0003</internalNumber>
<isInsideTheScopeOfVat>true</isInsideTheScopeOfVat>
<isReverseChargeVatDocument>false</isReverseChargeVatDocument>
<methodOfPayment>CreditCard</methodOfPayment>
<number>678/2021</number>
<paymentBankAccountNumber></paymentBankAccountNumber>
<paymentDueDate>2021-02-05</paymentDueDate>
<paymentReference></paymentReference>
<receivalDate>2021-01-29</receivalDate>
<receivedAdvancecredit noteRef></receivedAdvancecredit noteRef>
<roundingDifference>0.00</roundingDifference>
<supplier>4 Partner Foreign Company</supplier>
<supplierCode>666000</supplierCode>
<paymentAmount>689.000</paymentAmount>
<paymentCurrency>EUR</paymentCurrency>
<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>
</ReceivedCreditNote>
</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 credit note for number: 055/11,
</response>
ReceivedCreditNoteCreate
Create new received credit note.
Parameters
| ReceivedCreditNote | Received credit note'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="ReceivedCreditNoteCreate">
<parameter name="ReceivedCreditNote">
<amountWithVAT>689.000</amountWithVAT> <!-- (Optional) amount with VAT in default currency
<paymentAmount>689.000</paymentAmount> <!-- (Mandatory) payment amount
<paymentCurrency>EUR</paymentCurrency> <!-- (Mandatory) payment currency
<businessYear>2021</businessYear> <!-- (Mandatory) business year of received credit note
<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 credit note
<number>678/2021</number> <!-- (Mandatory) suppliers number of received credit note
<paymentDueDate>2021-02-05</paymentDueDate> <!-- (Mandatory) payment due date
<receivalDate>2021-01-29</receivalDate> <!-- (Mandatory) date of receival of document
<dateOfSupplyFrom>2021-01-21</dateOfSupplyFrom> <!-- (Mandatory) date of supplay from
<dateOfSupplyUntil>2021-02-21</dateOfSupplyUntil> <!-- (Optional)
<isInsideTheScopeOfVat>true</isInsideTheScopeOfVat> <!-- (Optional) settting if received document is inside scope of VAT
<isReverseChargeVatDocument>false</isReverseChargeVatDocument> <!-- (Optional) settting if received document is reverse charge. This and abowe option "isInsideTheScopeOfVat" exclude each other
<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
<receivedAdvancecredit noteRef>9384-2021</receivedAdvancecredit noteRef> <!-- (Optional) received advance credit note reference
<roundingDifference>0.00</roundingDifference> <!-- (Optional)
<supplierCode>666000</supplierCode> <!-- (Mandatory) If supplier documentID specified, use this supplier identificator for referencing supplier on received document
<supplierDocumentID>55:666</supplierDocumentID> <!-- (Mandatory) If supplier code not 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 credit note 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 credit note
</response>
ReceivedCreditNoteUpdate
Update existing received credit note.
Parameters
| ReceivedCreditNote | Received credit note 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="ReceivedCreditNoteUpdate">
<parameter name="ReceivedCreditNote">
<!-- Parameters are identical to the parameters in ReceivedCreditNoteCreate 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 credit note for number: 055/11, missing mandatory attributes, invalid values, no privileges,
</response>
ReceivedCreditNoteDelete
Delete received credit note.
Parameters
| number | Supplier number of received credit note. |
| internalNumber | Internal number of received credit note. |
| 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="ReceivedCreditNoteDelete">
<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 credit note for number: 055/11, Can not delete. Found 3 received credit note with number 055,
</response>
ReceivedCreditNoteList
Get list of received credit notes for specified criteria.
Parameters
| number | Suppliers number |
| internalNumber | Internal number |
| dateFrom | The date which is used to select received credit notes whose date is following it |
| dateTo | The date which is used to select received credit notes whose date is preceding it |
| supplier | Supplier code or name |
| costPosition | Cost position code |
| paymentAmount | Payment amount of the document |
| paymentCurrency | Payment currency of document |
| 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="ReceivedCreditNoteList">
<parameter name="number" value="123456" />
</method>
</request>
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="ivan" md5pass="8b29582ce0a1c85dc0c574d218acb900" token="649026C063054A139549200F3C9D01C6" />
<method name="ReceivedCreditNoteList">
<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" >
<ReceivedCreditNote>
<!-- structure of received credit note data is the same as in ReceivedCreditNoteGet
</ReceivedCreditNote>
<ReceivedCreditNote>
<!-- structure of received credit note data is the same as in ReceivedCreditNoteGet
</ReceivedCreditNote>
...
</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>
ReceivedCreditNoteInvoiceAttachmentAdd
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="ReceivedCreditNoteInvoiceAttachmentAdd">
<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>
ReceivedCreditNoteInvoiceAttachmentSetDefault
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="ReceivedCreditNoteInvoiceAttachmentSetDefault">
<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>
ReceivedCreditNoteInvoiceAttachmentGet
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="ReceivedCreditNoteInvoiceAttachmentGet">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<ReceivedCreditNoteInvoice>
<Attachments>
<Attachment>
<fileName>att.jpg</fileName>
<contents encoding="BASE64">BASE64</contents>
</Attachment>
</Attachments>
</ReceivedCreditNoteInvoice>
</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>
ReceivedCreditNoteInvoiceAttachmentList
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="ReceivedCreditNoteInvoiceAttachmentList">
<parameter name="number" type="String" value="2020-00001" />
</method>
</request>
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
<ReceivedCreditNoteInvoice>
<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>
</ReceivedCreditNoteInvoice>
</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>
