Gaat af op het moment dat er een bijlage aan een opdracht is toegevoegd.

nl.assistanceonline.webhooks.invoicefinalized.v1

Gaat af op het moment dat de pdf van de factuur is gegenereerd. Dit is vlak nadat de factuur gefinaliseerd is.

Definities

Hieronder wordt kort toegelicht hoe responses van de webhooks eruit komen te zien. De basis bestaat uit en CloudEvent met daarin één Event en optioneel een aantal Resources.

...

nl.assistanceonline.webhooks.jobetacalculated.v1

Status mutaties van een dossier in AO:json voorbeeld bericht

Code Block

language	json

{
    "eta": "2021-11-01T13:41:10+01:00",
    "startLocation": "/tenants/1/orders/017ccb9f-4659-40e9-accb-1f8fe215bb31/locations/017ccb9f-467b-4fde-b14f-463fe651d7de",
    "destination": "/tenants/1/orders/017ccb9f-4659-40e9-accb-1f8fe215bb31/locations/017ccb9f-467b-4fde-b14f-463fe651d7de",
    "timestamp": "2021-11-01T11:17:16.3991916+01:00",
    "orderNumber": "O-0000090",
    "imNumber": null,
    "jobType": "BreakDownAssistance",
    "resourceReference": "/tenants/1/jobs/017ccb9f-cf0b-4097-8ee4-78f9e48e0584",
    "eventType": "nl.assistanceonline.webhooks.jobetacalculated.v1",
    "resources": {
        "/tenants/1/jobs/017ccb9f-cf0b-4097-8ee4-78f9e48e0584": {
            /* jobdata */
        }
    }
}

...

Veld	Type	Omschrijving	Voorbeeld
type	stringString	moment Moment waarvoor de vrachtbrief is gegenereerd	Load of Unload
downloadUrl	stringString	url Url naar document incl sas-token. Deze is 7 dagen geldig.
orderNumber	stringString	Ordernumber binnen AO	O-0000090
generatedAt	DateTimeOffset	Tijdstip waarop vrachtbrief is gegenereerd

...

Code Block

