Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface ScheduleException

    A dated change to the weekly pattern — time off, or extra hours.

    date is a local calendar date; endDate (inclusive) makes it a range — "away 2026-12-20 → 2027-01-04" is ONE exception. Both minute fields absent = the whole of each day; present = that window on each day of the range.

    interface ScheduleException {
        id?: string;
        date: string;
        endDate?: string | null;
        kind: "block" | "open";
        startMinute?: number | null;
        endMinute?: number | null;
        specialty?: ScheduleSpecialty;
        reason?: string | null;
    }
    Index
    id? date endDate? kind startMinute? endMinute? specialty? reason?
    id?: string

    Server id. Absent on an exception that has not been stored yet.

    date: string

    First (or only) local date, YYYY-MM-DD.

    endDate?: string | null

    Last local date, inclusive. Absent = date alone.

    kind: "block" | "open"

    block removes time (wins over everything); open adds it.

    startMinute?: number | null

    Minutes from local midnight. BOTH or NEITHER.

    endMinute?: number | null
    specialty?: ScheduleSpecialty

    For an open exception: restrict the extra hours to one specialty slug, as a rule's specialty does. Ignored on a block — time off is time off, whichever clinic the window belonged to.

    reason?: string | null

    Shown to the physician only — never to patients.

    Settings
    Member Visibility

    On This Page
    Properties