Lar - Sicop Plus Help Page

Authentication

Describe the authentication method to use the API endpoints


Auth typeDescription
Generic authenticated required requests
Send Bearer token in request headers
Header Value
Authorization Bearer GENERATED_TOKEN
POST api/token
Generate Bearer authentication token
Header Value
Content-type application/x-www-form-urlencoded
AppVersion APP_VERSION
AppName NAME_OF_APP
AppPlatform DEVICE_PLATFORM
DeviceUID string - unique identifier of device

BODY: grant_type=password&username=THE_USERNAME&password=THE_USER_PASSWORD

Use Basic Authentication: for register USERS and DEVICES endpoints. Other endpoints describe with basic authentication method.
Basic Authentication.

Set headers

Header Value
Authorization Basic base64(USERNAME:PASSWORD)

VendasVarejo

Dados sobre Preço FOB

APIDescription
GET api/v1/vendasVarejo/precoFob

Listar pedidos de alteração de preço FOB

PUT api/v1/vendasVarejo/precoFob

Aprovar/recusar alteração de preço FOB

WeatherForecast

APIDescription
GET api/v1/weatherforecast/{id}

Buscar previsão do tempo de uma cidade

GET api/v1/weatherforecast/cities

Buscar as cidades disponíveis para ver a previsão do tempo

GET api/v1/weatherforecast/basic/{id}

Buscar previsão do tempo de uma cidade com Autenticação Basic

GET api/v1/weatherforecast/cities/basic

Buscar as cidades disponíveis para ver a previsão do tempo com Autenticação Basic

Permissions

APIDescription
GET api/v1/permissions/actives?userId={userId}&areaId={areaId}

Get all permissions actives

GET api/v1/permissions

Get all areas

POST api/v1/permissions

Enable/disable permission

ParecerAnaliseCreditoPF

APIDescription
DELETE api/v1/analisecredito/pessoafisica/arquivo?id={id}

No documentation available.

GET api/v1/analisecredito/pessoafisica/dadosgerais?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/analiseatual?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/listar?matricula={matricula}&fechada={fechada}&financeiro={financeiro}&finalidade={finalidade}&grupoFamiliar={grupoFamiliar}&dataInicio={dataInicio}&somenteComParecerJaDado={somenteComParecerJaDado}&analise={analise}&situacao={situacao}&lac={lac}&safra={safra}&comite={comite}

No documentation available.

GET api/v1/analisecredito/pessoafisica/areaplantio?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/arquivo?id={id}&asDownloadedFile={asDownloadedFile}

No documentation available.

GET api/v1/analisecredito/pessoafisica/arquivos?analise={analise}&matricula={matricula}&cpf={cpf}

No documentation available.

GET api/v1/analisecredito/pessoafisica/grupofamiliar?analise={analise}&matricula={matricula}

No documentation available.

GET api/v1/analisecredito/pessoafisica/descricoes?matricula={matricula}&analise={analise}

No documentation available.

GET api/v1/analisecredito/pessoafisica/dividas?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/finalidade?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/buscarfinalidades

No documentation available.

GET api/v1/analisecredito/pessoafisica/info/comites?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/pareceres?matricula={matricula}&analise={analise}

No documentation available.

GET api/v1/analisecredito/pessoafisica/pareceres/timeline?matricula={matricula}&analise={analise}

No documentation available.

GET api/v1/analisecredito/pessoafisica/meuspareceres?aPartirDe={aPartirDe}&parecerAnaliseCredito={parecerAnaliseCredito}

No documentation available.

GET api/v1/analisecredito/pessoafisica/posses?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/receitas?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/ultimaanalise?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

GET api/v1/analisecredito/pessoafisica/comites/validos

No documentation available.

GET api/v1/analisecredito/pessoafisica/valoresvencidos?matricula={matricula}&analise={analise}&fechada={fechada}

No documentation available.

POST api/v1/analisecredito/pessoafisica/arquivo

No documentation available.

POST api/v1/analisecredito/pessoafisica/serasa?cpf={cpf}

No documentation available.

POST api/v1/analisecredito/pessoafisica/arquivos/zip/{asDownloadedFile}

No documentation available.

POST api/v1/analisecredito/pessoafisica/parecer

No documentation available.

POST api/v1/analisecredito/pessoafisica/imprimir

No documentation available.

Migration

APIDescription
GET api/v1/migration

No documentation available.

POST api/v1/migration/email

No documentation available.

POST api/v1/migration/validate

No documentation available.

GraosRomaneiosComercial

Romaneios

APIDescription
GET api/v1/GraosRomaneiosComercial?ie={ie}&dataInicial={dataInicial}&dataFinal={dataFinal}&safra[0]={safra[0]}&safra[1]={safra[1]}&codigoProduto[0]={codigoProduto[0]}&codigoProduto[1]={codigoProduto[1]}&codigoCultura[0]={codigoCultura[0]}&codigoCultura[1]={codigoCultura[1]}&status={status}&select={select}&expand={expand}&filter={filter}&top={top}&skip={skip}&orderby={orderby}&count={count}

Obter Romaneios

GET api/v1/GraosRomaneiosComercial/total?ie={ie}&dataInicial={dataInicial}&dataFinal={dataFinal}&safra[0]={safra[0]}&safra[1]={safra[1]}&codigoProduto[0]={codigoProduto[0]}&codigoProduto[1]={codigoProduto[1]}&codigoCultura[0]={codigoCultura[0]}&codigoCultura[1]={codigoCultura[1]}&status={status}

Obter Totalizador

GET api/v1/GraosRomaneiosComercial/filtros

Obter Opções para filtros

GET api/v1/GraosRomaneiosComercial/dashboard?ie={ie}

Obter dashboard

AnaliseCreditoPJ

APIDescription
GET api/v1/analisecredito/pessoajuridica/limitecredito?matricula={matricula}&simples={simples}

Get all provisional to update credit limit simples = Sem dados do serasa e cisp

POST api/v1/analisecredito/pessoajuridica/limitecredito

Update one provisional credit limit

GET api/v1/analisecredito/pessoajuridica/analises

Get all analises to send parecer

POST api/v1/analisecredito/pessoajuridica/analise/parecer

Send parecer

GET api/v1/analisecredito/pessoajuridica/provisorios?cnpj={cnpj}&palm={palm}

Get all provisorios

GET api/v1/analisecredito/pessoajuridica/provisorio?cnpj={cnpj}

Get one provisorio

POST api/v1/analisecredito/pessoajuridica/provisorio

Create provisorio

PUT api/v1/analisecredito/pessoajuridica/provisorio

Remove from screen or reject provisorio

GET api/v1/analisecredito/pessoajuridica/observacoes?matricula={matricula}

Get observacoes provisorio

PUT api/v1/analisecredito/pessoajuridica/observacoes

Update observacoes provisorio

GET api/v1/analisecredito/pessoajuridica/prazos?matricula={matricula}

Get prazos

POST api/v1/analisecredito/pessoajuridica/prazos

Update prazos

GET api/v1/analisecredito/pessoajuridica/relato/proxy?cnpj={cnpj}

Get relato proxy serasa (atuais)

GET api/v1/analisecredito/pessoajuridica/cisp?cnpj={cnpj}

Get relato proxy (atuais)

Forms

APIDescription
POST api/v1/forms/consumo-de-agua

