thumb_up
thumb_down
link
Copy link
Copied
insert_emoticon
lmatfy
Copied

API-responses bij connectoren

Bij het gebruik van de AFAS API geven de GetConnectoren en UpdateConnectoren altijd een response. Je krijgt deze response als het proces op de AFAS server is afgerond. De data is bijvoorbeeld opgehaald of de invoer is volledig verwerkt. Ook krijg je altijd een response als er een fout optreedt of de service niet beschikbaar is.

HTTP staat voor Hypertext Transfer Protocol. Dit is een reeks aan regels en afspraken op basis waarvan informatie via internet wordt uitgewisseld.

Inhoud

Success responses

Wanneer je verbinding maakt met de AFAS API en je krijgt een response in de HTTP 200 range dan weet je dat je request gelukt is.

  • HTTP 200: De GetConnector heeft succesvol data opgehaald of de UpdateConnector is succesvol uitgevoerd
  • HTTP 201: De UpdateConnector is uitgevoerd en er is een response body toegevoegd met bijvoorbeeld het ID van de aangemaakte regel

Error Responses

  • HTTP 401 betekent dat je niet geauthentiseerd bent om verbinding te maken. Er zijn meerdere mogelijke redenen waarom je deze error krijgt:
    • Verkeerde URL of webservice adres
    • GetConnector of UpdateConnector is niet toegevoegd aan de AppConnector
    • Token is verlopen
  • HTTP 400 geeft aan dat de request die je doet niet volgens de afspraken is. Je geeft bijvoorbeeld geen Get/Post/Put/Delete parameter mee aan je request
  • HTTP 500 geeft aan dat er verbinding gemaakt wordt met AFAS maar dat de request inhoudelijk wordt afgekeurd. Dit zijn inhoudelijk meldingen waarbij je in de response een bericht krijgt met beknopte uitleg en een verwijzing naar het Profit logboek. Dit logboek geeft diepgaande informatie over de foutmelding. Zie ook: Errors Connectoren interpreteren.

HTTP 503 Wanneer de webservice niet beschikbaar is, bijvoorbeeld door onderhoud of een verstoring, krijg je deze response. Meestal kun je met een retry de request opnieuw uitvoeren en wordt deze wel goed behandeld. Zie hierbij ook afasstatus.nl

Response teruggeven bij INSERT

Bij het aanmaken van een nieuw gegeven met de onderstaande UpdateConnectoren wordt in de response de code teruggegeven.

Zie de nieuwe responses bij Factuurtermijnen en Vaste activa.

Naam

Connector

Velden

Abonnementen

FbSubscription

Administratienummer (UnId)

SeNo

Artikel

FbItemArticle

Itemcode (ItCd)

Balie-/directfacturen

FbDirectInvoice

Factuurnummer (Liln)

Ordernummer (OrNu)

Beoordelingen medewerkers

 

HrJudgement

Medewerker (EmId)

Volgnummer (JuSn)

Contracten financieel

FiContract

Contractnummer (CoNu)

Volgnummer contract (SeNo)

Cursusevenement

KnCourseEvent

Evenement-id (Id)

Declaraties

(Flex)

PtDeclaration

Nummer declaratie (DcCo)

Nummer dossieritem (SbId)

De response bevat alleen een dossieritemnummer als de declaratie in een workflow terechtkomt ( <ApprovWorkflow> bevat de waarde 1)

Declaraties InSite

(Flex)

HrDeclarationInSite

MutatieId (MuId)

Mutatietype(ViMt)

MedewerkerId (EmId)

MutatieGUID (MutatieGuid)

Dossieritems

KnSubject

Nummer dossieritem (SbId)

Factuurtermijnen (Profit 20)

FbInstalment

Projectnummer (PrId)

termijnnummer (Inst)

Financiële mutaties

FiEntries

Administratienummer (UnId)

Nummer Journaalpost (EnNo)

Factuurnummer (InID)

Meer informatie

Forecasts

CmForecast

volgnummer (SqNo)

Functies per werkgever

KnOrgEmrFun

Werkgever (CmId)

Functie ID (FuId)

Inkoopoffertes

FbPurchQuotation

Nummer offerte (OrNu)

Inkooporders

FbPurch

Ordernummer (OrNu)

Inkooprelatie (organisatie)

KnPurchaseRelationOrg

 

 

Nummer crediteur (CrId)

Nummer organisatie

