Lista os sindicatos ativos da empresa
/v1/catalogos/sindicatosOs sindicatos são cadastrados pelo escritório no Motor. Use o id em vinculo.sindicato_id. Sindicato sem CNPJ não monta o S-2200 (SINDICATO_SEM_CNPJ) — quem o completa é o escritório.
Cabeçalhos e parâmetros
AuthorizationBearer <chave>cabeçalhoobrigatórioAuthorization: Bearer <chave>. A chave é gerada pelo escritório na ficha da empresa, com um nome, aparece uma vez (o Motor guarda só o resumo SHA-256 dela), e alcança uma empresa e só a admissão. Vale enquanto não for revogada e o escritório que a gerou atender a empresa. A empresa pode ter até duas chaves ativas ao mesmo tempo, para trocar sem parar; o endereço do webhook e o segredo dele são da integração da empresa, não de cada chave — o webhook é opcional, e trocar o endereço gera um segredo novo na hora. Sessão de usuário e token OAuth são recusados nestas rotas.
Respostas
200
Sindicatos ativos.
Campos do corpo (1)
itenslista de objetoobrigatórioCampos de
itens(4)iduuidobrigatórionometextoobrigatóriocnpjtexto ou nullobrigatório14 dígitos
dt_baseinteiro ou nullobrigatórioMês da data-base da categoria.
de 1 a 12
401
CHAVE_INVALIDA — ausente, malformada, desconhecida, credencial que não é chave de integração, ou chave de uma empresa que deixou de ser atendida pelo escritório que a gerou. CHAVE_REVOGADA — a chave foi revogada pelo escritório; vale a partir da chamada seguinte à revogação. Admissão enviada por ela e ainda não transmitida vai para a fila do escritório (aviso admissao.aguardando_escritorio).
Campos do corpo (3)
codigotextoobrigatórioCódigo estável. Conhecidos: IDEMPOTENCY_KEY_INVALIDA, CHAVE_INVALIDA, CHAVE_REVOGADA, CHAVE_SEM_ESCOPO, EMPRESA_NAO_HABILITADA, CERTIFICADO_INDISPONIVEL, NAO_ENCONTRADA, METODO_NAO_PERMITIDO, TRABALHADOR_JA_ADMITIDO, IDEMPOTENCIA_CONFLITO, IDEMPOTENCIA_EM_CURSO, CORPO_GRANDE_DEMAIS, CAMPO_DESCONHECIDO, DADOS_INVALIDOS, DADOS_FALTANDO, LIMITE_EXCEDIDO, INDISPONIVEL (a lista, com o que fazer em cada um, está em
x-motor-codigos.recusas). Trate código desconhecido como erro que exige olhar humano.mensagemtextoobrigatórioTexto em português para pessoas. Não o use para decidir — use
codigo.camposlista de objetoobrigatórioProblemas campo a campo. Vazio quando o erro não é de um campo.
Campos de
campos(3)campotextoobrigatórioCaminho no corpo, com ponto e índice —
trabalhador.cpf,dependentes.0.cpf.(corpo)quando o JSON não pôde ser lido.codigotextoobrigatórioCódigo do campo; a lista completa, com quem corrige cada um, está em
x-motor-codigos.campos. Quem corrige depende do código: os de jornada e sindicato são do cadastro do escritório, não do pedido.mensagemtextoobrigatório
429
LIMITE_EXCEDIDO — mais de 60 chamadas por minuto com esta chave. Só isso: a admissão pela API não tem limite próprio no plano do escritório (conta como colaborador ativo, como a da tela). Espere o Retry-After (em segundos).
Retry-AftercabeçalhoSegundos a esperar antes de repetir.
Campos do corpo (3)
codigotextoobrigatórioCódigo estável. Conhecidos: IDEMPOTENCY_KEY_INVALIDA, CHAVE_INVALIDA, CHAVE_REVOGADA, CHAVE_SEM_ESCOPO, EMPRESA_NAO_HABILITADA, CERTIFICADO_INDISPONIVEL, NAO_ENCONTRADA, METODO_NAO_PERMITIDO, TRABALHADOR_JA_ADMITIDO, IDEMPOTENCIA_CONFLITO, IDEMPOTENCIA_EM_CURSO, CORPO_GRANDE_DEMAIS, CAMPO_DESCONHECIDO, DADOS_INVALIDOS, DADOS_FALTANDO, LIMITE_EXCEDIDO, INDISPONIVEL (a lista, com o que fazer em cada um, está em
x-motor-codigos.recusas). Trate código desconhecido como erro que exige olhar humano.mensagemtextoobrigatórioTexto em português para pessoas. Não o use para decidir — use
codigo.camposlista de objetoobrigatórioProblemas campo a campo. Vazio quando o erro não é de um campo.
Campos de
campos(3)campotextoobrigatórioCaminho no corpo, com ponto e índice —
trabalhador.cpf,dependentes.0.cpf.(corpo)quando o JSON não pôde ser lido.codigotextoobrigatórioCódigo do campo; a lista completa, com quem corrige cada um, está em
x-motor-codigos.campos. Quem corrige depende do código: os de jornada e sindicato são do cadastro do escritório, não do pedido.mensagemtextoobrigatório
503
INDISPONIVEL — falha nossa, não do pedido nem da chave. No POST, repita com a MESMA Idempotency-Key, respeitando Retry-After quando vier: não haverá duplicata — se a admissão tiver sido criada, a repetição devolve o 202 dela.
Retry-AftercabeçalhoSegundos a esperar antes de repetir, quando vier.
Campos do corpo (3)
codigotextoobrigatórioCódigo estável. Conhecidos: IDEMPOTENCY_KEY_INVALIDA, CHAVE_INVALIDA, CHAVE_REVOGADA, CHAVE_SEM_ESCOPO, EMPRESA_NAO_HABILITADA, CERTIFICADO_INDISPONIVEL, NAO_ENCONTRADA, METODO_NAO_PERMITIDO, TRABALHADOR_JA_ADMITIDO, IDEMPOTENCIA_CONFLITO, IDEMPOTENCIA_EM_CURSO, CORPO_GRANDE_DEMAIS, CAMPO_DESCONHECIDO, DADOS_INVALIDOS, DADOS_FALTANDO, LIMITE_EXCEDIDO, INDISPONIVEL (a lista, com o que fazer em cada um, está em
x-motor-codigos.recusas). Trate código desconhecido como erro que exige olhar humano.mensagemtextoobrigatórioTexto em português para pessoas. Não o use para decidir — use
codigo.camposlista de objetoobrigatórioProblemas campo a campo. Vazio quando o erro não é de um campo.
Campos de
campos(3)campotextoobrigatórioCaminho no corpo, com ponto e índice —
trabalhador.cpf,dependentes.0.cpf.(corpo)quando o JSON não pôde ser lido.codigotextoobrigatórioCódigo do campo; a lista completa, com quem corrige cada um, está em
x-motor-codigos.campos. Quem corrige depende do código: os de jornada e sindicato são do cadastro do escritório, não do pedido.mensagemtextoobrigatório