Calendário
URL base: $BUSINESS_API
O objecto
idtenant_idsource_idformatum de
ics,csvstatusum de
preview,applied,faileditemsMostrar atributos filhos
kinduiddatemonthdayweekdaypositioneaster_kindum de
western,orthodoxeaster_offsetobservedum de
none,next,previous,nearestvalid_fromvalid_toname_ptname_enkind_of_dayum de
holiday,closure,workingarea_idsource_ref
addedMostrar atributos filhos
kinduiddatemonthdayweekdaypositioneaster_kindum de
western,orthodoxeaster_offsetobservedum de
none,next,previous,nearestvalid_fromvalid_toname_ptname_enkind_of_dayum de
holiday,closure,workingarea_idsource_ref
changedMostrar atributos filhos
kinduiddatemonthdayweekdaypositioneaster_kindum de
western,orthodoxeaster_offsetobservedum de
none,next,previous,nearestvalid_fromvalid_toname_ptname_enkind_of_dayum de
holiday,closure,workingarea_idsource_ref
removedMostrar atributos filhos
kinduiddatemonthdayweekdaypositioneaster_kindum de
western,orthodoxeaster_offsetobservedum de
none,next,previous,nearestvalid_fromvalid_toname_ptname_enkind_of_dayum de
holiday,closure,workingarea_idsource_ref
conflictsMostrar atributos filhos
dateexisting_kindum de
holiday,closure,workingincoming_kindum de
holiday,closure,workingdetail
affectedMostrar atributos filhos
typeidnamefromtocount
affected_limitationsConsumer coverage gaps and date behaviors not recalculated by this preview.
confirmed_byoutcomecreated_atapplied_at
Operações
- GET
/calendar - PUT
/calendar - GET
/calendar/days - POST
/calendar/days - DELETE
/calendar/days/{id} - POST
/calendar/occurrences - GET
/calendar/rules - POST
/calendar/rules - PATCH
/calendar/rules/{id} - DELETE
/calendar/rules/{id} - GET
/calendar/sources - POST
/calendar/sources - PATCH
/calendar/sources/{id} - DELETE
/calendar/sources/{id} - POST
/calendar/imports - GET
/calendar/imports/{id} - POST
/calendar/imports/{id}/apply - GET
/calendar/export.ics - GET
/calendar/export.csv
O objecto
{
"id": "cal_26gTtQiVPucb3CyVJaoRD6UlbOQ",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"source_id": "sou_2fjWEpPCsLRCQBV64hz26xd8MF9",
"format": "ics",
"status": "preview",
"items": [
{
"kind": "active",
"uid": "uid",
"date": "2026-11-19",
"month": 1,
"day": 1,
"weekday": 1,
"position": 1,
"easter_kind": "western",
"easter_offset": 1,
"observed": "none",
"valid_from": "2026-11-19",
"valid_to": "2026-11-19",
"name_pt": "name pt",
"name_en": "name en",
"kind_of_day": "holiday",
"area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
"source_ref": "source ref"
}
],
"added": [
{
"kind": "active",
"uid": "uid",
"date": "2026-11-19",
"month": 1,
"day": 1,
"weekday": 1,
"position": 1,
"easter_kind": "western",
"easter_offset": 1,
"observed": "none",
"valid_from": "2026-11-19",
"valid_to": "2026-11-19",
"name_pt": "name pt",
"name_en": "name en",
"kind_of_day": "holiday",
"area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
"source_ref": "source ref"
}
],
"changed": [
{
"kind": "active",
"uid": "uid",
"date": "2026-11-19",
"month": 1,
"day": 1,
"weekday": 1,
"position": 1,
"easter_kind": "western",
"easter_offset": 1,
"observed": "none",
"valid_from": "2026-11-19",
"valid_to": "2026-11-19",
"name_pt": "name pt",
"name_en": "name en",
"kind_of_day": "holiday",
"area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
"source_ref": "source ref"
}
],
"removed": [
{
"kind": "active",
"uid": "uid",
"date": "2026-11-19",
"month": 1,
"day": 1,
"weekday": 1,
"position": 1,
"easter_kind": "western",
"easter_offset": 1,
"observed": "none",
"valid_from": "2026-11-19",
"valid_to": "2026-11-19",
"name_pt": "name pt",
"name_en": "name en",
"kind_of_day": "holiday",
"area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
"source_ref": "source ref"
}
],
"conflicts": [
{
"date": "2026-11-19",
"existing_kind": "holiday",
"incoming_kind": "holiday",
"detail": "detail"
}
],
"affected": [
{
"type": "active",
"id": "cal_26gTtQiVPucb3CyVJaoRD6UlbOQ",
"name": "Ana Matsinhe",
"from": "2026-11-19T09:30:00Z",
"to": "2026-11-19T09:30:00Z",
"count": 1
}
],
"affected_limitations": [
"affected limitation"
],
"confirmed_by": "confirmed by",
"outcome": "outcome",
"created_at": "2026-11-19T09:30:00Z",
"applied_at": "2026-11-19T09:30:00Z"
}- CalendárioObter o calendário · Actualizar o calendário · Calcular as ocorrências de um agendamento · Exportar o calendário em iCalendar …5 operações
- DiasListar dias do calendário · Adicionar um dia ao calendário · Remover um dia do calendário3 operações
- RegrasListar regras do calendário · Adicionar uma regra ao calendário · Actualizar uma regra do calendário · Remover uma regra do calendário4 operações
- FontesListar fontes do calendário · Adicionar uma fonte ao calendário · Actualizar uma fonte do calendário · Remover uma fonte do calendário4 operações
- ImportaçõesImportar um calendário · Obter uma importação de calendário · Aplicar uma importação de calendário3 operações