Domů 
Předchozí stránka 
Následující stránka 
Historie změn 
 Kopírovat URL stránky 
 
Vytisknout tuto stránkuVytisknout tuto stránku  
Web services - API  >  API Reference  >  Partner API

Partner API

PartnerGetByIDGet partner by partner ID.
PartnerGetByCodeGet partner by partner's code.
PartnerCreateCreate new partner.
PartnerUpdateUpdate existing partner.
PartnerImportImport partner by creating new and/or updating existing ones.
PartnerDeleteDelete partner.
PartnerListGet list of partners for specified criteria.
PartnerListBuyersGet list of buyers for specified criteria.
PartnerListSuppliersGet list of suppliers for specified criteria.
PartnerListEmployeesGet list of employees for specified criteria.
PartnerBuyerCreditLimitGetGet partner buyer credit limit with unpaid amount by invoices and posted debt.
PartnerAttachmentAddAdd attachment to partner.
PartnerAttachmentSetDefaultAdd attachment to partner and set is as default.
PartnerAttachmentGetGet default attachment of partner.
PartnerAttachmentListGet all attachments of partner.
PartnerImageAddAdd partner's image.
PartnerImageGetGet partner's image.
PartnerImageRemoveRemove partner's image.

PartnerGetByID

Get partner by partner ID (personal identification number).

Parameters

IDPartners ID (partner taxNumber accepted too). Partner ID is external number (IČO) in case of legal person and in case of natural persion it is RČ.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerGetByID">
       <parameter name="ID" value="73691234" />
</method>
</request>

HTTP/1.1 200 OK
Server: eurofaktura.cz 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">
       <Partner>
               <ID>02169711</ID>                                       <!-- Partner ID.
               <partnerCode>111</partnerCode>                  <!-- Partner code.
               <taxNumber>02169711</taxNumber>                 <!-- Tax number
               <vatID>1587277000</vatID>                               <!-- VAT number
               <companyName>Test s.r.o.</companyName>          <!-- Company name
               <companyType>Organization</ companyType>                <!-- Type of company. (Contractor, Ltd, Plc, Co, Organization, Subsidiary, Association, Direction, Unit, Division, Edu, Gov, Charity, Cooperative)
               <vatRegistration>Unknown</vatRegistration>              <!-- VAT reg type (Unknown, None, Registered)
               <dateOfRegistration></ dateOfRegistration>              <!-- Company establishment date
               <branchClassification></branchClassification>           <!-- Branch classification
               <firstName>Petr</firstName>                             <!-- For legal person is first name of contact person
               <lastName>Novak</lastName>                              <!-- For legal person is last name of contact person
               <gender>male</ gender>                          <!-- Type of person sex. (male, female, unknown)
               <dateOfBirth></dateOfBirth>                             <!-- For natural person only   birth date
               <maritalStatus></maritalStatus>                         <!-- For natural person   (single, married, widowed, concubinance)
               <mobilePhone>064/123456</mobilePhone>
               <fax>05/625 94 40</fax>
               <eMail>petr@novak.cz,pavel@novak.cz</eMail>     <!-- comma delimited list of emails
               <remarks>test partner for testing web services</remarks><!-- remarks for partner
               <homepage>www.testWS.com</homepage>                     <!-- homapege of partner
               <Addresses>
                       <Address>                               
                               <type>Primary</type>                            <!--Primary address (possible address types are: Invoicing, Primary, Delivery)
                               <street>Celní 22</street>
                               <city>Brno</city>
                               <postalCode>60200</postalCode>
                               <country>CZ</country>
                               <telephone>600 000 051</telephone>
                               <fax>600 100 051</fax>
                       </Address>
                       <Address>
                               <type>Invoicing</type>                          <!--Invoicing address, can include tags "firstAddressLine" and "additionalLine" for additional data for invoicing
                               <additionalLine>Test Company</additionalLine>
                               <firstAddressLine>Petr Novak</firstAddressLine>
                               <street>Celní 22</street>
                               <city>Brno</city>
                               <postalCode>60200</postalCode>
                               <country>CZ</country>
                               <telephone>600 000 051</telephone>
                       </Address>
                       <Address>
                               <type>Delivery</type>                           <!--Delivery address, can include tag "additionalLine" for name of recipient
                               <addressCode>69300</addressCode>
                               <additionalLine>Test s.r.o.</additionalLine>
                               <street>Nová 15</street>
                               <city>Ostrava</city>
                               <postalCode>70900</postalCode>
                               <country>CZ</country>
                               <telephone>600 000 051</telephone>
                       </Address>
               </Addresses>
               <EmployeeData>
                       <status>active</status>                         <!-- Employee status (active, inactive)
                       <Employments>                                   <!-- Employements data
                       </Employments>
               </EmployeeData>
               <BuyerData>
                       <buyerCode>00000105</buyerCode>
                       <buyerGroupCode>01</buyerGroupCode>
                       <costPosition>1</costPosition>
                       <discountPercentage>5.000</discountPercentage>
                       <numberOfDaysForPayment>15</numberOfDaysForPayment>
                       <numberOfDaysForPaymentBaseDate>fromDocumentDate</numberOfDaysForPaymentBaseDate>       <!-- allowed values: fromDocumentDate, fromServiceOrDeliveryDate
                       <serialNumberForCollectionCenter></serialNumberForCollectionCenter>
                       <status>trustworthyBuyer</status>  <!-- allowed values: defaultBuyer, buyerOnBlackList, trustworthyBuyer, buyerDoesNotExistAnymore.
               </BuyerData>
               <SupplierData>