Insere formularo de consumo de agua

POST api/v1/forms/temperatura-e-umidade

Insere formularo de temperatura e umidade

GET api/v1/forms/temperatura-e-umidade/ultimo-lancamento?aviario={aviario}&lote={lote}

Obtem a ultima data de lancamento

PUT api/v1/forms/temperatura-e-umidade

atualiza forms temperatura e umidade

PUT api/v1/forms/consumo-de-agua

atualiza forms de consumo de agua

GET api/v1/forms/temperatura-e-umidade?aviario={aviario}

obtem ultimos 2 anos de dados

POST api/v1/forms/controle-de-roedores?tipoFormulario={tipoFormulario}

Insere formularo de roedores

PUT api/v1/forms/controle-de-roedores

atualiza forms de roedores

GET api/v1/forms/controle-de-roedores?aviario={aviario}&tipoFormulario={tipoFormulario}

obtem ultimos 2 anos de dados

GET api/v1/forms/controle-de-roedores/ultima-lancamento?aviario={aviario}&lote={lote}&tipoFormulario={tipoFormulario}

obtem a ultima medida de consumo cadastrada

GET api/v1/forms/consumo-de-agua/ultima-medida?aviario={aviario}&lote={lote}

obtem a ultima medida de consumo cadastrada

GET api/v1/forms/pendencia?idFormulario={idFormulario}&parametro={parametro}

No documentation available.

GET api/v1/forms/consumo-de-agua?aviario={aviario}

obtem ultimos 2 anos de dados

GET api/v1/forms/formularios-pendente?aviario={aviario}&lote={lote}

ver formularios pendentes do aviario

GET api/v1/forms/estrutura-formulario?idFormulario={idFormulario}&parametro={parametro}

Obtem a estrutura de um formulario

POST api/v1/forms/resultado

Insere o resultado de um formulario

PUT api/v1/forms/resultado

Atualiza o resultado de um formulario

GET api/v1/forms/resultado?parametro={parametro}

No documentation available.

Avicultura

Dados sobre a Avicultura

APIDescription
GET api/v1/avicultura/avaliacao?aviario={aviario}

Buscar dados de avaliação do aviário

GET api/v1/avicultura/aviarios

Buscar os aviários do associado logado

GET api/v1/avicultura/bordero?aviario={aviario}&lote={lote}

Detalhes do lote - Borderô

GET api/v1/avicultura/notasfiscais?nfe={nfe}

Consultar notas fiscais da venda de frango por lotes fechados

GET api/v1/avicultura/lotes?aviario={aviario}

Buscar os lotes fechados do aviário

GET api/v1/avicultura/conversao/alimentar?tipo={tipo}

Buscar médias de conversão alimentar das ultimas semanas

GET api/v1/avicultura/mediasconversaoalimentar?semPromotor={semPromotor}

Buscar médias de conversão alimentar

GET api/v1/avicultura/conversao/alimentar/tipos

Buscar tipos de conversao alimentar disponiveis para consulta

GET api/v1/avicultura/mediasconversaoalimentartipo?tipo={tipo}

Buscar médias de conversão alimentar por tipo

GET api/v1/avicultura/racao/tipos

Buscar tipos de rações disponíveis

GET api/v1/avicultura/mediascaa?semPromotor={semPromotor}

Buscar médias de conversão alimentar V2

GET api/v1/avicultura/conversaoalimentar/{aviario}/{lote}

Buscar da conversão alimentar

GET api/v1/avicultura/conversaoalimentar/meta/{matricula}

Consulta das meta de conversao alimentar por região

GET api/v1/avicultura/mortalidade?aviario={aviario}&lote={lote}

Consultar mortalidades

POST api/v1/avicultura/mortalidade

Realizar lançamento dos dados de mortalidade

GET api/v1/avicultura/fechamentolote?aviario={aviario}&lote={lote}

Consultar o Fechamento do Lote

GET api/v1/avicultura/detalhesaviario?aviario={aviario}&lote={lote}

Consultar Detalhes do Aviario

GET api/v1/avicultura/telefones?aviario={aviario}

No documentation available.

POST api/v1/avicultura/telefones

No documentation available.

DELETE api/v1/avicultura/telefones/{aviario}/{identificador}

No documentation available.

POST api/v1/avicultura/racao/sobra

No documentation available.

GET api/v1/avicultura/silos?aviario={aviario}

Buscar os silos de um aviário

POST api/v1/avicultura/silo/informar-vazio

Informar que um aviário possui silo(s) vazio(s)

GET api/v1/avicultura/programacao-carregamento?aviario={aviario}&lote={lote}

Retorna lista de programação de carregamento aviário

GET api/v1/avicultura/indicadores-iep

Retorna as listas de indicadores de IEP (Misto, Macho e Femea)

GET api/v1/avicultura/nfe?aviario={aviario}&lote={lote}

No documentation available.

GET api/v1/avicultura/nfe/error

No documentation available.

GET api/v1/avicultura/nfe/all/error

No documentation available.

GET api/v1/avicultura/nfe/all

No documentation available.

GET api/v1/avicultura/nfe/recolha

No documentation available.

POST api/v1/avicultura/silo/pesoMedio-conversaoAlimentar

Retorna informações para o calculo de conversão alimentar

PUT api/v1/avicultura/silo/pesoMedio-conversaoAlimentar

No documentation available.

GET api/v1/avicultura/silo/pesoMedio-conversaoAlimentar?aviario={aviario}&lote={lote}

No documentation available.

GET api/v1/avicultura/nfe/cargas-nao-associadas?enrollment={enrollment}&chaveNfe={chaveNfe}

No documentation available.

PUT api/v1/avicultura/nfe/cargas-nao-associadas

No documentation available.

PUT api/v1/avicultura/nfe/pedir-cancelamento

No documentation available.

PUT api/v1/avicultura/nfe/impressao?chaveNfe={chaveNfe}

No documentation available.

GET api/v1/avicultura/global-gap

No documentation available.

GET api/v1/avicultura/global-gap/all

No documentation available.

POST api/v1/avicultura/transferenciaRacao

Transferir ração para outro aviário/lote

GET api/v1/avicultura/bordero/detalhes-gerais?aviario={aviario}&lote={lote}&isOwner={isOwner}

No documentation available.

POST api/v1/avicultura/isca-roedores

No documentation available.

GET api/v1/avicultura/isca-roedores?aviario={aviario}

No documentation available.

GET api/v1/avicultura/global-gap/aviario?aviario={aviario}

No documentation available.

GET api/v1/avicultura/consultaVeterinariosBySegmento?segmento={segmento}&ativos={ativos}

Obter os veterinário com base no segmento (Aves ou Suínos)

POST api/v1/avicultura/veterinarios

Adicionar veterinário

PUT api/v1/avicultura/veterinarios

Alterar veterinário

PUT api/v1/avicultura/veterinarios/status

Alterar o status do veterinário

GET api/v1/avicultura/resultadoConversaoAlimentar?aviario={aviario}&lote={lote}

Obter resultado da conversão alimentar do lote do aviário

GET api/v1/avicultura/resultadoPesoMedio?aviario={aviario}&lote={lote}

Obter resultado do peso médio do lote do aviário

Nfpe

Dados sobre as NFPE

APIDescription
GET api/v1/nfpe/ovos?NfpeNovas={NfpeNovas}

