front_ponto_eletronico/docs/company/get.yml
2025-04-16 19:48:09 -03:00

90 lines
2.4 KiB
YAML

tags:
- Company
summary: "Obtém os detalhes de uma Company cadastradas."
description: "Retorna os detalhes de uma Companys."
responses:
200:
description: "Detalhes de uma Company cadastradas."
schema:
type: "object"
properties:
name:
type: string
description: Nome da Company
example: "Company entrada"
fantasyName:
type: string
description: Nome fantasia da empresa
example: "Company entrada"
cnpj:
type: number
description: cnpj da empresa
example: "---"
type:
type: string
description: area de atuação da empresa
example: "Alimenticio"
contato:
type: number
description: contato
example: "219876-6543"
email:
type: string
description: email
example: "example@gmail.com"
email_sec:
type: string
description: email secundario
example: "example@gmail.com"
cep:
type: number
description: cep
example: "12345678"
phone_sec:
type: number
description: second phone
example: "2198768654"
phone:
type: number
description: phone
example: "2198763654"
rua:
type: string
description: endereco da empresa
example: "rua exemplo"
numero:
type: string
description: complemento endereço
example: "rua exemplo"
bairro:
type: string
description: bairro da empresa
example: "centro"
complemento:
type: string
description: completo do endereço da empresa
example: "rua A"
estado:
type: string
description: estado onde a empresa se localiza
example: "Rio de Janeiro"
municipio:
type: string
description: municipio onde a empresa se localiza
example: "Rio de Janeiro"
service_instance_id:
type: integer
description: ID da empresa associada
example: 1
404:
description: "Função de serviço não encontrada"
schema:
type: "object"
properties:
error:
type: "string"
example: "Função de serviço não encontrada"