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
| Atributos | Descrição | Tipo | Obrigatório | Validações |
|---|---|---|---|---|
| producer_id | Identificador da Companhia Produtora | UUID | Sim | - |
| cooperative-id | Identificador da cooperativa | UUID | Sim | - |
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
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| producer_id | Identificador da Companhia Produtora | String | Sim |
Parâmetros de Cabeçalho
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| Authorization | Chave de autenticação da API | String | Sim |
| cooperative-id | Identificador da cooperativa | String | Sim |
Respostas
- 200 - Ok
[
{
"harvest_name": "string",
"product_name": "string",
"estimated_balance": 0.000,
"allocated_balance": 0.000,
"available_balance": 0.000
}
]
| Campo | Descrição | Tipo |
|---|---|---|
| harvest_name | Nome da safra | String |
| product_name | Nome do produto | String |
| estimated_balance | Saldo estimado de produção em toneladas, calculado com base na área e produtividade da safra | Decimal (3 casas) |
| allocated_balance | Saldo já alocado em negociações/compromissos, em toneladas | Decimal (3 casas) |
| available_balance | Saldo disponível para negociação (estimated_balance - allocated_balance), em toneladas | Decimal (3 casas) |
- 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
401 - Unauthorized
404 - Not Found