Obter as NFPE dos ovos

GraosFaturamento

Faturamento

APIDescription
GET api/v1/GraosFatramento?dataInicial={dataInicial}&dataFinal={dataFinal}&codigoProduto[0]={codigoProduto[0]}&codigoProduto[1]={codigoProduto[1]}&inscricaoEstadual[0]={inscricaoEstadual[0]}&inscricaoEstadual[1]={inscricaoEstadual[1]}&select={select}&expand={expand}&filter={filter}&top={top}&skip={skip}&orderby={orderby}&count={count}

Obter faturamento

GET api/v1/GraosFatramento/filtros

Obter Opções para filtros

GET api/v1/GraosFatramento/total?dataInicial={dataInicial}&dataFinal={dataFinal}&codigoProduto[0]={codigoProduto[0]}&codigoProduto[1]={codigoProduto[1]}&inscricaoEstadual[0]={inscricaoEstadual[0]}&inscricaoEstadual[1]={inscricaoEstadual[1]}

Obter totalizador

GET api/v1/GraosFatramento/dashboard

Obter dashboard

ReservaVeiculos

Obtém dados das reservas de veículos

APIDescription
GET api/v1/logistica/reservaveiculo/condutor?empresa={empresa}&value={value}

Consulta de condutores

POST api/v1/logistica/reservaveiculo

Registra reservas de veículo

POST api/v1/logistica/reservaveiculo/efetivar

Efetivação de reservas de veículo

DELETE api/v1/logistica/reservaveiculo

Cancelamento de reserva pelo usuário, necessário informar data de saída como chave

DELETE api/v1/logistica/reservaveiculo/cancelamento

Cancelamento de reserva pelo responsável, necessário informar data de saída como chave

GET api/v1/logistica/reservaveiculo

Consulta de reservas de veículos futura.

GET api/v1/logistica/reservaveiculo/quantidade

Consulta a quantidade total de veículos que a logistica possui

GET api/v1/logistica/reservaveiculo/cidade?cidade={cidade}

Consulta de cidades buscando dados do ibge

GET api/v1/logistica/reservaveiculo/filial?codigoIbge={codigoIbge}

Consulta de filiais buscando pelo código ibge da cidade

GET api/v1/logistica/reservaveiculo/placa

Obtém placa por departamento

Agriculture

Dados da agricultura

APIDescription
GET api/v1/agriculture/quotes

Cotações agrícolas

GET api/v1/agricultura/cotacoes

Cotações agrícolas

GET api/v1/agricultura/quotespy/basic

Cotações agrícolas Paraguai com autenticação Basic

GET api/v1/agricultura/cotacoespy/basic

Cotações agrícolas Paraguai com autenticação Basic

GET api/v1/agricultura/quotespy

Cotações agrícolas Paraguai

GET api/v1/agricultura/cotacoespy

Cotações agrícolas Paraguai

GET api/v1/agricultura/cotacoes/todosHorarios

Cotações agrícolas sem checagem da validade de horário

GET api/v1/agricultura/cotacoes/todosHorarios/locaisFormatados

Cotações agrícolas sem checagem da validade de horário

GET api/v1/agriculture/quotes/historic?branch={branch}&product={product}&rangeDay={rangeDay}

Historico de cotacoes

GET api/v1/agricultura/cotacoes/historico?branch={branch}&product={product}&rangeDay={rangeDay}

Historico de cotacoes

GET api/v1/agriculture/quotes/historic/basic?branch={branch}&company={company}&product={product}&rangeDay={rangeDay}

Historico de cotacoes com autenticação Basic

GET api/v1/agricultura/cotacoes/historico/basic?branch={branch}&company={company}&product={product}&rangeDay={rangeDay}

Historico de cotacoes com autenticação Basic

GET api/v1/agriculture/quotes/soybeanfuture

Cotacao de Soja Valor Futuro - Bolsa Chicago

GET api/v1/agriculture/quotes/soybeanfuture/basic

Cotacao de Soja Valor Futuro - Bolsa Chicago - Site Lar

GET api/v1/agriculture/quotes/basic

Cotações agrícolas com autenticação Basic

GET api/v1/agricultura/cotacoes/basic

Cotações agrícolas com autenticação Basic

GET api/v1/agricultura/cotacoes/todosHorarios/basic

Cotações agrícolas sem checagem da validade de horário e Autenticação Basic

GET api/v1/agricultura/cotacoesdia/basic?branch={branch}&company={company}&data={data}

Buscar cotações agrícolas de um dia específico

GET api/v1/agricultura/fazendas

Buscar todas as fazendas com base na matrícula

GET api/v1/agricultura/contrato-romaneio?matricula={matricula}&ie={ie}

Buscar contratos romaneios

GET api/Agriculture?branch={branch}&company={company}&product={product}&rangeDay={rangeDay}

No documentation available.

GET api/Agriculture?branch={branch}&company={company}&data={data}

No documentation available.

GET api/Agriculture?enrollment={enrollment}

No documentation available.

GET api/Agriculture?matricula={matricula}&ie={ie}

No documentation available.

Veiculo

[Reserva de veículo] Obtém dados relacionado a veículos

APIDescription
GET api/v1/reserva-veiculo/veiculo/placa

Obtém placas de veículos por departamento do usuário logado

SicopAccount

APIDescription
GET api/v1/sicopAccount

No documentation available.

POST api/v1/sicopAccount/register

No documentation available.

PUT api/v1/sicopAccount/setSicopAccountDefault

No documentation available.

DELETE api/v1/sicopAccount/deleteSicopAccount

No documentation available.

Funcionario

APIDescription
GET api/v1/funcionario/demonstrativo?data={data}&asPdf={asPdf}

No documentation available.

GET api/v1/funcionario/seguro

No documentation available.

GET api/v1/funcionario/holerite?data={data}

No documentation available.

GET api/v1/funcionario/holerite/pdf?data={data}

No documentation available.

GET api/v1/funcionario/informeRendimentos/pdf?anoBase={anoBase}

No documentation available.

GET api/v1/funcionario/estourodefolha/pdf?data={data}

No documentation available.

GET api/v1/funcionario/cartao-visita

No documentation available.

POST api/v1/funcionario/cartao-visita

No documentation available.

PUT api/v1/funcionario/cartao-visita

No documentation available.

POST api/v1/funcionario/cartao-visita/validation-code?email={email}

No documentation available.

POST api/v1/funcionario/cartao-visita/resend-validation-code

No documentation available.

POST api/v1/funcionario/cartao-visita/validar-email?codigo={codigo}

No documentation available.

GET api/v1/funcionario/consultaDocumentoAssinado

No documentation available.

Suinocultura

Dados sobre a Suinocultura

APIDescription
GET api/v1/suinocultura/granjas

Listar granjas

GET api/v1/suinocultura/lotes?granja={granja}

Listar lotes

GET api/v1/suinocultura/lote?granja={granja}&lote={lote}

Resultado Lote

GET api/v1/suinocultura/mediaslar

Medias lar ultimos 30 dias

POST api/v1/suinocultura/mortalidade

Realizar lançamento dos dados de mortalidade

PUT api/v1/suinocultura/mortalidade

No documentation available.

GET api/v1/suinocultura/mortalidade?granja={granja}&lote={lote}

Obtem lançamentos de mortalidade

