Boletagem
- Fluxo para criação de uma negociação
- Detalhes dos campos exigidos para a boletagem
Fluxograma
Detalhando o fluxograma
Para a criação de uma negociação na plataforma Merx, é necessário ter no mínimo 4 cadastros básicos já realizados: produtor, usuário interno (emissor da negociação), carteira e unidade de entrega. Caso ainda não tenha feito a integração, você pode acessar os seguintes links para mais detalhes:
Cadastro
Também disponibilizamos APIs que permitem realizar a consulta dessas entidades a partir de algumas informações. Ex: Você pode verificar se o produtor já existe, buscando através do CPF/CNPJ dele. Para obter as informações de como consultar essas entidades para verificar se já estão cadastradas em nossa plataforma, basta acessar os links abaixo:
Consulta
Uma vez estando de posse dos identificadores (ids - formato uuid) dessas 4 entidades — enviados nos campos producer_id, issuer_id, wallet_id e delivery_place_id — já é possível, informando mais algums campos, cadastrar uma negociação.
Para ter acesso a documentação da API de criação de negociação(boletagem), clique aqui!
Para melhor entendimento, descreveremos os campos necessários bem como o de/para
em nossa plataforma backoffice.
- order_type
Tipo da negociação: Esse campo permite as seguintes opções: COMPRA, VENDA, FIXACAO_COMPRA, FIXACAO_VENDA, FIXACAO_DEPOSITO, ANTECIPACAO, A_FIXAR
No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- product
Produto negociado: Campo de texto com o nome do produto (ex: SOJA, TRIGO, MILHO). A API não valida o valor contra uma lista fixa — o produto é resolvido por busca do nome, e um nome que não exista na plataforma faz a negociação ser recusada.
No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- modality
Modalidade da negociação: Esse campo permite as seguintes opções: BALCAO, DISPONIVEL, FUTURO, EXPORTACAO
No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- currency
Moeda utilizada na negociação: Campo de texto com o código da moeda (ex: BRL). A API não valida o valor contra uma lista fixa — a moeda é resolvida por busca do código. No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- price
Preço da negociação: Campo numérico referente ao valor negociado por unidade de medida selecionada. No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- unit_of_measurement
Unidade de medida da negociação: Campo de texto com o código da unidade (ex: SC, KG, TON). A API não valida o valor contra uma lista fixa. No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- amount
Volume da negociação: Campo numérico referente à quantidade na unidade de medida escolhida. No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- haverst
Safra do produto negociado: Campo de texto no padrão 'ano/ano' ou 'ano - Safrinha'. Ex: 2021/2022. O nome do campo é grafado haverst mesmo — mantenha essa escrita no corpo da requisição.
No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- initial_delivery_date
Data inicial da entrega: Data no padrão YYYY-MM-DD. Obrigatória apenas quando o order_type é COMPRA ou VENDA. No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- end_delivery_date
Data final da entrega: Data no padrão YYYY-MM-DD. Obrigatória apenas quando o order_type é COMPRA ou VENDA. No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- payday
Data do pagamento: Data no padrão YYYY-MM-DD. No backoffice esse campo pode ser localizado no cadastro de uma oferta:
- payment_type
Tipo do pagamento: Esse campo permite as seguintes opções: DINHEIRO, TROCA No backoffice esse campo pode ser localizado no cadastro de uma oferta:
Os campos acima são os que têm equivalente direto na tela de oferta do backoffice. A negociação também exige order_date e, quando o order_type é COMPRA, o objeto shipping (com shipping.type e, no caso de FOB, shipping.city e shipping.state). A lista completa de campos, tipos e obrigatoriedades condicionais está em Criar Nova Negociação.