{"items":[{"type":"link","label":"API pública TiqueTaque","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"API pública TiqueTaque"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"API pública TiqueTaque (2.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h2","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Autenticação"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  Para todas as requisições é necessária a autenticação com um token gerado a partir da plataforma do gestor, \n  utilizando o token com autenticação "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BasicAuth"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" sendo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"user=public"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"senha="},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"seu_token"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":">"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".  \n  Verifique a seção de integrações do TiqueAdmin para gerar o token.\n"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h2","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Rate limiting"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  Requisições são limitadas a 60 requisições por janela deslizante de 1 minuto.\n  Se o limite for excedido, será retornada uma resposta HTTP "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"429 Too Many Requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"group","label":"Afastamentos","link":"/openapi/afastamentos","routeSlug":"/openapi/afastamentos","items":[{"label":"Cria um afastamento para um funcionário","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/afastamentos/createworkleave","routeSlug":"/openapi/afastamentos/createworkleave","metadata":{"seo":{"title":"Cria um afastamento para um funcionário","description":"Cria um afastamento para um funcionário"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWorkLeave","name":"Cria um afastamento para um funcionário","isWebhook":false,"pointer":"/paths/~1work-leaves/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria um afastamento para um funcionário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25","pointer":"/paths/~1work-leaves/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O afastamento pode ser parcial ou de dia inteiro. Os valores "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" são opcionais, e devem ser preenchidos caso o afastamento seja parcial. Caso seja de dia inteiro, informar apenas "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Um dos valores entre "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é obrigatório e são mutuamente exclusivos."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/work-leaves","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_25"}},"responseCodes":["200","401","409","422"],"pointer":"/work-leaves","href":"afastamentos/createworkleave","openApiOperationId":"createWorkLeave","summary":"Cria um afastamento para um funcionário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Afastamento criado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/401/content/application~1json/examples/401"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro de validação dos dados."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}},"schemaId":"components/schemas/ErroRespostaModel"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por parâmetros incorretos."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1work-leaves/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/401/content/application~1json/examples/401"]}}},{"code":"409","schemaId":"components/schemas/ErroRespostaModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/post/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/afastamentos/createworkleave"}],"panels":[]}]},"httpPath":"/work-leaves"},{"label":"Retorna uma lista com os afastamentos de um funcionário","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/afastamentos/getworkleaves","routeSlug":"/openapi/afastamentos/getworkleaves","metadata":{"seo":{"title":"Retorna uma lista com os afastamentos de um funcionário","description":"Os afastamentos retornados, conforme os filtros aplicados são associados a um funcionário identificado por employee_id. Eles representam variados motivos que fazem com que o funcionário deixe de trabalhar o tempo previsto. Retorna todos os registros de afastamentos que contenham as  datas entre start_date e end_date. Resultado paginado"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkLeaves","name":"Retorna uma lista com os afastamentos de um funcionário","isWebhook":false,"pointer":"/paths/~1work-leaves/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retorna uma lista com os afastamentos de um funcionário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Os afastamentos retornados, conforme os filtros aplicados são associados a um funcionário identificado por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Eles representam variados motivos que fazem com que o funcionário deixe de trabalhar o tempo previsto. Retorna todos os registros de afastamentos que contenham as  datas entre "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end_date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Resultado paginado"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"employee_id","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}]},{"name":"employee_external_id","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID externo do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtro para data de início dos afastamentos."},"children":[]}]}]}],"required":true},{"name":"end_date","in":"query","schemaId":"schema_28","description":"Filtro para data de fim dos afastamentos","required":true},{"name":"type","in":"query","schemaId":"schema_29","description":"filtro por tipo de afastamento."},{"name":"status","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filtro por situação do afastamento."},"children":[]}]}]}]},{"name":"max_results","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados paginados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados a retornar"},"children":[]}]}]}]}],"pointer":"/paths/~1work-leaves/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/work-leaves","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"employee_id","in":"query","schemaId":"schema_27"},{"name":"employee_external_id","in":"query","schemaId":"schema_27"},{"name":"start_date","in":"query","required":true,"example":"2023-09-27","schemaId":"components/schemas/DateParamModel"},{"name":"end_date","in":"query","required":true,"example":"2023-09-27","schemaId":"components/schemas/DateParamModel"},{"name":"type","in":"query","required":false,"schemaId":"components/schemas/TipoAfastamentoModel"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/StatusAfastamentoModel"},{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/work-leaves","href":"afastamentos/getworkleaves","openApiOperationId":"getWorkLeaves","summary":"Retorna uma lista com os afastamentos de um funcionário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna listagem de todos os afastamentos que atendem aos critérios dos filtros."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro afastamento não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/404/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente ou com formato inválido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1work-leaves/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves/get/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/afastamentos/getworkleaves"}],"panels":[]}]},"httpPath":"/work-leaves"},{"label":"Aprova um afastamento","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/afastamentos/approveworkleave","routeSlug":"/openapi/afastamentos/approveworkleave","metadata":{"seo":{"title":"Aprova um afastamento","description":"Aprova um afastamento"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"approveWorkLeave","name":"Aprova um afastamento","isWebhook":false,"pointer":"/paths/~1work-leaves~1{id}~1approve/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aprova um afastamento","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":"ID do afastamento","required":true}],"pointer":"/paths/~1work-leaves~1{id}~1approve/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para aprovar um afastamento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1work-leaves~1{id}~1approve/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/work-leaves/{id}/approve","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","412","428"],"pointer":"/work-leaves/{id}/approve","href":"afastamentos/approveworkleave","openApiOperationId":"approveWorkLeave","summary":"Aprova um afastamento"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1work-leaves~1{id}~1approve/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1approve/patch/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/afastamentos/approveworkleave"}],"panels":[]}]},"httpPath":"/work-leaves/{id}/approve"},{"label":"Reprova um afastamento","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/afastamentos/rejectworkleave","routeSlug":"/openapi/afastamentos/rejectworkleave","metadata":{"seo":{"title":"Reprova um afastamento","description":"Reprova um afastamento"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rejectWorkLeave","name":"Reprova um afastamento","isWebhook":false,"pointer":"/paths/~1work-leaves~1{id}~1reject/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reprova um afastamento","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Pode ser usado tanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1work-leaves~1{id}~1reject/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para reprovar um afastamento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1work-leaves~1{id}~1reject/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/work-leaves/{id}/reject","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","412","428"],"pointer":"/work-leaves/{id}/reject","href":"afastamentos/rejectworkleave","openApiOperationId":"rejectWorkLeave","summary":"Reprova um afastamento"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1work-leaves~1{id}~1reject/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}~1reject/patch/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/afastamentos/rejectworkleave"}],"panels":[]}]},"httpPath":"/work-leaves/{id}/reject"},{"label":"Retorna os dados de um afastamento","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/afastamentos/getworkleavebyid","routeSlug":"/openapi/afastamentos/getworkleavebyid","metadata":{"seo":{"title":"Retorna os dados de um afastamento","description":"Retorna todos campos de"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkLeaveById","name":"Retorna os dados de um afastamento","isWebhook":false,"pointer":"/paths/~1work-leaves~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retorna os dados de um afastamento","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retorna todos campos de\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":"ID do afastamento.","required":true}],"pointer":"/paths/~1work-leaves~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/work-leaves/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/work-leaves/{id}","href":"afastamentos/getworkleavebyid","openApiOperationId":"getWorkLeaveById","summary":"Retorna os dados de um afastamento"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados cadastrados para o afastamento.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AfastamentoModel"}},"schemaId":"components/schemas/AfastamentoModel"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Se o ID do afastamento não corresponder a um existente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1work-leaves~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AfastamentoModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AfastamentoModel"}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/afastamentos/getworkleavebyid"}],"panels":[]}]},"httpPath":"/work-leaves/{id}"},{"label":"Exclui um afastamento","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/afastamentos/deleteworkleave","routeSlug":"/openapi/afastamentos/deleteworkleave","metadata":{"seo":{"title":"Exclui um afastamento","description":"Exclui um afastamento"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWorkLeave","name":"Exclui um afastamento","isWebhook":false,"pointer":"/paths/~1work-leaves~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exclui um afastamento","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":"ID do afastamento.","required":true}],"pointer":"/paths/~1work-leaves~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para remover um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1work-leaves~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/work-leaves/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","412","428"],"pointer":"/work-leaves/{id}","href":"afastamentos/deleteworkleave","openApiOperationId":"deleteWorkLeave","summary":"Exclui um afastamento"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cadastro excluído com sucesso."},"children":[]}]}]}]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1work-leaves~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-leaves~1{id}/delete/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/afastamentos/deleteworkleave"}],"panels":[]}]},"httpPath":"/work-leaves/{id}"}],"content":{"contentType":"group","meta":{"name":"Afastamentos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Afastamentos","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações referentes aos afastamentos de um funcionário."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/work-leaves","summary":"Cria um afastamento para um funcionário","prefix":{"name":"post","color":"post"},"badges":[],"link":"/afastamentos/createworkleave","deprecated":false},{"title":"/work-leaves","summary":"Retorna uma lista com os afastamentos de um funcionário","prefix":{"name":"get","color":"get"},"badges":[],"link":"/afastamentos/getworkleaves","deprecated":false},{"title":"/work-leaves/{id}/approve","summary":"Aprova um afastamento","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/afastamentos/approveworkleave","deprecated":false},{"title":"/work-leaves/{id}/reject","summary":"Reprova um afastamento","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/afastamentos/rejectworkleave","deprecated":false},{"title":"/work-leaves/{id}","summary":"Retorna os dados de um afastamento","prefix":{"name":"get","color":"get"},"badges":[],"link":"/afastamentos/getworkleavebyid","deprecated":false},{"title":"/work-leaves/{id}","summary":"Exclui um afastamento","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/afastamentos/deleteworkleave","deprecated":false}]}]}]}]}},{"type":"group","label":"Escalas","link":"/openapi/escalas","routeSlug":"/openapi/escalas","items":[{"label":"Lista com sumário de escalas de trabalho","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/escalas/getworkschedulessummary","routeSlug":"/openapi/escalas/getworkschedulessummary","metadata":{"seo":{"title":"Lista com sumário de escalas de trabalho","description":"Retorna a listagem paginada de nomes de escalas de trabalho ativas e visíveis, com o correspondente ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkSchedulesSummary","name":"Lista com sumário de escalas de trabalho","isWebhook":false,"pointer":"/paths/~1work-schedules~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista com sumário de escalas de trabalho","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna a listagem paginada de nomes de escalas de trabalho ativas e visíveis, com o correspondente ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"max_results","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados paginados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados a retornar"},"children":[]}]}]}]}],"pointer":"/paths/~1work-schedules~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/work-schedules/summary","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/work-schedules/summary","href":"escalas/getworkschedulessummary","openApiOperationId":"getWorkSchedulesSummary","summary":"Lista com sumário de escalas de trabalho"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de usuários."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro usuário não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1work-schedules~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1work-schedules~1summary/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/escalas/getworkschedulessummary"}],"panels":[]}]},"httpPath":"/work-schedules/summary"}],"content":{"contentType":"group","meta":{"name":"Escalas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Escalas","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações dos cadastros de escalas de trabalho."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/work-schedules/summary","summary":"Lista com sumário de escalas de trabalho","prefix":{"name":"get","color":"get"},"badges":[],"link":"/escalas/getworkschedulessummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Funcionários","link":"/openapi/funcionarios","routeSlug":"/openapi/funcionarios","items":[{"label":"Cadastra um novo funcionário","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/funcionarios/createemployee","routeSlug":"/openapi/funcionarios/createemployee","metadata":{"seo":{"title":"Cadastra um novo funcionário","description":"Para detalhes dos formatos de dados do corpo da requisição, veja a descrição do schema."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmployee","name":"Cadastra um novo funcionário","isWebhook":false,"pointer":"/paths/~1employees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cadastra um novo funcionário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para detalhes dos formatos de dados do corpo da requisição, veja a descrição do schema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEmployeeModel"}},"schemaId":"components/schemas/PostEmployeeModel","pointer":"/paths/~1employees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/employees","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostEmployeeModel"}},"responseCodes":["200","401","409","422"],"pointer":"/employees","href":"funcionarios/createemployee","openApiOperationId":"createEmployee","summary":"Cadastra um novo funcionário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/PostEmployeeModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEmployeeModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Novo funcionário criado com sucesso."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/401/content/application~1json/examples/401"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro de validação dos dados."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}},"schemaId":"components/schemas/ErroRespostaModel"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente ou com formato inválido."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1employees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/401/content/application~1json/examples/401"]}}},{"code":"409","schemaId":"components/schemas/ErroRespostaModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/post/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funcionarios/createemployee"}],"panels":[]}]},"httpPath":"/employees"},{"label":"Lista o cadastro dos funcionários ativos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/funcionarios/getemployees","routeSlug":"/openapi/funcionarios/getemployees","metadata":{"seo":{"title":"Lista o cadastro dos funcionários ativos","description":"Resultado paginado. A ausência de um campo na resposta indica que seu valor ainda não foi definido. Pode ser filtrado por empregador (payment_source), útil para localizar funcionários de um empregador específico que ainda não possuem external_id. Quando nenhum funcionário é encontrado, a resposta é 200 com _items vazio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployees","name":"Lista o cadastro dos funcionários ativos","isWebhook":false,"pointer":"/paths/~1employees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista o cadastro dos funcionários ativos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resultado paginado. A ausência de um campo na resposta indica que seu valor ainda não foi definido. Pode ser filtrado por empregador ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), útil para localizar funcionários de um empregador específico que ainda não possuem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quando nenhum funcionário é encontrado, a resposta é 200 com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" vazio."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"payment_source","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtra os funcionários pelo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do empregador (payment-source) vinculado. Deve ser um ObjectId válido."},"children":[]}]}]}]},{"name":"max_results","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados paginados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados a retornar"},"children":[]}]}]}]}],"pointer":"/paths/~1employees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employees","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"payment_source","in":"query","required":false,"example":"5f3551beeb623e8ebe0ae994","schemaId":"schema_35"},{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/employees","href":"funcionarios/getemployees","openApiOperationId":"getEmployees","summary":"Lista o cadastro dos funcionários ativos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de funcionários. Quando nenhum funcionário atende à consulta, o retorno também é 200, com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" vazio e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_meta.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" igual a 0."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36","exampleIds":["paths/~1employees/get/responses/200/content/application~1json/examples/lista_vazia"]}},"schemaId":"schema_36","exampleIds":["paths/~1employees/get/responses/200/content/application~1json/examples/lista_vazia"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/401/content/application~1json/examples/401"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtro "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com formato inválido."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1employees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","exampleIds":["paths/~1employees/get/responses/200/content/application~1json/examples/lista_vazia"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36","exampleIds":["paths/~1employees/get/responses/200/content/application~1json/examples/lista_vazia"]}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/401/content/application~1json/examples/401"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees/get/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funcionarios/getemployees"}],"panels":[]}]},"httpPath":"/employees"},{"label":"Cadastra funcionários em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/funcionarios/createemployeesbulk","routeSlug":"/openapi/funcionarios/createemployeesbulk","metadata":{"seo":{"title":"Cadastra funcionários em lote","description":"Cria vários funcionários em uma única requisição (até 100), reduzindo o número de chamadas frente ao limite de 60 requisições por minuto. A operação é atômica: todos os itens são validados antes da criação e, se qualquer um falhar, nenhum funcionário é criado."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmployeesBulk","name":"Cadastra funcionários em lote","isWebhook":false,"pointer":"/paths/~1employees~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cadastra funcionários em lote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria vários funcionários em uma única requisição (até 100), reduzindo o número de chamadas frente ao limite de 60 requisições por minuto. A operação é atômica: todos os itens são validados antes da criação e, se qualquer um falhar, nenhum funcionário é criado."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37","pointer":"/paths/~1employees~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/employees/bulk","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_37"}},"responseCodes":["200","401","422"],"pointer":"/employees/bulk","href":"funcionarios/createemployeesbulk","openApiOperationId":"createEmployeesBulk","summary":"Cadastra funcionários em lote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Todos os funcionários foram criados com sucesso."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/401/content/application~1json/examples/401"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lote com tamanho inválido (vazio ou acima de 100), ou um ou mais itens com erro de validação. Quando há erros de validação nenhum funcionário é criado e o campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_issues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" traz os erros de cada item que falhou, indexados pela posição do item na lista enviada e, dentro dela, pelo campo a que o erro se refere. Os mesmos erros também são descritos, em texto, nas mensagens de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroLoteRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/tamanho_invalido","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/itens_invalidos","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/item_nao_objeto"]}},"schemaId":"components/schemas/ErroLoteRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/tamanho_invalido","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/itens_invalidos","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/item_nao_objeto"]}],"pointer":"/paths/~1employees~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/401/content/application~1json/examples/401"]}}},{"code":"422","schemaId":"components/schemas/ErroLoteRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/tamanho_invalido","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/itens_invalidos","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/item_nao_objeto"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroLoteRespostaModel","exampleIds":["paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/tamanho_invalido","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/itens_invalidos","paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/item_nao_objeto"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funcionarios/createemployeesbulk"}],"panels":[]}]},"httpPath":"/employees/bulk"},{"label":"Atualiza um funcionário","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/funcionarios/updateemployee","routeSlug":"/openapi/funcionarios/updateemployee","metadata":{"seo":{"title":"Atualiza um funcionário","description":"Atualiza um funcionário"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEmployee","name":"Atualiza um funcionário","isWebhook":false,"pointer":"/paths/~1employees~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualiza um funcionário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Pode ser usado tanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employees~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para atualizar um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employees~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEmployeeModel"}},"schemaId":"components/schemas/PostEmployeeModel","pointer":"/paths/~1employees~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/employees/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostEmployeeModel"}},"responseCodes":["200","401","412","428"],"pointer":"/employees/{id}","href":"funcionarios/updateemployee","openApiOperationId":"updateEmployee","summary":"Atualiza um funcionário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/PostEmployeeModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEmployeeModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1employees~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/patch/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funcionarios/updateemployee"}],"panels":[]}]},"httpPath":"/employees/{id}"},{"label":"Retorna os detalhes de um funcionário","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/funcionarios/getemployeebyid","routeSlug":"/openapi/funcionarios/getemployeebyid","metadata":{"seo":{"title":"Retorna os detalhes de um funcionário","description":"São retornados os funcionário ativos apenas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployeeById","name":"Retorna os detalhes de um funcionário","isWebhook":false,"pointer":"/paths/~1employees~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retorna os detalhes de um funcionário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"São retornados os funcionário ativos apenas."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Pode ser usado tanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employees~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employees/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/employees/{id}","href":"funcionarios/getemployeebyid","openApiOperationId":"getEmployeeById","summary":"Retorna os detalhes de um funcionário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de funcionários."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeModel"}},"schemaId":"components/schemas/EmployeeModel"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Se o ID do funcionário não corresponder a um existente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1employees~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmployeeModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeModel"}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funcionarios/getemployeebyid"}],"panels":[]}]},"httpPath":"/employees/{id}"},{"label":"Exclui um funcionário","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/funcionarios/deleteemployee","routeSlug":"/openapi/funcionarios/deleteemployee","metadata":{"seo":{"title":"Exclui um funcionário","description":"Exclui um funcionário"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmployee","name":"Exclui um funcionário","isWebhook":false,"pointer":"/paths/~1employees~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exclui um funcionário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Pode ser usado tanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employees~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para remover um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employees~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/employees/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","412","428"],"pointer":"/employees/{id}","href":"funcionarios/deleteemployee","openApiOperationId":"deleteEmployee","summary":"Exclui um funcionário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cadastro excluído com sucesso."},"children":[]}]}]}]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1employees~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1employees~1{id}/delete/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funcionarios/deleteemployee"}],"panels":[]}]},"httpPath":"/employees/{id}"}],"content":{"contentType":"group","meta":{"name":"Funcionários"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Funcionários","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações sobre os cadastros de funcionários."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employees","summary":"Cadastra um novo funcionário","prefix":{"name":"post","color":"post"},"badges":[],"link":"/funcionarios/createemployee","deprecated":false},{"title":"/employees","summary":"Lista o cadastro dos funcionários ativos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/funcionarios/getemployees","deprecated":false},{"title":"/employees/bulk","summary":"Cadastra funcionários em lote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/funcionarios/createemployeesbulk","deprecated":false},{"title":"/employees/{id}","summary":"Atualiza um funcionário","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/funcionarios/updateemployee","deprecated":false},{"title":"/employees/{id}","summary":"Retorna os detalhes de um funcionário","prefix":{"name":"get","color":"get"},"badges":[],"link":"/funcionarios/getemployeebyid","deprecated":false},{"title":"/employees/{id}","summary":"Exclui um funcionário","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/funcionarios/deleteemployee","deprecated":false}]}]}]}]}},{"type":"group","label":"Registros de ponto","link":"/openapi/registros-de-ponto","routeSlug":"/openapi/registros-de-ponto","items":[{"label":"Adiciona um registro de ponto","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/registros-de-ponto/createtimerecord","routeSlug":"/openapi/registros-de-ponto/createtimerecord","metadata":{"seo":{"title":"Adiciona um registro de ponto","description":"Adiciona um registro por vez para o funcionário na data e hora passada. Este registro é armazenado como um registro com type='registro externo'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTimeRecord","name":"Adiciona um registro de ponto","isWebhook":false,"pointer":"/paths/~1times/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adiciona um registro de ponto","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adiciona um registro por vez para o funcionário na data e hora passada. Este registro é armazenado como um registro com type='registro externo'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Os registros de um funcionário mesmo que inseridos com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sucesso por este endpoint, serão exibidos na interface do admin TiqueTaque apenas se o cadastro do  funcionário possuir uma escala e um empregador configurados. Depois de configurados os campos os registros  previamente adicionados serão exibidos também. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Os campos "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" são mutuamente exclusivos no corpo da requisição."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39","pointer":"/paths/~1times/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/times","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_39"}},"responseCodes":["200","401","403","404","422"],"pointer":"/times","href":"registros-de-ponto/createtimerecord","openApiOperationId":"createTimeRecord","summary":"Adiciona um registro de ponto"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"applicaton/json","mediaTypes":["applicaton/json"],"mediaTypeContent":{"applicaton/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/401/content/application~1json/examples/401"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sem permissão para realizar registros via API"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID de funcionário não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/404/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erros de formato de dados de entrada. Os erros podem ser por motivos variados como falta de  algum dos parâmetros, ou formatos inválidos."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1times/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["applicaton/json"],"mediaTypeContent":{"applicaton/json":{"schemaId":"schema_40"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/401/content/application~1json/examples/401"]}}},{"code":"403","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/post/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registros-de-ponto/createtimerecord"}],"panels":[]}]},"httpPath":"/times"},{"label":"Registros de ponto","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/registros-de-ponto/gettimerecords","routeSlug":"/openapi/registros-de-ponto/gettimerecords","metadata":{"seo":{"title":"Registros de ponto","description":"Retorna os detalhes dos registros para o funcionário solicitado, dentro do intervalo,o formato da resposta é o seguinte:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTimeRecords","name":"Registros de ponto","isWebhook":false,"pointer":"/paths/~1times/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Registros de ponto","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna os detalhes dos registros para o funcionário solicitado, dentro do intervalo,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"o formato da resposta é o seguinte:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"employee_id\": \"5f5bc225b511a6e44c2891f6\",\n    \"times\": [\n        {\n            \"approved\": true,\n            \"justification\": \"Esqueci de registrar\",\n            \"time\": \"2024-09-25T07:32\",\n            \"type\": \"ajuste manual\"\n        },\n        {\n            \"approved\": true,\n            \"justification\": \"Registro via app com geolocalização\",\n            \"time\": \"2024-09-25T11:59\",\n            \"type\": \"app\"\n        }\n    ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"employee_id\": \"5f5bc225b511a6e44c2891f6\",\n    \"times\": [\n        {\n            \"approved\": true,\n            \"justification\": \"Esqueci de registrar\",\n            \"time\": \"2024-09-25T07:32\",\n            \"type\": \"ajuste manual\"\n        },\n        {\n            \"approved\": true,\n            \"justification\": \"Registro via app com geolocalização\",\n            \"time\": \"2024-09-25T11:59\",\n            \"type\": \"app\"\n        }\n    ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chave"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"employee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"times"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de registros de ponto encontrados para o funcionário."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Os valores para cada um dos itens da lista de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"times"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" são:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": [true, false]. Indica se o registro já está aprovado pelo gestor."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": [pré-assinalado, aparelho, web, desconsiderado, app, reconhecimento facial, ajuste manual, offline, registro externo]"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Data e hora no format YYYY-MM-DDTHH:MM"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"justification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": justificativa do registro, caso exista."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"employee_id","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}]},{"name":"employee_external_id","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID externo do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_28","description":"Data inicial.","required":true},{"name":"end_date","in":"query","schemaId":"schema_28","description":"Data final.","required":true}],"pointer":"/paths/~1times/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/times","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"employee_id","in":"query","required":false,"schemaId":"schema_27"},{"name":"employee_external_id","in":"query","required":false,"schemaId":"schema_27"},{"name":"start_date","in":"query","required":true,"example":"2023-09-27","schemaId":"components/schemas/DateParamModel"},{"name":"end_date","in":"query","required":true,"example":"2023-09-27","schemaId":"components/schemas/DateParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","409","422"],"pointer":"/times","href":"registros-de-ponto/gettimerecords","openApiOperationId":"getTimeRecords","summary":"Registros de ponto"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resposta de sucesso, com detalhes dos registros de ponto. Os exemplos mostrams os valores de resposta possíveis."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1times/get/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_42","exampleIds":["paths/~1times/get/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro funcionário não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/404/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por cadastro de funcionário incompleto."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por parâmetros incorretos."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1times/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_42","exampleIds":["paths/~1times/get/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1times/get/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1times/get/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registros-de-ponto/gettimerecords"}],"panels":[]}]},"httpPath":"/times"}],"content":{"contentType":"group","meta":{"name":"Registros de ponto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Registros de ponto","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações referentes aos registros de ponto."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/times","summary":"Adiciona um registro de ponto","prefix":{"name":"post","color":"post"},"badges":[],"link":"/registros-de-ponto/createtimerecord","deprecated":false},{"title":"/times","summary":"Registros de ponto","prefix":{"name":"get","color":"get"},"badges":[],"link":"/registros-de-ponto/gettimerecords","deprecated":false}]}]}]}]}},{"type":"group","label":"Empregadores","link":"/openapi/empregadores","routeSlug":"/openapi/empregadores","items":[{"label":"Adiciona um novo empregador","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/empregadores/postpaymentsource","routeSlug":"/openapi/empregadores/postpaymentsource","metadata":{"seo":{"title":"Adiciona um novo empregador","description":"Cria o novo empregador. Não é suportada a configuração de dados dos layouts de exportação através desta API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPaymentSource","name":"Adiciona um novo empregador","isWebhook":false,"pointer":"/paths/~1payment-sources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adiciona um novo empregador","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria o novo empregador. Não é suportada a configuração de dados dos layouts de exportação através desta API."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSourceModel"}},"schemaId":"components/schemas/PaymentSourceModel","pointer":"/paths/~1payment-sources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-sources","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentSourceModel"}},"responseCodes":["200","401","409","422"],"pointer":"/payment-sources","href":"empregadores/postpaymentsource","openApiOperationId":"postPaymentSource","summary":"Adiciona um novo empregador"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/PaymentSourceModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSourceModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/401/content/application~1json/examples/401"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro de validação dos dados."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}},"schemaId":"components/schemas/ErroRespostaModel"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente ou com formato inválido."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1payment-sources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/401/content/application~1json/examples/401"]}}},{"code":"409","schemaId":"components/schemas/ErroRespostaModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/post/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/empregadores/postpaymentsource"}],"panels":[]}]},"httpPath":"/payment-sources"},{"label":"Lista os empregadores","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/empregadores/getpaymentsources","routeSlug":"/openapi/empregadores/getpaymentsources","metadata":{"seo":{"title":"Lista os empregadores","description":"Lista todos empregadores ativos da conta. Pode ser filtrado por CNPJ e/ou CPF, útil para localizar empregadores criados na TiqueTaque que ainda não possuem external_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentSources","name":"Lista os empregadores","isWebhook":false,"pointer":"/paths/~1payment-sources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista os empregadores","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista todos empregadores ativos da conta. Pode ser filtrado por CNPJ e/ou CPF, útil para localizar empregadores criados na TiqueTaque que ainda não possuem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cnpj","in":"query","schemaId":"schema_44","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtra empregadores pelo CNPJ, sem máscara. Aceita o formato numérico ou alfanumérico (12 caracteres alfanuméricos maiúsculos seguidos de 2 dígitos verificadores). Se enviado junto com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cpf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", retorna os empregadores que casam com qualquer um dos dois (OR)."},"children":[]}]}]}]},{"name":"cpf","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtra empregadores pelo CPF, apenas números, sem máscara. Se enviado junto com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cnpj"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", retorna os empregadores que casam com qualquer um dos dois (OR)."},"children":[]}]}]}]},{"name":"max_results","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados paginados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados a retornar"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-sources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-sources","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"cnpj","in":"query","required":false,"example":"23467093000164","schemaId":"schema_44"},{"name":"cpf","in":"query","required":false,"example":"01234567890","schemaId":"schema_45"},{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/payment-sources","href":"empregadores/getpaymentsources","openApiOperationId":"getPaymentSources","summary":"Lista os empregadores"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de usuários."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}},"schemaId":"schema_46"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro empregador não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/404/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtro "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cnpj"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cpf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com formato inválido."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1payment-sources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources/get/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/empregadores/getpaymentsources"}],"panels":[]}]},"httpPath":"/payment-sources"},{"label":"Dados de um empregador","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/empregadores/getpaymentsourcebyid","routeSlug":"/openapi/empregadores/getpaymentsourcebyid","metadata":{"seo":{"title":"Dados de um empregador","description":"Retorna um empregador pelo ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentSourceById","name":"Dados de um empregador","isWebhook":false,"pointer":"/paths/~1payment-sources~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dados de um empregador","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retorna um empregador pelo ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do empregador. Pode ser usado tanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-sources~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-sources/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/payment-sources/{id}","href":"empregadores/getpaymentsourcebyid","openApiOperationId":"getPaymentSourceById","summary":"Dados de um empregador"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Empregador encontrado.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentSourceModel"}},"schemaId":"components/schemas/PaymentSourceModel"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro empregador não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1payment-sources~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentSourceModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentSourceModel"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/empregadores/getpaymentsourcebyid"}],"panels":[]}]},"httpPath":"/payment-sources/{id}"},{"label":"Atualiza um empregador","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/empregadores/updatepaymentsource","routeSlug":"/openapi/empregadores/updatepaymentsource","metadata":{"seo":{"title":"Atualiza um empregador","description":"Atualiza um empregador."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentSource","name":"Atualiza um empregador","isWebhook":false,"pointer":"/paths/~1payment-sources~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualiza um empregador","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Atualiza um empregador.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia (\"\")."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-sources~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para atualizar um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-sources~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchPaymentSourceModel"}},"schemaId":"components/schemas/PatchPaymentSourceModel","pointer":"/paths/~1payment-sources~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/payment-sources/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchPaymentSourceModel"}},"responseCodes":["200","401","412","428"],"pointer":"/payment-sources/{id}","href":"empregadores/updatepaymentsource","openApiOperationId":"updatePaymentSource","summary":"Atualiza um empregador"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/PatchPaymentSourceModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchPaymentSourceModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1payment-sources~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/patch/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/empregadores/updatepaymentsource"}],"panels":[]}]},"httpPath":"/payment-sources/{id}"},{"label":"Exclui um empregador","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/empregadores/deletepaymentsource","routeSlug":"/openapi/empregadores/deletepaymentsource","metadata":{"seo":{"title":"Exclui um empregador","description":"Exclui um empregador"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentSource","name":"Exclui um empregador","isWebhook":false,"pointer":"/paths/~1payment-sources~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exclui um empregador","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do empregador. Pode ser usado tanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quanto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-sources~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para remover um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-sources~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payment-sources/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","412","428"],"pointer":"/payment-sources/{id}","href":"empregadores/deletepaymentsource","openApiOperationId":"deletePaymentSource","summary":"Exclui um empregador"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cadastro excluído com sucesso."},"children":[]}]}]}]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1payment-sources~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1payment-sources~1{id}/delete/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/empregadores/deletepaymentsource"}],"panels":[]}]},"httpPath":"/payment-sources/{id}"}],"content":{"contentType":"group","meta":{"name":"Empregadores"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Empregadores","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas aos empregadores."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-sources","summary":"Adiciona um novo empregador","prefix":{"name":"post","color":"post"},"badges":[],"link":"/empregadores/postpaymentsource","deprecated":false},{"title":"/payment-sources","summary":"Lista os empregadores","prefix":{"name":"get","color":"get"},"badges":[],"link":"/empregadores/getpaymentsources","deprecated":false},{"title":"/payment-sources/{id}","summary":"Dados de um empregador","prefix":{"name":"get","color":"get"},"badges":[],"link":"/empregadores/getpaymentsourcebyid","deprecated":false},{"title":"/payment-sources/{id}","summary":"Atualiza um empregador","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/empregadores/updatepaymentsource","deprecated":false},{"title":"/payment-sources/{id}","summary":"Exclui um empregador","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/empregadores/deletepaymentsource","deprecated":false}]}]}]}]}},{"type":"group","label":"Espelhos de ponto","link":"/openapi/espelhos-de-ponto","routeSlug":"/openapi/espelhos-de-ponto","items":[{"label":"Espelhos de ponto","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/espelhos-de-ponto/gettimesheet","routeSlug":"/openapi/espelhos-de-ponto/gettimesheet","metadata":{"seo":{"title":"Espelhos de ponto","description":"Retorna espelhos de ponto com totais e detalhamento dia a dia."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTimesheet","name":"Espelhos de ponto","isWebhook":false,"pointer":"/paths/~1timesheets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Espelhos de ponto","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna espelhos de ponto com totais e detalhamento dia a dia."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modos de operação:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": retorna um único objeto de espelho para o funcionário informado."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sem filtro de funcionário: retorna uma lista paginada de espelhos para todos os funcionários ativos que possuem"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"espelho no período solicitado. Funcionários com cadastro incompleto são ignorados."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informar "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" simultaneamente retorna erro."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banco de horas e período parcial:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" os dados de banco de horas — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"banco_horas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e o objeto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hours_bank_summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — só são calculados quando o período solicitado corresponde exatamente a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uma folha de ponto completa do funcionário (do início ao fim do período de pagamento). Para um período"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parcial (qualquer intervalo diferente da folha, inclusive um recorte que começa no início dela ou que"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"abrange mais de uma folha), o espelho é retornado normalmente com as demais rubricas, porém sem nenhum"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dado de banco de horas. No modo lista, funcionários cujo período de pagamento não coincide exatamente com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"o intervalo solicitado também são incluídos, sem os dados de banco de horas."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As chaves possíveis em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" representam o total em horas centesimais de cada rubrica no período,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e podem ser as seguintes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"total"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"horas_normais"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"banco_horas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"falta_injustificada"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"falta_justificada"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"abono"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"folga"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"atraso"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dsr"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desconto_dsr"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inss"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"atestado"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispensa_legal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adicional_noturno"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adicional_noturno_extra_N (onde N é a faixa de horas extras em adicional noturno. e.g. adicional_noturno_extra_50)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hora_noturna_reduzida"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"afastamento_nao_remunerado"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sobreaviso"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suspensao"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ferias"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"extra_N (onde N é a faixa de horas extras. e.g. extra_50)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"employee_id","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Opcional. Se informado, retorna apenas o espelho deste funcionário. Não pode ser usado em conjunto com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"employee_external_id","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID externo do funcionário. Opcional. Se informado, retorna apenas o espelho deste funcionário. Não pode ser usado em conjunto com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"start_date","in":"query","schemaId":"schema_28","description":"Data inicial da folha de ponto.","required":true},{"name":"end_date","in":"query","schemaId":"schema_28","description":"Data final da folha de ponto.","required":true},{"name":"max_results","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados. Utilizado apenas quando nenhum filtro de funcionário é informado. O total reflete o número de funcionários com espelho no período, não o total de funcionários cadastrados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados. Utilizado apenas quando nenhum filtro de funcionário é informado."},"children":[]}]}]}]}],"pointer":"/paths/~1timesheets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/timesheets","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"employee_id","in":"query","schemaId":"schema_27"},{"name":"employee_external_id","in":"query","schemaId":"schema_27"},{"name":"start_date","in":"query","required":true,"example":"2023-09-27","schemaId":"components/schemas/DateParamModel"},{"name":"end_date","in":"query","required":true,"example":"2023-09-27","schemaId":"components/schemas/DateParamModel"},{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404","409","422"],"pointer":"/timesheets","href":"espelhos-de-ponto/gettimesheet","openApiOperationId":"getTimesheet","summary":"Espelhos de ponto"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resposta de sucesso. Quando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é informado, retorna um único objeto de espelho. Quando nenhum filtro de funcionário é informado, retorna uma lista paginada de espelhos. Valores em horas centesimais."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}},"schemaId":"schema_47"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por funcionário não encontrado, ou por não existir espelho de ponto para o período solicitado (período fora do contrato do funcionário). Retornado apenas quando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é informado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/404/content/application~1json/examples/funcionario_nao_encontrado","paths/~1timesheets/get/responses/404/content/application~1json/examples/periodo_sem_espelho"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/404/content/application~1json/examples/funcionario_nao_encontrado","paths/~1timesheets/get/responses/404/content/application~1json/examples/periodo_sem_espelho"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por cadastro de funcionário incompleto. Retornado apenas quando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é informado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por parâmetros incorretos."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1timesheets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_47","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/404/content/application~1json/examples/funcionario_nao_encontrado","paths/~1timesheets/get/responses/404/content/application~1json/examples/periodo_sem_espelho"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/404/content/application~1json/examples/funcionario_nao_encontrado","paths/~1timesheets/get/responses/404/content/application~1json/examples/periodo_sem_espelho"]}}},{"code":"409","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1timesheets/get/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/espelhos-de-ponto/gettimesheet"}],"panels":[]}]},"httpPath":"/timesheets"}],"content":{"contentType":"group","meta":{"name":"Espelhos de ponto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Espelhos de ponto","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dados relativos à um período de espelho de ponto, como totais trabalhados, horas extras, banco de horas e afastamentos."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/timesheets","summary":"Espelhos de ponto","prefix":{"name":"get","color":"get"},"badges":[],"link":"/espelhos-de-ponto/gettimesheet","deprecated":false}]}]}]}]}},{"type":"group","label":"Unidades","link":"/openapi/unidades","routeSlug":"/openapi/unidades","items":[{"label":"Cria uma nova unidade","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/unidades/createsite","routeSlug":"/openapi/unidades/createsite","metadata":{"seo":{"title":"Cria uma nova unidade","description":"Cria uma nova unidade. Unidades agrupam funcionários e podem ser utilizadas para vincular funcionários aos aparelhos TiqueTaque"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSite","name":"Cria uma nova unidade","isWebhook":false,"pointer":"/paths/~1sites/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria uma nova unidade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria uma nova unidade. Unidades agrupam funcionários e podem ser utilizadas para vincular funcionários aos aparelhos TiqueTaque"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteModel"}},"schemaId":"components/schemas/SiteModel","pointer":"/paths/~1sites/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sites","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SiteModel"}},"responseCodes":["200","401","409","422"],"pointer":"/sites","href":"unidades/createsite","openApiOperationId":"createSite","summary":"Cria uma nova unidade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/SiteModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/401/content/application~1json/examples/401"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro de validação dos dados."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}},"schemaId":"components/schemas/ErroRespostaModel"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente ou com formato inválido."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1sites/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/401/content/application~1json/examples/401"]}}},{"code":"409","schemaId":"components/schemas/ErroRespostaModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/post/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unidades/createsite"}],"panels":[]}]},"httpPath":"/sites"},{"label":"Retorna uma lista com as unidades ativas da conta","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/unidades/getsites","routeSlug":"/openapi/unidades/getsites","metadata":{"seo":{"title":"Retorna uma lista com as unidades ativas da conta","description":"Lista as unidades ativas"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSites","name":"Retorna uma lista com as unidades ativas da conta","isWebhook":false,"pointer":"/paths/~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retorna uma lista com as unidades ativas da conta","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lista as unidades ativas\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"max_results","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados paginados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados a retornar"},"children":[]}]}]}]}],"pointer":"/paths/~1sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sites","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/sites","href":"unidades/getsites","openApiOperationId":"getSites","summary":"Retorna uma lista com as unidades ativas da conta"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de usuários."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro unidade não encontrada."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unidades/getsites"}],"panels":[]}]},"httpPath":"/sites"},{"label":"Detalhes de  uma unidade","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/unidades/getsitebyid","routeSlug":"/openapi/unidades/getsitebyid","metadata":{"seo":{"title":"Detalhes de  uma unidade","description":"Retorna uma unidade específica."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSiteById","name":"Detalhes de  uma unidade","isWebhook":false,"pointer":"/paths/~1sites~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detalhes de  uma unidade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna uma unidade específica."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":"ID da unidade.","required":true}],"pointer":"/paths/~1sites~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sites/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/sites/{id}","href":"unidades/getsitebyid","openApiOperationId":"getSiteById","summary":"Detalhes de  uma unidade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Unidade encontrado.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteModel"}},"schemaId":"components/schemas/SiteModel"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro unidade não encontrada."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1sites~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteModel"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unidades/getsitebyid"}],"panels":[]}]},"httpPath":"/sites/{id}"},{"label":"Atualiza uma unidade","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/unidades/updatesite","routeSlug":"/openapi/unidades/updatesite","metadata":{"seo":{"title":"Atualiza uma unidade","description":"Atualiza uma unidade específica."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSite","name":"Atualiza uma unidade","isWebhook":false,"pointer":"/paths/~1sites~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualiza uma unidade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atualiza uma unidade específica."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":"ID da unidade.","required":true}],"pointer":"/paths/~1sites~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para atualizar um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1sites~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteModel"}},"schemaId":"components/schemas/SiteModel","pointer":"/paths/~1sites~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/sites/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SiteModel"}},"responseCodes":["200","401","412","428"],"pointer":"/sites/{id}","href":"unidades/updatesite","openApiOperationId":"updateSite","summary":"Atualiza uma unidade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/SiteModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SiteModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1sites~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/patch/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unidades/updatesite"}],"panels":[]}]},"httpPath":"/sites/{id}"},{"label":"Exclui uma unidade","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/unidades/deletesite","routeSlug":"/openapi/unidades/deletesite","metadata":{"seo":{"title":"Exclui uma unidade","description":"Exclui uma unidade"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSite","name":"Exclui uma unidade","isWebhook":false,"pointer":"/paths/~1sites~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exclui uma unidade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":"ID da unidade.","required":true}],"pointer":"/paths/~1sites~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para remover um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1sites~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sites/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","428"],"pointer":"/sites/{id}","href":"unidades/deletesite","openApiOperationId":"deleteSite","summary":"Exclui uma unidade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cadastro excluído com sucesso."},"children":[]}]}]}]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/401/content/application~1json/examples/401"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1sites~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/401/content/application~1json/examples/401"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1sites~1{id}/delete/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unidades/deletesite"}],"panels":[]}]},"httpPath":"/sites/{id}"}],"content":{"contentType":"group","meta":{"name":"Unidades"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unidades","showPageActions":true},{"nodeType":"markdoc","content":"Cadastros de unidades."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sites","summary":"Cria uma nova unidade","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unidades/createsite","deprecated":false},{"title":"/sites","summary":"Retorna uma lista com as unidades ativas da conta","prefix":{"name":"get","color":"get"},"badges":[],"link":"/unidades/getsites","deprecated":false},{"title":"/sites/{id}","summary":"Detalhes de  uma unidade","prefix":{"name":"get","color":"get"},"badges":[],"link":"/unidades/getsitebyid","deprecated":false},{"title":"/sites/{id}","summary":"Atualiza uma unidade","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/unidades/updatesite","deprecated":false},{"title":"/sites/{id}","summary":"Exclui uma unidade","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/unidades/deletesite","deprecated":false}]}]}]}]}},{"type":"group","label":"Usuários","link":"/openapi/usuarios","routeSlug":"/openapi/usuarios","items":[{"label":"Cria um novo usuário","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/usuarios/createuser","routeSlug":"/openapi/usuarios/createuser","metadata":{"seo":{"title":"Cria um novo usuário","description":"Cria um novo usuário."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Cria um novo usuário","isWebhook":false,"pointer":"/paths/~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria um novo usuário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria um novo usuário."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPostModel"}},"schemaId":"components/schemas/UserPostModel","pointer":"/paths/~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserPostModel"}},"responseCodes":["200","401","409","422"],"pointer":"/users","href":"usuarios/createuser","openApiOperationId":"createUser","summary":"Cria um novo usuário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/UserPostModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPostModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/401/content/application~1json/examples/401"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro de validação dos dados."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}},"schemaId":"components/schemas/ErroRespostaModel"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente ou com formato inválido."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/422/content/application~1json/examples/422"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/422/content/application~1json/examples/422"]}],"pointer":"/paths/~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/401/content/application~1json/examples/401"]}}},{"code":"409","schemaId":"components/schemas/ErroRespostaModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel"}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/422/content/application~1json/examples/422"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/post/responses/422/content/application~1json/examples/422"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usuarios/createuser"}],"panels":[]}]},"httpPath":"/users"},{"label":"Lista usuários da conta","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/usuarios/getusers","routeSlug":"/openapi/usuarios/getusers","metadata":{"seo":{"title":"Lista usuários da conta","description":"Retorna uma lista com os usuários da conta."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUsers","name":"Lista usuários da conta","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista usuários da conta","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna uma lista com os usuários da conta."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"max_results","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados paginados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados a retornar"},"children":[]}]}]}]}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/users","href":"usuarios/getusers","openApiOperationId":"getUsers","summary":"Lista usuários da conta"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de usuários."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro usuário não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usuarios/getusers"}],"panels":[]}]},"httpPath":"/users"},{"label":"Detalhes de um usuário","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/usuarios/getuserbyid","routeSlug":"/openapi/usuarios/getuserbyid","metadata":{"seo":{"title":"Detalhes de um usuário","description":"Retorna um usuário específico."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserById","name":"Detalhes de um usuário","isWebhook":false,"pointer":"/paths/~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detalhes de um usuário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna um usuário específico."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do usuário."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/users/{id}","href":"usuarios/getuserbyid","openApiOperationId":"getUserById","summary":"Detalhes de um usuário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usuário encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserModel"}},"schemaId":"components/schemas/UserModel"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/examples/401"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro usuário não encontrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserModel"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/401/content/application~1json/examples/401"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usuarios/getuserbyid"}],"panels":[]}]},"httpPath":"/users/{id}"},{"label":"Atualiza um usuário","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/usuarios/updateuser","routeSlug":"/openapi/usuarios/updateuser","metadata":{"seo":{"title":"Atualiza um usuário","description":"Atualiza um usuário específico."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Atualiza um usuário","isWebhook":false,"pointer":"/paths/~1users~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualiza um usuário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atualiza um usuário específico."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do usuário."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para atualizar um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPostModel"}},"schemaId":"components/schemas/UserPostModel","pointer":"/paths/~1users~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/users/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserPostModel"}},"responseCodes":["200","401","412","428"],"pointer":"/users/{id}","href":"usuarios/updateuser","openApiOperationId":"updateUser","summary":"Atualiza um usuário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"schemaId":"components/schemas/UserPostModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPostModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dados atualizados com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1users~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/patch/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usuarios/updateuser"}],"panels":[]}]},"httpPath":"/users/{id}"},{"label":"Exclui um usuário","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/usuarios/deleteuser","routeSlug":"/openapi/usuarios/deleteuser","metadata":{"seo":{"title":"Exclui um usuário","description":"Exclui um usuário"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Exclui um usuário","isWebhook":false,"pointer":"/paths/~1users~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exclui um usuário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do usuário."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para remover um documento é necessário o header com o valor do campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" atual do documento."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_27"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","required":true,"schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","412","428"],"pointer":"/users/{id}","href":"usuarios/deleteuser","openApiOperationId":"deleteUser","summary":"Exclui um usuário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cadastro excluído com sucesso."},"children":[]}]}]}]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/401/content/application~1json/examples/401"]},{"code":"412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag inválida."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/412/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/412/content/application~1json/example"]},{"code":"428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro _etag ausente."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/428/content/application~1json/example"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/428/content/application~1json/example"]}],"pointer":"/paths/~1users~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/401/content/application~1json/examples/401"]}}},{"code":"412","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/412/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/412/content/application~1json/example"]}}},{"code":"428","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/428/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1users~1{id}/delete/responses/428/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usuarios/deleteuser"}],"panels":[]}]},"httpPath":"/users/{id}"}],"content":{"contentType":"group","meta":{"name":"Usuários"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Usuários","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações sobre os cadastros de usuários."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Cria um novo usuário","prefix":{"name":"post","color":"post"},"badges":[],"link":"/usuarios/createuser","deprecated":false},{"title":"/users","summary":"Lista usuários da conta","prefix":{"name":"get","color":"get"},"badges":[],"link":"/usuarios/getusers","deprecated":false},{"title":"/users/{id}","summary":"Detalhes de um usuário","prefix":{"name":"get","color":"get"},"badges":[],"link":"/usuarios/getuserbyid","deprecated":false},{"title":"/users/{id}","summary":"Atualiza um usuário","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/usuarios/updateuser","deprecated":false},{"title":"/users/{id}","summary":"Exclui um usuário","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/usuarios/deleteuser","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/IsoDateTimeModel":{"id":"components/schemas/IsoDateTimeModel","kind":"json-schema","title":"IsoDateTimeModel","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$","example":"2024-09-29T08:00"}},"components/schemas/IsoDateTimeTzModel":{"id":"components/schemas/IsoDateTimeTzModel","kind":"json-schema","title":"IsoDateTimeTzModel","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}[+-][0-2]\\d:[0-5]\\d$","example":"2024-09-29T08:00-03:00"}},"components/schemas/EtagModel":{"id":"components/schemas/EtagModel","kind":"json-schema","title":"EtagModel","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos"},"children":[]}]}]}]}},"components/schemas/TimezoneModel":{"id":"components/schemas/TimezoneModel","kind":"json-schema","title":"TimezoneModel","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fuso Horário utilizado para controle do horário de registro de ponto."},"children":[]}]}]}],"example":"America/Sao_Paulo","enum":["America/Araguaina","America/Bahia","America/Belem","America/Boa_Vista","America/Campo_Grande","America/Cuiaba","America/Eirunepe","America/Noronha","America/Fortaleza","America/Maceio","America/Manaus","America/Porto_Velho","America/Recife","America/Rio_Branco","America/Santarem","America/Sao_Paulo","Africa/Algiers","Europe/Amsterdam","Europe/Athens","Pacific/Auckland","Asia/Bangkok","Europe/Berlin","America/Bogota","Europe/Brussels","America/Argentina/Buenos_Aires","Egypt","Asia/Kolkata","America/Caracas","Asia/Dubai","Europe/Dublin","Africa/Casablanca","US/Central","America/Mexico_City","US/Mountain","America/Guatemala","Europe/Helsinki","Pacific/Honolulu","Europe/Istanbul","Asia/Jerusalem","America/Lima","Europe/Lisbon","Europe/London","US/Pacific","Europe/Madrid","Europe/Moscow","Africa/Nairobi","US/Eastern","Europe/Paris","Europe/Prague","Europe/Rome","America/Santiago","Asia/Seoul","Australia/Sydney","Asia/Tokyo","America/Toronto","America/Vancouver","Europe/Vienna","Asia/Shanghai","Europe/Zurich"]}},"components/schemas/UserPermissionsModel":{"id":"components/schemas/UserPermissionsModel","kind":"json-schema","title":"UserPermissionsModel","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configurações de permissões de usuário."},"children":[]}]}]}],"properties":{"allow_ws_edition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se o usuário pode editar escalas, apenas aplicável quando role = 'supervisor'"},"children":[]}]}]}],"default":true,"type":"boolean"}}}},"components/schemas/AllowedSitesModel":{"id":"components/schemas/AllowedSitesModel","kind":"json-schema","title":"AllowedSitesModel","data":{"type":"array","items":{"type":"string"},"example":["id_1","id_2"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de unidades as quais o usuário tem acesso. Obrigatório e aplicável apenas quando o usuário não é admin. Restringe a visualização de funcionários apenas aos funcionários vinculados à estas unidades. O formato dos dados é uma lista de IDs de unidades cadastradas na conta. NOTA: Não existe ainda na API pública  o recurso de unidades, isto será adicionado futuramente."},"children":[]}]}]}]}},"components/schemas/RoleModel":{"id":"components/schemas/RoleModel","kind":"json-schema","title":"RoleModel","data":{"type":"string","example":"admin-supervisor","description":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]\n- admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema, como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões; lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.\n- admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador, porém apenas para as unidades selecionadas.\n- supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.\n- read-only: Pode apenas: visualizar os dados das unidades selecionadas.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]\n- admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema, como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões; lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.\n- admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador, porém apenas para as unidades selecionadas.\n- supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.\n- read-only: Pode apenas: visualizar os dados das unidades selecionadas.\n"},"children":[]}]}]}},"components/schemas/UserModel":{"id":"components/schemas/UserModel","kind":"json-schema","title":"UserModel","data":{"type":"object","properties":{"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do recurso, gerado internamente."},"children":[]}]}]}],"type":"string"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_updated":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_etag":{"$ref":"#/components/schemas/EtagModel"},"full_name":{"description":"Nome completo.","type":"string","example":"Exemplo da Silva"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endereço de e-mail."},"children":[]}]}]}],"type":"string","example":"exemplo@tiquetaque.com"},"mobile_phone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de telefone celular com código de área, somente números."},"children":[]}]}]}],"type":"string","example":"11991234567"},"external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia (\"\")."},"children":[]}]}]}],"type":"string"},"intercom_chat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se o chat do intercom no TiqueAdmin está habilitado para este usuário."},"children":[]}]}]}],"type":"boolean"},"verified_user":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se a conta do usuário já foi verificada através do email de ativação."},"children":[]}]}]}],"type":"boolean","example":true},"role":{"$ref":"#/components/schemas/RoleModel"},"allowed_sites":{"$ref":"#/components/schemas/AllowedSitesModel"},"permissions":{"$ref":"#/components/schemas/UserPermissionsModel"}}}},"components/schemas/UserPostModel":{"id":"components/schemas/UserPostModel","kind":"json-schema","title":"UserPostModel","data":{"type":"object","properties":{"full_name":{"description":"Nome completo.","type":"string","example":"Exemplo da Silva"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endereço de e-mail."},"children":[]}]}]}],"type":"string","example":"exemplo@tiquetaque.com"},"external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia (\"\")."},"children":[]}]}]}],"type":"string"},"mobile_phone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de telefone celular com código de área, somente números."},"children":[]}]}]}],"type":"string","example":"11991234567"},"intercom_chat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Habilita o chat intercom para o usuário."},"children":[]}]}]}],"type":"boolean"},"role":{"$ref":"#/components/schemas/RoleModel"},"allowed_sites":{"$ref":"#/components/schemas/AllowedSitesModel"},"permissions":{"$ref":"#/components/schemas/UserPermissionsModel"}}}},"components/schemas/WorkScheduleSummaryModel":{"id":"components/schemas/WorkScheduleSummaryModel","kind":"json-schema","title":"WorkScheduleSummaryModel","data":{"type":"object","properties":{"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da escala, gerado internamente."},"children":[]}]}]}],"type":"string"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equivalente ao nome da escala de trabalho."},"children":[]}]}]}],"type":"string"}}}},"components/schemas/SiteModel":{"id":"components/schemas/SiteModel","kind":"json-schema","title":"SiteModel","data":{"type":"object","properties":{"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do recurso, gerado internamente."},"children":[]}]}]}],"type":"string"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_updated":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_etag":{"$ref":"#/components/schemas/EtagModel"},"name":{"description":"Nome da unidade.","type":"string","example":"Loja Matriz"},"geofence_location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cerca virtual. Ponto lng/lat em conjunto com um raio define uma área onde é permitido o registro de ponto para funcionários vinculados à esta unidade."},"children":[]}]}]}],"type":"object","properties":{"radius_meters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raio em metros onde é permitido o registro de ponto geolocalizado à partir do ponto location."},"children":[]}]}]}],"type":"integer","minimum":30},"location":{"type":"array","items":{"type":"number"},"description":"Ponto inicial no formato Longitude, Latitude usado para definir o local da Unidade.","example":[-23.550513,-46.633309]}}},"timezone":{"$ref":"#/components/schemas/TimezoneModel"},"employees":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de IDs de funcionários. Vincula os funcionários à esta unidade para todos efeitos."},"children":[]}]}]}],"example":["5f5bc225b511a6edec2891f7","0c5bc225b511a6edec289199"]}}}},"components/schemas/PaymentSourceModel":{"id":"components/schemas/PaymentSourceModel","kind":"json-schema","title":"PaymentSourceModel","data":{"type":"object","properties":{"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do recurso, gerado internamente."},"children":[]}]}]}],"type":"string","example":"5f5bc225b511a6edec2891f7"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_updated":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_etag":{"$ref":"#/components/schemas/EtagModel"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Razão social do empregador."},"children":[]}]}]}],"example":"TIQUETAQUE SERVICOS DE TECNOLOGIA S.A."},"cpf":{"type":"string","pattern":"^\\d{11}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPF do empregador. Apenas números, sem máscara. Necessário que exista ou este campo ou o campo CNPJ mutuamente exclusivos."},"children":[]}]}]}],"example":"01234567890"},"cnpj":{"type":"string","pattern":"^[0-9A-Z]{12}\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNPJ do empregador, sem máscara. Aceita tanto o formato numérico tradicional quanto o alfanumérico (12 caracteres alfanuméricos maiúsculos seguidos de 2 dígitos verificadores). Necessário que exista ou este campo ou o campo CPF mutuamente exclusivos."},"children":[]}]}]}],"example":"23467093000164"},"external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia (\"\")."},"children":[]}]}]}],"type":"string"},"period_cut_day":{"type":"integer","maximum":31,"minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de corte dos espelhos para este empregador. Depois de criado o documento, não é permitida a alteração deste valor através desta API."},"children":[]}]}]}]},"address":{"type":"object","properties":{"cep":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CEP do endereço deste empregador. Apenas números."},"children":[]}]}]}],"example":"90240111"},"street_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logradouro do endereço."},"children":[]}]}]}],"example":"RUA FREDERICO MENTZ"},"street_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do endereço."},"children":[]}]}]}],"example":"1606"},"complement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complemento do endereço, caso exista."},"children":[]}]}]}],"example":"LOJA 134 E 135"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UF do endereço."},"children":[]}]}]}],"example":"RS"},"city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade do endereço do empregador."},"children":[]}]}]}],"example":"Porto Alegre"}}}}}},"components/schemas/PatchPaymentSourceModel":{"id":"components/schemas/PatchPaymentSourceModel","kind":"json-schema","title":"PatchPaymentSourceModel","data":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Razão social do empregador."},"children":[]}]}]}]},"cpf":{"type":"string","pattern":"^\\d{11}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPF do empregador, apenas números. Necessário que exista ou este campo ou o campo CNPJ mutuamente exclusivos."},"children":[]}]}]}]},"cnpj":{"type":"string","pattern":"^[0-9A-Z]{12}\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNPJ do empregador, sem máscara. Aceita o formato numérico tradicional ou o alfanumérico (12 caracteres alfanuméricos maiúsculos seguidos de 2 dígitos verificadores). Necessário que exista ou este campo ou o campo CPF mutuamente exclusivos."},"children":[]}]}]}]},"external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia (\"\")."},"children":[]}]}]}],"type":"string"},"address":{"type":"object","properties":{"cep":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CEP do endereço deste empregador. Apenas números."},"children":[]}]}]}],"example":"01307002"},"street_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logradouro do endereço."},"children":[]}]}]}]},"street_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do endereço."},"children":[]}]}]}]},"complement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complemento do endereço, caso exista."},"children":[]}]}]}]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UF do endereço."},"children":[]}]}]}],"example":"SC"},"city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade do endereço do empregador."},"children":[]}]}]}],"example":"São Paulo"}}}}}},"components/schemas/TimesheetModel":{"id":"components/schemas/TimesheetModel","kind":"json-schema","title":"Espelho único","data":{"title":"Espelho único","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Espelho de um único funcionário (quando employee_id ou employee_external_id é informado)."},"children":[]}]}]}],"type":"object","properties":{"employee_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário."},"children":[]}]}]}],"type":"string","example":"5f5bc225b511a6e44c2891f6"},"employee_external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID externo do funcionário. Presente apenas se o funcionário possuir ID externo cadastrado."},"children":[]}]}]}],"type":"string"},"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Período do espelho de ponto solicitado."},"children":[]}]}]}],"type":"object","properties":{"start_date":{"description":"Data inicial do espelho.","type":"string","format":"date"},"end_date":{"description":"Data final do espelho.","type":"string","format":"date"}}},"totals":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Totais de cada rubrica dentro do período do espelho de ponto."},"children":[]}]}]}],"type":"object","properties":{"horas_normais":{"type":"string","example":"6.00"},"banco_horas":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saldo de banco de horas. Presente apenas quando o período solicitado corresponde a uma folha de ponto completa; não é calculado para períodos parciais."},"children":[]}]}]}],"type":"string","example":"123.00"},"falta_injustificada":{"type":"string","example":"36.00"},"falta_justificada":{"type":"string","example":"12.00"},"abono":{"type":"string","example":"4.00"},"folga":{"type":"string","example":"1.00"},"atraso":{"type":"string","example":"22.13"},"dsr":{"type":"string","example":"8.00"},"desconto_dsr":{"type":"string","example":"16.00"},"inss":{"type":"string","example":"40.00"},"atestado":{"type":"string","example":"1.00"},"dispensa_legal":{"type":"string","example":"2.00"},"adicional_noturno":{"type":"string","example":"1.20"},"extra_50":{"type":"string","example":"1.00"},"extra_75":{"type":"string","example":"2.00"},"extra_100":{"type":"string","example":"3.00"},"extra_200":{"type":"string","example":"4.00"},"adicional_noturno_extra_50":{"type":"string","example":"2.13"},"adicional_noturno_extra_75":{"type":"string","example":"1.12"},"adicional_noturno_extra_100":{"type":"string","example":"1.00"},"adicional_noturno_extra_200":{"type":"string","example":"2.89"},"hora_noturna_reduzida":{"type":"string","example":"2.30"},"afastamento_nao_remunerado":{"type":"string","example":"2.50"},"sobreaviso":{"type":"string","example":"5.55"},"suspensao":{"type":"string","example":"6.77"},"ferias":{"type":"string","example":"3.69"}}},"days":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detalhes de cada um dos dias da folha de ponto, contendo os horários de batidas e rubricas parciais dos dias."},"children":[]}]}]}],"properties":{"horarios":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Horários de registro de ponto válidos no formato \"HH:MM\"."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["08:12","18:00"]},"horas_normais":{"type":"string","example":"6.00"},"banco_horas":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saldo de banco de horas. Presente apenas quando o período solicitado corresponde a uma folha de ponto completa; não é calculado para períodos parciais."},"children":[]}]}]}],"type":"string","example":"123.00"},"falta_injustificada":{"type":"string","example":"36.00"},"falta_justificada":{"type":"string","example":"12.00"},"abono":{"type":"string","example":"4.00"},"folga":{"type":"string","example":"1.00"},"atraso":{"type":"string","example":"22.13"},"dsr":{"type":"string","example":"8.00"},"desconto_dsr":{"type":"string","example":"16.00"},"inss":{"type":"string","example":"40.00"},"atestado":{"type":"string","example":"1.00"},"dispensa_legal":{"type":"string","example":"2.00"},"adicional_noturno":{"type":"string","example":"1.20"},"extra_50":{"type":"string","example":"1.00"},"extra_75":{"type":"string","example":"2.00"},"extra_100":{"type":"string","example":"3.00"},"extra_200":{"type":"string","example":"4.00"},"adicional_noturno_extra_50":{"type":"string","example":"2.13"},"adicional_noturno_extra_75":{"type":"string","example":"1.12"},"adicional_noturno_extra_100":{"type":"string","example":"1.00"},"adicional_noturno_extra_200":{"type":"string","example":"2.89"},"hora_noturna_reduzida":{"type":"string","example":"2.30"},"afastamento_nao_remunerado":{"type":"string","example":"2.50"},"sobreaviso":{"type":"string","example":"5.55"},"suspensao":{"type":"string","example":"6.77"},"ferias":{"type":"string","example":"3.69"}}},"hours_bank_summary":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resumo de banco de horas do período. Presente apenas se o período solicitado corresponder a uma folha de ponto completa, do início ao fim. Não é retornado para períodos parciais."},"children":[]}]}]}],"properties":{"previous_balance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saldo anterior de banco de horas gerado até o início deste período."},"children":[]}]}]}],"type":"string","example":"-9.17"},"generated_balance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saldo de banco de horas gerado dentro deste período pelos registros."},"children":[]}]}]}],"type":"string","example":"1.00"},"created_balance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saldo de banco de horas adicionado manualmente dentro deste período."},"children":[]}]}]}],"type":"string","example":"3.00"},"final_balance":{"description":"Saldo final de banco de horas.","type":"string","example":"-5.17"},"period":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo de banco de horas configurado, podendo ser "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aberto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" onde existe apenas start_date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cíclico"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", que se renova automaticamente após a quantidade de meses configurada, ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", contendo start_date e end_date fixos."},"children":[]}]}]}],"enum":["fixed","open","cyclic"],"type":"string","example":"open"},"start_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de início do período de banco de horas ativo."},"children":[]}]}]}],"type":"string","example":"2021-03-10"},"end_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de fim do período de banco de horas ativo."},"children":[]}]}]}],"type":"string","example":"2021-06-09"}}}}}}}},"components/schemas/EmployeeModel":{"id":"components/schemas/EmployeeModel","kind":"json-schema","title":"EmployeeModel","data":{"type":"object","properties":{"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do recurso, gerado internamente."},"children":[]}]}]}],"type":"string"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_updated":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_etag":{"$ref":"#/components/schemas/EtagModel"},"external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia (\"\")."},"children":[]}]}]}],"type":"string"},"full_name":{"description":"Nome completo.","type":"string"},"cpf":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPF do funcionário, somente números. Exclusivo com CNPJ."},"children":[]}]}]}],"type":"string","pattern":"^\\d{11}$","example":"01234567890"},"cnpj":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNPJ em caso de prestador de serviço autônomo. Exclusivo com CPF."},"children":[]}]}]}],"type":"string","pattern":"^\\d{14}$","example":"41443245000170"},"nis":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código NIS/PIS do funcionário, somente números."},"children":[]}]}]}],"type":"string","pattern":"^\\d{11}$","example":"12345678901"},"mobile_phone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de telefone celular com código de área, somente números."},"children":[]}]}]}],"type":"string","example":"11991234567"},"work_schedule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID da escala de trabalho. Não pode ser removido. Referência para work-schedules."},"children":[]}]}]}],"type":"string","pattern":"^[0-9a-fA-F]{24}$","nullable":false,"example":"5ebee54eee1767f30129e61c"},"phone_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de país para telefone celular."},"children":[]}]}]}],"type":"string","example":"55","default":"55"},"email":{"type":"string","pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$","example":"exemplo@tiquetaque.com"},"birth_date":{"type":"string","description":"Data de nascimento.","format":"date"},"city":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade de alocação do funcionário para fins de feriados utilizados na contabilização de horas."},"children":[]}]}]}],"type":"string","example":"São Paulo"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estado da cidade de alocação."},"children":[]}]}]}],"type":"string","example":"SP"},"timezone":{"$ref":"#/components/schemas/TimezoneModel"},"send_app_link":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enviar por e-mail, no momento da criação, as instruções de uso do app mobile para o funcionário."},"children":[]}]}]}],"type":"boolean","default":false},"contract_data":{"type":"object","properties":{"registration_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de matrícula."},"children":[]}]}]}],"type":"string"},"payment_source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do empregador deste funcionário. Não pode ser removido. Referência para payment-sources."},"children":[]}]}]}],"type":"string","pattern":"^[0-9a-fA-F]{24}$","nullable":false,"example":"5ebee54eee1767f30129e61c"},"manager":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do gestor deste funcionário. Referência externa para qualquer documento de usuário /users."},"children":[]}]}]}],"type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"5f5bc225b511a6edec2891f7"},"admission_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de admissão."},"children":[]}]}]}],"format":"date","type":"string"},"dismissal_date":{"description":"Data de desligamento.","format":"date","type":"string"},"records_start_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de início dos registros."},"children":[]}]}]}],"format":"date","type":"string"},"hour_rate_cents":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor hora em centavos utilizado para cálculos de valor de horas extras."},"children":[]}]}]}],"type":"integer","minimum":1},"department":{"type":"string","description":"Departamento"},"job_role":{"type":"string","description":"Cargo"},"allow_electronic_signature":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite que o funcionário realize a assinatura eletrônica do espelho de ponto."},"children":[]}]}]}],"default":true,"type":"boolean"},"app_auto_approve":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados via app."},"children":[]}]}]}],"type":"boolean","default":false},"web_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados via web."},"children":[]}]}]}],"default":false},"qrcode_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados com QR Code."},"children":[]}]}]}],"default":false},"face_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados com reconhecimento facial."},"children":[]}]}]}],"default":false},"geo_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados que contenham geolocalização."},"children":[]}]}]}],"default":false},"manual_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de ajustes de ponto manuais."},"children":[]}]}]}],"default":false},"work_leave_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática para criação de afastamentos."},"children":[]}]}]}],"default":false},"offline_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática para registros off-line via app."},"children":[]}]}]}],"default":false},"requires_geotag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Faz com que seja necessário o envio de dados de geolocalização para o registro de ponto."},"children":[]}]}]}],"default":false},"requires_web_photo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Faz com que seja necessário o envio de foto para o registro de ponto."},"children":[]}]}]}],"default":false},"enabled_geofence":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Habilita a verificação de perímetros para o registro de ponto."},"children":[]}]}]}],"default":false},"requires_justification":{"type":"boolean","description":"Obriga o preenchimento de uma justificativa para ajustes manuais.","default":false},"requires_work_leave_justification":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obriga o preenchimento de uma justificativa para a criação de afasfamentos."},"children":[]}]}]}],"default":false},"allow_web_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto via web."},"children":[]}]}]}],"default":false},"allow_face_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto através de reconhecimento facial."},"children":[]}]}]}],"default":false},"allow_manual_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de ajustes manuais pelo funcionário."},"children":[]}]}]}],"default":false},"allow_offline_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto off-line."},"children":[]}]}]}],"default":false},"allow_work_leave_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a criação de registros de afastamento exceto férias pelo funcionário."},"children":[]}]}]}],"default":false},"allow_vacation_work_leave_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a criação de registros de afastamento do tipo férias pelo funcionário."},"children":[]}]}]}],"default":false},"allow_app_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto via app."},"children":[]}]}]}],"default":false},"allow_qrcode_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto via TiQR Code."},"children":[]}]}]}],"default":false},"allow_external_api_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto para o funcionário através desta API."},"children":[]}]}]}],"default":true},"allow_face_store":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite que o funcionário cadastre o rosto para reconhecimento facial através do seu app."},"children":[]}]}]}],"default":false},"allow_access_app":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite acesso ao aplicativo de funcionários."},"children":[]}]}]}],"default":false},"allow_access_web":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite acesso web ao funcionário."},"children":[]}]}]}],"default":false}}}}}},"components/schemas/PostEmployeeModel":{"id":"components/schemas/PostEmployeeModel","kind":"json-schema","title":"PostEmployeeModel","data":{"type":"object","required":["full_name","city","state"],"properties":{"external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia (\"\")."},"children":[]}]}]}],"type":"string"},"full_name":{"description":"Nome completo.","type":"string"},"cpf":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPF do funcionário, somente números. Exclusivo com CNPJ."},"children":[]}]}]}],"type":"string","pattern":"^\\d{11}$","example":"01234567890"},"cnpj":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNPJ em caso de prestador de serviço autônomo. Exclusivo com CPF."},"children":[]}]}]}],"type":"string","pattern":"^\\d{14}$","example":"41443245000170"},"nis":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código NIS/PIS do funcionário, somente números."},"children":[]}]}]}],"type":"string","pattern":"^\\d{11}$","example":"12345678901"},"mobile_phone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de telefone celular com código de área, somente números."},"children":[]}]}]}],"type":"string","example":"11991234567"},"work_schedule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID da escala de trabalho. Não pode ser removido. Referência para work-schedules."},"children":[]}]}]}],"type":"string","pattern":"^[0-9a-fA-F]{24}$","nullable":false,"example":"5ebee54eee1767f30129e61c"},"phone_country_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de país para telefone celular."},"children":[]}]}]}],"type":"string","example":"55","default":"55"},"email":{"type":"string","pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$","example":"exemplo@tiquetaque.com"},"birth_date":{"type":"string","description":"Data de nascimento.","format":"date"},"city":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade de alocação do funcionário para fins de feriados utilizados na contabilização de horas."},"children":[]}]}]}],"type":"string","example":"São Paulo"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estado da cidade de alocação."},"children":[]}]}]}],"type":"string","example":"SP"},"timezone":{"$ref":"#/components/schemas/TimezoneModel"},"send_app_link":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enviar por e-mail, no momento da criação, as instruções de uso do app mobile para o funcionário."},"children":[]}]}]}],"type":"boolean","default":false},"contract_data":{"type":"object","properties":{"payment_source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do empregador deste funcionário. Não pode ser removido. Referência para payment-sources."},"children":[]}]}]}],"type":"string","pattern":"^[0-9a-fA-F]{24}$","nullable":false,"example":"5ebee54eee1767f30129e61c"},"manager":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do gestor deste funcionário. Referência externa para qualquer documento de usuário /users."},"children":[]}]}]}],"type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"5f5bc225b511a6edec2891f7"},"registration_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de matrícula."},"children":[]}]}]}],"type":"string"},"admission_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de admissão."},"children":[]}]}]}],"format":"date","type":"string"},"dismissal_date":{"description":"Data de desligamento.","format":"date","type":"string"},"records_start_date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de início dos registros"},"children":[]}]}]}],"format":"date","type":"string"},"hour_rate_cents":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor hora em centavos utilizado para cálculos de valor de horas extras."},"children":[]}]}]}],"type":"integer"},"department":{"type":"string","description":"Departamento"},"job_role":{"type":"string","description":"Cargo"},"allow_electronic_signature":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite que o funcionário realize a assinatura eletrônica do espelho de ponto."},"children":[]}]}]}],"default":true,"type":"boolean"},"app_auto_approve":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados via app."},"children":[]}]}]}],"type":"boolean","default":false},"web_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados via web."},"children":[]}]}]}],"default":false},"qrcode_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados com QR Code."},"children":[]}]}]}],"default":false},"face_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados com reconhecimento facial."},"children":[]}]}]}],"default":false},"geo_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de registros realizados que contenham geolocalização."},"children":[]}]}]}],"default":false},"manual_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática de ajustes de ponto manuais."},"children":[]}]}]}],"default":false},"work_leave_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática para criação de afastamentos."},"children":[]}]}]}],"default":false},"offline_auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configura aprovação automática para registros off-line via app."},"children":[]}]}]}],"default":false},"requires_geotag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Faz com que seja necessário o envio de dados de geolocalização para o registro de ponto."},"children":[]}]}]}],"default":false},"requires_web_photo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Faz com que seja necessário o envio de foto para o registro de ponto."},"children":[]}]}]}],"default":false},"enabled_geofence":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Habilita a verificação de perímetros para o registro de ponto."},"children":[]}]}]}],"default":false},"requires_justification":{"type":"boolean","description":"Obriga o preenchimento de uma justificativa para ajustes manuais.","default":false},"requires_work_leave_justification":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obriga o preenchimento de uma justificativa para a criação de afasfamentos."},"children":[]}]}]}],"default":false},"allow_web_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto via web."},"children":[]}]}]}],"default":false},"allow_face_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto através de reconhecimento facial."},"children":[]}]}]}],"default":false},"allow_manual_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de ajustes manuais pelo funcionário."},"children":[]}]}]}],"default":false},"allow_offline_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto off-line."},"children":[]}]}]}],"default":false},"allow_work_leave_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a criação de registros de afastamento exceto férias pelo funcionário."},"children":[]}]}]}],"default":false},"allow_vacation_work_leave_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a criação de registros de afastamento do tipo férias pelo funcionário."},"children":[]}]}]}],"default":false},"allow_app_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto via app."},"children":[]}]}]}],"default":false},"allow_qrcode_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto via TiQR Code."},"children":[]}]}]}],"default":false},"allow_external_api_record":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite a realização de registros de ponto para o funcionário através desta API."},"children":[]}]}]}],"default":true},"allow_face_store":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite que o funcionário cadastre o rosto para reconhecimento facial através do seu app."},"children":[]}]}]}],"default":false},"allow_access_app":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite acesso ao aplicativo de funcionários."},"children":[]}]}]}],"default":false},"allow_access_web":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite acesso web ao funcionário."},"children":[]}]}]}],"default":false}}}}}},"components/schemas/ErroRespostaModel":{"id":"components/schemas/ErroRespostaModel","kind":"json-schema","title":"ErroRespostaModel","data":{"description":"Resposta de erro","type":"object","properties":{"_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de erro interno."},"children":[]}]}]}],"type":"integer"},"_status":{"type":"string","example":"ERR"},"_error":{"type":"object","properties":{"code":{"description":"Codigo de erro HTTP.","type":"integer"},"message":{"description":"Mensagem de erro interna.","type":"string"},"ui_message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mensagem de erro para o usuário."},"children":[]}]}]}],"type":"string"}}}}}},"components/schemas/ErroLoteRespostaModel":{"id":"components/schemas/ErroLoteRespostaModel","kind":"json-schema","title":"ErroLoteRespostaModel","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resposta de erro de uma requisição em lote. Além dos campos da resposta de erro padrão, traz o campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_issues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com os erros de cada item que falhou."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ErroRespostaModel"},{"type":"object","properties":{"_issues":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erros de validação por item. Cada chave é a posição (índice, iniciando em 0) do item na lista enviada e apenas os itens com erro estão presentes. O valor é um objeto com os erros do item, indexados pelo campo a que se referem, seguindo a estrutura do corpo enviado (erros de campos aninhados, como os de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contract_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", vêm aninhados). Erros que não pertencem a um campo, como um item que não é um objeto, são indexados por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":{"type":"object","additionalProperties":true},"example":{"1":{"full_name":"Campo obrigatório.","state":"Campo com valor inválido."},"2":{"contract_data":{"records_start_date":"Campo obrigatório."}}}}}}]}},"components/schemas/AfastamentoModel":{"id":"components/schemas/AfastamentoModel","kind":"json-schema","title":"AfastamentoModel","data":{"type":"object","properties":{"_id":{"description":"ID do afastamento","type":"string"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_updated":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_etag":{"$ref":"#/components/schemas/EtagModel"},"employee_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário"},"children":[]}]}]}],"type":"string"},"type":{"$ref":"#/components/schemas/TipoAfastamentoModel"},"end_date":{"type":"string","format":"date"},"start_date":{"type":"string","format":"date"},"approval_info":{"type":"object","properties":{"approved":{"type":"boolean","description":"Indica se o afastamento foi aprovado."},"request_date":{"type":"string","description":"Data em que o afastamento foi solicitado.","example":"2020-05-05T08:28:14+00:00"},"change_request":{"type":"object","properties":{"approved_date":{"type":"string","description":"Data em que o afastamento foi aprovado, caso tenha sido.","example":"2020-05-05T08:28:14+00:00"},"rejected_date":{"type":"string","description":"Data em que o afastamento foi rejeitado, caso tenha sido.","example":"2020-05-05T08:28:14+00:00"},"rejected_by":{"type":"object","description":"Dados existentes apenas quando o afastamento foi rejeitado.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do usuário que rejeitou o afastamento."},"children":[]}]}]}]},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome do funcionário que rejeitou o afastamento."},"children":[]}]}]}],"type":"string"}}},"approved_by":{"type":"object","description":"Dados existentes apenas quando o afastamento foi aprovado.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do usuário que aprovou o afastamento."},"children":[]}]}]}]},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome do funcionário que aprovou o afastamento."},"children":[]}]}]}],"type":"string"}}}}}}}}}},"components/schemas/LinksModel":{"id":"components/schemas/LinksModel","kind":"json-schema","title":"LinksModel","data":{"type":"object","properties":{"parent":{"type":"object","properties":{"href":{"type":"string"},"title":{"type":"string"}}},"self":{"type":"object","properties":{"href":{"type":"string"},"title":{"type":"string"}}}}}},"components/schemas/MetaModel":{"id":"components/schemas/MetaModel","kind":"json-schema","title":"MetaModel","data":{"type":"object","properties":{"max_results":{"type":"integer"},"page":{"type":"integer"},"total":{"type":"integer"}}}},"components/schemas/TipoAfastamentoModel":{"id":"components/schemas/TipoAfastamentoModel","kind":"json-schema","title":"TipoAfastamentoModel","data":{"type":"string","enum":["abono","afastamento","atestado","dispensa_legal","falta_justificada","falta_injustificada","ferias","folga","inss","suspensao"]}},"components/schemas/StatusAfastamentoModel":{"id":"components/schemas/StatusAfastamentoModel","kind":"json-schema","title":"StatusAfastamentoModel","data":{"type":"string","enum":["aprovado","pendente","reprovado"]}},"components/schemas/DateParamModel":{"id":"components/schemas/DateParamModel","kind":"json-schema","title":"DateParamModel","data":{"type":"string","format":"date","example":"2023-09-27"}},"components/schemas/TimeParamModel":{"id":"components/schemas/TimeParamModel","kind":"json-schema","title":"TimeParamModel","data":{"type":"string","example":"HH:MM"}},"components/schemas/MaxResultsParamModel":{"id":"components/schemas/MaxResultsParamModel","kind":"json-schema","title":"MaxResultsParamModel","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página dos resultados, valor padrão 25."},"children":[]}]}]}],"default":25}},"components/schemas/PageParamModel":{"id":"components/schemas/PageParamModel","kind":"json-schema","title":"PageParamModel","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados solicitada."},"children":[]}]}]}],"default":1}},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"employee_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}],"type":"string"},"employee_external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID externo do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}],"type":"string"},"type":{"$ref":"#/components/schemas/TipoAfastamentoModel"},"start_date":{"$ref":"#/components/schemas/DateParamModel"},"end_date":{"$ref":"#/components/schemas/DateParamModel"},"start_time":{"$ref":"#/components/schemas/TimeParamModel"},"end_time":{"$ref":"#/components/schemas/TimeParamModel"}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"_id":{"type":"string"},"_status":{"type":"string","example":"OK"},"_created":{"type":"string"}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"string"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DateParamModel"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TipoAfastamentoModel"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"$ref":"#/components/schemas/StatusAfastamentoModel"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"$ref":"#/components/schemas/MaxResultsParamModel"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PageParamModel"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"$ref":"#/components/schemas/AfastamentoModel"}},"_links":{"$ref":"#/components/schemas/LinksModel"},"_meta":{"$ref":"#/components/schemas/MetaModel"}}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleSummaryModel"}},"_links":{"$ref":"#/components/schemas/LinksModel"},"_meta":{"$ref":"#/components/schemas/MetaModel"}}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string","example":"5f3551beeb623e8ebe0ae994"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeModel"}},"_links":{"$ref":"#/components/schemas/LinksModel"},"_meta":{"$ref":"#/components/schemas/MetaModel"}}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","required":["employees"],"properties":{"employees":{"type":"array","minItems":1,"maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de funcionários a criar. Cada item segue o mesmo formato do cadastro individual."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PostEmployeeModel"}}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_etag":{"$ref":"#/components/schemas/EtagModel"},"_status":{"type":"string","example":"OK"}}}}}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","properties":{"employee_id":{"type":"string"},"employee_external_id":{"type":"string"},"time":{"$ref":"#/components/schemas/IsoDateTimeModel"}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","properties":{"_status":{"type":"string","example":"OK"},"employee":{"type":"string","example":"fff5bc225b511a6edec2873ff"},"time":{"$ref":"#/components/schemas/IsoDateTimeModel"}}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","properties":{"_code":{"type":"integer","example":156},"_error":{"type":"object","properties":{"code":{"type":"integer","example":403},"message":{"type":"string","example":"No permission for external records."},"ui_message":{"type":"string","example":"Você não possui permissão para adicionar registros via API."}}},"status":{"type":"string","example":"ERR"}}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"object","properties":{"employee_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}],"type":"string","example":"5f5bc225b511a6e44c2891f6"},"employee_external_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID externo do funcionário. Obrigatório caso "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não esteja presente."},"children":[]}]}]}],"type":"string"},"times":{"description":"Lista de registros de ponto.","type":"array","items":{"type":"object","properties":{"approved":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se o registro está aprovado ou pendente de aprovação para fins de cálculos."},"children":[]}]}]}],"type":"boolean"},"justification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações adicionais do motivo ou origem do registro."},"children":[]}]}]}],"type":"string"},"time":{"type":"string","description":"Data e hora do registro de ponto.","example":"2024-09-30T10:19","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origem do registro, os valores possíveis são "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pré-assinalado, aparelho, web, desconsiderado, app, reconhecimento facial, offline, ajuste manual, registro externo, N/D"},"children":[]}]}]}]}],"enum":["pré-assinalado","aparelho","web","desconsiderado","app","reconhecimento facial","offline","ajuste manual","registro externo","N/D"]},"location":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"longitude e latitude de um registro de ponto com geolocalização."},"children":[]}]}]}],"example":[-32.04910884654619,-54.188595456807924],"items":{"type":"number"}}}}}}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"object","properties":{"_id":{"type":"string"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"_etag":{"$ref":"#/components/schemas/EtagModel"},"_status":{"type":"string","example":"OK"}}},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9A-Z]{12}\\d{2}$","example":"23467093000164"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","pattern":"^\\d{11}$","example":"01234567890"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentSourceModel"}},"_links":{"$ref":"#/components/schemas/LinksModel"},"_meta":{"$ref":"#/components/schemas/MetaModel"}}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/TimesheetModel"},{"title":"Lista paginada","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista paginada de espelhos (quando nenhum filtro de funcionário é informado)."},"children":[]}]}]}],"type":"object","properties":{"_items":{"type":"array","description":"Lista de espelhos de ponto. Cada item possui a mesma estrutura do retorno individual.","items":{"$ref":"#/components/schemas/TimesheetModel"}},"_meta":{"$ref":"#/components/schemas/MetaModel"},"_links":{"$ref":"#/components/schemas/LinksModel"}}}]},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"$ref":"#/components/schemas/SiteModel"}},"_links":{"$ref":"#/components/schemas/LinksModel"},"_meta":{"$ref":"#/components/schemas/MetaModel"}}},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"$ref":"#/components/schemas/UserModel"}},"_links":{"$ref":"#/components/schemas/LinksModel"},"_meta":{"$ref":"#/components/schemas/MetaModel"}}},"id":"schema_49"}},"exampleStore":{"components/examples/401_example":{"id":"components/examples/401_example","value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"}},"components/examples/422_example":{"id":"components/examples/422_example","value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"}},"paths/~1work-leaves/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1work-leaves/post/responses/401/content/application~1json/examples/401"},"paths/~1work-leaves/post/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1work-leaves/post/responses/422/content/application~1json/examples/422"},"paths/~1work-leaves/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"afastamento not found.","ui_message":"afastamento não encontrado."},"_status":"ERR"},"id":"paths/~1work-leaves/get/responses/404/content/application~1json/example"},"paths/~1work-leaves/get/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1work-leaves/get/responses/422/content/application~1json/examples/422"},"paths/~1work-leaves~1{id}~1approve/patch/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1work-leaves~1{id}~1approve/patch/responses/401/content/application~1json/examples/401"},"paths/~1work-leaves~1{id}~1approve/patch/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1work-leaves~1{id}~1approve/patch/responses/412/content/application~1json/example"},"paths/~1work-leaves~1{id}~1approve/patch/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1work-leaves~1{id}~1approve/patch/responses/428/content/application~1json/example"},"paths/~1work-leaves~1{id}~1reject/patch/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1work-leaves~1{id}~1reject/patch/responses/401/content/application~1json/examples/401"},"paths/~1work-leaves~1{id}~1reject/patch/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1work-leaves~1{id}~1reject/patch/responses/412/content/application~1json/example"},"paths/~1work-leaves~1{id}~1reject/patch/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1work-leaves~1{id}~1reject/patch/responses/428/content/application~1json/example"},"paths/~1work-leaves~1{id}/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"resource not found.","ui_message":"afastamento não encontrado."},"_status":"ERR"},"id":"paths/~1work-leaves~1{id}/get/responses/404/content/application~1json/example"},"paths/~1work-leaves~1{id}/delete/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1work-leaves~1{id}/delete/responses/401/content/application~1json/examples/401"},"paths/~1work-leaves~1{id}/delete/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1work-leaves~1{id}/delete/responses/412/content/application~1json/example"},"paths/~1work-leaves~1{id}/delete/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1work-leaves~1{id}/delete/responses/428/content/application~1json/example"},"paths/~1work-schedules~1summary/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1work-schedules~1summary/get/responses/401/content/application~1json/examples/401"},"paths/~1work-schedules~1summary/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"usuário not found.","ui_message":"usuário não encontrado."},"_status":"ERR"},"id":"paths/~1work-schedules~1summary/get/responses/404/content/application~1json/example"},"paths/~1employees/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1employees/post/responses/401/content/application~1json/examples/401"},"paths/~1employees/post/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1employees/post/responses/422/content/application~1json/examples/422"},"paths/~1employees/get/responses/200/content/application~1json/examples/lista_vazia":{"value":{"_items":[],"_links":{"parent":{"href":"/","title":"home"}},"_meta":{"max_results":25,"page":1,"total":0}},"key":"lista_vazia","summary":"Nenhum funcionário encontrado","id":"paths/~1employees/get/responses/200/content/application~1json/examples/lista_vazia"},"paths/~1employees/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1employees/get/responses/401/content/application~1json/examples/401"},"paths/~1employees/get/responses/422/content/application~1json/example":{"value":{"_code":1403,"_error":{"code":422,"message":"Invalid format for payment_source.","ui_message":"payment_source com formato inválido."},"_status":"ERR"},"id":"paths/~1employees/get/responses/422/content/application~1json/example"},"paths/~1employees~1bulk/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1employees~1bulk/post/responses/401/content/application~1json/examples/401"},"paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/tamanho_invalido":{"value":{"_code":1427,"_error":{"code":422,"message":"The 'employees' list must contain between 1 and 100 items.","ui_message":"A lista 'employees' deve conter entre 1 e 100 itens."},"_status":"ERR"},"key":"tamanho_invalido","summary":"Lista vazia ou com mais de 100 itens","id":"paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/tamanho_invalido"},"paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/itens_invalidos":{"value":{"_code":157,"_error":{"code":422,"message":"Errors found for fields: {1: ['Campo full_name obrigatório.', 'Campo state com valor inválido.'], 2: ['Campo birth_date com formato inválido.', 'Campo city não pode ser vazio.', 'Campo records_start_date obrigatório.'], 3: ['Documento com id aaaaaaaaaaaaaaaaaaaaaaaa não encontrado no recurso payment_sources.']}","ui_message":"Os seguintes erros foram encontrados: {1: ['Campo full_name obrigatório.', 'Campo state com valor inválido.'], 2: ['Campo birth_date com formato inválido.', 'Campo city não pode ser vazio.', 'Campo records_start_date obrigatório.'], 3: ['Documento com id aaaaaaaaaaaaaaaaaaaaaaaa não encontrado no recurso payment_sources.']}"},"_status":"ERR","_issues":{"1":{"full_name":"Campo obrigatório.","state":"Campo com valor inválido."},"2":{"birth_date":"Campo com formato inválido.","city":"Campo não pode ser vazio.","contract_data":{"records_start_date":"Campo obrigatório."}},"3":{"contract_data":{"payment_source":"Documento com id aaaaaaaaaaaaaaaaaaaaaaaa não encontrado no recurso payment_sources."}}}},"key":"itens_invalidos","summary":"Itens com erro de validação. No exemplo, o item da posição 0 é válido, o da posição 1 está sem `full_name` e com `state` inválido, o da posição 2 tem `city` vazio, `birth_date` com formato inválido e está sem `contract_data.records_start_date`, e o da posição 3 informa um `contract_data.payment_source` que não existe.\n","id":"paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/itens_invalidos"},"paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/item_nao_objeto":{"value":{"_code":157,"_error":{"code":422,"message":"Errors found for fields: {2: ['Campo employees deve conter objetos.']}","ui_message":"Os seguintes erros foram encontrados: {2: ['Campo employees deve conter objetos.']}"},"_status":"ERR","_issues":{"2":{"employees":"Campo employees deve conter objetos."}}},"key":"item_nao_objeto","summary":"Item da lista que não é um objeto","id":"paths/~1employees~1bulk/post/responses/422/content/application~1json/examples/item_nao_objeto"},"paths/~1employees~1{id}/patch/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1employees~1{id}/patch/responses/401/content/application~1json/examples/401"},"paths/~1employees~1{id}/patch/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1employees~1{id}/patch/responses/412/content/application~1json/example"},"paths/~1employees~1{id}/patch/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1employees~1{id}/patch/responses/428/content/application~1json/example"},"paths/~1employees~1{id}/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"resource not found.","ui_message":"funcionário não encontrado."},"_status":"ERR"},"id":"paths/~1employees~1{id}/get/responses/404/content/application~1json/example"},"paths/~1employees~1{id}/delete/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1employees~1{id}/delete/responses/401/content/application~1json/examples/401"},"paths/~1employees~1{id}/delete/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1employees~1{id}/delete/responses/412/content/application~1json/example"},"paths/~1employees~1{id}/delete/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1employees~1{id}/delete/responses/428/content/application~1json/example"},"paths/~1times/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1times/post/responses/401/content/application~1json/examples/401"},"paths/~1times/post/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"resource not found.","ui_message":"funcionário não encontrado."},"_status":"ERR"},"id":"paths/~1times/post/responses/404/content/application~1json/example"},"paths/~1times/post/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1times/post/responses/422/content/application~1json/examples/422"},"paths/~1times/get/responses/200/content/application~1json/examples/OK":{"value":{"employee_id":"5f5bc225b511a6e44c2891f6","times":[{"approved":true,"justification":"Esqueci de registrar","time":"2024-09-24T07:32","type":"ajuste manual"},{"approved":false,"justification":"Sem rede","time":"2024-09-22T11:59","location":[-32.04910884654619,-54.188595456807924],"type":"offline"},{"approved":true,"time":"2023-09-24T12:00","type":"pré-assinalado"},{"approved":true,"time":"2023-09-24T08:00","type":"aparelho"},{"approved":true,"time":"2023-09-24T18:00","type":"app"},{"approved":true,"justification":"Registro feito via ponto web com geolocalização aprovado automaticamente.","location":[-33.03922962211942,-51.22087741934293],"time":"2023-09-25T13:05","type":"web"},{"approved":true,"justification":"Registro realizado com reconhecimento facial.","time":"2023-09-25T20:51","type":"reconhecimento facial"},{"approved":true,"justification":"Esqueci de registrar","time":"2024-09-26T07:32","type":"ajuste manual"},{"approved":true,"justification":"desconsiderado!","time":"2023-09-26T08:44","type":"desconsiderado"},{"approved":true,"justification":"Registro adicionado via API.","time":"2023-09-27T08:12","type":"registro externo"}]},"key":"OK","summary":"OK","id":"paths/~1times/get/responses/200/content/application~1json/examples/OK"},"paths/~1times/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1times/get/responses/401/content/application~1json/examples/401"},"paths/~1times/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"resource not found.","ui_message":"funcionário não encontrado."},"_status":"ERR"},"id":"paths/~1times/get/responses/404/content/application~1json/example"},"paths/~1times/get/responses/409/content/application~1json/example":{"value":{"_code":128,"_error":{"code":409,"message":"Incomplete employee profile.","ui_message":"Erro, cadastro de funcionário incompleto. Verifique com seu gestor."},"_status":"ERR"},"id":"paths/~1times/get/responses/409/content/application~1json/example"},"paths/~1times/get/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1times/get/responses/422/content/application~1json/examples/422"},"paths/~1payment-sources/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1payment-sources/post/responses/401/content/application~1json/examples/401"},"paths/~1payment-sources/post/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1payment-sources/post/responses/422/content/application~1json/examples/422"},"paths/~1payment-sources/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1payment-sources/get/responses/401/content/application~1json/examples/401"},"paths/~1payment-sources/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"empregador not found.","ui_message":"empregador não encontrado."},"_status":"ERR"},"id":"paths/~1payment-sources/get/responses/404/content/application~1json/example"},"paths/~1payment-sources/get/responses/422/content/application~1json/example":{"value":{"_code":1403,"_error":{"code":422,"message":"Invalid format for cnpj.","ui_message":"cnpj com formato inválido."},"_status":"ERR"},"id":"paths/~1payment-sources/get/responses/422/content/application~1json/example"},"paths/~1payment-sources~1{id}/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1payment-sources~1{id}/get/responses/401/content/application~1json/examples/401"},"paths/~1payment-sources~1{id}/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"empregador not found.","ui_message":"empregador não encontrado."},"_status":"ERR"},"id":"paths/~1payment-sources~1{id}/get/responses/404/content/application~1json/example"},"paths/~1payment-sources~1{id}/patch/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1payment-sources~1{id}/patch/responses/401/content/application~1json/examples/401"},"paths/~1payment-sources~1{id}/patch/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1payment-sources~1{id}/patch/responses/412/content/application~1json/example"},"paths/~1payment-sources~1{id}/patch/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1payment-sources~1{id}/patch/responses/428/content/application~1json/example"},"paths/~1payment-sources~1{id}/delete/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1payment-sources~1{id}/delete/responses/401/content/application~1json/examples/401"},"paths/~1payment-sources~1{id}/delete/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1payment-sources~1{id}/delete/responses/412/content/application~1json/example"},"paths/~1payment-sources~1{id}/delete/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1payment-sources~1{id}/delete/responses/428/content/application~1json/example"},"paths/~1timesheets/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1timesheets/get/responses/401/content/application~1json/examples/401"},"paths/~1timesheets/get/responses/404/content/application~1json/examples/funcionario_nao_encontrado":{"value":{"_code":56,"_error":{"code":404,"message":"funcionário not found.","ui_message":"funcionário não encontrado."},"_status":"ERR"},"key":"funcionario_nao_encontrado","summary":"Funcionário não encontrado.","id":"paths/~1timesheets/get/responses/404/content/application~1json/examples/funcionario_nao_encontrado"},"paths/~1timesheets/get/responses/404/content/application~1json/examples/periodo_sem_espelho":{"value":{"_code":96,"_error":{"code":404,"message":"No timesheet found for selected period.","ui_message":"Não existem espelhos de ponto para o período selecionado."},"_status":"ERR"},"key":"periodo_sem_espelho","summary":"Período sem espelho de ponto para o funcionário.","id":"paths/~1timesheets/get/responses/404/content/application~1json/examples/periodo_sem_espelho"},"paths/~1timesheets/get/responses/409/content/application~1json/example":{"value":{"_code":128,"_error":{"code":409,"message":"Incomplete employee profile.","ui_message":"Erro, cadastro de funcionário incompleto. Verifique com seu gestor."},"_status":"ERR"},"id":"paths/~1timesheets/get/responses/409/content/application~1json/example"},"paths/~1timesheets/get/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1timesheets/get/responses/422/content/application~1json/examples/422"},"paths/~1sites/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1sites/post/responses/401/content/application~1json/examples/401"},"paths/~1sites/post/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1sites/post/responses/422/content/application~1json/examples/422"},"paths/~1sites/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1sites/get/responses/401/content/application~1json/examples/401"},"paths/~1sites/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"unidade not found.","ui_message":"unidade não encontrada."},"_status":"ERR"},"id":"paths/~1sites/get/responses/404/content/application~1json/example"},"paths/~1sites~1{id}/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1sites~1{id}/get/responses/401/content/application~1json/examples/401"},"paths/~1sites~1{id}/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"unidade not found.","ui_message":"unidade não encontrada."},"_status":"ERR"},"id":"paths/~1sites~1{id}/get/responses/404/content/application~1json/example"},"paths/~1sites~1{id}/patch/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1sites~1{id}/patch/responses/401/content/application~1json/examples/401"},"paths/~1sites~1{id}/patch/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1sites~1{id}/patch/responses/412/content/application~1json/example"},"paths/~1sites~1{id}/patch/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1sites~1{id}/patch/responses/428/content/application~1json/example"},"paths/~1sites~1{id}/delete/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1sites~1{id}/delete/responses/401/content/application~1json/examples/401"},"paths/~1sites~1{id}/delete/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1sites~1{id}/delete/responses/428/content/application~1json/example"},"paths/~1users/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1users/post/responses/401/content/application~1json/examples/401"},"paths/~1users/post/responses/422/content/application~1json/examples/422":{"value":{"_code":1300,"_error":{"code":422,"message":"Missing 'p1' query parameter.","ui_message":"Falta o parâmetro 'p1' na requisição."},"_status":"ERR"},"key":"422","summary":"422","id":"paths/~1users/post/responses/422/content/application~1json/examples/422"},"paths/~1users/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1users/get/responses/401/content/application~1json/examples/401"},"paths/~1users/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"usuário not found.","ui_message":"usuário não encontrado."},"_status":"ERR"},"id":"paths/~1users/get/responses/404/content/application~1json/example"},"paths/~1users~1{id}/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1users~1{id}/get/responses/401/content/application~1json/examples/401"},"paths/~1users~1{id}/get/responses/404/content/application~1json/example":{"value":{"_code":56,"_error":{"code":404,"message":"usuário not found.","ui_message":"usuário não encontrado."},"_status":"ERR"},"id":"paths/~1users~1{id}/get/responses/404/content/application~1json/example"},"paths/~1users~1{id}/patch/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1users~1{id}/patch/responses/401/content/application~1json/examples/401"},"paths/~1users~1{id}/patch/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1users~1{id}/patch/responses/412/content/application~1json/example"},"paths/~1users~1{id}/patch/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1users~1{id}/patch/responses/428/content/application~1json/example"},"paths/~1users~1{id}/delete/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1users~1{id}/delete/responses/401/content/application~1json/examples/401"},"paths/~1users~1{id}/delete/responses/412/content/application~1json/example":{"value":{"_code":1352,"_error":{"code":412,"message":"Invalid If-Match header.","ui_message":"Cabeçalho If-Match inválido."},"_status":"ERR"},"id":"paths/~1users~1{id}/delete/responses/412/content/application~1json/example"},"paths/~1users~1{id}/delete/responses/428/content/application~1json/example":{"value":{"_code":1406,"_error":{"code":428,"message":"To edit a document its etag must be provided using the If-Match header.","ui_message":"Erro de versão ao atualizar documento."},"_status":"ERR"},"id":"paths/~1users~1{id}/delete/responses/428/content/application~1json/example"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.tiquetaque.com/v2.1","description":"Production"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"API pública TiqueTaque","description":"<h2>Autenticação</h2>\n  Para todas as requisições é necessária a autenticação com um token gerado a partir da plataforma do gestor, \n  utilizando o token com autenticação <code>BasicAuth</code> sendo <code>user=public</code>, <code>senha=&ltseu_token&gt</code>.  \n  Verifique a seção de integrações do TiqueAdmin para gerar o token.\n<h2>Rate limiting</h2>\n  Requisições são limitadas a 60 requisições por janela deslizante de 1 minuto.\n  Se o limite for excedido, será retornada uma resposta HTTP <code>429 Too Many Requests</code>.<br>\n"}},"baseSlug":"/openapi","routesMapping":{}}