DELETE api/v1/suinocultura/mortalidade/{granja}/{lote}/{sequencia}

Deleta lançamento de mortalidade

GET api/v1/suinocultura/medicamentos?granja={granja}&lote={lote}&matricula={matricula}

Consulta de remedios por lote de suinos

POST api/v1/suinocultura/LancamentoMedicamento

Lançar medicamento suinocultura

PUT api/v1/suinocultura/LancamentoMedicamento

Alterar medicamento pendente

GET api/v1/suinocultura/ObterMedicamentosLancados?granja={granja}&lote={lote}

Obter medicamentos lançados

GET api/v1/suinocultura/ObterMedicamentosLotes?granja={granja}&lote={lote}

Obter Medicamentos dos Lotes

DELETE api/v1/suinocultura/DeletarMedicamentoLancado

Deletar medicamento lançado

GET api/v1/suinocultura/programacao-carregamento?granja={granja}&lote={lote}

Consulta de programacao de carregamento de suinos

GET api/v1/suinocultura/vacinas?granja={granja}&lote={lote}

Consulta lista de vacinas lançadas

PUT api/v1/suinocultura/vacinas

Altera/Atualiza vacina suino já lançada

GET api/v1/suinocultura/lista-medicamentos?granja={granja}&lote={lote}&matricula={matricula}

Consulta de remedios por lote de suinos

ReservaVeiculo

Inclui e obtém dados de reservas dos veículos

APIDescription
GET api/v1/reserva-veiculo

Obtém reservas de veículos futuras

GET api/v1/reserva-veiculo/matricula?matricula={matricula}

Obtém reservas passadas e futuras por matricula

POST api/v1/reserva-veiculo

Faz a reserva de veículos

POST api/v1/reserva-veiculo/efetivar

Efetiva reservas de veículos

DELETE api/v1/reserva-veiculo

Cancelamento de reservas, data de saída como chave

POST api/v1/reserva-veiculo/limitar?dia={dia}&quantidade={quantidade}

Limitar reservas de veículos

GET api/v1/reserva-veiculo/limite?dia={dia}

Obet limite reservas de veículos

Notifications

APIDescription
GET api/v1/notifications?externalId={externalId}

Get Notification Status By ExternalId

POST api/v1/notifications

Store notification to send after by service

POST api/v1/notifications/push?company={company}&enrollment={enrollment}&title={title}&message={message}&notificationClass={notificationClass}

Envia um push notification para todos os devices do dono da matricula

DiarioBordo

Obtém dados das reservas de veículos

APIDescription
GET api/v1/reserva-veiculo/diariobordo?dataSaida={dataSaida}

Consulta o diário de bordo de uma reserva de veículo

POST api/v1/reserva-veiculo/diariobordo

Adiciona o diário de bordo para uma reserva de veículo

PATCH api/v1/reserva-veiculo/diariobordo

Atualiza parcialmente o diário de bordo para uma reserva de veículo

DELETE api/v1/reserva-veiculo/diariobordo?data={data}

Deleta rateio de um diário de bordo

Admin

APIDescription
POST api/v1/admin/group

No documentation available.

DELETE api/v1/admin/group?id={id}

No documentation available.

POST api/v1/admin/user/disable

Desativar um usuário

POST api/v1/admin/user/enrollment/disable

Desativar uma matricula de um usuário usuário

PUT api/v1/admin/group

No documentation available.

POST api/v1/admin/user/enable

Ativar um usuário

POST api/v1/admin/user/enrollment/enable

Desativar uma matricula de um usuário usuário

GET api/v1/admin/users

Buscar todos usuários

GET api/v1/admin/groups/{userId}/{onlyGroupsOfUser}

Buscar grupos que usuário pode ter autorização

GET api/v1/admin/device/{id}

Buscar um dispositivo por Id

GET api/v1/admin/devices

Buscar todos dispositivos ativos

GET api/v1/admin/device/{id}/users

Buscar Usuários de um dispositivo

GET api/v1/admin/enrollment/{id}

Buscar uma matricula

GET api/v1/admin/enrollment/{id}/users

Buscar a associação usuário x matricula que estão usando uma matricula

GET api/v1/admin/group/{id}

Buscar um Grupo

GET api/v1/admin/groups?onlyEnabled={onlyEnabled}

No documentation available.

GET api/v1/admin/group/{id}/users

Buscar Usuários de um grupo

GET api/v1/admin/profile/{id}

Buscar um Perfil

GET api/v1/admin/profile/{id}/roles

Buscar Roles de um Perfil

GET api/v1/admin/profiles

Buscar todos os perfis

GET api/v1/admin/profiles/{enrollmentId}

Buscar todos os perfis que podem ser liberados para um determinados tipo de matricula (funcionário, gerente, etc)

GET api/v1/admin/profile/{id}/enrollments

Buscar as Associações Usuários x Matriculas de um peril

GET api/v1/admin/role/{id}

Buscar uma Role

GET api/v1/admin/role/{id}/profiles

Buscar todos os Perfis que possuem a role

GET api/v1/admin/roles

Buscar todas as roles

GET api/v1/admin/user/{id}

Buscar um usuários por Id

GET api/v1/admin/user/document/{document}

No documentation available.

GET api/v1/admin/enrollment/{userId}/{enrollmentId}/profiles

Buscar os Perfis de uma associação usuário x matricula

GET api/v1/admin/user/{id}/devices

Buscar os dispositivos de um usuário

GET api/v1/admin/user/{id}/enrollments

Buscar matriculas associadas ao usuário

GET api/v1/admin/user/{id}/groups

Buscar os Grupos do Usuário

GET api/v1/admin/user/{id}/image

Buscar uma imagem de usuário por Id

GET api/v1/admin/users/blocked

Usuários bloqueados por muitas tentativas inválidas de Login

GET api/v1/admin/users/state?state={state}

Get new users pending to be released

GET api/v1/admin/users/dashboard-summary

Obter resumo do dashboard de usuários

GET api/v1/admin/users/unauthorized

Usuários que estão liberados porém sem permissão

POST api/v1/admin/user/profile

Adicionar um perfil ao usuário

POST api/v1/admin/change/phone?id={id}&newNumber={newNumber}

No documentation available.

POST api/v1/admin/remove/enrollment?enrollment={enrollment}&idUser={idUser}

No documentation available.

DELETE api/v1/admin/user/profile

Remover perfil do usuário

POST api/v1/admin/reset/password?id={id}&method={method}

No documentation available.

PUT api/v1/admin/user/{id}/image/rotate?direction={direction}

Rotacionar a imagem do usuario Informar ID do usuário Informar 'left' OU 'right'

POST api/v1/admin/user/group

No documentation available.

PUT api/v1/admin/user/group

No documentation available.

DELETE api/v1/admin/user/group

No documentation available.

GET api/v1/admin/notifications?idUser={idUser}

Geth the last 7 days user notifications

PUT api/v1/admin/user/enrollment/owner

No documentation available.

GET api/v1/admin/user/cartoes-visita/pendente

No documentation available.

POST api/v1/admin/user/cartoes-visita/update-status?idCartaoVisita={idCartaoVisita}&aprovado={aprovado}&motivoRecusa={motivoRecusa}

No documentation available.

Postos

APIDescription
POST api/v1/postos

No documentation available.

