Gerar Relatório 2BSVS

Descrição: Gera um relatório 2BSVS de acordo com os parâmetros informados. O relatório 2BSVS (Biomass-Based Voluntary Sustainability) é utilizado para verificar a conformidade de propriedades rurais com critérios de sustentabilidade, incluindo análises de desmatamento, áreas de proteção permanente, reservas legais e outros indicadores ambientais.

Endpoint

POST/api/v1/integration/bsvs/report

Regras

Atributos	Descrição	Tipo	Obrigatório
producer_name	Nome do produtor	String	Sim
cooperative_name	Nome da cooperativa	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	Sim
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

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/bsvs/report" \
--data '{
    "producer_name": "João da Silva",
    "cooperative_name": "Cooperativa ABC",
    "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
cooperative_name	Nome da cooperativa	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

Dicionário de Dados da Resposta

Nome	Descrição	Tipo
created_at	Data de criação do relatório	DateTime
report_request_id	ID único da requisição do relatório	UUID
cooperative_id	ID da cooperativa	UUID
cooperative_name	Nome da cooperativa	String
civil_year	Ano civil de referência	Integer
harvest	Nome da safra	String
layer	Camada de análise (SOY ou CORN)	Enum
error	Mensagem de erro, se houver	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
bsvs	Lista de resultados por CAR	Array
bsvs[].property_data	Dados da propriedade	Object
bsvs[].property_data.farm_name	Nome da fazenda	String
bsvs[].property_data.car	Código CAR	String
bsvs[].property_data.area	Área do imóvel em hectares	Number
bsvs[].property_data.geometry	Geometria da propriedade (GeoJSON)	String
bsvs[].property_data.centroid	Centróide da propriedade	String
bsvs[].property_data.latitude	Latitude	Float
bsvs[].property_data.longitude	Longitude	Float
bsvs[].property_data.car_status	Status do CAR (AT, CA, SU, PE)	Enum
bsvs[].property_data.car_status_updated_at	Data de atualização do status	DateTime
bsvs[].car_declaration_sigef	Dados da declaração CAR/SIGEF	Object
bsvs[].car_declaration_sigef.declared_area	Área declarada	Number
bsvs[].car_declaration_sigef.legal_reserve_area	Área de reserva legal	Number
bsvs[].car_declaration_sigef.permanent_protection_area	Área de proteção permanente	Number
bsvs[].car_declaration_sigef.tax_modules	Módulos fiscais	Number
bsvs[].productivity	Dados de produtividade	Array
bsvs[].productivity[].crop	Cultura	String
bsvs[].productivity[].harvest	Safra	String
bsvs[].productivity[].planted_area	Área plantada	Number
bsvs[].productivity[].layer	Camada (SOY ou CORN)	Enum
bsvs[].productivity[].projected_productivity	Produtividade projetada	Number
bsvs[].productivity[].estimated_total_annual_production	Produção total anual estimada	Number
bsvs[].bsvs_data_information	Informações específicas 2BSVS	Object
bsvs[].bsvs_data_information.conservation_unit_area	Área em unidade de conservação	Number
bsvs[].bsvs_data_information.conservation_unit_status	Status da unidade de conservação	Enum
bsvs[].bsvs_data_information.indigenous_area	Área indígena	Number
bsvs[].bsvs_data_information.indigenous_area_status	Status da área indígena	Enum
bsvs[].bsvs_data_information.quilombola_area	Área quilombola	Number
bsvs[].bsvs_data_information.quilombola_area_status	Status da área quilombola	Enum
bsvs[].bsvs_data_information.biomass_area	Área de biomassa	Number
bsvs[].bsvs_data_information.biomass_status	Status da biomassa	Enum
bsvs[].bsvs_data_information.app_area	Área de APP	Number
bsvs[].bsvs_data_information.biomass_app_area	Área de biomassa em APP	Number
bsvs[].bsvs_data_information.biomass_app_status	Status da biomassa em APP	Enum
bsvs[].bsvs_data_information.accumulated_supression	Supressão acumulada	Number
bsvs[].bsvs_data_information.biomass_supression_area	Área de supressão de biomassa	Number
bsvs[].bsvs_data_information.biomass_supression_status	Status da supressão de biomassa	Enum
bsvs[].bsvs_data_information.biomass_supression_eligibility	Elegibilidade da supressão de biomassa	Enum
bsvs[].bsvs_data_information.biomass_total_production	Produção total de biomassa	Number
bsvs[].layer_esg_data	Dados de camadas ESG	Array
bsvs[].layer_esg_data[].embargo_type	Tipo de embargo	String
bsvs[].layer_esg_data[].layer_name	Nome da camada	String
bsvs[].layer_esg_data[].esg_status	Status ESG	Enum
bsvs[].layer_esg_data[].total_area	Área total	Number
bsvs[].layer_esg_data[].total_issues	Total de apontamentos	Integer
bsvs[].environmental_protection_layers	Camadas de proteção ambiental	Array
bsvs[].environmental_protection_layers[].layer_name	Nome da camada	String
bsvs[].environmental_protection_layers[].total_area	Área total	Number
bsvs[].environmental_protection_layers[].total_issues	Total de apontamentos	Integer
bsvs[].environmental_protection_layers[].environmental_protection_status	Status de proteção ambiental	Enum
bsvs[].permanent_protection_areas	Áreas de proteção permanente	Array
bsvs[].permanent_protection_areas[].area	Área em hectares	Number
bsvs[].permanent_protection_areas[].city	Cidade	String
bsvs[].permanent_protection_areas[].state	Estado	String
bsvs[].permanent_protection_areas[].description	Descrição	String

