Gerar Relatório CBIOS

Descrição: Gera um relatório CBIOS de acordo com os parâmetros informados. O relatório CBIOS (Créditos de Descarbonização) é utilizado para verificar a elegibilidade de propriedades rurais para a geração de créditos de carbono, analisando a supressão de vegetação nativa e a conformidade com os critérios do programa RenovaBio.

Endpoint

POST/api/v1/integration/cbios/report

Regras

Atributos	Descrição	Tipo	Obrigatório
producer_name	Nome do produtor	String	Sim
producer_document	Documento do produtor (CPF/CNPJ)	String	Sim
civil_year	Ano civil de referência	Integer	Sim
harvest_code	Código da safra	Integer	Sim
layer	Camada de análise (SOY ou CORN)	Enum	Sim
cars	Lista de códigos CAR	Array	Não
username	Nome do usuário	String	Não
name	Nome do relatório	String	Não
preserve_on_backoffice_history	Preservar no histórico do backoffice	Boolean	Não
preserve_result	Preservar resultado	Boolean	Não

Exemplo de Requisição

Exemplo de Requisição
curl -X POST \
-H "Authorization: [[apiKey]]" \
-H "cooperative-id: [[cooperativeId]]" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://homolog.api.merx.tech/api/v1/integration/cbios/report" \
--data '{
    "producer_name": "João da Silva",
    "producer_document": "12345678901",
    "civil_year": 2024,
    "harvest_code": 2024,
    "layer": "SOY",
    "cars": ["MT-5107925-7515B28AEE9240ACAB464D8DF624D470"]
}'

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Token de autenticação	String	Sim
cooperative-id	ID da cooperativa (UUID)	UUID	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório
producer_name	Nome do produtor	String	Sim
producer_document	Documento do produtor (CPF/CNPJ)	String	Sim
civil_year	Ano civil de referência	Integer	Sim
harvest_code	Código da safra	Integer	Sim
layer	Camada de análise. Valores: `SOY`, `CORN`	Enum	Sim
cars	Lista de códigos CAR para análise	Array	Não
username	Nome do usuário que está gerando o relatório	String	Não
name	Nome personalizado do relatório	String	Não
preserve_on_backoffice_history	Se deve preservar o relatório no histórico do backoffice	Boolean	Não
preserve_result	Se deve preservar o resultado do relatório	Boolean	Não

Dicionário de Dados da Resposta

Nome	Descrição	Tipo
layer	Camada de análise (SOY ou CORN)	Enum
civil_year	Ano civil de referência	Integer
harvest	Nome da safra	String
producer_data	Dados do produtor	Object
producer_data.document	Documento do produtor	String
producer_data.name	Nome do produtor	String
producer_data.dap_code	Código DAP	String
producer_data.caf_code	Código CAF	String
producer_data.ricaf_code	Código RICAF	String
cbios	Lista de resultados por CAR	Array
cbios[].property_data	Dados da propriedade	Object
cbios[].property_data.farm_name	Nome da fazenda	String
cbios[].property_data.car	Código CAR	String
cbios[].property_data.area	Área do imóvel em hectares	Number
cbios[].property_data.geometry	Geometria da propriedade (GeoJSON)	String
cbios[].property_data.centroid	Centróide da propriedade	String
cbios[].property_data.latitude	Latitude	Float
cbios[].property_data.longitude	Longitude	Float
cbios[].property_data.car_status	Status do CAR (AT, CA, SU, PE)	Enum
cbios[].property_data.car_status_updated_at	Data de atualização do status	DateTime
cbios[].car_declaration_sigef	Dados da declaração CAR/SIGEF	Object
cbios[].car_declaration_sigef.declared_area	Área declarada	Number
cbios[].car_declaration_sigef.legal_reserve_area	Área de reserva legal	Number
cbios[].car_declaration_sigef.permanent_protection_area	Área de proteção permanente	Number
cbios[].car_declaration_sigef.tax_modules	Módulos fiscais	Number
cbios[].car_declaration_sigef.analysis_date	Data de análise	String
cbios[].car_declaration_sigef.registration_date	Data de registro	String
cbios[].car_declaration_sigef.rectification_date	Data de retificação	String
cbios[].car_declaration_sigef.merx_updated_at	Data de atualização no Merx	DateTime
cbios[].productivity	Dados de produtividade	Array
cbios[].productivity[].crop	Cultura	String
cbios[].productivity[].harvest	Safra	String
cbios[].productivity[].planted_area	Área plantada	Number
cbios[].productivity[].layer	Camada (SOY ou CORN)	Enum
cbios[].productivity[].projected_productivity_year	Ano de produtividade projetada	Integer
cbios[].productivity[].projected_productivity	Produtividade projetada	Number
cbios[].productivity[].estimated_total_annual_production_year	Ano de produção total estimada	Integer
cbios[].productivity[].estimated_total_annual_production	Produção total anual estimada	Number
cbios[].cbios_data_information	Informações específicas CBIOS	Object
cbios[].cbios_data_information.native_area2017	Área nativa em 2017 (hectares)	Float
cbios[].cbios_data_information.native_area_civil_year	Área nativa no ano civil (hectares)	Float
cbios[].cbios_data_information.supressed_area	Área suprimida (hectares)	Float
cbios[].cbios_data_information.harvest_biomass_area	Área de biomassa da safra (hectares)	Float
cbios[].cbios_data_information.biomass_area_supressed	Área de biomassa suprimida (hectares)	Float
cbios[].cbios_data_information.harvest_supression	Houve supressão na safra. Valores: `SIM`, `NAO`, `NAO_APLICAVEL`	Enum
cbios[].cbios_data_information.cbios_status	Status CBIOS	Enum
cbios[].cbios_data_information.cbios_manual_status	Status CBIOS manual	Enum
cbios[].cbios_data_information.geometries	Geometrias relacionadas	Array
cbios[].cbios_data_information.geometries[].geometry_type	Tipo de geometria	Enum
cbios[].cbios_data_information.geometries[].geo_json	Geometria em formato GeoJSON	String
cbios[].cbios_data_information.geometries[].subtitle	Legenda da geometria	String