PUT api/v1/postos/{id}

No documentation available.

DELETE api/v1/postos/{id}

No documentation available.

GET api/v1/postos

No documentation available.

GET api/v1/postos/{id}

No documentation available.

GET api/v1/postos/filtros

No documentation available.

GET api/v1/postos/filter?estados[0]={estados[0]}&estados[1]={estados[1]}&cidades[0]={cidades[0]}&cidades[1]={cidades[1]}&combustiveis[0]={combustiveis[0]}&combustiveis[1]={combustiveis[1]}

No documentation available.

POST api/v1/postos/avaliacoes

No documentation available.

DELETE api/v1/postos/avaliacoes/{id}

No documentation available.

GET api/v1/postos/avaliacoes/{id}

No documentation available.

PUT api/v1/postos/avaliacoes/{id}

No documentation available.

POST api/v1/postos/comentarios

No documentation available.

DELETE api/v1/postos/comentarios/{id}

No documentation available.

GET api/v1/postos/comentarios/{id}

No documentation available.

PUT api/v1/postos/comentarios/{id}

No documentation available.

POST api/v1/postos/analise

No documentation available.

GET api/v1/postos/analise

No documentation available.

Pecuaria

Dados sobre a Pecuária

APIDescription
GET api/v1/pecuaria/contato?Enrollment={Enrollment}&Tipo={Tipo}&AviarGranja={AviarGranja}

Obtem os contatos de uma matrícula, aviário/granja

POST api/v1/pecuaria/contato

Adicionar um novo contato

PUT api/v1/pecuaria/contato

Alterar contato

DELETE api/v1/pecuaria/contato/{Enrollment}/{DDD}/{Prefixo}/{Numero}/{Tipo}/{AviarGranja}

Deletar contato

Associado

APIDescription
GET api/v1/associado/buscarassociado?empresa={empresa}&value={value}

No documentation available.

GET api/v1/associado/compras?matricula={matricula}

No documentation available.

GET api/v1/associado/contas?matricula={matricula}&analise={analise}

No documentation available.

GET api/v1/associado/localidades

No documentation available.

GET api/v1/associado/pagamentos?matricula={matricula}

No documentation available.

GET api/v1/associado/limiteDeCredito?matricula={matricula}&safra={safra}

No documentation available.

GET api/v1/associado/funcionarios/basic?nome={nome}

Consultar funcionários por nome

GET api/v1/associado/producoes?matricula={matricula}

No documentation available.

GET api/v1/associado/situacaofinanceira?matricula={matricula}

No documentation available.

GET api/v1/associado/situacaofinanceira/grupofamiliar?matricula={matricula}&analise={analise}

No documentation available.

GET api/v1/associado/limite/credito/overview?matricula={matricula}&analise={analise}

No documentation available.

GET api/v1/associado/termo-consentimento-analise-credito

No documentation available.

POST api/v1/associado/Agrisk

cadastra cpf agrisk

DELETE api/v1/associado/Agrisk?cpf={cpf}

Deletar CPF Agrisk

GET api/v1/associado/Agrisk?assinados={assinados}

obtem todos agrisk

GET api/v1/associado/Contatos?document={document}

No documentation available.

Condutor

[Reserva de veículo] Obtém dados de condutores para reservas de veículos

APIDescription
GET api/v1/reserva-veiculo/condutor?empresa={empresa}&matricula={matricula}

Consulta de condutor por nome ou matrícula filtrando por empresa

GET api/v1/reserva-veiculo/condutores?empresa={empresa}&termo={termo}

Consulta de condutor por nome ou matrícula filtrando por empresa

ExtratoProdutor

APIDescription
GET api/v1/extratoProdutor/agricultura

Consultar extrato agrícola

GET api/v1/extratoProdutor/comprasInsumos

Consultar extrato de compras

GET api/v1/extratoProdutor/financeiro

Consultar extrato financeiro

GET api/v1/extratoProdutor/permutas

Consultar extrato de permutas

GET api/v1/extratoProdutor/romaneiosAno

Consultar extrato de romaneios no ano

GET api/v1/extratoProdutor/romaneiosDeposito

Consultar extrato de romaneios no depósito

GET api/v1/extratoProdutor/romaneiosFixar

Consultar extratos de romaneios a fixar

GET api/v1/extratoProdutor/vendasAgricolas

Consultar extrato de vendas agrícolas

GET api/v1/extratoProdutor/saldoCompraFutura

Consultar saldo de compra futura

Cidade

[Reserva de veículo] Endpoints relacionados a cidade

APIDescription
GET api/v1/cidade?cidade={cidade}

Consulta cidades com base no termo fornecido em cidade

GET api/v1/cidade/local?codigoIbge={codigoIbge}

Consulta filiais de uma cidade buscando pelo código ibge

User

Controle de acesso e cadastro de usuários

APIDescription
GET api/v1/user/enrollments/used/{enrollment}

No documentation available.

GET api/v1/user/notifications

Geth the last user notifications

GET api/v1/user/image

Geth the user image

GET api/v1/user

Get Logged User Info, the roles, and enrollment that users can login

GET api/v1/user/suggestionsenrollments?companyId={companyId}

List all enrollments associated to the user´s document for suggest to register. If companyId parameters not sent, a default company will be used (CT: Lar Cooperativa)

GET api/v1/user/register/validate?document={document}&company={company}

Validate the user document to continue the registration process. Return true if the user is already registered

POST api/v1/user/changepassword

Change the user Password

POST api/v1/user/recoverypassword/request?isWhatsapp={isWhatsapp}

Request Password Recovery Validation Code (SMS notification)

POST api/v1/user/recoverypassword/validate

Validate the validation code

POST api/v1/user/recoverypassword/change

Recovery the User Password (with validation code)

POST api/v1/user/defaultenrollment

Set default User Enrollment

DELETE api/v1/user/enrollment/{enrollmentNumber}

Delete User Enrollment Association

POST api/v1/user/register/device?isWhatsapp={isWhatsapp}

Associate a new device to an existing user

POST api/v1/user/register/enrollment

No documentation available.

POST api/v1/user/image

Send a new user image

POST api/v1/user/register?isWhatsapp={isWhatsapp}

Add a User if is not added and link with the device

POST api/v1/user/register/simple?isWhatsapp={isWhatsapp}

