Set up web services in domain and/or administration

Disclaimer

All screenshots in the article were taken in the Dutch version of Yuki.

The settings you can configure in a domain depend on the selected bundle (and any additional features) and your user role(s) within the domain.

In Yuki you can integrate with Mollie (online payment provider), web services (methods for data exchange with third-party applications), Peppol (e-invoicing) and Rabobank (automatic submission of bank transactions).

A web service contains one or more methods for the exchange of information with applications/services of external parties. Just think of financial data, submitting data of sales invoices and access and/or upload to the Yuki archive. 

Only a user with a 'Back office' role in the domain or the role 'Management' can set (access) rights to web services in the domain and/or administration(s) by means of the web service API key and Administration ID.

Access to Web services

All settings for web services are centralized within your domain and divided into logical categories.

To access these settings:

• click on the Settings icon in the navigation bar
• then, in the now-opened screen, in the Integrations section click on Web services.
  
  

Web services

Web service calls

By default, each domain has 1,000 web service calls (calls) per day available for free.

Should there be a need for more Web service then a user with the “Portal administrator” role has the option to add one of the following accountant features to the domain: 

• Yuki Webservice (from 1,000 to a maximum of 5,000 calls per day)
• Yuki Webservice Extended (from 5,000 to a maximum of 10,000 calls per day).

Available web services

ATTENTION!

In case of illegal use we can block the access to our API.

At this moment there are twelve web services available. 

These web services contain one or more methods for the exhange of information:

• Accounting web service:
  • Retrieve financial reports
  • Create general journal entries
• AccountingInfo web service:
  • Retrieve information about GL accounts and transactions
• Sales web service:
  • Create sales invoices (UBL)
    
    ATTENTION!
    In a domain with the Minimal version of Yuki, the Sales web service (1,000 calls per day) must be added to the domain as an accountant feature. In all other bundles, the Sales web service is included for free.
    
    
• Upload web service:
  • Submit documents
• Archive web service:
  • Retrieve and submit documents
  • Access (via app) to the archive
• Contact web service:
  • Retrieve contact details (read-only)
  • Update or create contact
• PettyCash web service:
  • Import cash transactions
• Domains web service:
  • Create active and trial domains by accountants
  • Retrieve and create users in a domain.
• Projects web service:
  • Create projects (files)
  • Update existing projects (files).
• Back office web service:
  • Check outstanding questions for backoffice in administration
  • Retrieve backoffice workflow of administration
  • Check specific back office roles of portal users in domain
  • Update specific back office roles of portal users in domain.
• VAT web service:
  • Retrieve statuses of VAT returns submitted in Yuki (from AdminPulse).
• Purchase  web service:
  • Create purchase invoices.
    
    ATTENTION!
    To use the Purchase web service, a formal request must be sent by email to support@yuki.nl.
    You will then receive a Client ID/Secret by email from Yuki. You will need this in addition to the API key for authentication in order to gain access to the Purchase web service.

Web service links access

The following steps are required for successful interfacing with external software:

1. API key and Administration ID:
   These must be generated in Yuki to grant external software access without requiring login.
2. Rights management:
   The access rights for web services set at domain or administration level are leading and thus 'override' the settings at portal level.
3. Realize access to external software:
   Add API key and/or the Administration ID in software.

If the software application you want to link with already has a link, then a number of settings need to be defined in that software or with the third party providing the link. 

Step 1. Generate web service API key (WebserviceAccessKey) and Administration ID

The web service API key and Administration ID can be generated from different places in Yuki:

• click on the Switch domain icon above the navigation bar
• click on My domain
• click on the administration name
• then, in the now-opened screen, click on Web services.
  
  OR
  
  
• hover your mouse over the Home icon in the navigation bar
• click on My domain
• click on the administration name
• then, in the now-opened screen, click on Web services.
  
  OR
  
  
• Click on the Settings icon in the navigation bar
• then, in the now-opened screen, click on Web services.

TIPS!

• If you want to link multiple administrations, you need to create multiple web service API keys.
• If you no longer trust the security of an API key, generate a new one!

The following screen is opened:

In this screen click on the + button in order to activate the web services in the domain or the administration and generate a web service API key. 

The following screen is opened:

Step 2. Rights management

Specify in the above screen whether you want to generate a web service API key for a 'Domain' or an 'Administration' (select the correct administration), select the web services (all web services or a selection thereof) for which you to grant (access) rights and then click on the Save button.

TIPS!

• Select only specific web services to which you want to grant access when building your own link. 
• If you want to interface with an existing software application then you must select ‘All web services’.
  
  

Step 3. Realize access to external software

Then, copy the API key and/or Administration ID to use in your application. In many software applications, the “Access code” field is present.