Valores de Enums

Status 2BSVS

Valor	Descrição
CONFORME	Propriedade em conformidade
NAO_CONFORME	Propriedade não conforme
NAO_APLICAVEL	Não aplicável
NAO_ELEGIVEL	Não elegível
ELEGIVEL	Elegível
NAO_ENCONTRADO	Não encontrado

Status CAR

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

Layer (Camada)

Valor	Descrição
SOY	Soja
CORN	Milho

Respostas

200 - Ok

{
    "created_at": "2024-01-15T10:30:00Z",
    "report_request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cooperative_id": "12345678-1234-1234-1234-123456789012",
    "cooperative_name": "Cooperativa ABC",
    "producer_data": {
        "document": "12345678901",
        "name": "João da Silva",
        "dap_code": null,
        "caf_code": null,
        "ricaf_code": null
    },
    "bsvs": [
        {
            "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
            },
            "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
                }
            ],
            "bsvs_data_information": {
                "conservation_unit_area": 0.0,
                "conservation_unit_status": "CONFORME",
                "indigenous_area": 0.0,
                "indigenous_area_status": "CONFORME",
                "quilombola_area": 0.0,
                "quilombola_area_status": "CONFORME",
                "biomass_area": 125.35,
                "biomass_status": "APLICAVEL",
                "app_area": 25.25,
                "biomass_app_area": 0.0,
                "biomass_app_status": "CONFORME",
                "accumulated_supression": 0.0,
                "biomass_supression_area": 0.0,
                "biomass_supression_status": "CONFORME",
                "biomass_supression_eligibility": "ELEGIVEL",
                "biomass_total_production": 21000.0
            },
            "layer_esg_data": [
                {
                    "embargo_type": "EMBARGOS_IBAMA",
                    "layer_name": "IBAMA - EMBARGOS",
                    "esg_status": "CONFORME",
                    "total_area": 0.0,
                    "total_issues": 0
                }
            ],
            "environmental_protection_layers": [
                {
                    "environmental_protection_layer_enum": "UNIDADE_CONSERVACAO",
                    "layer_name": "Unidades de Conservação",
                    "total_area": 0.0,
                    "total_issues": 0,
                    "environmental_protection_status": "CONFORME"
                }
            ],
            "permanent_protection_areas": []
        }
    ],
    "civil_year": 2024,
    "harvest": "2023/2024",
    "layer": "SOY",
    "error": null
}

400 - Bad Request

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

401 - Unauthorized
404 - Not Found

Gerar Relatório 2BSVS

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 2BSVS​

Status CAR​

Layer (Camada)​

Respostas​