Add a User Simple (Document not exist in Sicop/Lar - Only CT

POST api/v1/user/register/simple/validate

No documentation available.

DELETE api/v1/user/enrollment/used/{userId}

No documentation available.

POST api/v1/user/login/basic

Login user to Agricola Api

GET api/v1/user/basic?document={document}

Get user info to Agricola Api

POST api/v1/user/privacypolicy/accept

Accept privacy policy

DELETE api/v1/user/unregister

Unregister user

Login

APIDescription
GET api/v1/login/basicauthtoken

Generate Basic Access Token

POST api/v1/login/changeaccount

Change active Enrollment

POST api/v1/login

Login to Aplication

PedidosInsumos

APIDescription
GET api/v1/insumos/pedidos/{rsnPedido}

Obtém um pedido

GET api/v1/insumos/pedidos/{rsnPedido}/compras?select={select}&expand={expand}&filter={filter}&top={top}&skip={skip}&orderby={orderby}&count={count}

Obtém insumos com pendências para retirada

EntregaFutura

Compras de Insumos

APIDescription
GET api/v1/insumos/pendentes?dataInicial={dataInicial}&dataFinal={dataFinal}&nomeProduto[0]={nomeProduto[0]}&nomeProduto[1]={nomeProduto[1]}&codigoGrupo[0]={codigoGrupo[0]}&codigoGrupo[1]={codigoGrupo[1]}&codigoCultura[0]={codigoCultura[0]}&codigoCultura[1]={codigoCultura[1]}&codigoGrupoInsumos[0]={codigoGrupoInsumos[0]}&codigoGrupoInsumos[1]={codigoGrupoInsumos[1]}&safra[0]={safra[0]}&safra[1]={safra[1]}&filtroEntregaFutura={filtroEntregaFutura}&select={select}&expand={expand}&filter={filter}&top={top}&skip={skip}&orderby={orderby}&count={count}

Obtém insumos com pendências para retirada

GET api/v1/insumos/pendentes/total?dataInicial={dataInicial}&dataFinal={dataFinal}&nomeProduto[0]={nomeProduto[0]}&nomeProduto[1]={nomeProduto[1]}&codigoGrupo[0]={codigoGrupo[0]}&codigoGrupo[1]={codigoGrupo[1]}&codigoCultura[0]={codigoCultura[0]}&codigoCultura[1]={codigoCultura[1]}&codigoGrupoInsumos[0]={codigoGrupoInsumos[0]}&codigoGrupoInsumos[1]={codigoGrupoInsumos[1]}&safra[0]={safra[0]}&safra[1]={safra[1]}&filtroEntregaFutura={filtroEntregaFutura}

Obtém insumos com pendências para retirada

Estatistica

[Reserva de veículo] Obtém estatística de reserva dos veículos

APIDescription
GET api/v1/reserva-veiculo/estatistica/quantidade

Obtém a quantidade total de veículos que a logistica possui

GET api/v1/reserva-veiculo/estatistica/anual

Obtém estatística das reservas de veículos anualmente

GET api/v1/reserva-veiculo/estatistica/mensal

Obtém estatística das reservas de veículos mensalmente

GET api/v1/reserva-veiculo/estatistica/top10

Obtém estatística top 10 condutores e cidades das reservas de veículos

Piscicultura

Dados sobre a Piscicultura

APIDescription
GET api/v1/piscicultura/tanques

Listar tanques

GET api/v1/piscicultura/tanque/lotes?tanque={tanque}

Listar lotes de um tanque

GET api/v1/piscicultura/detalhes-gerais?tanque={tanque}&lote={lote}

Obter detahes gerais de um lote

GET api/v1/piscicultura/mortalidade?nrTanque={nrTanque}&nrLote={nrLote}

Obter mortalidades

PUT api/v1/piscicultura/mortalidade

Adição e alterações nas mortalidades

CadastroAnaliseCreditoPF

Dados sobre a associado para analise e cadastro de analise

APIDescription
GET api/v1/analisecredito/cadastro/associado/{matricula}

Buscar do associado para analise e posteriormente alteração de dados do cadastro

GET api/v1/analisecredito/cadastro/dependentes/{matricula}

Buscar dos dependentes do associado para analise e posteriormente alteração de dados do cadastro

GET api/v1/analisecredito/cadastro/propriedade/associado/{matricula}

Buscar as Propriedades vinculadas ao associado

GET api/v1/analisecredito/cadastro/detalhes/propriedade/{matricula}/{propriedade}

Buscar os Detalhes da Propriedade vinculadas ao associado

GET api/v1/analisecredito/cadastro/ocupacao/{matricula}

Buscar os Detalhes da Propriedade vinculadas ao associado

GET api/v1/analisecredito/cadastro/dividas/{matricula}

Buscar as dividas vinculadas ao associado

GET api/v1/analisecredito/cadastro/dividasterceiro/{matricula}

Buscar as dividas vinculadas a terceiro e associados

GET api/v1/analisecredito/cadastro/garantia/{matricula}

Buscar as dividas vinculadas a terceiro e associados

DocGenerator

Dados sobre os Contratos CPRFs

APIDescription
POST api/v1/docgenerator/contracts/generator/character

Gerar documento apartiir de personagens

POST api/v1/docgenerator/contracts/generator

Gera o Documento apartir de templates salvos no Banco e de dados inseridos na Front-End

POST api/v1/docgenerator/generator/new/character

Gerar Characters

POST api/v1/docgenerator/pessoafisica

Buscar dados pessoa fisica

POST api/v1/docgenerator/contracts/generator/pdf

Gera o documento PDF apartir de um contrato ja salvo no Banco

GET api/v1/docgenerator/character

Buscar todos os contratos salvos

PUT api/v1/docgenerator/character

Salva a Alteração e Buscar todos os contratos salvos

POST api/v1/docgenerator/character

Salva e Buscar todos os contratos salvos

DELETE api/v1/docgenerator/character

Salva e Buscar todos os contratos salvos

POST api/v1/docgenerator/contracts/filters/{isCharacter}

Salva e Buscar todos os contratos salvos

GET api/v1/docgenerator/contracts/Id/{Id}

Busca pelo Id

GET api/v1/docgenerator/contracts/filial/{filial}

Buscar todos os contratos salvos

GET api/v1/docgenerator/contracts/{numero}

Busca pelo numero do contrato

GET api/v1/docgenerator/contracts/{unidade}/{analisado}

Buscar todos por local e se esta analizado ou não

PUT api/v1/docgenerator/contracts

Salva a Alteração e Buscar todos os contratos salvos

POST api/v1/docgenerator/contracts

Salva e Buscar todos os contratos salvos

DELETE api/v1/docgenerator/contracts

Salva e Buscar todos os contratos salvos

GET api/v1/docgenerator/contracts/source

Buscar todos os contratos Padroes salvos

PUT api/v1/docgenerator/contracts/source

Salva a Alteração e Buscar todos os contratos Padroes salvos

POST api/v1/docgenerator/contracts/source

Salva e Buscar todos os contratos Padroes salvos

DELETE api/v1/docgenerator/contracts/source

Salva e Buscar todos os contratos Padroes salvos

POST api/v1/docgenerator/contrato/cadastro/new

Criar Contrato PECPR

GET api/v1/docgenerator/status/{id}

Busca pelo Id

GET api/v1/docgenerator/status

Buscar todos os Status salvos

GET api/v1/docgenerator/status/dashboard

Buscar dados do Dashboard salvos

GET api/v1/docgenerator/status/dashboard/safra

Buscar dados do Dashboard safra salvos

PUT api/v1/docgenerator/status

Salva a Alteração e Buscar todos os Status salvos

POST api/v1/docgenerator/status

Salva e Buscar todos os Status salvos

DELETE api/v1/docgenerator/status?id={id}

Salva e Buscar todos os Status salvos

GET api/v1/docgenerator/anexosource

Buscar todos os Anexos Padrão salvos

PUT api/v1/docgenerator/anexosource

Salva a Alteração e Buscar todos os Anexos Padrão salvos

POST api/v1/docgenerator/anexosource

Salva e Buscar todos os Anexos Padrão salvos

DELETE api/v1/docgenerator/anexosource

Salva e Buscar todos os Anexos Padrão salvos

DELETE api/v1/docgenerator/integrante

Deleta um registro e Buscar todos os Integrantes salvos

GET api/v1/docgenerator/cadastro

Buscar todos os Cadastro Padrão salvos

PUT api/v1/docgenerator/cadastro

Salva a Alteração e Buscar todos os Cadastro Padrão salvos

POST api/v1/docgenerator/cadastro

Salva e Buscar todos os Cadastro Padrão salvos

DELETE api/v1/docgenerator/cadastro

Salva e Buscar todos os Cadastro Padrão salvos

GET api/v1/docgenerator/integrante/numerocontrato/{numero}

Buscar todos os Integrantes por numero do contrato

GET api/v1/docgenerator/integrante

Buscar todos os Integrantes salvos

PUT api/v1/docgenerator/integrante

Salva a Alteração e Buscar todos os Integrantes Padrão salvos

POST api/v1/docgenerator/integrante/many

Salva uma lista de Integrantes

POST api/v1/docgenerator/package/file/many/{filt}

Salva e retorna uma lista filtrada de files

POST api/v1/docgenerator/integrante

Salva e Buscar todos os Integrante salvos

GET api/v1/docgenerator/package/file/filter/id/{filter}

Buscar todos os files salvos

GET api/v1/docgenerator/package/file

Buscar todos os files salvos

PUT api/v1/docgenerator/package/file/{filt}

Salva a Alteração e retorna uma lista filtrada de files

POST api/v1/docgenerator/package/file/{filt}/{type}

Salva e retorna uma lista filtrada de files

DELETE api/v1/docgenerator/package/file/{filt}/{id}

Deleta um registro e Buscar todos os files salvos

GET api/v1/docgenerator/anexo/unidade/{unidade}/{analisado}

Buscar todos por local e se esta analizado ou não

GET api/v1/docgenerator/anexo/{id}

Buscar pelo Id

GET api/v1/docgenerator/anexo/analise

Buscar todos os Anexos salvos sem analise

GET api/v1/docgenerator/anexo

Buscar todos os Anexos salvos

PUT api/v1/docgenerator/anexo

Salva a Alteração e Buscar todos os Anexos salvos

POST api/v1/docgenerator/anexo

Salva e Buscar todos os Anexos salvos

DELETE api/v1/docgenerator/anexo

Salva e Buscar todos os Anexos salvos

POST api/v1/docgenerator/cerc/registrar/{numeroCedula}

Registrar Cédula na Cerc

GET api/v1/docgenerator/cerc/info/registro/{numeroCedula}

Obter informações do registro da Cédula na Cerc

GET api/v1/docgenerator/cerc/carteiras

Obter Carteiras Cerc

PUT api/v1/docgenerator/cerc/cancelar/{idRegistro}

Cancelar registro na Cerc

GET api/v1/docgenerator/cerc/{assing}

Buscar Contratos sem registro

Midia

APIDescription
GET api/v1/midia/areas

No documentation available.

GET api/v1/midia/area/{id}

No documentation available.

Device

Controle de acesso e cadastro de dispositivos

APIDescription
GET api/v1/device/register/validate?deviceUID={deviceUID}

Validate if the device is registered

GET api/v1/device/register/validate?deviceUID={deviceUID}&platform={platform}&appIdentifier={appIdentifier}&appVersion={appVersion}

Validate if the device is registered and check Version

GET api/v1/device/register/validate/checkversion?deviceUID={deviceUID}&platform={platform}&appIdentifier={appIdentifier}&appVersion={appVersion}

Validate if the device is registered and check Version

POST api/v1/device/register

Add new devices

POST api/v1/device/pushnotificationtoken

No documentation available.

POST api/v1/device/validate

Validar o código de autorização do dispositivo e usuário

POST api/v1/device/resend/validationcode?isWhatsapp={isWhatsapp}

No documentation available.

Filial

APIDescription
GET api/v1/filial/empresas/basic

Consultar todas as empresas

GET api/v1/filial/unidades/basic?empresa={empresa}

Consultar todas as filiais de determinada empresa

GET api/v1/filial/unidades/cotacoes/basic?empresa={empresa}

Consultar todas as filiais que possuem cotações de preços dos produtos agrícolas de determinada empresa

GET api/v1/filial/setores/basic?empresa={empresa}&filial={filial}

Consultar todos os setores de determinada empresa e filial

Historico

[Reserva de veículo] Obtém dados relacionado ao histórico de reserva dos veículo

APIDescription
GET api/v1/reserva-veiculo/historico?data={data}

Obtém o histórico de reservas por data

GET api/v1/reserva-veiculo/historico/cancelamento

Obtém o histórico de cancelamento dos últimos 90 dias

Caktoos

Dados sobre a Caktoos

APIDescription
GET api/v1/caktoos/licencas/produtor?matricula={matricula}

Buscar dados de avaliação do aviário

Helper

Utilitários do sistema

APIDescription
GET api/v1/helper/errors

Códigos de erros de retorno padronizados (Enum)

GET api/v1/helper/relationshiptypes

Tipos de Matriculas

GET api/v1/helper/branchs?company={company}

Tipos de Matriculas

GET api/v1/helper/efpool

Entity Framework Pool Status

GET api/v1/helper/mimetype

Get MimeType from imagem base64

PATCH api/v1/helper/update/enrollments/users/py

Atualiza matriculas base de dados SicopPlusApi com base no codigo interno do associado no Dolphin. Retorna as matriculas NAO ATUALIZADAS

PATCH api/v1/helper/update/enrollments/py

Atualiza matriculas base de dados SicopPlusApi com base no nome do dona da matricula

Carona

[Reserva de veículo] Consulta, insere, atualiza e excluir caronas de reserva

APIDescription
GET api/v1/reserva-veiculo/carona?dataReserva={dataReserva}

Consultar carona de uma reserva

POST api/v1/reserva-veiculo/carona

Adicionar carona a uma reserva

PATCH api/v1/reserva-veiculo/carona

Atualizar carona a uma reserva

DELETE api/v1/reserva-veiculo/carona

Excluir carona de uma reserva

Communication

APIDescription
GET api/v1/communication/radio

No documentation available.

Larcard

Dados de Larcard

APIDescription
GET api/v1/larcard/extrato/cesta?data={data}

Get "food ticket" extract

GET api/v1/larcard/extrato/larcard?data={data}

Get larcard extract

GET api/v1/larcard/extrato/larcard/simplificado?data={data}

Get larcard extract

DELETE api/v1/larcard/cartao/impressao/{matricula}

Cancelar pedido de emissão de cartão em aberto.

GET api/v1/larcard/cartao/impressao

Buscar lista de cartões pendentes de impressão

GET api/v1/larcard/cartao/{matricula}

Buscar dados para realizar manutenção no cartão

GET api/v1/larcard/opcoes/diapagamento

Opções de dia de pagamento do cartão

GET api/v1/larcard/opcoes/formapagamento

Opções de forma de pagamento

GET api/v1/larcard/opcoes/tipopagamento

Opções de tipo de pagamento

GET api/v1/larcard/opcoes/motivobloqueio

Opções de motivo de bloqueio de cartão

GET api/v1/larcard/opcoes/reemissao

Opções de reemissao de cartão

GET api/v1/larcard/opcoes/tipoconvenio

Opções de tipo de convênio

GET api/v1/larcard/cartao/senha/recuperar

Listar pedidos de recuperação de senhas pendentes

GET api/v1/larcard/cartao/senha/{id}

Buscar dados de pedido de recuperação de senha para avaliação

PUT api/v1/larcard/cartao/{matricula}

Alterar dados de manutenção do cartão. Para não alterar o valor, submeter valor atual. Para limpar o valor (alguns campos), submeter nulo.

PUT api/v1/larcard/cartao/bloqueio

Bloquear e desbloquear o cartão. Usuário só pode bloquear por motivo específico. Unidades Lar só realizam bloqueio. Financeiro do Centro Adm pode Bloquear e Desbloquear.

PUT api/v1/larcard/cartao/bloqueiousuario

Bloquear e desbloquear o cartão. Usuário só pode bloquear por motivo específico. Unidades Lar só realizam bloqueio. Financeiro do Centro Adm pode Bloquear e Desbloquear.

POST api/v1/larcard/cartao/cadastrar

Realizar o cadastro de um novo cartão, para associados ou clientes terceiros.

POST api/v1/larcard/cartao/senha

Criar uma nova senha para o cartão, tenho um código de validação. Não é necessário conhecer a senha atual. Funcionalidade pode ser consumida em caso de novo cartão ou após pedido e aprovação (pela Lar) de recuperação de senha. Código é recebido no celular por SMS.

POST api/v1/larcard/cartao/contrato

Solicitar impressão de contrato do cartão, para associados e clientes.

POST api/v1/larcard/cartao/senha/recuperar

Realizar o pedido de recuperação de senha do cartão (pelo usuário). Este pedido será avaliado pela Lar para então ser aprovado ou recusado. A resposta será enviada via SMS depois da avaliação. Para recuperar a senha, chamar o método específico.

POST api/v1/larcard/cartao/impressao

Solicitar reemissao do cartão Larcard, em caso de perca, cartão danificado, etc... É necessário criar uma nova senha neste caso.

PUT api/v1/larcard/cartao/limite

Alteração do limite do cartão

PUT api/v1/larcard/cartao/senha

Alterar a senha do cartão, conhecendo a senha atual.

PUT api/v1/larcard/cartao/senha/recuperar

Realizar a avaliação

GET api/v1/larcard/cartao/status?matricula={matricula}

Consultar status atual do Larcard

GET api/v1/larcard/cartao/funcionario/limite

Obter dados para alteração do limite via Lar Digital

PUT api/v1/larcard/cartao/funcionario/limite

Alterar dados do limite via Lar Digital

Document

Handle User Documents

APIDescription
GET api/v1/documents/nfe?documentKey={documentKey}

Get Document NFe

GET api/v1/documents/nfe?local={local}&numeroNota={numeroNota}&serie={serie}

Get Document NFe

GET api/v1/documents/nfe/documentkey?documentKey={documentKey}

Get Document NFe by Document Key

GET api/v1/documents/nfe/documentnumber?local={local}&numeroNota={numeroNota}&serie={serie}

Get Document NFe by Document Number

GET api/v1/documents/nfe/documentnumbergranja?local={local}&numeroNota={numeroNota}&serie={serie}&granja={granja}

Get Document NFe by Document Number

GET api/v1/documents/reports/fechamentolote/aves?aviario={aviario}&lote={lote}

Get Document NFe

GET api/v1/documents/reports/fechamentolote/aves/parceiro?aviario={aviario}&lote={lote}

Get Document NFe

GET api/v1/documents/reports/bordero/suino?granja={granja}&lote={lote}

Get Document NFe

GET api/v1/documents/reports/carteirinha/associado

Get Document NFe

GET api/v1/documents/reports/extrato-imposto-de-renda?year={year}

Extrato Imposto de Renda (Do usuário logado)

GET api/v1/documents/nfeterceiros/{documentKey}

Get Document NFe Terceiros

GET api/v1/documents/nfeterceiros/danfe/{documentKey}

Get Document NFe Terceiros

GET api/v1/documents/checklist-verificacao-de-materiais?nucleo={nucleo}

Obtem o pdf de um forms

GET api/v1/documents/relatorio-controle-de-roedores?aviario={aviario}&tipoFormulario={tipoFormulario}

Obtem o pdf de um forms

GET api/v1/documents/relatorio-controle-de-agua?aviario={aviario}

Obtem o pdf do relatorio controle de agua

GET api/v1/documents/relatorio-temperatura-e-umidade?aviario={aviario}

Obtem o pdf do relatorio de temperatura e umidade

GET api/v1/documents/reports/romaneios?DataInicial={DataInicial}&DataFinal={DataFinal}&InscrEst={InscrEst}&Status={Status}&NrArm={NrArm}

Get Document Romaneios

GET api/v1/documents/assinatura-digital/associado/assinatura/documentos

Get Assinatura digital

ComprasInsumos

Compras de Insumos

APIDescription
GET api/v1/insumos/compras?dataInicial={dataInicial}&dataFinal={dataFinal}&nomeProduto[0]={nomeProduto[0]}&nomeProduto[1]={nomeProduto[1]}&codigoGrupo[0]={codigoGrupo[0]}&codigoGrupo[1]={codigoGrupo[1]}&codigoCultura[0]={codigoCultura[0]}&codigoCultura[1]={codigoCultura[1]}&codigoGrupoInsumos[0]={codigoGrupoInsumos[0]}&codigoGrupoInsumos[1]={codigoGrupoInsumos[1]}&safra[0]={safra[0]}&safra[1]={safra[1]}&filtroEntregaFutura={filtroEntregaFutura}&select={select}&expand={expand}&filter={filter}&top={top}&skip={skip}&orderby={orderby}&count={count}

Obtém aquisições de insumos por matrícula

GET api/v1/insumos/compras/total?dataInicial={dataInicial}&dataFinal={dataFinal}&nomeProduto[0]={nomeProduto[0]}&nomeProduto[1]={nomeProduto[1]}&codigoGrupo[0]={codigoGrupo[0]}&codigoGrupo[1]={codigoGrupo[1]}&codigoCultura[0]={codigoCultura[0]}&codigoCultura[1]={codigoCultura[1]}&codigoGrupoInsumos[0]={codigoGrupoInsumos[0]}&codigoGrupoInsumos[1]={codigoGrupoInsumos[1]}&safra[0]={safra[0]}&safra[1]={safra[1]}&filtroEntregaFutura={filtroEntregaFutura}

Obtém aquisições de insumos por matrícula

GET api/v1/insumos/compras/pedidos?dataInicial={dataInicial}&dataFinal={dataFinal}&nomeProduto[0]={nomeProduto[0]}&nomeProduto[1]={nomeProduto[1]}&codigoGrupo[0]={codigoGrupo[0]}&codigoGrupo[1]={codigoGrupo[1]}&codigoCultura[0]={codigoCultura[0]}&codigoCultura[1]={codigoCultura[1]}&codigoGrupoInsumos[0]={codigoGrupoInsumos[0]}&codigoGrupoInsumos[1]={codigoGrupoInsumos[1]}&safra[0]={safra[0]}&safra[1]={safra[1]}&filtroEntregaFutura={filtroEntregaFutura}&select={select}&expand={expand}&filter={filter}&top={top}&skip={skip}&orderby={orderby}&count={count}

Obter Pedidos por Cliente

GET api/v1/insumos/compras/filtros

Obter Opções para filtros