Om te bepalen in welke fase een scenario zich bevindt, moest je tot nu toe zelf een aantal velden combineren: de status van het scenario, of er een offertedocument is, hoe de offerte is aangeboden en wat de klant heeft geantwoord. Elke afnemer bouwde die logica apart, en moest hem apart bijhouden.

Het scenario levert die uitkomst nu zelf, in twee nieuwe velden: PresentatieStatusId en OfferteGeldigheidId. Beide komen als tekst terug, net als bijvoorbeeld StatusAanbodId.

De velden zitten in het antwoord van deze ingangen:

• GET contract/api/v1/scenarios
• GET contract/api/v1/scenarios/{id}
• PUT contract/api/v1/scenarios/starten
• PUT contract/api/v1/scenarios/starten/preview

Presentatiestatus

PresentatieStatusId geeft de fase van het scenario in gebruikerstermen. De mogelijke waarden zijn:

Twee paren waarden hebben dezelfde omschrijving: bij Geaccepteerd door klant en Afgekeurd door klant zie je aan de waarde of de offerte handmatig of digitaal is aangeboden, en aan de omschrijving niet. Gebruik dus de waarde en niet de omschrijving als je dat onderscheid nodig hebt.

Staat een scenario in een fase waarvoor geen presentatiestatus is bepaald, bijvoorbeeld Doorgevoerd, dan krijg je NotSet terug.

Offertegeldigheid

OfferteGeldigheidId geeft aan hoever een offerte is in haar geldigheidstermijn:

De grenzen tussen deze waarden volgen uit de termijnen die je inricht bij Digitaal offreren: de geldigheidstermijn van de offerte, de intrekkingstermijn en het aantal overgebleven dagen waarbij een offerte als bijna verlopen geldt. Heeft een scenario geen offertedatum, dan is OfferteGeldigheidId leeg.

Omschrijvingen opvragen

De omschrijvingen staan in de tabel hierboven, maar je kunt ze ook ophalen. Daarvoor zijn vier ingangen toegevoegd:

• GET codering/api/v1/aanduidingen/presentatiestatussen
• GET codering/api/v1/aanduidingen/presentatiestatussen/{id}
• GET codering/api/v1/aanduidingen/offertegeldigheden
• GET codering/api/v1/aanduidingen/offertegeldigheden/{id}

De lijstvariant levert per waarde een Id en een Omschrijving, de detailvariant levert die van één waarde. Een onbekend id geeft een Not Found.

Impact voor jou

Je kunt de fase van een scenario nu rechtstreeks uit het antwoord halen, zonder zelf statusvelden te combineren. Bestaande velden zijn ongewijzigd, dus je hoeft niets aan te passen; de nieuwe velden komen er alleen bij.