<acceptsOrdersReceivedAtLeastDaysInAdvance>30</acceptsOrdersReceivedAtLeastDaysInAdvance>
                       <costPosition>1</costPosition>
                       <defaultExpensesAccount>120</defaultExpensesAccount>
                       <numberOfDaysForPayment>14</numberOfDaysForPayment>
                       <numberOfDaysForPaymentBaseDate>fromDocumentDate</numberOfDaysForPaymentBaseDate>       <!-- allowed values: fromDocumentDate, fromServiceOrDeliveryDate, fromDocumentReceivedDate
                       <status>defaultSupplier</status>        <!-- defaultSupplier, supplierOnBlackList, trustworthySupplier, supplierDoesNotExistAnymore
                       <supplierCode>1122</supplierCode>
               </SupplierData>
               <BankAccounts>
                       <BankAccount>
                               <bank>KB</bank>
                               <accountNumber>2020090102/2600</accountNumber>
                               <IBAN></IBAN>
                               <SWIFT></SWIFT>
                               <description></description>
                       </BankAccount>
                       <BankAccount>
                               <bank>Komerční banka, a.s.</bank>
                               <accountNumber>2020091112/2600</accountNumber>
                               <IBAN></IBAN>
                               <SWIFT></SWIFT>
                               <currency></currency>
                               <status>Active</status>
                               <description></description>
                       </BankAccount>
               </BankAccounts>
       </Partner>
</response>

Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
       <error description="Partner not found,  "><error/>      
</response>


PartnerGetByCode

Get partner by partner code.

Parameters

partnerCodePartner code.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerGetByCode">
       <parameter name="partnerCode" value="1234" />
</method>
</request>

Response
Response structure is identical to the structure of response in PartnerGetByID


PartnerGetByDocumentID

Get partner by partner documentID.

Parameters

documentIDPartner documentID (internal id from program).

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerGetByCode">
       <parameter name="documentID" value="34:1234" />
</method>
</request>

Response
Response structure is identical to the structure of response in PartnerGetByID


PartnerCreate