Valores de Enums

Status CBIOS

Valor	Descrição
NAO_ENCONTRADO	Não encontrado
ELEGIVEL	Elegível para geração de CBIOS
NAO_ELEGIVEL	Não elegível para geração de CBIOS
NAO_APLICAVEL	Não aplicável

Supressão na Safra (harvest_supression)

Valor	Descrição
SIM	Houve supressão de vegetação
NAO	Não houve supressão de vegetação
NAO_APLICAVEL	Não aplicável

Status CAR

Valor	Descrição
AT	Ativo
CA	Cancelado
SU	Suspenso
PE	Pendente

Layer (Camada)

Valor	Descrição
SOY	Soja
CORN	Milho

Geometry Type (Tipo de Geometria)

Valor	Descrição
SUPRESSED_AREA	Área suprimida
SOY_AREA	Área de soja
CORN_AREA	Área de milho
SOY_IN_ACCUMULATED_SUPPRESSION_AREA	Área de soja em supressão acumulada
CORN_IN_ACCUMULATED_SUPPRESSION_AREA	Área de milho em supressão acumulada
PERMANENT_PROTECTION_AREA	Área de proteção permanente
INDIGENOUS_AREA	Área indígena
CONSERVATION_UNIT_AREA	Área de unidade de conservação
QUILOMBOLA_AREA	Área quilombola

Respostas

200 - Ok

{
    "layer": "SOY",
    "producer_data": {
        "document": "12345678901",
        "name": "João da Silva",
        "dap_code": null,
        "caf_code": null,
        "ricaf_code": null
    },
    "cbios": [
        {
            "property_data": {
                "farm_name": "Fazenda São José",
                "car": "MT-5107925-7515B28AEE9240ACAB464D8DF624D470",
                "area": 500.50,
                "geometry": "{...}",
                "centroid": "POINT(-55.123 -15.456)",
                "latitude": -15.456,
                "longitude": -55.123,
                "car_status": "AT",
                "car_status_updated_at": "2024-01-10T00:00:00Z"
            },
            "car_declaration_sigef": {
                "declared_area": 500.50,
                "legal_reserve_area": 100.10,
                "permanent_protection_area": 25.25,
                "tax_modules": 5.5,
                "analysis_date": "2024-01-01",
                "registration_date": "2020-06-15",
                "rectification_date": null,
                "merx_updated_at": "2024-01-15T10:30:00Z"
            },
            "productivity": [
                {
                    "crop": "Soja",
                    "harvest": "2023/2024",
                    "planted_area": 350.00,
                    "layer": "SOY",
                    "projected_productivity_year": 2024,
                    "projected_productivity": 60.0,
                    "estimated_total_annual_production_year": 2024,
                    "estimated_total_annual_production": 21000.0
                }
            ],
            "cbios_data_information": {
                "native_area2017": 150.25,
                "native_area_civil_year": 145.50,
                "supressed_area": 4.75,
                "harvest_biomass_area": 350.00,
                "biomass_area_supressed": 0.0,
                "harvest_supression": "NAO",
                "cbios_status": "ELEGIVEL",
                "cbios_manual_status": null,
                "geometries": [
                    {
                        "geometry_type": "SOY_AREA",
                        "geo_json": "{\"type\":\"Polygon\",\"coordinates\":[...]}",
                        "subtitle": "Área de Soja 2023/2024"
                    }
                ]
            }
        }
    ],
    "civil_year": 2024,
    "harvest": "2023/2024"
}

400 - Bad Request

{
    "timestamp": "2024-01-15T10:30:00Z",
    "status": 400,
    "errors": [
        "producer_name is required",
        "producer_document is required"
    ]
}

401 - Unauthorized
404 - Not Found

Gerar Relatório CBIOS

Endpoint​

Regras​

Exemplo de Requisição​

Parâmetros​

Parâmetros de Cabeçalho​

Parâmetros do Corpo​

Dicionário de Dados da Resposta​

Valores de Enums​

Status CBIOS​

Supressão na Safra (harvest_supression)​

Status CAR​

Layer (Camada)​

Geometry Type (Tipo de Geometria)​

Respostas​