API Architectuur uitgelegd

Visma Cash Payroll is een salarisverwerkingssysteem met een eigen specifieke structuur en achterliggende logica. Zorg ervoor dat je de verschillende niveaus van de twee producten begrijpt: Cash Paryoll Accountant en Cash Payroll Business. Houd er daarnaast rekening mee dat de meeste bedrijfs- en werknemersgegevens in Cash Payroll periodegebonden zijn. Dit wordt in het onderstaande artikel verder uitgelegd.

• Visma Cash Payroll Accountant-niveaus

• Visma Cash Payroll Business-niveaus

• Periodegebonden gegevens (Period based data)

Cash Payroll Accountant-niveaus

De eigenaar van een Cash Payroll Accountant-omgeving is een salarisprofessional die de salarisverwerking verzorgt voor zijn eigen cliënten. Cash Payroll Accountant kent 4 niveaus:

• Topniveau (Top level): De gebruiker kan instellingen op het hoogste niveau beheren en inrichten voor al zijn cliënten.

• Debiteurenniveau (Debtor level): Voordat je een bedrijf kunt aanmaken, moet je een debiteur aanmaken. Nadat de debiteur is aangemaakt, kun je één of meerdere bedrijven aanmaken die onder deze debiteur vallen. Op debiteurenniveau kun je informatie voor die specifieke debiteur opslaan en wijzigen. Je gebruikt de API-methoden van de Debtor Service om debiteurgegevens op te halen.

• Bedrijfsniveau (Company level): Voordat je een werknemer kunt aanmaken, moet je een bedrijf aanmaken. Nadat het bedrijf is aangemaakt, kun je werknemers aanmaken die aan dit bedrijf gekoppeld zijn. Op bedrijfsniveau kun je informatie voor dat specifieke bedrijf opslaan en wijzigen. Je gebruikt de API-methoden van de Company Service om bedrijfsinformatie op te halen.

• Werknemersniveau (Employee level): Op werknemersniveau kun je informatie voor die specifieke werknemer opslaan en wijzigen. Je gebruikt de API-methoden van de Employee Service om werknemersgegevens op te halen.

Wijzigingen die je doorvoert, hebben altijd een top-down effect. Bijvoorbeeld: een salariswijziging op debiteurenniveau is alleen van toepassing op die specifieke debiteur en de onderliggende bedrijven en werknemers.

De niveaustructuur wordt weergegeven in de onderstaande afbeelding.

Visma Cash Payroll Business-niveaus

De eigenaar van een Cash Payroll Business-omgeving is een bedrijf dat de salarisverwerking voor zichzelf doet. Cash Payroll Business heeft slechts één debiteur en kan meerdere bedrijven bevatten. Dit product kent 3 niveaus:

• Debiteurenniveau (Debtor level): Op debiteurenniveau kun je informatie voor die specifieke debiteur opslaan en wijzigen. Je gebruikt de API-methoden van de Debtor Service om debiteurgegevens op te halen.

• Bedrijfsniveau (Company level): Voordat je een werknemer kunt aanmaken, moet je een bedrijf aanmaken. Nadat het bedrijf is aangemaakt, kun je werknemers aanmaken die aan dit bedrijf gekoppeld zijn. Op bedrijfsniveau kun je informatie voor dat specifieke bedrijf opslaan en wijzigen. Je gebruikt de API-methoden van de Company Service om bedrijfsinformatie op te halen.

• Werknemersniveau (Employee level): Op werknemersniveau kun je informatie voor die specifieke werknemer opslaan en wijzigen. Je gebruikt de API-methoden van de Employee Service om werknemersgegevens op te halen.

Wijzigingen die je doorvoert, hebben altijd een top-down effect. Bijvoorbeeld: een salariswijziging op debiteurenniveau is alleen van toepassing op die specifieke debiteur en de onderliggende bedrijven en werknemers.

De niveaustructuur wordt weergegeven in de onderstaande afbeelding.

Periodegebonden gegevens (Period based data)

De meeste bedrijfs- en werknemersgegevens in Cash Payroll zijn periodegebonden. Dit betekent dat informatie die nodig is voor de salarisverwerking kan worden opgeslagen en gewijzigd in de huidige periode, de toekomst of het verleden. Dit houdt ook in dat wijzigingen in het verleden invloed kunnen hebben op andere perioden, waardoor gegevens bij de eerstvolgende salarisverwerking worden aangepast.

Het salarisverwerkingsproces, dat we een run noemen, sluit de huidige periode af. Onderstaand voorbeeld licht dit verder toe:

Voorbeeld: De werkelijke datum is september 2026. Omdat er nog geen run is gedraaid voor september, is de huidige periode van het bedrijf augustus. Wijzigingen die in de huidige periode worden doorgevoerd, hebben betrekking op augustus. Nadat je een run doet, worden de berekeningen voor augustus gemaakt, wordt de periode gesloten en wordt de huidige periode september.

Als we ditzelfde voorbeeld nemen, maar je voert wijzigingen door in februari (een eerdere periode): nadat je een run doet, heeft de berekening invloed op alle perioden vanaf februari tot en met augustus.

Houd er rekening mee dat het mogelijk is om runs, pre-runs en correctieruns te draaien, correctieruns mee te nemen in een normale run, meerdere perioden in één run te verwerken en runs samen te voegen. Zie voor meer informatie: Salarisverwerking (Process payroll).

Elk bedrijf heeft een eigen periodetype, zie voor meer informatie: Bedrijfsperiode (Company period). De uitzonderingen hierop zijn de debiteurgegevens en informatie waaraan een specifieke periode of datum kan worden toegevoegd.

De onderstaande vragen helpen je te begrijpen hoe je met perioden moet omgaan binnen de integratie:

• Zijn de gegevens in jouw eigen applicatie periodegebonden?

• Is het in jouw applicatie mogelijk om gegevens in eerdere perioden te wijzigen?

• Hoe ga je om met wijzigingen in het verleden (met terugwerkende kracht)?

• Wat is de verwachting van de gebruiker?

Gegevens in onze software, zoals werknemers, bedrijven, functies, afdelingen en dergelijke, worden in de gebruikersinterface geregistreerd met nummers. Bij het gebruik van de API werken we echter met unieke ID's.

• Nummers en ID's (Numbers and IDs),  klik hier voor meer informatie.