Overslaan naar inhoud
Nederlands
Meer over Cash
  • Er zijn geen suggesties want het zoekveld is leeg.

API: Hoe krijg ik ID's

Een ID is een uniek nummer dat niet direct zichtbaar is in de gebruikersinterface. ID's worden veelvuldig gebruikt binnen de API-service.

In dit artikel komen de volgende onderwerpen aan bod:

  1. Nummers en ID's

  2. Een werknemer-ID ophalen

  3. Een bedrijf-ID ophalen

  4. Een debiteur-ID ophalen

1. Zijn het nummer en het ID van een werknemer/bedrijf/debiteur hetzelfde?

Nee, het nummer is een numeriek veld dat door gebruikers kan worden aangepast. Daarom mag dit veld niet worden gebruikt als uniek kenmerk om werknemers en bedrijven te identificeren. Het ID is wel uniek en moet worden gebruikt om werknemers, bedrijven en debiteuren te identificeren.

2. Een werknemer-ID ophalen (Retrieving an Employee ID)

Werknemer-ID's zijn niet zichtbaar in de gebruikersinterface. Deze kunnen worden opgehaald door de API-methode List_GetByCompany of List_GetByDebtor aan te roepen. Deze methoden retourneren een lijst met werknemersgegevens, inclusief de werknemer-ID's.

  • List_GetByCompany retourneert alle werknemers die bij een specifiek bedrijf horen.

  • ListGetByDebtor retourneert alle werknemers die bij een specifieke debiteur horen.

Voor deze aanroepen moet je de gebruikersnaam, de token en het CompanyId opgeven.

In het veld <active> zijn drie opties mogelijk: active (actief), notActive (niet actief) of all (alle). Actieve werknemers zijn werknemers met een actief dienstverband in de huidige periode van een bedrijf. Werknemers die 'notActive' zijn, zijn uit dienst of treden pas in de toekomst (ten opzichte van de huidige periode van het bedrijf) in dienst.

Als de aanroep succesvol is, ontvang je het ID, het nummer en de weergavenaam (display name) van de werknemer.

3. Een bedrijf-ID ophalen (Retrieving a company ID)

Bedrijf-ID's zijn niet zichtbaar in de gebruikersinterface. Deze kunnen worden opgehaald door de API-methode List_GetAll of  List_GetByDebtor.  aan te roepen. Deze methoden retourneren een lijst met bedrijfsgegevens, inclusief de bedrijf-ID's.

  • List_GetAll retourneert alle bedrijven (waar jij toegang toe hebt). Je hoeft hierbij alleen je gebruikersnaam en een token mee te sturen. Als de test slaagt, ontvang je het <ID>, wat het CompanyId is. Je ontvangt ook overige informatie; zie hiervoor de API description van de respons.

  • List_GetByDebtor retourneert bedrijven die onder een specifieke debiteur vallen. Om deze aanroep succesvol uit te voeren, moet je een debiteur-ID opgeven.

4. Een debiteur-ID ophalen (Retrieving a debtor ID)

Dezelfde aanpak kan worden gebruikt om debiteur-ID's op te halen (op basis van nummer of allemaal). Gebruik hiervoor de methode List_GetAll of List_GetByNumber. 

  • List_GetAll retourneert alle debiteuren (waar jij toegang toe hebt). Je hoeft alleen je gebruikersnaam en een token op te geven. Als de test slaagt, ontvang je het  <ID>, wat het API description is. Je ontvangt ook overige informatie; zie hiervoor de API-beschrijving van de respons.