1. Objetivo¶
Este documento define o Data Dictionary oficial da API de Integração da Certificadora, estabelecendo:
- significado semântico dos campos
- domínio de dados
- cardinalidade
- formato e regras de validação
- exemplos de payload
- relacionamento entre entidades
O objetivo é garantir padronização na integração entre certificadoras e a plataforma.
2. Convenções de Dados¶
2.1 Identificadores¶
| Prefixo | Significado |
|---|---|
| id | identificador técnico interno |
| codigo | código de domínio |
| identificador | chave natural |
| numero | número de documento |
2.2 Datas¶
Formato padrão:
Exemplo:
2.3 Identificadores Fiscais¶
| Tipo | Formato |
|---|---|
| CPF | 11 dígitos numéricos |
| CNPJ | 14 dígitos numéricos |
3. Data Dictionary¶
Entidade: Produtor¶
| Campo | Tipo | Formato | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| idProdutor | UUID | uuid | Sim | Identificador interno do produtor | 4f3b1e30-3cdd |
| identificadorReceitaProdutor | STRING | CPF/CNPJ | Sim | CPF ou CNPJ do produtor | 12345678901 |
| nomeProdutor | STRING | texto | Sim | Nome completo do produtor | João Silva |
| STRING | Não | Email do produtor | joao@email.com | ||
| ativo | BOOLEAN | true/false | Sim | Indica se produtor está ativo | true |
Entidade: Propriedade¶
| Campo | Tipo | Formato | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| idPropriedade | UUID | uuid | Sim | Identificador interno da propriedade | 3e2c1a1a |
| codigoEras | INTEGER | int64 | Sim | Código ERAS da propriedade | 123456 |
| codigoExploracao | STRING | texto | Não | Código de exploração pecuária | BOV |
| areaM2 | NUMBER | double | Não | Área da propriedade em metros quadrados | 350000 |
| certificada | BOOLEAN | true/false | Sim | Indica certificação ativa | true |
| acessoAFazenda | STRING | texto | Não | Descrição de acesso à fazenda | Estrada vicinal km 10 |
Entidade: Animal¶
| Campo | Tipo | Formato | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| idAnimal | UUID | uuid | Sim | Identificador do animal | 3fdd1b0c |
| codigoRaca | STRING | domínio | Sim | Código da raça | ANG |
| dataNascimento | DATE | yyyy-MM-dd | Sim | Data de nascimento do animal | 2022-03-10 |
| dataMorte | DATE | yyyy-MM-dd | Não | Data da morte do animal | 2024-01-10 |
| statusAnimal | STRING | domínio | Sim | Status do animal | ATIVO |
Entidade: Movimentação Animal¶
| Campo | Tipo | Formato | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| dataMovimentacao | DATE | yyyy-MM-dd | Sim | Data da movimentação | 2023-10-10 |
| ERASPropriedadeOrigem | INTEGER | int64 | Sim | Código ERAS origem | 100234 |
| ERASPropriedadeDestino | INTEGER | int64 | Sim | Código ERAS destino | 100987 |
Entidade: GTA¶
| Campo | Tipo | Formato | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| numeroCompleto | STRING | texto | Sim | Número completo da GTA | 352023000123 |
| dataEmissao | DATE | yyyy-MM-dd | Sim | Data de emissão | 2023-09-10 |
| fileName | STRING | texto | Não | Nome do arquivo da GTA | gta_123.pdf |
4. Exemplos de Payload¶
4.1 Buscar Animais¶
Request¶
Query Params
Response¶
{
"currentPage": 0,
"totalPages": 2,
"animais": [
{
"idAnimal": "3fdd1b0c-23c2-41d8",
"codigoRaca": "ANG",
"dataNascimento": "2022-03-10",
"statusAnimal": "ATIVO",
"propriedade": {
"codigoEras": 123456
}
}
]
}
4.2 Registrar morte de animal¶
Request¶
Exemplo:
Response¶
4.3 Upload de GTA¶
Request¶
Exemplo:
Response¶
5. Domínios de Referência¶
Domínios controlados podem ser consultados via:
GET /integracao/util/dominio/listDominio/{dominio}
GET /integracao/util/municipio/list
GET /integracao/util/raca/list
Campos que usam domínio:
6. Autenticação¶
Autenticação via API Keys
Headers obrigatórios:
Endpoint de autenticação:
7. Paginação de Consultas¶
Endpoints de listagem utilizam padrão:
| Campo | Descrição |
|---|---|
| currentPage | página atual |
| pageSize | quantidade por página |
8. Boas Práticas de Integração¶
- Sempre utilizar paginação em endpoints de listagem.
- Utilizar domínios de referência para evitar valores inválidos.
- Respeitar formato de datas ISO-8601.
- Utilizar identificador técnico (UUID) para operações de atualização.
Dicionário de Dados¶
Glossário Completo de Variáveis¶
| Campo | Entidade | Descrição | Tipo | Formato | Endpoints |
|---|---|---|---|---|---|
| identificadorReceitaProdutor | Produtor | CPF ou CNPJ do produtor | string | 11 ou 14 dígitos | PUT /integracao/propriedade/... |
| idProdutor | Produtor | Identificador interno do produtor | string | uuid | GET /integracao/produtor/... |
| codigoEras | Propriedade | Código ERAS da propriedade | integer | int64 | GET /integracao/propriedade/... |
| idAnimal | Animal | Identificador único do animal | string | uuid | GET /integracao/animal/... |
| dataNascimento | Animal | Data de nascimento do animal | string | yyyy-MM-dd | GET /integracao/animal/... |
| dataMovimentacao | Movimentacao | Data da movimentação do animal | string | yyyy-MM-dd | GET /integracao/movimentacao/... |
| numeroCompleto | GTA | Número completo da GTA | string | texto | PUT /integracao/gta/... |
| ERASPropriedadeDestino | Propriedade | ERAS da propriedade de destino | string,integer | int64 | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| ERASPropriedadeLocalizacao | Propriedade | Código ERAS da propriedade de localização ERAS da propriedade de localização | string | GET /integracao/animal/count; GET /integracao/animal/list | |
| ERASPropriedadeNascimento | Propriedade | ERAS da propriedade de nascimento Código ERAS da propriedade de nascimento | string | GET /integracao/animal/count; GET /integracao/animal/list | |
| ERASPropriedadeOrigem | Propriedade | ERAS da propriedade de origem | string,integer | int64 | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| ERASPropriedadeResponsavel | Propriedade | Código ERAS da propriedade responsável ERAS da propriedade responsável | string | GET /integracao/animal/count; GET /integracao/animal/list | |
| UFInscricaoEstadual | GTA | Unidade Federativa da Inscrição Estadual do produtor (opcional) UF da inscrição estadual (opcional) | string | PUT /integracao/propriedade/{codigoEras}/vincularProdutorPorCodigoEras/{identificadorReceitaProdutor}; PUT /integracao/propriedade/{id}/vincularProdutor/{idProdutor} | |
| X-ACCESS-KEY | GTA | Chave de acesso do usuário | string | POST /integracao/auth/system | |
| X-SECRET-KEY | GTA | Chave secreta do usuário | string | POST /integracao/auth/system | |
| acessoAFazenda | GTA | Descrição de como chegar à Propriedade | string | ||
| alias | GTA | string | |||
| animais | GTA | array | |||
| ano | GTA | integer | int32 | GET /integracao/animal/countAnimaisStatus/{statusAnimal}; GET /integracao/animal/listaAnimaisStatus/{statusAnimal} | |
| apiChangeLog | GTA | string | |||
| appChangeLog | GTA | string | |||
| aprovada | GTA | boolean | |||
| areaM2 | GTA | Identificador da Área ao qual esta Propriedade está vinculada | string,number | double | |
| ativo | GTA | Propriedade ativa Habilita/desabilita usuário no sistema. | boolean,string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| bairro | GTA | Bairro da propriedade Bairro do endereço Identificador do Bairro ao qual este Endereço está vinculado Bairro do proprietário | string | GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integracao/propriedade/count; GET /integracao/propriedade/list; GET /integracao/proprietario/count; GET /integracao/proprietario/lis | |
| bairroCorrespondencia | GTA | Bairro de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| car | GTA | string | |||
| cep | GTA | CEP da propriedade CEP do endereço Identificador de CEP ao qual este Endereço está vinculado CEP do proprietário | string | GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integracao/propriedade/count; GET /integracao/propriedade/list; GET /integracao/proprietario/count; GET /integracao/proprietario/lis | |
| cepCorrespondencia | GTA | CEP de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| certificada | GTA | Propriedade certificada | boolean,string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| certificadora | GTA | Identificador da Certificadora ao qual esta Propriedade está vinculada Identificador da Certificadora ao qual este Ato de Verificação está vinculado | object | ||
| classificacao | GTA | Eventual classificação que o registro possa ter | string | ||
| cnpj | Produtor | CNPJ da certificadora (com ou sem formatação) CNPJ (sem pontuação) Identificador do CNPJ ao qual esta Certificadora está vinculada | |||
| @Column(unique = true, nullable = false),length = 14 | string | GET /integracao/certificadora/byCnpj/{cnpj}; GET /integracao/frigorifico/byCnpj/{cnpj} | |||
| cnpjCertificadora | Produtor | CNPJ da certificadora (chave natural) | string | PUT /integracao/produtor/{identificadorReceitaProdutor}/encerrarCertificadoraPorIdentificadores/{cnpjCertificadora}; PUT /integracao/produtor/{identificadorReceitaProdutor}/vincularCertificadoraPorIde | |
| cnpj_frigorifico | Produtor | string | |||
| codMunicipio | GTA | Código do Município ao qual este Endereço está vinculado | string | ||
| codigo | GTA | Código IBGE do município Identificador do Código ao qual esta Raça está vinculada Código da raça a ser buscada Identificador do Código do Munício ao qual este Município está vinculado Identificador do | string,integer | int64 | GET /integracao/numeracao/byCodigoSolicitacao/{codigo}; GET /integracao/util/dominio/getByCodigo/{dominio}/{codigo}; GET /integracao/util/municipio/getByCodigo/{codigo}; GET /integracao/util/raca/getB |
| codigoERAS | Propriedade | string | |||
| codigoEras | Propriedade | Identificador da OESA ao qual esta Propriedade está vinculada | |||
| @Column(nullable = false) Código ERAS da propriedade para filtrar (opcional) Código ERAS da propriedade (chave natural) | string,integer | int64 | GET /integracao/produtor/{identificadorReceitaProdutor}/countAnimaisStatusPorIdentificador/{status}; GET /integracao/produtor/{identificadorReceitaProdutor}/countAnimaisVivosPorIdentificador; GET /int | ||
| codigoExploracao | GTA | Código de exploração (opcional) Código de exploração pecuária do produtor (opcional) | string | PUT /integracao/propriedade/{codigoEras}/vincularProdutorPorCodigoEras/{identificadorReceitaProdutor}; PUT /integracao/propriedade/{id}/vincularProdutor/{idProdutor} | |
| codigoMunicipio | GTA | string | |||
| codigoRaca | GTA | Código da raça do animal Código da raça | string | GET /integracao/animal/count; GET /integracao/animal/list | |
| codigoReset | GTA | Identificador do Código Reset ao qual este Usuário está vinculado | string | ||
| codigoSolicitacao | GTA | string | |||
| codmunicipio | GTA | Código do município Código IBGE do município | string | GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integracao/propriedade/count; GET /integracao/propriedade/list; GET /integracao/proprietario/count; GET /integracao/proprietario/lis | |
| codmunicipioCorrespondencia | GTA | Código do município de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| complemento | GTA | Identificador do Complemento ao qual este Endereço está vinculado Complemento do endereço | string | GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integracao/propriedade/count; GET /integracao/propriedade/list; GET /integracao/proprietario/count; GET /integracao/proprietario/lis | |
| complementoCorrespondencia | GTA | Complemento do endereço de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| confinamentos | GTA | Identificador da Propriedade em Confinamento da Classe Propriedade | array | ||
| cpf | Produtor | Identificador de CPF ao qual este Responsável Técnico está vinculado | |||
| @Column(unique = true, nullable = false,length = 11) Identificador de CPF ao qual este Usuário está vinculado | |||||
| @Column(unique = true | string | ||||
| createDate | GTA | Identificador de Criação de Data de Classe Usuario | string | ||
| currentPage | GTA | Página atual (iniciando em 0) Página atual (baseada em zero) | integer | int32 | GET /integracao/animal/list; GET /integracao/animal/listaAnimaisStatus/{statusAnimal}; GET /integracao/atoDeSolicitacao/list; GET /integracao/certificadora/list; GET /integracao/certificadora/produtor |
| currentpage | GTA | Página atual (iniciando em 0) Página atual | integer | GET /integracao/produtor/listSimplificada; GET /integracao/propriedade/listSimplificada; GET /integracao/util/dominio/listdto; GET /integracao/util/municipio/list; GET /integracao/util/raca/list | |
| dados | GTA | string | |||
| dadosProfissionais | GTA | Identificador dos Dados Profissionais ao qual este Responsável Técnico está vinculado | array | ||
| data | GTA | string | |||
| dataAbate | GTA | Data de abate (YYYY-MM-DD) Data de abate do animal | string | date | GET /integracao/animal/count; GET /integracao/animal/list |
| dataAgendamento | GTA | Data de Agendamento ao qual este Ato de Verificação está vinculado Identificador da Data de Agendamento ao qual este Ato de Verificação está vinculado | string | ||
| dataAprovacao | GTA | Data da aprovação (YYYY-MM-DD) | string | GET /integracao/atoDeSolicitacao/count; GET /integracao/atoDeSolicitacao/list; GET /integracao/solicitacaoNumeracao/count; GET /integracao/solicitacaoNumeracao/list | |
| dataCadastro | GTA | Data de cadastro (YYYY-MM-DD) Data de cadastro do animal | string | date | GET /integracao/animal/count; GET /integracao/animal/list |
| dataCancelamento | GTA | Identificador da Data de Cancelamento ao qual este Ato de Verificação está vinculado Data de cancelamento (YYYY-MM-DD) | string | GET /integracao/movimentacao/count; GET /integracao/movimentacao/list | |
| dataDesligamento | GTA | Data do desligamento (YYYY-MM-DD) Data do desligamento | string | date | PUT /integracao/animal/{id}/registraDesligamento/{idTipoDesligamento}; PUT /integracao/animal/{numero}/registraDesligamentoPorNumero/{idTipoDesligamento} |
| dataEmissao | GTA | Data de emissão (YYYY-MM-DD) | string | date | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| dataEntrada | GTA | Data de entrada (YYYY-MM-DD) | string | date | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| dataEntradaPropriedade | Propriedade | Data de entrada na propriedade Data de entrada na propriedade (YYYY-MM-DD) | string | date | GET /integracao/animal/count; GET /integracao/animal/list |
| dataEntradaPropriedadeCertificada | Propriedade | Data de entrada na propriedade certificada (YYYY-MM-DD) Data de entrada em propriedade certificada | string | date | GET /integracao/animal/count; GET /integracao/animal/list |
| dataExpedicao | GTA | Data de expedição do RG do Supervisor | string | ||
| dataFim | GTA | string | |||
| dataFinal | GTA | Identificador da Data Final ao qual esta Propriedade está vinculada Data final (YYYY-MM-DD) | string | POST /integracao/propriedade/{codigoEras}/informarPeriodoConfinamentoPorCodigoEras/{dataInicial}/{dataFinal}/{idVistoria}; POST /integracao/propriedade/{id}/informarPeriodoConfinamento/{dataInicial}/{ | |
| dataIdentificacao | GTA | Data de identificação do animal Data de identificação (YYYY-MM-DD) | string | date | GET /integracao/animal/count; GET /integracao/animal/list |
| dataInicial | GTA | Identificador da Data Inicial ao qual esta Propriedade está vinculada Data inicial (YYYY-MM-DD) | string | POST /integracao/propriedade/{codigoEras}/informarPeriodoConfinamentoPorCodigoEras/{dataInicial}/{dataFinal}/{idVistoria}; POST /integracao/propriedade/{id}/informarPeriodoConfinamento/{dataInicial}/{ | |
| dataInicio | GTA | Data de início do técnico | string | GET /integracao/tecnico/count; GET /integracao/tecnico/list | |
| dataMorte | GTA | Data da morte (YYYY-MM-DD) | string | date | PUT /integracao/animal/{id}/registraMorte/{idCausaMorte}/{dataMorte}; PUT /integracao/animal/{numero}/registraMortePorNumero/{idCausaMorte}/{dataMorte} |
| dataMovimentacao | GTA | Data de movimentação (YYYY-MM-DD) Data da movimentação (YYYY-MM-DD) | GET /integracao/movimentacao/count; GET /integracao/movimentacao/list | ||
| dataNascimento | GTA | Data de nascimento do Supervisor Data de nascimento do animal Data de nascimento (YYYY-MM-DD) | string | date | GET /integracao/animal/count; GET /integracao/animal/list |
| dataNotaFiscal | GTA | Data da nota fiscal (YYYY-MM-DD) | string | GET /integracao/numeracao/count; GET /integracao/numeracao/list | |
| dataRealizacao | GTA | Identificador da Data de Realização ao qual este Ato de Verificação está vinculado | string | ||
| dataSaida | GTA | Data de saída (YYYY-MM-DD) | string | date | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| dataSolicitacao | GTA | Data da solicitação (YYYY-MM-DD) | string | GET /integracao/atoDeSolicitacao/count; GET /integracao/atoDeSolicitacao/list; GET /integracao/solicitacaoNumeracao/count; GET /integracao/solicitacaoNumeracao/list | |
| dataTerminoVistoria | GTA | Identificador da Data Termino Vistoria ao qual esta Propriedade está vinculada | string | ||
| dataUltimaVistoria | GTA | string | |||
| dataUtilizacao | GTA | Data de utilização (YYYY-MM-DD) | GET /integracao/numero/count; GET /integracao/numero/list | ||
| dataValidade | GTA | Identificador da Data de Validade ao qual este Ato de Verificação está vinculado Data de validade (YYYY-MM-DD) | string | date | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| data_abate | GTA | string | |||
| data_desligamento | GTA | string | |||
| data_entrada_propriedade | Propriedade | string | |||
| data_entrada_propriedade_certificada | Propriedade | string | |||
| data_identificacao | GTA | string | |||
| data_liberacao_abate | GTA | string | |||
| data_morte | GTA | string | |||
| data_nascimento | GTA | string | |||
| date | GTA | Data de geração da Lista Tracer Data da última publicação | string | ||
| descricao | GTA | string | |||
| dias_na_propriedade | Propriedade | integer | int64 | ||
| dias_vivo | GTA | integer | int64 | ||
| dominio | GTA | Identificador do Domínio ao qual esta Tabela de Domínio está vinculada Tipo de domínio | string | GET /integracao/util/dominio/getByCodigo/{dominio}/{codigo}; GET /integracao/util/dominio/getByValor/{dominio}/{valor}; GET /integracao/util/dominio/listDominio/{dominio} | |
| eRASPropriedadeDestino | Propriedade | integer | int64 | ||
| eRASPropriedadeLocalizacao | Propriedade | string | |||
| eRASPropriedadeNascimento | Propriedade | string | |||
| eRASPropriedadeOrigem | Propriedade | integer | int64 | ||
| eRASPropriedadeResponsavel | Propriedade | string | |||
| em_noventena | GTA | string | |||
| em_quarentena | GTA | string | |||
| GTA | Identificador de E-mail ao qual este Responsável Técnico está vinculado | ||||
| @Column(unique = true, nullable = false) Identificador do E-mail ao qual esta Propriedade está vinculada | |||||
| @Column(unique = true, | string | ||||
| endereco | GTA | Identificador do Endereço ao qual esta Certificadora está vinculada Identificador de Endereço ao qual esta Propriedade está vinculada Identificador do Endereço ao qual este Produtor está vinculado Ide | object | ||
| enderecoCorrespondencia | GTA | Identificador de Endereço de Correspondência ao qual esta Propriedade está vinculada | object | ||
| eras | Propriedade | Número de eras para filtrar (opcional) | integer | int64 | GET /integracao/produtor/{id}/listResumoAnimais |
| erros | GTA | array | |||
| especie | GTA | Identificador da Especie ao qual esta Raça está vinculada | string | ||
| exception | GTA | string | |||
| fileName | GTA | Nome do arquivo concluído | string | PUT /integracao/gta/{numeroCompleto}/concluirUploadPorNumeroCompleto/{fileName} | |
| filter | GTA | Filtro a ser aplicado | string | GET /integracao/util/dominio/listdto; GET /integracao/util/municipio/list; GET /integracao/util/raca/list | |
| frigorifico | GTA | string | |||
| grupo | GTA | string | |||
| gtas | GTA | array | |||
| habilitada | GTA | Propriedade habilitada | boolean,string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| habilitado | GTA | boolean | |||
| id | GTA | ID único do produtor Identificador de Chave Primária da Classe Pergunta Verificacao Identificador de Chave Primário da Classe Morte Identificador de Chave Primária da Classe Certificadora ID do número | string | uuid | DELETE /integracao/gta/{id}; DELETE /integracao/lote/{id}; DELETE /integracao/lote/{id}/removerTodosAnimais; DELETE /integracao/movimentacao/{id}; DELETE /integracao/movimentacao/{id}/removerAnimais; |
| idAnimal | Animal | Identificador único do animal a ser removido ID do animal | DELETE /integracao/lote/removerAnimal/{idAnimal}; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list | ||
| idCausaMorte | GTA | UUID da causa da morte ID da causa da morte | string | uuid | PUT /integracao/animal/{id}/registraMorte/{idCausaMorte}/{dataMorte}; PUT /integracao/animal/{numero}/registraMortePorNumero/{idCausaMorte}/{dataMorte} |
| idCertificadora | GTA | Identificador único da certificadora ID da certificadora Identificador da certificadora | string | uuid | GET /integracao/animal/count; GET /integracao/animal/getQuantitativosAnimaisStatus; GET /integracao/animal/list; GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count |
| idDadosProfissionais | GTA | DELETE /integracao/tecnico/{id}/removerDadosProfissionais/{idDadosProfissionais} | |||
| idDesligamento | GTA | ID do registro de desligamento | string | GET /integracao/animal/getDesligamento/{idDesligamento} | |
| idEndereco | GTA | string | |||
| idEnderecoCorrespondencia | GTA | string | |||
| idExterno | GTA | Id no sistema da certificadora | string | ||
| idFabrica | GTA | ID da fábrica | string | GET /integracao/numeracao/count; GET /integracao/numeracao/list; GET /integracao/solicitacaoNumeracao/count; GET /integracao/solicitacaoNumeracao/list | |
| idFaixaDeNumeracao | GTA | string | |||
| idFrigorifico | GTA | ID do frigorífico Identificador do frigorífico | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list |
| idFrigorificoDestino | GTA | ID do frigorífico de destino | string | uuid | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| idGTA | GTA | ID da GTA Identificador único da GTA | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| idLote | GTA | ID do lote Identificador único do lote | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list |
| idMorte | GTA | ID da morte no sistema SISBOV | string | GET /integracao/animal/getMorte/{idMorte} | |
| idMovimentacao | GTA | Identificador único da movimentação ID da movimentação | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list; GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/lote/listByMovimentacao/{idMovimentacao} |
| idNumeracao | GTA | ID da numeração Identificador de numeração Identificador único da numeração | string | GET /integracao/animal/count; GET /integracao/animal/list; GET /integracao/numero/count; GET /integracao/numero/list; GET /integracao/numero/{idNumeracao}/proximoDisponivel | |
| idNumero | GTA | string | |||
| idProdutor | Produtor | ID do produtor vinculado Identificador do produtor associado ao animal ID do produtor ID do produtor relacionado ID único do produtor a ser vinculado ID único do produtor a ser desvinculado ID do prod | string | uuid | GET /integracao/animal/count; GET /integracao/animal/countAnimaisStatus/{statusAnimal}; GET /integracao/animal/getQuantitativosAnimaisStatus; GET /integracao/animal/list; GET /integracao/animal/listaA |
| idProdutorCadastramento | Produtor | ID do produtor de cadastramento Identificador do produtor responsável pelo cadastramento | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list |
| idProdutorDestino | Produtor | ID do produtor que receberá a posse dos animais ID do produtor de destino Identificador único do produtor de destino | string | uuid | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list; POST /integracao/numeracao/{id}/transferirNumeracao/{idProdutorDestino}/{idP |
| idProdutorOrigem | Produtor | ID do produtor de origem | string | uuid | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| idPropriedade | Propriedade | ID da propriedade ID da propriedade associada ID único da propriedade à qual o proprietário será vinculado ID da propriedade vinculada ID da propriedade para filtrar (opcional) | string | uuid | GET /integracao/animal/countAnimaisStatus/{statusAnimal}; GET /integracao/animal/getQuantitativosAnimaisStatus; GET /integracao/animal/listaAnimaisStatus/{statusAnimal}; GET /integracao/numeracao/coun |
| idPropriedadeDestino | Propriedade | Identificador único da propriedade de destino ID da propriedade de destino | string | uuid | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list; POST /integracao/numeracao/{id}/transferirNumeracao/{idProdutorDestino}/{idP |
| idPropriedadeLocalizacao | Propriedade | ID da propriedade de localização Identificador da propriedade de localização | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list |
| idPropriedadeNascimento | Propriedade | ID da propriedade de nascimento Identificador da propriedade de nascimento | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list |
| idPropriedadeOrigem | Propriedade | ID da propriedade de origem | string | uuid | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list |
| idPropriedadeResponsavel | Propriedade | ID da propriedade responsável Identificador da propriedade responsável | string | uuid | GET /integracao/animal/count; GET /integracao/animal/list |
| idProprietario | GTA | ID único do proprietario a ser desvinculado ID do proprietário vinculado ID único do proprietario a ser vinculado | string | uuid | GET /integracao/propriedade/count; GET /integracao/propriedade/list; PUT /integracao/propriedade/{id}/desvincularProprietario/{idProprietario}; PUT /integracao/propriedade/{id}/vincularProprietario/{i |
| idResposta | GTA | PUT /integracao/vistoria/resposta/{idResposta}/responderAtualizar/{opcaoSelecionada} | |||
| idSolicitacao | GTA | string | |||
| idTecnico | GTA | ID do técnico associado | GET /integracao/vistoria/count; GET /integracao/vistoria/list | ||
| idTipoDesligamento | GTA | ID do tipo de desligamento UUID do tipo de desligamento | string | uuid | PUT /integracao/animal/{id}/registraDesligamento/{idTipoDesligamento}; PUT /integracao/animal/{numero}/registraDesligamentoPorNumero/{idTipoDesligamento} |
| idUsuarioAprovacao | GTA | string | |||
| idUsuarioSolicitante | GTA | ID do usuário solicitante | string | GET /integracao/atoDeSolicitacao/count; GET /integracao/atoDeSolicitacao/list | |
| idVinculo | GTA | Identificador de Chave do Vínculo de Classe Usuário | string | ||
| idVistoria | GTA | ID da vistoria | string | uuid | POST /integracao/propriedade/{codigoEras}/informarPeriodoConfinamentoPorCodigoEras/{dataInicial}/{dataFinal}/{idVistoria}; POST /integracao/propriedade/{id}/informarPeriodoConfinamento/{dataInicial}/{ |
| id_externo | GTA | string | |||
| id_listaTraces | GTA | Identificador da Lista Tracer. | object | ||
| idade | GTA | string | |||
| identificadorReceita | GTA | CPF ou CNPJ do proprietário (chave natural) Identificador da Receita ao qual este Proprietário está vinculado | |||
| @Column(unique = true, nullable = false,length = 14) CPF ou CNPJ do produtor (chave natura | string | GET /integracao/produtor/{identificadorReceita}/getProdutorPorIdentificador; GET /integracao/proprietario/{identificadorReceita}/getPropriedadesVinculadasPorIdentificador; GET /integracao/proprietario | |||
| identificadorReceitaProdutor | Produtor | Identificador de receita do produtor associado Identificador da receita do produtor CPF ou CNPJ do produtor para filtro (opcional) CPF ou CNPJ do produtor (chave natural) Identificador de receita do p | string | GET /integracao/animal/count; GET /integracao/animal/list; GET /integracao/produtor/{identificadorReceitaProdutor}/countAnimaisStatusPorIdentificador/{status}; GET /integracao/produtor/{identificadorR | |
| identificadorReceitaProdutorCadastramento | Produtor | Identificador da receita do produtor de cadastramento Identificador de receita do produtor de cadastramento | string | GET /integracao/animal/count; GET /integracao/animal/list | |
| identificadorReceitaProdutorDestino | Produtor | CPF ou CNPJ do produtor destino (chave natural) Identificador da receita do produtor de destino | string | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list; PUT /integracao/animal/registraSolicitacaoAlteracaoDePossePorIdentificador/{ | |
| identificadorReceitaProdutorNaoCadastrado | Produtor | string | |||
| identificadorReceitaProdutorOrigem | Produtor | Identificador da receita do produtor de origem | string | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list | |
| identificador_receita | GTA | string | |||
| importado | GTA | Animal importado (S/N) Indica se o animal é importado (true/false) | string | GET /integracao/animal/count; GET /integracao/animal/list | |
| incra | GTA | Identificador do INCRA ao qual esta Propriedade está vinculada | |||
| @Column(unique = true, nullable = false,length = 8) | string | ||||
| inscricaoEstadual | GTA | Identificador da Inscrição Estadual ao qual esta Propriedade está vinculada Inscrição estadual do produtor (opcional) Inscrição estadual (opcional) Inscrição estadual do proprietario (opcional) | string | PUT /integracao/propriedade/{codigoEras}/vincularProdutorPorCodigoEras/{identificadorReceitaProdutor}; PUT /integracao/propriedade/{codigoEras}/vincularProprietarioPorCodigoEras/{identificadorReceita} | |
| isProprietario | GTA | Filtrar apenas proprietários | boolean | GET /integracao/produtor/count; GET /integracao/produtor/list | |
| lastUpdate | GTA | string | |||
| latitude | GTA | number | double | ||
| logradouro | GTA | Logradouro do endereço Logradouro do proprietário Identificador de Logradouro ao qual este Endereço está vinculado Logradouro da propriedade | string | GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integracao/propriedade/count; GET /integracao/propriedade/list; GET /integracao/proprietario/count; GET /integracao/proprietario/lis | |
| logradouroCorrespondencia | GTA | Logradouro de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| longitude | GTA | number | double | ||
| message | GTA | string | |||
| motivo | GTA | Identificador do Motivo de Solicitação da Classe Ato De Solicitacao | string | ||
| motivoCancelamento | GTA | Motivo do cancelamento | string | GET /integracao/numero/count; GET /integracao/numero/list; PUT /integracao/numeracao/{codigo}/cancelar/{motivoCancelamento} | |
| motivoSuspensao | GTA | string | |||
| municipio | GTA | Município do proprietário Identificador do Município ao qual este Endereço está vinculado Município da propriedade Município do endereço | string | GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integracao/propriedade/count; GET /integracao/propriedade/list; GET /integracao/proprietario/count; GET /integracao/proprietario/lis | |
| municipioCorrespondencia | GTA | Município de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| nirf | GTA | Identificador do NIRF ao qual esta Propriedade está vinculada@Column(unique = true, nullable = true,length = 14) | string | ||
| nome | GTA | Nome da API Nome do arquivo a enviar Identificador de Nome ao qual este Perfil está vinculado Identificador do Nome do Produtor ao qual este Checklist está vinculado Identificador de Nome ao qual este | string | GET /integracao/util/municipio/getByNome/{nome}; GET /integracao/util/raca/getByNome/{nome}; POST /integracao/gta/{id}/informarUpload/{nome}; POST /integracao/gta/{numeroCompleto}/informarUploadPorNum | |
| nomeCertificadora | GTA | string | |||
| nomeFantasia | GTA | Identificador do Nome Fantasia ao qual esta Propriedade está vinculada | |||
| @Column(nullable = true) Identificador do Nome Fantasia ao qual esta Certificadora está vinculada | |||||
| @Column(nullable = false) | string | ||||
| nomeProdutorNaoCadastrado | Produtor | string | |||
| nomePropriedade | Propriedade | string | |||
| nomePropriedadeNaoCadastrada | Propriedade | string | |||
| nome_produtor | Produtor | string | |||
| nome_propriedade | Propriedade | string | |||
| notaFiscal | GTA | string | |||
| novaData | GTA | PUT /integracao/vistoria/{id}/reagendar/{novaData} | |||
| numero | GTA | Número do endereço Identificador do Número ao qual este Endereço está vinculado Número de identificação/rastreabilidade do animal (chave natural) Número de identificação do animal Número de identifica | string | GET /integracao/animal/byNumero/{numero}; GET /integracao/animal/consultaSimplificadaPorNumero/{numero}/{status}; GET /integracao/animal/{numero}/consultaSimplificadaPorNumero/{status}; GET /integraca | |
| numeroCompleto | GTA | Número composto da GTA (chave natural) | string | DELETE /integracao/gta/{numeroCompleto}/deletarGTAPorNumeroCompleto; GET /integracao/gta/{numeroCompleto}/getGTAPorNumeroCompleto; POST /integracao/gta/{numeroCompleto}/informarUploadPorNumeroCompleto | |
| numeroComposto | GTA | Número composto da GTA | string | GET /integracao/gta/{numeroComposto}/movimentacao | |
| numeroConselho | GTA | Identificador do Número Conselho ao qual este Dados Profissionais está vinculado | |||
| @Column(nullable = false) | string | ||||
| numeroCorrespondencia | GTA | Número do endereço de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| numeroGTAInclusao | GTA | string | |||
| numeroInferior | GTA | string | |||
| numeroSuperior | GTA | string | |||
| observacao | GTA | string | |||
| observacaoSumario | GTA | string | |||
| observacaoValidacao | GTA | string | |||
| oesa | GTA | Identificador da OESA ao qual esta Propriedade está vinculada | |||
| @Column(nullable = false),length = 9 | string | ||||
| oesaPropriedadeNaoCadastrada | Propriedade | string | |||
| opcaoSelecionada | GTA | Identificador da Opção Selecionada ao qual esta Resposta de Verificacao está vinculada | string | PUT /integracao/vistoria/resposta/{idResposta}/responderAtualizar/{opcaoSelecionada} | |
| opcoes | GTA | Identificador de Opções da Classe Pergunta Verificação | string | ||
| order | GTA | integer | int64 | ||
| orgaoExpedidor | GTA | Orgão expedidor do RG do Supervisor | string | ||
| pageSize | GTA | Número de registros por página (máximo 30) Tamanho da página Número de registros por página | integer | int32 | GET /integracao/animal/list; GET /integracao/animal/listaAnimaisStatus/{statusAnimal}; GET /integracao/atoDeSolicitacao/list; GET /integracao/certificadora/list; GET /integracao/certificadora/produtor |
| pagesize | GTA | Tamanho da página Número de registros por página | integer | GET /integracao/produtor/listSimplificada; GET /integracao/propriedade/listSimplificada; GET /integracao/util/dominio/listdto; GET /integracao/util/municipio/list; GET /integracao/util/raca/list | |
| parecer | GTA | Identificador do Parecer ao qual este Ato de Verificação está vinculado | string | PUT /integracao/vistoria/{id}/aprovar/{parecer}; PUT /integracao/vistoria/{id}/reprovar/{parecer} | |
| parecerAprovacao | GTA | string | |||
| parecerLiberacao | GTA | string | |||
| perfil | GTA | Identificador do Perfil ao qual este Usuário está vinculado | object | ||
| pergunta | GTA | Identificador da Pergunta ao qual esta Resposta de Verificação está vinculada | object | ||
| permissao | GTA | Permissão da Certificadora | string | ||
| produtores | Produtor | Identificador do Produtor ao qual esta Certificadora está vinculada | array | ||
| profissao | GTA | Identificador de Profissão ao qual este Dados Profissionais está vinculado | string | ||
| propriedade | Propriedade | Identificador da Propriedade da Classe Propriedade Confinamento Identificador de Propriedade ao qual este Ato de Verificação está vinculado Identificador da Propriedade habilitada. Identificador de Pr | object | ||
| propriedades | Propriedade | Identificador de Propriedade ao qual esta Certificadora está vinculada Identificador da Propriedade ao qual este Produtor está vinculado Identificador da Propriedade ao qual este Proprietário está vin | array | ||
| proprietario | GTA | Identificador do proprietário cadastrado caso o Produtor também seja um | object | ||
| proprietarios | GTA | Identificador do Produtor ao qual esta Propriedade está vinculada | array | ||
| quantidade | GTA | integer | int32 | ||
| quantidadeAnimais | GTA | integer | int64 | ||
| quantidadeDeAnimais | GTA | integer | int32 | ||
| questao | GTA | Identificador de Questão ao qual esta Pergunta Verificação está vinculada | string | ||
| raca | GTA | string | |||
| razaoSocial | GTA | Identificador de Razão Social ao qual esta Propriedade está vinculada | |||
| @Column(nullable = true) Identificador da Razão Social ao qual este Proprietário está vinculado | |||||
| @Column(nullable = true) Identific | string | ||||
| razaosocial | GTA | string | |||
| registroDefinitivo | GTA | string | |||
| registroProvisorio | GTA | string | |||
| reprovada | GTA | boolean | |||
| responsavelTecnico | GTA | Identificador do Responsável Técnico ao qual esta Propriedade está vinculada | object | ||
| respostas | GTA | Identificador das Respostas ao qual este Ato de Verificação está vinculado | object,array | ||
| rg | GTA | Número de RG do Supervisor | string | ||
| search | GTA | Termo de busca geral | string | GET /integracao/animal/count; GET /integracao/animal/list; GET /integracao/atoDeSolicitacao/count; GET /integracao/atoDeSolicitacao/list; GET /integracao/certificadora/count; GET /integracao/certifica | |
| senha | GTA | Identificador de Senha ao qual este Usuário está vinculado | string | ||
| serie | GTA | string | |||
| sexo | GTA | Sexo do animal Sexo do animal (MA/FE) Sexo do Supervisor | string | GET /integracao/animal/count; GET /integracao/animal/countAnimaisStatus/{statusAnimal}; GET /integracao/animal/list; GET /integracao/animal/listaAnimaisStatus/{statusAnimal} | |
| sif | GTA | SIF | string | GET /integracao/frigorifico/bySif/{sif} | |
| sifFrigorificoDestino | GTA | SIF do frigorífico de destino | string | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list | |
| situacaoAuditoria | GTA | string | |||
| situacaoVistoria | GTA | string | |||
| sort | GTA | Campo para ordenação Ordenação dos resultados Ordenação (formato: campo1,ASC;campo2,DESC) | string | GET /integracao/animal/list; GET /integracao/atoDeSolicitacao/list; GET /integracao/gta/list; GET /integracao/movimentacao/list; GET /integracao/numeracao/list; GET /integracao/numero/list; GET /integ | |
| stackMessages | GTA | array | |||
| status | GTA | Status dos animais a serem listados Status dos animais Status da numeração Status dos animais a serem contados Status da solicitação Status do animal Identificador do Status ao qual este Ato de Verifi | string | GET /integracao/animal/consultaSimplificada/{id}/{status}; GET /integracao/animal/consultaSimplificadaPorNumero/{numero}/{status}; GET /integracao/animal/{numero}/consultaSimplificadaPorNumero/{status | |
| statusAnimal | Animal | Status atual do animal Status do animal | string | GET /integracao/animal/count; GET /integracao/animal/countAnimaisStatus/{statusAnimal}; GET /integracao/animal/list; GET /integracao/animal/listaAnimaisStatus/{statusAnimal} | |
| statusAtividade | GTA | Identificador do Status de Atividade da Classe Responsável Técnico Identificador do Status da Atividade da Classe Produtor Status da atividade do proprietário Status atividade do técnico Status de ati | string | GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integracao/proprietario/count; GET /integracao/proprietario/list; GET /integracao/tecnico/count; GET /integracao/tecnico/list | |
| statusAuditoria | GTA | string | |||
| statusVistoria | GTA | string | |||
| status_animal | Animal | string | |||
| statusatividade | GTA | Status da atividade | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| suspensa | GTA | Propriedade suspensa | boolean,string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| tecnico | GTA | Identificador do Responsável Técnico ao qual este Ato de Verificação está vinculado Identificador do Responsável Técnico ao qual este Dados Profissionais está vinculado | object | ||
| telefonePrimario | GTA | Identificador do Telefone Primário, padrão length = 14, nullable = false, default = "+550000000000", sem máscara | string | ||
| telefoneSecundario | GTA | Identificador do Telefone Secundário, padrão length = 14, nullable = false, default = "+550000000000", sem máscara | string | ||
| telefoneprimario | GTA | string | |||
| telefonesecundario | GTA | string | |||
| tempo_identificacao | GTA | string | |||
| tempo_na_propriedade | Propriedade | string | |||
| tipo | GTA | Identificador do Tipo de Usuário ao qual este Usuário está vinculado Tipo da propriedade Tipo da solicitação Identificador do Tipo de Propriedade da Classe Propriedade Identificador do Tipo de Respons | string | GET /integracao/atoDeSolicitacao/count; GET /integracao/atoDeSolicitacao/list; GET /integracao/numeracao/count; GET /integracao/numeracao/list; GET /integracao/propriedade/count; GET /integracao/propr | |
| tipoAlvo | GTA | Identificador do Tipo de Entidade ao qual este Ato de Verificação está vinculado | string | ||
| tipoEntrada | GTA | string | |||
| tipoIdentificacao | GTA | Tipo de identificação | string | GET /integracao/animal/count; GET /integracao/animal/list | |
| tipos | GTA | array | |||
| totalPropriedadesHabilitadas | Propriedade | integer | int64 | ||
| totalPropriedadesIncluidas | Propriedade | integer | int64 | ||
| totalPropriedadesRemovidas | Propriedade | integer | int64 | ||
| type | GTA | string | |||
| uf | GTA | Unidade Federativa Identificador da UF ao qual este Dados Profissionais está vinculado Identificador de UF ao qual este Endereço está vinculado UF do proprietário Unidade Federativa (Estado) Identific | string | GET /integracao/gta/count; GET /integracao/gta/list; GET /integracao/movimentacao/count; GET /integracao/movimentacao/list; GET /integracao/produtor/count; GET /integracao/produtor/list; GET /integrac | |
| ufCorrespondencia | GTA | UF de correspondência | string | GET /integracao/propriedade/count; GET /integracao/propriedade/list | |
| ufExpedidor | GTA | UF de expedição do RG do Supervisor | string | ||
| ultima_atualizacao | GTA | string | |||
| updateType | GTA | string | |||
| usuarioResponsavel | GTA | Identificador do Usuario Responsável pela criação do ajuste. Identificador do Usuario Responsável pela geração. | object | ||
| utilizada | GTA | Utilizada (true or false) | boolean,string | boolean | GET /integracao/gta/count; GET /integracao/gta/list |
| valor | GTA | Valor a ser buscado no domínio Identificador do Valor ao qual esta Tabela de Domínio está vinculada | string | GET /integracao/util/dominio/getByValor/{dominio}/{valor} | |
| versao | GTA | Número da versão | string | ||
| vistoria | GTA | Identificador da Vistoria da Classe Propriedade Confinamento | object |