Inkooprelatie (persoon)

KnPurchaseRelationPer

Nummer crediteur (CrId)

Nummer persoon

Intercompany ontvangst op pakbon

FbDelNoteReceived)

Ontvangstnummer (OrNu)

Kostendragers werkgever

 

HrCostCarrier

Werkgever (CmId)

Kostendrager (CcId)

Kostenplaats per verkooprelatie

KnSreCostCentre

Nummer debiteur (DbId)

Kostenplaats (CoId)

Kostenplaatsen werkgever

 

HrCostCentre

Werkgever (CmId)

Kostenplaats (CrId)

Loonmutaties

 

HrCompMut

Regelnummer (Id)

Loonmutaties o.b.v. GUID

 

HrCompMutGUID

Regelnummer (Id)

Loonstrook (België)

HrEmpPaySlip

Nummer dossieritem (SbId)

Medewerker

 

KnEmployee

KnEmployeeGUID

Medewerker (EmId)

Meetstaten

PtMeasurement

Meetstaatnummer (MsId)

Nacalculatie

PtRealization

Regel id (Id)

Externe Id (XpRe)

Sessie-GUID (Sessieguid)

Meer informatie

Ontvangstbonnen

FbWarTransferIn

Nummer magazijnverplaatsing (OrNu)

Ontvangsten

FbGoodsReceived

Ontvangstnummer (OrNu)

Organisaties

KnOrganisation

Nummer (BcCo)

Organisatie/persoon (intern) (BcId)

Organisatorische eenheid

 

KnOrgUnit

Organisatorische eenheid (OuId)

Pakbonnen

FbDeliveryNote

Nummer pakbon (OrNu)

Parameters medewerker

 

HrVarVal

Parameter (VaId)

Volgnummer (SeNo)

Personen

KnPerson

Nummer (BcCo)

Organisatie/persoon (intern) (BcId)

Productieorders

FbAssembly

Ordernummer (OrNu)

Productievoorstellen

FbAssemblyPrep

Ordernummer (OrNu)

Projecten

PtProject

Projectnummer (PrId)

Sociale secretariaten

HrTimeRegSocSec

Regelnummer (Id)

Sollicitanten

 

HrApplicant

Sollicitant (EmId)

Sollicitanten SSS

 

HrCreateApplicant

Deze UpdateConnector geeft een response, maar het betreffende nummer is niet correct.

Reserveringen

FiReservation

Administratienummer (UnId)

Nummer reservering (SeNo)

Vaste activa (Profit 20)

FiFixedAssets

Activacode (SeNo)

Verkoopoffertes

FbSalesQuotation

Nummer offerte (OrNu)

Verkooporders

FbSales

Ordernummer (OrNu)

Verkooprelatie(organisatie)

KnSalesRelationOrg

Nummer debiteur (DbId)

Nummer organisatie

Verkooprelatie (persoon)

KnSalesRelationPer

Nummer debiteur (DbId)

Nummer organisatie

Verlofboekingen

 

HrAbsence

Regelnummer (Id)

Verlofboekingen InSite

 

HrAbsenceInSite

Regelnummer (Id)

Verlofcorrecties

 

HrAbsCorrection

Medewerker (EmId),

Regelnummer (Id)

Verplichtingen

FiCommitment

Administratienummer (UnId)

Nummer verplichting (SeNo)

Verzendbonnen

FbWarTransferOut

Nummer verzendbon (OrNu)

Verzuim

 

HrIllness

HrIllnessGUID

HrIllnessInSite

AbId (Identity)

Bij HrIllnessGUID wordt ook de GUID teruggemeld.

Voorbereidingen magazijnverplaatsing

FbWarTransferPrep

Nummer magazijnverplaatsing (OrNu)

Voorcalculatie

KnQuotation

Nummer voorcalculatie

Voorbeeld van de response met één code:

<?xml version="1.0"?>

<results><FbDirectInvoice><OrNu>70000183</OrNu></FbDirectInvoice></results>

Voorbeeld van de response met meerdere codes:

<?xml version="1.0"?>

<results><FbDeliveryNote><OrNu>70000156</OrNu></FbDeliveryNote></results>

<?xml version="1.0"?>

<results><FbDeliveryNote><OrNu>70000182</OrNu></FbDeliveryNote></results>

Direct naar

  1. Connector - externe software koppelen met Profit (API)

Process

Connector XML/SOAP

Work area

Connectoren