Skip to main content

Consultar saldo de produção por produto do produtor

Descrição: Retorna o saldo de produção (em toneladas) agregado por produto e safra de um produtor, incluindo saldo estimado, saldo alocado em negociações e saldo disponível.

Endpoint

GET/api/v1/integration/producers/{producer_id}:balanceByProduct

Regras

AtributosDescriçãoTipoObrigatórioValidações
producer_idIdentificador da Companhia ProdutoraUUIDSim-
cooperative-idIdentificador da cooperativaUUIDSim-

Exemplo de Requisição

Exemplo de Requisição
curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "cooperative-id: [[cooperativeId]]"\
-H "Accept: application/json"\
"https://homolog.api.merx.tech/api/v1/integration/producers/{producer_id}:balanceByProduct"

Parâmetros

Parâmetros de Caminho

NomeDescriçãoTipoObrigatório
producer_idIdentificador da Companhia ProdutoraStringSim

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationChave de autenticação da APIStringSim
cooperative-idIdentificador da cooperativaStringSim

Respostas

  • 200 - Ok
[
{
"harvest_name": "string",
"product_name": "string",
"estimated_balance": 0.000,
"allocated_balance": 0.000,
"available_balance": 0.000
}
]
CampoDescriçãoTipo
harvest_nameNome da safraString
product_nameNome do produtoString
estimated_balanceSaldo estimado de produção em toneladas, calculado com base na área e produtividade da safraDecimal (3 casas)
allocated_balanceSaldo já alocado em negociações/compromissos, em toneladasDecimal (3 casas)
available_balanceSaldo disponível para negociação (estimated_balance - allocated_balance), em toneladasDecimal (3 casas)
  • 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
  • 401 - Unauthorized

  • 404 - Not Found