Yuki webservice - Projecten

Deze webservice werd ontwikkeld vanuit de vraag om vanuit externe ERP pakketten rechtstreeks projecten aan te maken in Yuki. Hierdoor hoeft de ondernemer niet meer op twee plaatsen een project handmatig aan te maken en bespaart dus tijd omdat de projecten nu automatisch vanuit het ERP pakket worden aangemaakt in Yuki.


Procedure

Kijk eerst na of de module Yuki Dossiers is geactiveerd. Indien dit niet het geval is, zal de webservice een foutmelding geven. 


Om reeds bestaande projecten eerst op te halen kan de AccountingInfo webservice gebruikt worden. Deze beschikt over een GetProjects functie die alle dossiers van een domein weergeeft.


URL


https://api.yukiworks.nl/ws/Projects.asmx?WSDL


Functionele beschrijving


Voorbeeld XML schema


   <project>

                <Description>Test dossier 1</Description>

                <Code>TESTDOS</Code> 

                <Company>?</Company>

                <Manager>?</Manager>

                <Contact>?</Contact>

                <Notes>?</Notes>

                <SecurityLevel>2</SecurityLevel>

                <AllowOCRMatching>1</AllowOCRMatching>

                <StartDate>?</StartDate>

                <EndDate>?</EndDate>

                <BudgetRevenue>?</BudgetRevenue>

                <BudgetCosts>?</BudgetCosts>

         </project>


Omschrijving velden

Alle velden corresponderen met de beschikbare velden in een nieuw aan te maken dossier/project.



Project: Description

Hier geef je de omschrijving/naam van je project in. De Description is de meest belangrijke tag, omdat alle andere velden na aanmaken van een dossier via deze identifier geüpdatet kunnen worden. Het Description veld moet steeds uniek zijn per project. Dit veld is hoofdlettergevoelig.


Project: Code

Dit omvat de code waarmee documenten aan het project gelinkt kunnen worden. De OCR herkenning kan deze code uitlezen in PDF documenten of kan ingegeven worden vooraan in het e-mail onderwerp met een hekje/hashtag.

De code moet minimaal 6 tekens lang zijn wanneer AllowOCRMatching op True staat.


Project: Company

Als je domein over meerdere administraties beschikt, kan je hier de administrationID van je administratie invullen.


Project: Manager

Als je een bepaalde beheerder aan het dossier wilt toekennen kan dit hier. Een beheerder is een gebruiker in het domein. Gebruik het e-mailadres van deze gebruiker in de XML. Wordt er geen beheerder toegekend dan zal hier standaard 'Yuki' staan.


Project: Contact

Het Contact veld verwijst naar een bepaalde relatie (leverancier of klant). Een relatie kan je toevoegen door de relatie ID in te geven. Deze IDs kan je ophalen via de SearchContacts call.


Project: Notes

Hier kan je extra notities toevoegen.


Project: SecurityLevel

Je kan dossiers beveiligen door de toegang te bepalen. Er zijn vier beveiligingsniveau's:


Beveiliging
CodeExtra info
Alle gebruikers
1Alle gebruikers hebben toegang.
Alle werknemers
2Enkel de gebruikers die ook als werknemer zijn aangemaakt hebben toegang.
Directie3Enkel een gebruiker met de rol 'Directie' heeft toegang.
Beheerder + leden4Enkel de beheerder (Project: Manager) heeft toegang en eventueel andere leden. De leden moeten nog handmatig worden geselecteerd in Yuki.


Als er geen Securitylevel wordt meegegeven bij het aanmaken van een dossier staat deze standaard op "Alle werknemers".


Project:AllowOCRMatching

Zet je de waarde van dit veld op '0', dan zullen documenten niet automatisch worden toegekend via de OCR herkenning. De waarde '1' zorgt ervoor dat de documenten wel automatisch aan het project worden toegewezen. Standaard wordt 0 ingevuld wanneer je dit weglaat.


Project: StartDate

Startdatum van het project. Documenten die een factuurdatum vóór deze startdatum hebben, worden niet automatisch toegekend aan dit dossier.


Project: EndDate

Einddatum van het project. Documenten die een factuurdatum na deze einddatum hebben, worden niet automatisch toegekend aan dit dossier.


Project: BudgetRevenue

Geraamde omzet van dit project.


Project: BudgetCosts

Geraamde kosten voor dit project.


Mogelijke foutmeldingen


SOAP foutmeldingOorzaak
No valid company was found for this ID
Er werd geen geldige AdministrationID als Company doorgegeven.
No valid user was found for this login
De login in het Manager veld correspondeert niet met een bestaande gebruiker van het domein.
The given contact ID is not a valid GUID
Een gegeven ID in het Contact veld is geen geldige GUID.
No valid contact can be found for this ID
Er kan geen bestaande relatie gematcht worden met een ingegeven Contact ID.
Code needs to be longer than 6 characters if AllowOCRMatching is true
Indien AllowOCRMatching de waarde 1 krijgt moet de project Code langer zijn dan 6 tekens.
The domain is not licensed for this functionality
De module Yuki Dossiers is niet actief in dit domein.