{
    "downloadUrl": "url withmet sastoken",
    "name": "download (1).jfif",
    "orderNumber": "O-0000357",
    "resourceReference": "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/attachments/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10",
    "eventType": "nl.assistanceonline.webhooks.orderattachmentadded.v1",
    "resources": {
        "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/attachments/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10": {
            // order attachment data
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld
downloadUrl	stringString	url Url naar document incl sas-token. Deze is 7 dagen geldig.
name	stringString	Naam van het bestand
orderNumber	stringString	Ordernumber binnen AO	O-0000090

Resource data

Iedere resource bevat twee standaard velden:

...

Veld

...

Type

...

Omschrijving

...

Voorbeeld

...

resourceReference

...

String

...

Referentie naar het resource voor het opvragen van meer details

nl.assistanceonline.webhooks.invoicefinalized.v1

json voorbeeld bericht

Code Block
{ "downloadUrl": "url met sastoken", "invoiceNumber": 21000009, "resourceReference": "/tenants/1/

...

invoices/

...

017d528c-

...

e5d8-

...

487a-

...

resourceType

...

String

...

Typering van de resource. B.v. Order, Job, Location, etc.

...

Order

...

90a4-dfbb22a31bac",
    "eventType": "nl.assistanceonline.webhooks.invoicefinalized.v1",
    "resources": {
        "/tenants/1/invoices/017d528c-e5d8-487a-90a4-dfbb22a31bac": {
            // invoice data
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld
downloadUrl	String	Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig.
invoiceNumber	Long	Factuurnummer	21000009

Resource data

Iedere resource bevat twee standaard velden:

Veld	Type	Omschrijving	Voorbeeld
resourceReference	String	Referentie naar het resource voor het opvragen van meer details	/tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa
resourceType	String	Typering van de resource. B.v. Order, Job, Location, etc.	Order

ConsignmentNoteResource

Veld	Type	Omschrijving	Voorbeeld
type	String	Moment waarvoor de vrachtbrief is gegenereerd	Load of Unload
downloadUrl	String	Url naar document incl sas-token. Deze is 7 dagen geldig.
Order	OrderReference	Referentie naar de OrderResource	Zie OrderReference

JobBillingResource

Veld	Type	Omschrijving	Voorbeeld
type	String	Soort doorbelasting: Automatic (Behorende bij een behandeling) Manual (Aanvullende facturatie, handmatig toegevoegd) VehicleStorage (Stallingsbehandeling) StandByShift (Standbydienst)	Automatic
customerOrderNumber	String	Inkoopopdrachtnummer	S1234235
debtor	RelationReference	Referentie naar debiteurinformatie	Zie RelationReference
invoice	InvoiceReference	Referentie naar factuurinformatie (InvoiceResource wordt nog niet meegestuurd)	Zie InvoiceReference

JobResource

IMOrderDetailsResource

Veld

Type

Omschrijving

Voorbeeld

imNumber

String

IM-nummer

LCM20123456-IM

llNumber

String

LL-nummer

LCM20123456-1

receivedAt

DateTimeOffset

Datum en tijd van waarop de melding is ontvangen

2020-11-06T14:36:00.000+02:00

orders

OrderReference[]

Referenties naar opdrachtdossiers die zijn aangemaakt naar aanleiding van deze melding

Info
Let op: Bij nieuwe IM-melding is het mogelijk dat er nog geen opdrachten zijn aangemaakt.

Zie OrderReference

company

Veld	Type	Omschrijving	Voorbeeld
type

string

moment waarvoor de vrachtbrief is gegenereerd

Load of Unload

downloadUrl

string

url naar document incl sas-token. Deze is 7 dagen geldig.

Order

OrderReference

Referentie naar de OrderResource

Zie OrderReference

JobBillingResource

...

Veld

...

Type

...

Omschrijving

...

Voorbeeld

...

type

...

String

...

Soort doorbelasting:

Automatic (Behorende bij een behandeling)
Manual (Aanvullende facturatie, handmatig toegevoegd)
VehicleStorage (Stallingsbehandeling)
StandByShift (Standbydienst)

...

Automatic

...

customerOrderNumber

...

String

...

Inkoopopdrachtnummer

...

S1234235

...

debtor

...

RelationReference

...

Referentie naar debiteurinformatie

...

Zie RelationReference

...

invoice

...

InvoiceReference

...

Referentie naar factuurinformatie (InvoiceResource wordt nog niet meegestuurd)

...

Zie InvoiceReference

JobResource

...

Veld

...

Type

...

Omschrijving

...

Voorbeeld

...

type

...

String

...

Behandelingstype:

BreakDownAssistance (Pechhulp)
PlannableTransport (Planbaar transport)
VehicleStorage (Stalling)
Salvage (Berging)
ErrorParked (Foutparkeerder)
Cleaning (Reiniging)
Im (IM melding)
TransportAfterFirstService (Doortransport)
LostCargo (Afgevallen lading)
NonPlannableTransport (Niet planbaar transport
Seizure (Inbeslagname)
Security (Beveiliging)
AbandonedVehicle (Achtergelaten voertuig)
StandBy (Standby dienst)

...

BreakDownAssistance

...

solution

...

String

...

Tekstuele toelichting van uitgevoerde werkzaamheden

...

Band gepropt en garage advies gegeven

...

executeAfterDateTime

...

DateTimeOffset

...

Optioneel opgegeven tijdstip vanaf wanneer de opdracht uitgevoerd mag worden

...

2020-11-06T14:36:00.000+02:00

...

executeBeforeDateTime

...

DateTimeOffset

...

Leadtijd, uiterste tijd om ter plaatse te zijn

...

2020-11-06T14:36:00.000+02:00

...

result

...

String

...

Behandelingsresultaat. Dit is afhankelijk van het type behandeling.

Pechhulp specifiek:

BreakdownAssistanceOk (Pechhulp geslaagd)
BreakdownAssistanceNotRepairedTransportToDepot (Pechhulp naar depot)
BreakdownAssistanceNotRepairedTransportToDestination (Pechhulp naar eindbestemming)
BreakdownAssistanceTransportWithoutRepairAttempt (Transport zonder reparatiepoging)

Berging specifiek:

OwnStrength (Eigen kracht verder)
SalvageDepot (Berging naar depot)
SalvageFinalDestination (Berging naar eindbestemming)

Overige uitkomsten:

EmptyRide (Loze rit)
JobResultOk (Behandeling afgerond)
SecondSalvor (Tweede inzet gevraagd)

...

BreakdownAssistanceOk

...

locations

...

OrderLocationReference[]

...

Lijst met locatiereferenties

...

Zie OrderLocationReference

...

statusReports

...

StatusReports[]

...

Lijst met statusupdates

...

Zie StatusReport

...

order

...

OrderReference

...

Referentie naar de opdracht, kan leeg zijn

...

Zie OrderReference

...

imOrder

...

ImOrderReference

...

Referentie naar de imOpdracht, kan leeg zijn

...

Zie ImOrderReference

String	Behandelingstype: BreakDownAssistance (Pechhulp) PlannableTransport (Planbaar transport) VehicleStorage (Stalling) Salvage (Berging) ErrorParked (Foutparkeerder) Cleaning (Reiniging) Im (IM melding) TransportAfterFirstService (Doortransport) LostCargo (Afgevallen lading) NonPlannableTransport (Niet planbaar transport Seizure (Inbeslagname) Security (Beveiliging) AbandonedVehicle (Achtergelaten voertuig) StandBy (Standby dienst)	BreakDownAssistance
solution	String	Tekstuele toelichting van uitgevoerde werkzaamheden	Band gepropt en garage advies gegeven
executeAfterDateTime	DateTimeOffset	Optioneel opgegeven tijdstip vanaf wanneer de opdracht uitgevoerd mag worden	2020-11-06T14:36:00.000+02:00
executeBeforeDateTime	DateTimeOffset	Leadtijd, uiterste tijd om ter plaatse te zijn	2020-11-06T14:36:00.000+02:00
result	String	Behandelingsresultaat. Dit is afhankelijk van het type behandeling. Pechhulp specifiek: BreakdownAssistanceOk (Pechhulp geslaagd) BreakdownAssistanceNotRepairedTransportToDepot (Pechhulp naar depot) BreakdownAssistanceNotRepairedTransportToDestination (Pechhulp naar eindbestemming) BreakdownAssistanceTransportWithoutRepairAttempt (Transport zonder reparatiepoging) Berging specifiek: OwnStrength (Eigen kracht verder) SalvageDepot (Berging naar depot) SalvageFinalDestination (Berging naar eindbestemming) Overige uitkomsten: EmptyRide (Loze rit) JobResultOk (Behandeling afgerond) SecondSalvor (Tweede inzet gevraagd)	BreakdownAssistanceOk
locations	OrderLocationReference[]	Lijst met locatiereferenties	Zie OrderLocationReference
statusReports	StatusReports[]	Lijst met statusupdates	Zie StatusReport
order	OrderReference	Referentie naar de opdracht, kan leeg zijn	Zie OrderReference
imOrder	ImOrderReference	Referentie naar de imOpdracht, kan leeg zijn	Zie ImOrderReference

IMOrderDetailsResource

Veld

Type

Omschrijving

Voorbeeld

imNumber

String

IM-nummer

LCM20123456-IM

llNumber

String

LL-nummer

LCM20123456-1

receivedAt

DateTimeOffset

Datum en tijd van waarop de melding is ontvangen

2020-11-06T14:36:00.000+02:00

orders

OrderReference[]

Referenties naar opdrachtdossiers die zijn aangemaakt naar aanleiding van deze melding

Info
Let op: Bij nieuwe IM-melding is het mogelijk dat er nog geen opdrachten zijn aangemaakt.

Zie OrderReference

company

RelationReference

Referentie naar relatiedetails van de uitvoerende berger

Zie RelationReference

customer

RelationReference

Referentie naar relatiedetails van de opdrachtgever

Zie RelationReference

description

String

Tekstuele toelichting

WIS aanrijdend;Pa:1 Vluchtstrook rechts lekke band verkeerszijde

district

String

Rayon van deze melding

NH131

status

String

Voortgang van de melding

Accepted (Geaccepteerd)
Assigned (Toegewezen)
Enroute (Onderweg)
Arrived (Ter plaatse)
Empty (Loze rit)

Info
Let op: Een IM-melding is klaar als de berger ter plaatse is en gaat dan verder in het gerelateerde opdrachtdossier of als de rit loosgemeld is.

Assigned

incidentLocation

OrderLocationReference

Locatie van het incident

Zie OrderLocationReference

InvoiceResource

Veld	Type	Omschrijving	Voorbeeld
debtor	RelationReference	Referentie naar relatiedetails van de

uitvoerende berger

debiteur

Zie RelationReference

customer

company	RelationReference	Referentie naar relatiedetails van

opdrachtgever

de uitvoerende berger

Zie RelationReference

description

String

Tekstuele toelichting

WIS aanrijdend;Pa:1 Vluchtstrook rechts lekke band verkeerszijde

district

String

Rayon van deze melding

NH131

status

String

Voortgang van de melding

Accepted (Geaccepteerd)
Assigned (Toegewezen)
Enroute (Onderweg)
Arrived (Ter plaatse)
Empty (Loze rit)

Info
Let op: Een IM-melding is klaar als de berger ter plaatse is en gaat dan verder in het gerelateerde opdrachtdossier of als de rit loosgemeld is.

Assigned

incidentLocation

OrderLocationReference

Locatie van het incident

Zie OrderLocationReference


orders	List<OrderReference>	Lijst met referentie naar de opdrachten die in deze factuur zitten	Zie OrderReference
invoiceDate	DateTimeOffset	De factuurdatum	2020-11-06T14:36:00.000+02:00
paymentTerm	Integer	Betalingstermijn waarbinnen de factuur betaald moet zijn	30
period	Integer	Boekingsperiode: De maand waarin de factuur is geboekt	11
fiscalYear	Integer	Boekingsperiode: Het jaar waarin de factuur is geboekt	2021
invoiceNumber	Long	Factuurnummer	21000009
debtorNumber	String	Debiteurnummer	2142
downloadUrl	String	Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig.

LocationResource

Veld

Type

Omschrijving

Voorbeeld

type

String

Locatie type

MainRoad (A en N-wegen)
Address (Straatadres)

Address

name

String

Naam van het adres

RGB+ Automatisering B.V.

address

Address

Adresdetails

Info
Let op: Dit veld is alleen gevuld als type ‘Address’ is

Zie Address

mainRoad

MainRoad

Hoofdwegdetails

Info
Let op: Dit veld is alleen gevuld als type ‘MainRoad’ is

Zie MainRoad

coordinates

Coordinates

Coordinaten van deze locatie

Zie Coordinates

remark

String

Adres toelichting

Melden bij receptie

OrderAttachment

Veld	Type	Omschrijving	Voorbeeld
downloadUrl	stringString	url Url naar document incl sas-token. Deze is 7 dagen geldig.
name	stringString	naam Naam van het bestand
order	OrderReference	Verwijzing naar de opdracht waaraan het bestand is toegevoegd	Zie OrderReference
isInternal	booleanBoolean	Indicatie om aan te geven of een bestand alleen voor intern gebruik is.
fileSize	longLong	aantal Aantal bytes van het bestand
mimeType	stringString	mimetype Mimetype van het bestand
Timestamp	DateTimeOffset	Tijdstip waarop bestand is toegevoegd.

...

Versions Compared

Old Version 20

New Version 21

Key

nl.assistanceonline.webhooks.invoicefinalized.v1

Definities

nl.assistanceonline.webhooks.jobetacalculated.v1

Resource data

nl.assistanceonline.webhooks.invoicefinalized.v1

Resource data

ConsignmentNoteResource

JobBillingResource

JobResource

IMOrderDetailsResource

JobBillingResource

JobResource

IMOrderDetailsResource

InvoiceResource

LocationResource

OrderAttachment

Page Comparison

Versions Compared

Old Version 20

New Version 21

Key

nl.assistanceonline.webhooks.invoicefinalized.v1

Definities

nl.assistanceonline.webhooks.jobetacalculated.v1

Resource data

nl.assistanceonline.webhooks.invoicefinalized.v1

Resource data

ConsignmentNoteResource

JobBillingResource

JobResource

IMOrderDetailsResource

JobBillingResource

JobResource

IMOrderDetailsResource

InvoiceResource

LocationResource

OrderAttachment