Create new partner. (for more detailed partner's data structure look in API for PartnerGetByID)

Parameters

partnerPartner's data in xml substructure.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerCreate">
       <parameter name="partner">
                <companyType>Organization</companyType>   <!-- Mandatory when creating info about company
                <companyName>Test s.r.o.</companyName>   <!-- Mandatory when creating info about company
               <taxNumber>021697112</taxNumber>   <!-- optional data
               <mobilePhone>600 000 012</mobilePhone>
               <fax>600 100 012</fax>
               <eMail>petr@novak.cz,pavel@novak.cz</eMail>
               ...
               <!--  optional data in sub elements (see properties in PartnerGetByID)
               <Addresses>
                       <Address>
                               <type></type>   <!--(possible address types are: Invoicing, Primary, Delivery)
                               ...
                       </Address>
               </Addresses>
               <BuyerData></BuyerData>
               <SupplierData></SupplierData>
               <EmployeeData></EmployeeData>
               <BankAccounts>
                       <BankAccount></BankAccount>
               </BankAccounts>
        </parameter>
</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/>          <!-- missing mandatory attributes, invalid values, no privileges,  
</response>


Example with natural person:

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerCreate">
       <parameter name="partner">
               <partnerCode>112233</partnerCode>        
               <firstName>Tester</firstName>
              <lastName>1 Partner</lastName>
              <Addresses>
                  <Address>
                       <type>Primary</type>
                       <city>Praha</city>
                       <postalCode>10000</postalCode>
                       <street>Street 22</street>
                  </Address>
                    <Address>
                               <type>Invoicing</type>                          <!--Invoicing address, can include tags "firstAddressLine" and "additionalLine" for additional data for invoicing
                               <additionalLine>Test Company Group</additionalLine>
                               <firstAddressLine>Petr Novak</firstAddressLine>
                               <street>Celní 22</street>
                               <city>Brno</city>
                               <postalCode>60200</postalCode>
                               <country>CZ</country>
                     </Address>
               </Addresses>
        </parameter>
</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/>          <!-- missing mandatory attributes, invalid values, no privileges,  
</response>


PartnerUpdate

Update existing partner.

Parameters

partnerPartner's data in xml substructure.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerUpdate">
       <parameter name="partner">
                <partnerCode>7369</partnerCode>
               <!--other params as in PartnerCreate
        </parameter>
</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/>          <!-- missing mandatory attributes, invalid values, no privileges,  
</response>


PartnerDelete

Delete partner.

Parameters

IDPartner's ID.
taxNumberPartner's tax number.
partnerCodePartner's code.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerDelete">
        <parameter name="ID" value="7369" />
</method>
</request>

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerDelete">
        <parameter name="taxNumber" value="CZ12345678" />
</method>
</request>

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerDelete">
        <parameter name="partnerCode" value="PA7369" />
</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/>
</response>


PartnerImport

Import partner by creating new and/or updating existing ones. Parameter importType can be used to specify type of import. If parameter is not specified, createOrUpdate is used as default. For updating partner with this api call, partner's data must contain code as unique identifier.

Parameters

importTypeFlag for the type of import
  • createOrUpdate Import all - create new and update existing partners
  • createOnly  Skip import for existing partners
  • updateOnly  Skip import of new partners
partnerPartner's data in xml substructure.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerImport">
       <parameter name="importType" value="createOrUpdate" />
       <parameter name="partner">              <!-- parameter here is the same as for PartnerUpdate or PartnerCreate depending on importType
       </parameter>
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <ID></ID>
</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>


PartnerList

Get list of partners for specified criteria.

Parameters

partnerTypeType of partners to be answered. If this parameter is missing, answer all types of partners (default value is 'all'). Possible types are:
  • buyer 
  • supplier 
  • user 
searchKeySearch key. The value from this field is used for searching for: ( company name for partners as legal person, given name and name for partners as physical person)
partnerCodePartner's code
taxNumberTax number
streetStreet
postalCodeOrCityPostal code or City
eMailEmail
mobileOrPhoneNumberMobile or phone number

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerList">
       <parameter name="searchKey" type="String" value="Test s.r.o." />
       <parameter name="postalCodeOrCity" type="String" value="Brno" />
        <parameter name="street" type="String" value="Celní" />
       <parameter name="partnerCode" type="String" value="12" />
       <parameter name="partnerType" value="buyer"/>
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <Partner>
                <!-- structure of each partner is the same as in PartnerGetByID
       </Partner>
       <Partner>
       </Partner>
       ...
</response>


PartnerListBuyers

Get list of buyers for specified criteria. Response structure is identical to API "PartnerList"

Parameters

searchKeySearch key. The value from this field is used for searching for: (company name for partners as legal person, given name and name for partners as physical person)
partnerCodePartner's code
buyerCodeBuyer's code
taxNumberTax number
streetStreet
postalCodeOrCityPostal code or City
statusStatus of the buyers to be answered. It is optional and possible types are:
  • defaultBuyer 
  • buyerOnBlackList 
  • trustworthyBuyer 
  • buyerDoesNotExistAnymore 

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerListBuyers">
       <parameter name="buyerCode" type="String" value="111" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <Partner>
                <!-- structure of each partner is the same as in PartnerGetByID
       </Partner>
       <Partner>
       </Partner>
       ...
</response>

PartnerListSuppliers

Get list of suppliers for specified criteria. Response structure is identical to API "PartnerList"

Parameters

searchKeySearch key. The value from this field is used for searching for: (company name for partners as legal person, given name and name for partners as physical person)
partnerCodePartner's code
supplierCodeSupplier's code
taxNumberTax number
streetStreet
postalCodeOrCityPostal code or City
statusStatus of the suppliers to be answered. It is optional and possible types are:
  • defaultSupplier 
  • supplierOnBlackList 
  • trustworthySupplier 
  • supplierDoesNotExistAnymore 

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerListSupplier">
       <parameter name="supplierCode" type="String" value="111" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <Partner>
                <!-- structure of each partner is the same as in PartnerGetByID
       </Partner>
       <Partner>
       </Partner>
       ...
</response>

PartnerListEmployees

Get list of employees for specified criteria. Response structure is identical to API "PartnerList"

Parameters

searchKeySearch key. The value from this field is used for searching for: (company name for partners as legal person, given name and name for partners as physical person)
partnerCodePartner's code
taxNumberTax number
statusStatus of the employees. Possible types are:
  • active 
  • inactive 

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerListEmployees">
       <parameter name="partnerCode" type="String" value="111" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <Partner>
                <!-- structure of each partner is the same as in PartnerGetByID
       </Partner>
       <Partner>
       </Partner>
       ...
</response>

PartnerBuyerCreditLimitGet

Get partner buyer credit limit with unpaid amount by invoices and posted debt.

Parameters

IDPartner's ID.
taxNumberPartner's tax number.
partnerCodePartner's code.
creditLimitDateDate on which credit limit is calculated, if parameter is empty or not present, todays date is taken.
currencyCurreny of results, if not specified default currency is taken

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerBuyerCreditLimitGet">
       <parameter name="partnerCode" value="100011" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <buyerCreditLimit>20,00</buyerCreditLimit>
       <unpaidInvoicesAmount>16.278,76</unpaidInvoicesAmount>
       <postedDebt>5.167,96</postedDebt>
       <currency>EUR</currency>
</response>

Response on error
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
       <error description="Partner not found, Partner xyz is not defined as buyer!, Buyer kyz does not have defined credit limit or it is below minimum required amount! "><error/>    
</response>

PartnerAttachmentAdd

Add image/attachment to partner.

Parameters

partnerCodePartner code.
documentIDPartner's document ID.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerAttachmentAdd">
       <parameter name="partnerCode" type="String" value="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 partner 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 "partnerCode" or "documentID" is required, Can not find partner for code: 00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>

PartnerAttachmentSetDefault

Add attachment to partner and set it as default.

Parameters

partnerCodePartner code.
documentIDPartner's document ID.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerAttachmentSetDefault">
       <parameter name="partnerCode" 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 partner 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 "partnerCode" or "documentID" is required., Can not find partner for code: 00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>

PartnerAttachmentGet

Get default attachment of partner.

Parameters

partnerCodePartner code.
documentIDPartner's document ID.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerAttachmentGet">
       <parameter name="partnerCode" type="String" value="00001" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <Partner>
               <Attachments>
                       <Attachment>
                               <fileName>att.jpg</fileName>
                               <contents encoding="BASE64">BASE64</contents>
                       </Attachment>
               </Attachments>
       </Partner>
</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 "partnerCode" or "documentID" is required., Can not find partner for code: 00001, partner does not have attachemnts.
</response>

PartnerAttachmentList

Get all images/attachments of article.

Parameters

partnerCodePartner code.
documentIDPartner's document ID.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerAttachmentList">
       <parameter name="partnerCode" type="String" value="2020-00001" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <Partner>
               <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>
       </Partner>
</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 "partnerCode" or "documentID" is required., Can not find partner for code: 00001, partner does not have attachemnts.
</response>

PartnerImageAdd

Add image to partner. If partner already has image, old one is removed and new one set.

Parameters

partnerCodePartner code.
documentIDPartner's document ID.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerImageAdd">
       <parameter name="partnerCode" type="String" value="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 image att.jpg to partner 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 "partnerCode" or "documentID" is required, Can not find partner for code: 00001, Parameter <attachment> is missing, Parameter <attachment> cannot parse contents
</response>

PartnerImageGet

Get partner's image.

Parameters

partnerCodePartner code.
documentIDPartner's document ID.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerImageGet">
       <parameter name="partnerCode" type="String" value="00001" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <Partner>
               <Attachments>
                       <Attachment>
                               <fileName>att.jpg</fileName>
                               <contents encoding="BASE64">BASE64</contents>
                       </Attachment>
               </Attachments>
       </Partner>
</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 "partnerCode" or "documentID" is required., Can not find partner for code: 00001, partner does not have image.
</response>

PartnerImageRemove

Remove partner's image.

Parameters

partnerCodePartner code.
documentIDPartner's document ID.

Example request and response

POST /WebServicesCZ/API HTTP/1.1
Host: eurofaktura.cz
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream

<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="petr" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="PartnerImageRemove">
       <parameter name="partnerCode" type="String" value="00001" />
</method>
</request>

Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok" >
       <message>Successfully removed image att.jpg to partner 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 "partnerCode" or "documentID" is required., Can not find partner for code: 00001, partner does not have image.
</response>

Odkazy na tuto stránku

---
Datum a čas poslední úpravy 15.12.2021 11:10:53
© Eurofaktura s.r.o. 2003-2024