Monde API (V3)

Dúvidas e suporte: suporte@monde.com.br

Bem-vindo a API da Monde! Essa documentação detalha os endpoints disponíveis para você integrar seu sistema conosco.

Sobre a API V3

  • A URL base para as requisições é https://web.monde.com.br/api/v3.
  • As credenciais de autenticação serão fornecidas pela agência de viagens com a qual você está se integrando.
  • A API opera conforme os princípios RESTful, utilizando o formato JSON.
  • Seguimos a especificação OpenAPI; você pode baixar a documentação da API aqui para visualização em outras ferramentas.
  • Cada campo na API tem um tipo específico. Exemplos: string, integer, float, boolean, etc.
  • Os campos de data devem ter o formato ISO 8601 (AAAA-MM-DD). Exemplo: "2024-08-01".
  • Os campos do tipo float devem utilizar um ponto (.) como separador decimal, apenas nas últimas duas casas. Exemplo: 99999.99.
  • Os campos obrigatórios estão especificados como required.
  • O texto vazio ("") é um valor de texto: no campo de texto, é gravado como foi enviado, e no campo de texto obrigatório é recusado (422). Em campo de outro tipo (objeto, lista, número, booleano, data, opção ou referência por id), "" é recusado (422).
  • Na alteração (PATCH), o campo omitido fica como está, e o enviado como null tem o valor retirado. O campo que o registro não pode ficar sem recusa o null (422).

Disponibilidade dos endpoints

Cada endpoint tem uma etiqueta que indica se você já pode utilizá-lo:

  • Beta (laranja): já disponível para uso, mas ainda em fase de testes e ajustes. Pode sofrer alterações.
  • Em desenvolvimento (cinza): ainda não está pronto para uso. Está apenas documentado, como referência do que temos planejado, e ainda pode sofrer alterações.

Autenticação

Para acessar os endpoints, é necessário enviar uma credencial válida no cabeçalho Authorization da requisição, com o esquema Bearer.

Exemplo de cabeçalho de autenticação:

Authorization: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Sobre a autenticação:

  • As credenciais serão geradas e fornecidas pela agência de viagens com a qual você está se integrando.
  • As credenciais não expiram, mas podem ser revogadas a qualquer momento pela agência de viagens.

Idempotência

Alguns endpoints desta API utilizam uma chave de idempotência (Idempotency-Key) para garantir que requisições duplicadas (por exemplo, por timeout ou tentativas automáticas) não sejam processadas mais de uma vez.

Como usar

  • A chave deve ser um UUID v4 válido (ex.: 550e8400-e29b-41d4-a716-446655440000).
  • Use a mesma chave ao repetir a mesma requisição (mesmo endpoint e mesmo corpo da requisição).
  • Use uma nova chave para cada operação diferente (corpo da requisição diferente).
  • A chave é válida por pelo menos 1 dia após a primeira requisição. Passado esse prazo, ela é descartada na limpeza seguinte, que roda uma vez por dia, e reenviá-la é processado como uma requisição nova.

Comportamento

  • Repetição (replay): se a mesma chave for reutilizada com o mesmo corpo da requisição e a requisição anterior já tiver sido processada, a API retorna a resposta em cache e inclui o cabeçalho X-Idempotent-Replay: true.
  • Requisição em processamento: se uma requisição com a mesma chave ainda estiver em processamento, a API retorna 409 Conflict.
  • Requisição recusada: se a requisição anterior terminou em recusa (por exemplo, um 422 Unprocessable Content), a chave volta a ficar disponível: reenviar a mesma requisição com a mesma chave é processado de novo.
  • Chave reutilizada com corpo diferente: se a mesma chave for reutilizada com um corpo (payload) diferente, a API retorna 422 Unprocessable Content.

Limites de requisição

Para manter o serviço estável para todos, esta API limita quantas requisições cada cliente pode fazer em um curto intervalo de tempo.

Limite

  • Até 10 requisições a cada 3 segundos, contadas por endereço IP de origem. Em IPv6, a contagem é por rede /64: todos os endereços da mesma rede /64 somam no mesmo limite.

Quando o limite é excedido

  • A API responde com 429 Too Many Requests e uma mensagem de erro.
  • Nenhuma requisição é processada enquanto o limite estiver excedido.

Recomendação

  • Ao receber um 429, aguarde antes de tentar novamente e use um tempo de espera crescente entre as tentativas (backoff exponencial).

Paginação

As consultas de lista devolvem uma página de registros por vez. O nó pagination da resposta diz o tamanho da página, se existe uma próxima e qual cursor pedir para chegar nela.

Percorrer a consulta inteira

  1. Faça a primeira requisição sem cursor.
  2. Enquanto has_next_page for true, repita a requisição enviando cursor com o valor de next_cursor da resposta anterior.
  3. Quando has_next_page for false, next_cursor vem nulo e a varredura terminou.

Tamanho da página

  • size define quantos registros vêm por página: de 1 a 50. Sem o parâmetro, são 20.

O cursor

  • É opaco: guarde e devolva o valor exatamente como veio, sem interpretar o conteúdo.
  • Vale para a consulta que o gerou: mantenha os mesmos filtros ao avançar. Um cursor que esta API não devolveu é recusado com 400.
  • Marca uma posição na consulta, não um instante: registros criados ou alterados durante a varredura podem entrar nas páginas seguintes.

Anexos

Operações de envio, download e exclusão de anexos associados a recursos.

Enviar anexo Beta

  • As requisições são limitadas por IP (até 10 requisições a cada 3 segundos). Ao exceder, a API retorna 429.
  • Ao repetir o mesmo envio, reutilize o Idempotency-Key e aplique backoff exponencial.
  • A credencial anexa na venda e na conta a pagar ou receber que ela mesma criou e, com a permissão de abrir as vendas de outros vendedores ou de acessar os lançamentos de outros usuários, nas demais. Pela conexão automática, essas permissões são exceção concedida na homologação; a conexão autorizada antes delas só anexa no que o parceiro criou. Fora desse alcance, o registro responde 422 como não encontrado quando a credencial tem a permissão de adicionar anexos mas não o lê, e 403 quando lê ou quando não tem a permissão de adicionar anexos.
  • Na venda, na conta a pagar ou receber e na pessoa, anexar exige também a permissão "Editar" do recurso (vendas, contas a pagar e receber, pessoas), na empresa do registro, como no Monde, em que anexar grava o cadastro; sem ela, a resposta é 403 com a mensagem do Monde.
  • Na viagem, anexar exige "Adicionar anexos" e "Criar e editar" de Viagens, na empresa da viagem. A credencial anexa na viagem que ela cadastrou ou de que criou uma venda e, com "Consultar vendas de outros vendedores/intermediários" de Vendas, nas demais.
  • Na tarefa, anexar exige "Adicionar anexos" e "Editar" de Tarefas, na empresa da tarefa (a tarefa sem empresa vale em qualquer uma). A credencial anexa na tarefa que ela criou e, com "Ver tarefas de outros usuários", nas demais.
Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "multipart/form-data"
Example: multipart/form-data

Tipo de conteúdo da requisição. Deve ser multipart/form-data.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: multipart/form-data
required
resource_type
required
string
Enum: "sale" "person" "bill" "travel" "task"

Recurso que irá receber o anexo: "sale" para uma venda, "person" para uma pessoa, "bill" para uma conta a pagar ou receber, "travel" para uma viagem, "task" para uma tarefa.

Exemplo: "sale"

resource_id
required
string <uuid>

ID do recurso que irá receber o anexo.

Exemplo: "cc36d5d7-b699-43f1-b081-24c15e2db5e8"

file
required
string <binary>

Arquivo binário a ser anexado.

  • Apenas 1 arquivo por requisição.
  • Extensões permitidas: .pdf, .doc, .docx, .odt, .xls, .xlsx, .ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic, .heif, .txt, .csv.
  • Tamanho máximo por arquivo: 12 MB.

description
string <= 255 characters

Descrição do anexo. Sem ela, vale o nome do arquivo sem a extensão. Os caracteres que o Windows não aceita em nome de arquivo (\ / : * ? " < > |) são trocados por hífen (-).

Responses

Request samples

Content type
multipart/form-data
{
  "resource_type": "sale",
  "resource_id": "c52a1c51-80e2-4a28-925e-2102a7b5d4e1",
  "file": "@voucher.pdf",
  "description": "voucher"
}

Response samples

Content type
application/json
{}

Renomear anexo Beta

Troca o nome do anexo, como o Renomear do Monde. Só o nome muda: o arquivo e o cadastro dono ficam como estão. O nome em branco é recusado com 422. Exige as mesmas permissões de anexar no cadastro dono: "Adicionar anexos" e "Editar" dele, com o alcance aos registros de outras origens que a credencial tem. O anexo de um registro que a credencial não alcança responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3

Identificador do anexo.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
required
string

Nome novo do anexo. Não pode ficar em branco.

Responses

Request samples

Content type
application/json
{
  • "description": "Comprovante de pagamento"
}

Response samples

Content type
application/json
{}

Excluir anexo Beta

Manda o anexo para a lixeira do registro, como no Monde, de onde ele pode ser restaurado. O anexo excluído some da consulta do registro e não é mais baixado.

Como no Monde, excluir pede só a permissão "Excluir anexos" do recurso dono do anexo, na empresa do registro (a pessoa, que não pertence a empresa, vale em qualquer empresa que grave), e o mesmo alcance de anexar:

  • anexo de venda: "Excluir anexos" de Vendas. A credencial alcança a venda que ela criou e, com "Abrir vendas de outros vendedores/intermediários", as demais;
  • anexo de conta a pagar e receber: "Excluir anexos" de Contas a Pagar e Receber. A credencial alcança a conta que ela criou e, com as permissões de acessar os lançamentos de outros usuários, as demais;
  • anexo de pessoa: "Excluir anexos" de Pessoas;
  • anexo de viagem: "Excluir anexos" de Viagens. A credencial alcança a viagem que ela cadastrou ou de que criou uma venda e, com "Consultar vendas de outros vendedores/intermediários" de Vendas, as demais;
  • anexo de tarefa: "Excluir anexos" de Tarefas. A credencial alcança a tarefa que ela criou e, com "Ver tarefas de outros usuários", as demais.
O anexo do registro fora do alcance da credencial responde 404.
Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3

Identificador do anexo.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Baixar anexo Beta

Redireciona (302) para um link temporário do arquivo, que expira em poucos minutos. Um novo acesso gera um novo link. O conteúdo é compactado em gzip e vem sem o cabeçalho Content-Encoding: descompacte antes de usar.

O download exige a permissão de leitura do registro dono do anexo, concedida na empresa dele quando ele tem uma:

  • anexo de tarefa, inclusive o de comentário: "Visualizar" de Tarefas;
  • anexo de venda: "Visualizar" de Vendas;
  • anexo de viagem: "Ler todas as viagens";
  • anexo de conta a pagar e receber: "Visualizar" de Contas a Pagar e Receber;
  • anexo de pessoa: "Visualizar" de Pessoas.
Baixar o anexo segue a consulta do registro dono dele: baixar pede a permissão "Visualizar" do recurso, também no que a própria credencial criou, e o anexo do registro de outro usuário pede também o alcance com que ela consulta o registro.

O endereço vem pronto no campo download_url dos anexos, na consulta por ID de cada um desses registros.
Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3

Identificador do anexo.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Vendas

Uma venda é um objeto que representa a comercialização de um ou mais produtos entre uma agência de viagens e seus clientes. Para vender o produto ao cliente, a agência pode adquiri-lo diretamente de um fornecedor ou através de um representante.

  • Fornecedor: empresa proprietária direta do produto. Exemplos: seguradoras, companhias de cruzeiros marítimos, companhias aéreas, hotéis, locadoras de veículos, entre outros. No Monde, um produto deve obrigatoriamente ter um fornecedor.
  • Representante: empresa responsável por intermediar a comercialização e distribuição do produto do fornecedor junto à agência de viagens. Os exemplos mais comuns são operadoras e consolidadoras. No Monde, um produto deve ter um representante quando a agência não comprou o produto diretamente do fornecedor.
  • Algumas operadoras e consolidadoras também podem ser proprietárias diretas de produtos, como pacotes de viagem, por exemplo. Nesses casos, elas são fornecedoras do produto para a agência de viagens.

A venda que a credencial criou é sempre dela; a dos outros vendedores pede as permissões Consultar, Abrir e Editar vendas de outros vendedores, como no Monde (veja as Perguntas frequentes).

Consultar vendas Beta

Retorna uma lista paginada de vendas. Por padrão, retorna apenas vendas abertas e fechadas; para incluir vendas excluídas (canceladas), utilize o parâmetro status.

Authorizations:
bearerAuthentication
query Parameters
date_field
string
Enum: "sale_date" "departure_date" "return_date"
Example: date_field=sale_date

Campo de data usado no filtro. Valores aceitos: sale_date (data da venda), departure_date (início da viagem) e return_date (fim da viagem). Obrigatório quando date_from ou date_to é informado.

date_from
string <date>
Example: date_from=2024-01-01

Filtrar vendas cujo campo escolhido em date_field seja igual ou posterior a esta data, no formato ISO 8601 (AAAA-MM-DD).

date_to
string <date>
Example: date_to=2024-12-31

Filtrar vendas cujo campo escolhido em date_field seja igual ou anterior a esta data, no formato ISO 8601 (AAAA-MM-DD).

status
Array of strings
Items Enum: "opened" "closed" "canceled"
Examples:
  • status=canceled - Filtrar por uma situação
  • status=opened,closed,canceled - Filtrar por múltiplas situações

Filtrar vendas por situação. Para múltiplas situações, separe os valores por vírgula (ex.: opened,closed,canceled). Valores aceitos: opened (aberta), closed (fechada) e canceled (excluída). Quando o parâmetro não é informado, a API retorna apenas vendas abertas e fechadas; vendas excluídas só são retornadas quando solicitadas explicitamente.

people_id
Array of strings <uuid> [ items <uuid > ]
Examples:
  • people_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 - Filtrar por uma pessoa
  • people_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91,3f1c9e20-5d7a-4b6c-9e2f-1a2b3c4d5e6f - Filtrar por várias pessoas

Filtrar vendas pela pessoa participante, informando o identificador (UUID) dela. A venda é retornada quando a pessoa aparece em qualquer papel: pagante, vendedor, intermediário, solicitante, aprovador, promotor, passageiro, fornecedor, representante ou quem cadastrou a venda. Para vários identificadores, separe-os por vírgula — a venda é retornada quando qualquer uma das pessoas participa dela.

number
integer
Example: number=1024

Filtrar vendas pelo número exibido no aplicativo (ex.: 1024). Um número por requisição.

updated_since
string <date-time>
Example: updated_since=2026-08-01T14:30:00

Filtrar vendas atualizadas neste instante ou depois dele, no formato ISO 8601. Aceita data (AAAA-MM-DD, cai no início do dia) ou data-hora (AAAA-MM-DDTHH:MM:SS). Sem fuso no valor, considera o horário de Brasília. Útil para reprocessar apenas o que mudou desde a última consulta, inclusive no mesmo dia. A venda volta quando muda o cabeçalho ou uma destas partes dela, que aparecem em Consultar venda por ID: produtos, passageiros, trechos e assentos, comissões, anexos, pagamentos e as contas vinculadas (inclusão, cancelamento e exclusão). A liquidação de uma conta só traz a venda quando muda a taxa cartão agência dos produtos (baixa ou estorno com taxa de cartão) ou quando é parcial e gera a conta do saldo. A mudança num cadastro que a venda só referencia (pessoa, produto do catálogo, fornecedor, função do comissionado) não traz a venda: esses dados se consultam nos endpoints de cada cadastro. A listagem traz o resumo da venda, e o detalhe vem de Consultar venda por ID. Para acompanhar também as vendas excluídas, envie status=opened,closed,canceled junto. Para não perder uma venda gravada por uma operação que terminou depois do corte, guarde o instante em que a consulta começou, antes da primeira página, e na consulta seguinte parta dele com uma folga de alguns minutos para trás, que cubra também a diferença entre o seu relógio e o horário de Brasília. Regrave cada venda pelo id: a mesma venda pode vir de novo, sem duplicar.

kind
Array of strings
Items Enum: "insurance" "cruise" "hotel" "airline_ticket" "train_ticket" "ground_transportation" "excursion" "visa" "car_rental" "travel_package" "cvc_package" "operation" "others"
Example: kind=airline_ticket

Filtrar vendas pelo tipo de produto, com os mesmos tipos de kind dos produtos. A venda entra quando tem algum produto não excluído do tipo informado. Para vários tipos, separe-os por vírgula — a venda entra quando tem produto de qualquer um deles.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir venda Beta

  • Ligue o que você enviou aos ids do Monde pelo local_id. Dê a cada produto e a cada pagamento um local_id, um nome seu, único na requisição. Na resposta, cada um volta com o id gerado ao lado desse local_id. Guarde o par: para alterar a venda depois, você aponta cada produto e pagamento pelo id. O local_id não é gravado e não volta na consulta da venda. Exemplo: você envia "insurances": [{ "local_id": "seguro-1", ... }] e recebe "insurances": [{ "id": "5d7e2a91-…", "local_id": "seguro-1", ... }]; na alteração, aponta esse seguro por { "id": "5d7e2a91-…" }. Vale igual para cada pagamento.
  • A venda deve conter pelo menos um produto.
  • Produtos suportados no momento: Seguro viagem, cruzeiro, diárias de hospedagem, bilhete de trem, transporte terrestre, locação de veículo, pacote de viagem e operação.
  • Envie status: closed para já criar a venda fechada, respeitando as regras de fechamento. Sem esse campo a venda nasce aberta.
  • Enviar commissions com alguma comissão exige também as permissões "Ver aba comissões" e "Adicionar comissões" de vendas, na empresa da venda, como no Monde; sem elas, a resposta é 403 com a mensagem do Monde, e a venda não é criada.
  • Com a configuração Não permitir cadastrar vendas fora de viagens ligada na empresa do company_identifier, a criação é recusada com 422, como no Monde, que não deixa cadastrar venda fora de uma viagem nessa empresa. A API ainda não cria venda dentro de uma viagem.
  • Com a configuração Validar cadastro do pagante ligada, o cadastro do payer precisa ter, depois da requisição, os campos que o Monde exige para salvar a venda: sempre nome e endereço com rua, número, bairro e cidade; CEP para brasileiro; data de nascimento, celular e CPF (brasileiro) ou passaporte (estrangeiro) para pessoa física; razão social, telefone, e CNPJ e IE (brasileira) ou documento fiscal estrangeiro (tax_identification_number) para pessoa jurídica. Vale o cadastro como fica depois da requisição, inclusive o que ela cria ou completa. Faltando algum, a resposta é 422 com um erro por campo, e nada é gravado.
Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
required
string (company_identifier) = 14 characters ^[0-9]{14}$

CNPJ da agência de viagens emissora da venda. Deve conter somente dígitos.

Exemplo: "86452403000197".

sale_date
required
string <date> (sale_date)

Data da venda no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2026-11-15".

status
string
Default: "opened"
Enum: "opened" "closed"

Situação da venda na criação. Padrão opened. Envie closed para já criar a venda fechada. Isso exige que ela atenda a todas as regras de fechamento (sem saldo pendente). Se não puder fechar, a criação inteira é recusada com 422.

observations
string or null

Observações gerais da venda, em texto livre e sem limite de tamanho.

operation_id
string (operation_id)

ID da operação própria associada a essa venda. A operação precisa estar ativa. Exclusiva da agência; na operadora (consolidadora), o campo é recusado com 422.

Array of objects (custom_field)

Campos personalizados da venda, definidos pela agência. Na criação, envie cada campo por id e value; os campos ativos e obrigatórios do módulo de vendas passam a ser exigidos.

required
object (seller_create)

Dados para cadastrar um vendedor.

required
object (individual_or_company)

Contratante do produto, responsável pelo pagamento. Pode ser uma pessoa física ou jurídica. Mesmo que a negociação envolva múltiplos pagantes, informe apenas o pagante principal ou a pessoa que fez a negociação do produto com o vendedor.

individual_or_company (object) or null
individual_person (object) or null

Pessoa física que solicitou a venda.

individual_or_company (object) or null

Pessoa que aprovou a venda. Exclusivo da agência. A venda da operadora (consolidadora) não tem aprovador, e o campo enviado com valor é recusado com 422.

Array of objects (insurance)

Seguro viagem.

Array of objects (cruise)

Cruzeiro.

Array of objects (hotel)

Diárias de hospedagem.

Array of objects (airline_ticket)

Passagem aérea.

Array of objects (train_ticket)

Bilhete de trem.

Array of objects (ground_transportation)

Transporte terrestre.

Array of objects (car_rental)

Locação de veículos.

Array of objects (travel_package)

Pacotes turísticos.

Array of objects (excursion)

Passeios (excursões) da venda. A excursão é um produto do sistema: não é preciso informar qual produto está sendo vendido.

Array of objects (visa)

Vistos consulares da venda, um por pedido de visto. O visto é um produto do sistema: não é preciso informar qual produto está sendo vendido. Cada passageiro é um solicitante do visto.

Não há campo próprio para a taxa consular nem para a taxa de serviço: a taxa consular de cada solicitante vai em passengers[].fees (e soma no total da venda), e a taxa de serviço da agência vai em agency_service_fee do produto.

object or null

Produto de operação própria da venda. No máximo um por venda, e o produto informado precisa ser o mesmo de operation_id quando os dois vierem. Exclusivo da agência; na operadora (consolidadora), o campo é recusado com 422.

Array of objects (others)

Outros produtos da venda, que podem ou não ter passageiros.

Array of objects or objects (payment)

Lista de pagamentos realizados na venda. Cada pagamento tem uma única forma e pode ser distribuído entre um ou mais produtos, apontados por sale_product_local_id ou sale_product_id, permitindo o controle detalhado de como os valores foram alocados por produto.

Array of objects (commission_create)

Comissões a gravar na venda. Só é aceito quando status é closed; o saldo de cada linha é o valor menos o valor retido. Na criação da venda, a lista com alguma comissão exige as permissões "Ver aba comissões" e "Adicionar comissões" de vendas.

Responses

Request samples

Content type
application/json
Example
{
  • "company_identifier": "46598887000162",
  • "sale_date": "2026-11-15",
  • "seller": {
    },
  • "payer": {
    },
  • "intermediary": {
    },
  • "approver": {
    },
  • "requester": {
    },
  • "insurances": [
    ],
  • "cruises": [
    ],
  • "hotels": [
    ],
  • "airline_tickets": [
    ],
  • "train_tickets": [
    ],
  • "ground_transportations": [
    ],
  • "car_rentals": [
    ],
  • "travel_packages": [
    ],
  • "excursions": [
    ],
  • "payments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
  • "sale_number": 987,
  • "sale_date": "2026-11-15",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-11-15T10:30:00",
  • "totals": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "operation": {
    },
  • "seller": {
    },
  • "payer": {
    },
  • "intermediary": {
    },
  • "requester": {
    },
  • "approver": {
    },
  • "promoter": {
    },
  • "travel": {
    },
  • "custom_fields": [
    ],
  • "insurances": [
    ],
  • "cruises": [
    ],
  • "hotels": [
    ],
  • "airline_tickets": [
    ],
  • "train_tickets": [
    ],
  • "ground_transportations": [
    ],
  • "car_rentals": [
    ],
  • "travel_packages": [
    ],
  • "others": [
    ],
  • "excursions": [
    ],
  • "cvc_packages": [
    ],
  • "operations": [
    ],
  • "payments": {
    },
  • "commissions": [
    ],
  • "financial": {
    }
}

Consultar venda por ID Beta

Retorna os dados de uma venda específica. Como as colunas e abas que o Monde esconde, comissão, over e receitas (nos produtos e em totals.revenue) só vêm com a permissão "Visualizar comissão, over e receitas"; payments e financial, com "Ver aba financeiro"; e commissions, com "Ver aba comissões". Sem a permissão, o campo não vem na resposta. Vale também para a resposta de Inserir e Alterar venda: sem "Ver aba financeiro", payments traz só o id e o local_id dos pagamentos enviados.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da venda (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
  • "sale_number": 987,
  • "sale_date": "2026-11-15",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-11-15T10:30:00",
  • "totals": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "operation": {
    },
  • "seller": {
    },
  • "payer": {
    },
  • "intermediary": {
    },
  • "requester": {
    },
  • "approver": {
    },
  • "promoter": {
    },
  • "travel": {
    },
  • "custom_fields": [
    ],
  • "insurances": [
    ],
  • "cruises": [
    ],
  • "hotels": [
    ],
  • "airline_tickets": [
    ],
  • "train_tickets": [
    ],
  • "ground_transportations": [
    ],
  • "car_rentals": [
    ],
  • "travel_packages": [
    ],
  • "others": [
    ],
  • "excursions": [
    ],
  • "cvc_packages": [
    ],
  • "operations": [
    ],
  • "payments": {
    },
  • "commissions": [
    ],
  • "financial": {
    }
}

Excluir venda Beta

Exclui a venda como o Monde exclui: ela não é apagada, passa a ter status igual a canceled. A venda excluída deixa de aparecer em Consultar vendas, a não ser que o parâmetro status peça as excluídas, e continua disponível na consulta por ID. A agência pode restaurá-la pelo Monde.

A situação muda antes da resposta. Logo depois, o Monde desfaz o que a venda gerou no financeiro: os pagamentos são removidos e as contas a receber deles são excluídas, o pagamento incluído numa fatura de cliente sai dela, os itens do fornecedor ainda não faturados são removidos e as comissões pagas pela conta de um pagamento são desvinculadas dela. O que falta pagar de cada produto volta a ser saldo, devido pelo pagante (pelo intermediário, na operadora). Essa parte termina alguns instantes depois da resposta.

A venda não é excluída, e a resposta é 409 com o motivo, quando:

  • já está excluída;
  • tem produto cancelado;
  • está fechada;
  • a conta de algum pagamento está liquidada, ou há conta a pagar/receber liquidada vinculada à venda;
  • algum item do fornecedor já foi faturado pela agência;
  • tem reembolso;
  • algum pagamento está numa fatura de cliente fechada;
  • o saldo gerado pela conta de um pagamento já foi faturado em outro lançamento.

A venda com recibo impresso exige também a permissão "Alterar vendas com recibo impresso", como no Monde; sem ela, a resposta é 403.

Não exige Idempotency-Key: repetir a requisição depois de excluída responde 409.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da venda (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Alterar venda Beta

  • Comece pelos exemplos, no seletor do corpo da requisição: Alterar o aprovador e um campo personalizado, Alterar um produto e substituir os pagamentos, Manter um pagamento e incluir outro e Reabrir a venda fechada e alterar a data.
  • Só muda o que vier. O campo omitido fica como está, e o enviado como null é retirado (intermediary, approver, requester, operation_id e operation). seller e payer não podem ser retirados. Os campos personalizados enviados são gravados por cima dos atuais, e os demais ficam. O texto vazio é gravado como está (o valor vazio de um campo personalizado limpa o campo); no campo obrigatório, e em campo que não é texto, é recusado (422).
  • Listas substituem. Em cada tipo de produto (insurances, hotels etc.), em segments, payments e commissions: o item com id fica ou é alterado, o sem id é incluído (com um local_id), e o que não vier sai. A lista omitida fica como está. A venda não fica sem produtos, nem o produto sem passageiros.
  • Produtos. Aponte o existente pelo id da consulta, e mudam só os campos enviados. Não sai o produto com pagamento, com passageiro cancelado ou com o valor do fornecedor já faturado; produto cancelado não é alterado. No transporte terrestre e no trem, reenvie included_services junto com os segments.
  • Passageiros. O passageiro é a pessoa no produto, apontada por person.id (como a consulta devolve) ou pelo external_id, e a mesma pessoa aparece uma vez só no produto: repetida na lista, a resposta é 422. A pessoa que já é passageiro ativo tem o mesmo passageiro alterado; a nova entra; o passageiro ativo que não vier sai. O cancelado fica, venha ou não na lista: reenviado igual ao lido, nada muda, e com algum valor diferente a resposta é 422, porque o passageiro cancelado só muda pela reativação. A lista com só passageiros cancelados também responde 422.
  • Pagamentos. Não se alteram: para mudar um, retire-o e inclua outro. Os que não podem sair (liquidado, em fatura fechada, à agência registrado só na venda numa forma antiga) precisam vir pelo id, o da resposta que o criou ou o da consulta. O payer só muda se a venda ficar sem pagamentos.
  • Venda fechada. Sem reabrir, só mudam vendedor, solicitante, aprovador, campos personalizados, comissões e observações; o resto responde 409 (para alterar o resto, veja Fechar ou reabrir). Venda excluída também responde 409.
  • Fechar ou reabrir. Envie status: closed para fechar a venda ao final da alteração, com as regras de fechamento do Monde. Na venda fechada, status: opened reabre a venda antes de aplicar o resto do pedido: a alteração vale por inteiro, e se alguma parte for recusada nada muda e a venda continua fechada. Reabrir só muda a situação da venda; comissões e financeiro ficam como estão. Fechar exige a permissão "Fechar venda"; reabrir exige a permissão própria "Reabrir venda", conferida na empresa da venda, e "Fechar venda" sozinha não reabre.
  • Outra empresa. Envie o CNPJ em company_identifier. É recusado quando a venda tem pagamento lançado, valor do fornecedor faturado ou está vinculada a uma viagem.
  • Permissões. Além de "Editar", o que o Monde protege com permissão própria exige essa permissão na empresa da venda: "Alterar data da venda", "Alterar empresa da venda", "Alterar vendedor em vendas abertas" e "Alterar vendedor em venda fechada", na venda fechada "Alterar solicitante em venda fechada" e "Alterar campos personalizados em vendas fechadas", "Excluir produto" para tirar um produto da lista, "Ver aba comissões" para enviar commissions (mesmo vazia ou nula), mais "Adicionar comissões" para a lista com alguma comissão e "Excluir comissões" quando a venda já tem comissões manuais, e "Alterar vendas com recibo impresso" para qualquer alteração na venda com recibo impresso, mais "Trocar passageiro em vendas fechadas ou com recibo impresso" para trocar a pessoa de um passageiro dela. A pessoa, o vendedor, o navio e a cabine que a venda cria junto exigem "Editar" em Pessoas, Vendedores, Navios e Cabines, como na criação. Sem ela, a resposta é 403 com o nome da permissão, e nada é alterado. O campo reenviado igual ao gravado não pede permissão; commissions é a exceção, porque a lista enviada sempre substitui as comissões manuais.
  • Financeiro. Os totais são recalculados, e o saldo do pagante e o valor a faturar ao fornecedor são ajustados pela diferença, sem refazer o que já foi lançado.
  • Resposta. A venda no formato da consulta por ID, com o local_id ao lado do id de cada produto e pagamento enviado. Quando a credencial não pode consultar a venda, vêm só o id da venda e o id e o local_id do que você enviou, no mesmo formato. Consultar pede a permissão "Visualizar" de vendas na empresa da venda, também na venda que a própria credencial criou, e, na venda de outro vendedor, também a de abrir as vendas de outros vendedores: uma alteração sem nenhum campo não serve de consulta.
Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da venda (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
string

CNPJ da empresa da venda. Com outro CNPJ, a venda passa para essa empresa, se as regras da troca permitirem.

sale_date
string <date> (sale_date)

Data da venda no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2026-11-15".

status
string
Enum: "opened" "closed"

Envie closed para fechar a venda ao final da alteração, respeitando as regras de fechamento. Na venda aberta, opened a mantém aberta; na fechada, opened a reabre antes de aplicar o resto da alteração e closed a mantém fechada.

operation_id
string (operation_id)

ID da operação própria associada a essa venda. A operação precisa estar ativa. Exclusiva da agência; na operadora (consolidadora), o campo é recusado com 422.

observations
string or null

Observações gerais da venda. Substitui o texto atual; envie nulo para limpá-lo. Muda também na venda fechada, como no Monde, e a alteração vai para o histórico da venda.

Array of objects (custom_field)

Campos personalizados da venda. Não substitui: cada campo enviado é gravado por cima do valor atual e os demais permanecem. Enviado em branco ou como nulo, o campo é limpo, a não ser que seja obrigatório.

object (seller_create)

Dados para cadastrar um vendedor.

object (individual_or_company)

Pagante da venda. Só muda quando, depois da requisição, não sobra pagamento nos produtos da venda. Não pode ser enviado como nulo.

object (intermediary)

Intermediário da venda. Pessoa ou empresa que conecta as partes envolvidas na venda do produto, facilitando a negociação e, geralmente, recebendo uma comissão pela intermediação. É obrigatório na operadora, em que é ele quem deve a fatura do cliente.

object (individual_person)

Pessoa física que solicitou a venda.

object (individual_or_company)

Pessoa que aprovou a venda. Exclusivo da agência. A venda da operadora (consolidadora) não tem aprovador, e o campo enviado com valor é recusado com 422.

Array of objects

Lista que substitui os produtos deste tipo (insurances). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (cruises). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (hotels). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (airline_tickets). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (train_tickets). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (ground_transportations). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (car_rentals). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (travel_packages). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (excursions). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (others). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

Array of objects

Lista que substitui os produtos deste tipo (visas). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair.

object

Operação própria da venda. Com id, altera a que a venda já tem; sem id, inclui. Enviada como nula, o produto de operação própria sai da venda, que precisa continuar com ao menos um produto.

Array of objects or objects or objects (payment_update)

Lista final dos pagamentos dos produtos da venda. Com id (o da resposta que o criou ou o da consulta da venda), o pagamento fica como está e não aceita a forma de pagamento junto; sem id, é incluído; o que não vier é removido. Para alterar um pagamento, retire-o e inclua outro. Vazia ou nula, retira todos; se algum não puder sair, a alteração é recusada. No produto de um pagamento novo, use sale_product_local_id para um produto enviado nesta requisição ou sale_product_id para um produto que a venda mantém.

Array of objects (commission_create)

Lista que substitui as comissões informadas manualmente, no mesmo formato da criação. Vale para a venda que a requisição fecha ou que já está fechada. Vazia ou nula, retira todas; com comissão paga, a lista não pode ser substituída. Enviá-la, mesmo vazia ou nula, exige a permissão "Ver aba comissões" de vendas, além de "Adicionar comissões" para a lista com alguma comissão e "Excluir comissões" quando a venda já tem comissões manuais.

Responses

Request samples

Content type
application/json
Example

Só os campos enviados mudam: produtos, passageiros e pagamentos ficam como estão. O aprovador é exclusivo da agência: na operadora (consolidadora), envie só o campo personalizado.

{
  • "approver": {
    },
  • "custom_fields": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
  • "sale_number": 987,
  • "sale_date": "2026-11-15",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-11-15T10:30:00",
  • "totals": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "operation": {
    },
  • "seller": {
    },
  • "payer": {
    },
  • "intermediary": {
    },
  • "requester": {
    },
  • "approver": {
    },
  • "promoter": {
    },
  • "travel": {
    },
  • "custom_fields": [
    ],
  • "insurances": [
    ],
  • "cruises": [
    ],
  • "hotels": [
    ],
  • "airline_tickets": [
    ],
  • "train_tickets": [
    ],
  • "ground_transportations": [
    ],
  • "car_rentals": [
    ],
  • "travel_packages": [
    ],
  • "others": [
    ],
  • "excursions": [
    ],
  • "cvc_packages": [
    ],
  • "operations": [
    ],
  • "payments": {
    },
  • "commissions": [
    ],
  • "financial": {
    }
}

Cancelar produto da venda Beta

O produto só fica cancelado quando todos os passageiros dele estão cancelados. Cancelar só parte dos passageiros deixa o produto active, com esses passageiros marcados em canceled_at. O produto sem passageiros é cancelado direto. As opções calculate_commission, delete_supplier_balance e supplier_fine só valem quando o pedido deixa todos os passageiros cancelados, isto é, quando a lista cancela os que ainda faltavam. delete_customer_balance vale também no cancelamento de parte dos passageiros.

Cancela um produto da venda, ou parte dos passageiros dele, quando o cliente desiste do que foi vendido. Cancelar não é excluir: o produto excluído (que sai da lista de produtos no PATCH /sales/{id}) é o lançado por engano, sem nenhum movimento; o cancelado é a venda que aconteceu e foi desfeita. Para desfazer o cancelamento, use Reativar produto da venda.

O que muda e o que não muda

  • O produto cancelado continua somando no valor total da venda, de propósito, como histórico. Os valores dele não mudam e ele não pode mais ser alterado pelo PATCH da venda.
  • O financeiro só muda pelas opções enviadas: sem nenhuma delas, o saldo do cliente e o que falta faturar ao fornecedor ficam como estão.
  • A venda com produto cancelado não pode ser excluída. Para excluí-la, reative o produto antes.

Passageiros e datas O cancelamento é sempre pela lista passengers: não há data padrão nem cancelamento de todos sem listar. Nenhuma data pode ser anterior à data da venda.

  • Produto com passageiros sem passengers é recusado (422). Para cancelar o produto inteiro, liste todos os passageiros ativos.
  • Com passengers, só as pessoas da lista são canceladas, cada uma com o seu canceled_at, obrigatório no item. A pessoa é citada pelo person.id, o id da pessoa em passengers[].person na consulta da venda.
  • O produto só fica canceled quando todos os passageiros estão cancelados; antes disso continua active, com os passageiros cancelados marcados em canceled_at.
  • Produto sem passageiros é cancelado sem passengers (corpo {} ou só as opções): a data de cancelamento dele é a do dia, como no Monde.
  • canceled_at na raiz não é aceito (422): a data vai em cada passageiro da lista.
  • A data de cancelamento do produto é a data em que o cancelamento foi registrado no Monde, como no Monde Desktop.
  • Cancelar passageiro não ajusta sozinho a fatura do fornecedor: o acerto da parte do passageiro é feito na fatura.

Opções

  • delete_customer_balance: o saldo pendente a receber do cliente neste produto é excluído e passa a ser saldo excluído, que reduz a receita da venda. Só o saldo que ainda não virou pagamento sai: se o cliente não vai pagar uma forma de pagamento já lançada, exclua-a pelo PATCH da venda antes. Exige saldo a receber no produto.
  • delete_supplier_balance: os itens ainda em aberto para o fornecedor (sem lançamento ou, com a fatura automática, numa fatura não liquidada nem fechada), inclusive a Lei Kandir, são excluídos. O que já foi liquidado ou pago direto ao fornecedor fica. Só vale quando o pedido deixa todos os passageiros cancelados, e exige item em aberto. Não existe em produto de operação própria.
  • supplier_fine: a multa cobrada pelo fornecedor, informada como valor positivo na moeda em que o fornecedor é pago. Vira um item de multa a acertar com o fornecedor e reduz a receita. Exige delete_supplier_balance. Na agência, o fornecedor é pago na moeda final da venda, e a multa volta na consulta em supplier_fine. Na operadora, o fornecedor é pago na moeda de origem do produto: a multa enviada volta em supplier_fine_origin_currency, e supplier_fine traz o valor convertido para a moeda final pelo câmbio do produto. Exemplo na operadora, produto em USD com câmbio 5: supplier_fine: 30 no cancelamento volta como supplier_fine_origin_currency: 30 e supplier_fine: 150.
  • calculate_commission: o produto cancelado continua no cálculo da meta dos planos de comissão, como o campo calculate_commission da consulta do produto. Padrão false: o produto sai da meta. Só vale quando o pedido deixa todos os passageiros cancelados.
  • Na agência com o controle de crédito, o saldo do fornecedor não é excluído no cancelamento e não há multa: o acerto é feito na fatura do fornecedor, e delete_supplier_balance e supplier_fine são recusados.

Venda fechada

  • O produto inteiro pode ser cancelado com a venda fechada. Cancelar só parte dos passageiros exige a venda aberta (409).

Resposta

  • A venda inteira, como na consulta por ID, para a integração ver a situação do produto e o saldo. No produto, canceled_at, calculate_commission, deleted_balance, delete_supplier_balance, supplier_fine e supplier_fine_origin_currency mostram o que o cancelamento gravou; a multa informada na moeda em que o fornecedor é pago aparece em supplier_fine na agência e em supplier_fine_origin_currency na operadora. A credencial sem a permissão de consultar vendas recebe só o id da venda.

Exige, na empresa da venda, a permissão de editar vendas e a permissão "Cancelar produto", como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. Na venda de outro vendedor, exige também "Editar vendas de outros vendedores". A credencial da conexão automática, que só edita as vendas que criou, só cancela produto dessas vendas, e só quando o parceiro recebeu "Cancelar produto" na aprovação. O cancelamento fica no histórico da venda, com o nome da credencial.

Authorizations:
bearerAuthentication
path Parameters
sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador da venda (UUID), o id devolvido na consulta e na criação da venda.

product_id
required
string <uuid>
Example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45

Identificador do produto da venda (UUID), o id do produto em insurances, hotels, airline_tickets e nos demais nós de produto da venda.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
Array of objects

Os passageiros a cancelar, cada um com a sua data. Obrigatório no produto com passageiros: para cancelar o produto inteiro, liste todos os passageiros ativos. Não envie em produto sem passageiros. Cada pessoa vai uma vez só: repetida, responde 422.

calculate_commission
boolean
Default: false

Mantém o produto cancelado no cálculo da meta dos planos de comissão (o mesmo calculate_commission da consulta do produto). Padrão false. Só vale quando o pedido deixa todos os passageiros cancelados.

delete_customer_balance
boolean
Default: false

Exclui o saldo pendente a receber do cliente neste produto, que passa a ser saldo excluído.

delete_supplier_balance
boolean
Default: false

Exclui os itens ainda em aberto para o fornecedor (fatura e Lei Kandir). Só vale quando o pedido deixa todos os passageiros cancelados.

supplier_fine
number <double> >= 0
Default: 0

Multa cobrada pelo fornecedor, em valor positivo, na moeda em que o fornecedor é pago: a moeda final da venda na agência e a moeda de origem do produto na operadora. Na consulta, volta em supplier_fine na agência e em supplier_fine_origin_currency na operadora. Exige delete_supplier_balance.

Responses

Request samples

Content type
application/json
Example

Cancela os dois passageiros do produto, cada um com a sua data, e com isso o produto inteiro, e exclui o saldo que o cliente ainda deve no produto.

{
  • "passengers": [
    ],
  • "delete_customer_balance": true
}

Response samples

Content type
application/json
Example

Trecho da resposta ao cancelar um dos dois passageiros com delete_customer_balance: o produto continua active, e o passageiro cancelado traz o canceled_at. Os demais campos da venda são os da consulta por ID.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "sale_number": 1024,
  • "status": "opened",
  • "insurances": [
    ]
}

Reativar produto da venda Beta

Desfaz o cancelamento do produto, inteiro ou só de parte dos passageiros, como o descancelamento do Monde. O produto volta à situação active e entra de novo no cálculo da meta dos planos de comissão.

Passageiros

  • A reativação é sempre pela lista passengers, com a pessoa de cada passageiro cancelado que volta. Para reativar o produto inteiro, liste todos os passageiros cancelados. Produto com passageiros sem a lista é recusado (422).
  • Produto sem passageiros é reativado sem a lista (corpo {}).
  • Cada pessoa da lista, citada pelo person.id como no cancelamento, precisa ser passageiro cancelado do produto.
  • O corpo não aceita canceled_at nem as opções do cancelamento (422): a reativação desfaz o cancelamento como ele foi gravado.

Financeiro

  • Se o cancelamento excluiu o saldo do fornecedor, o que falta faturar ao fornecedor é lançado de novo.
  • Quando voltam todos os passageiros cancelados, o resto do cancelamento sai: o saldo do cliente excluído volta a ser saldo a receber do pagante, e a multa do fornecedor sai (se ela já foi faturada, um item de estorno a anula).
  • Reativando só parte dos passageiros, a multa e o saldo excluído ficam como estão.
  • Reembolsos e créditos já lançados pela venda não são desfeitos.
  • Com a venda fechada, a reativação é aceita, de parte dos passageiros ou do produto inteiro, como no Monde, sem reabrir a venda. A exceção é o produto cujo cancelamento excluiu saldo do cliente: a reativação que traz de volta todos os passageiros ainda cancelados, ou o produto inteiro, devolve esse saldo, e a venda fechada não tem saldo (409). Nesse produto, parte dos passageiros ainda pode ser reativada, mantendo o saldo excluído; para trazer de volta os últimos, reabra a venda antes.
  • Com a fatura automática do fornecedor, a multa do cancelamento é lançada na fatura alguns segundos depois. Enquanto isso, a reativação responde 409: repita a requisição em alguns segundos. A multa que não entrou na fatura em 10 minutos não trava mais a reativação.

Exige as mesmas permissões do cancelamento: editar vendas e "Cancelar produto", na empresa da venda, como o descancelamento do Monde. A resposta é a venda inteira, ou só o id dela para quem não pode consultar vendas. A reativação fica no histórico da venda, com o nome da credencial.

Authorizations:
bearerAuthentication
path Parameters
sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador da venda (UUID), o id devolvido na consulta e na criação da venda.

product_id
required
string <uuid>
Example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45

Identificador do produto da venda (UUID), o id do produto em insurances, hotels, airline_tickets e nos demais nós de produto da venda.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
Array of objects

Os passageiros cancelados a reativar. Obrigatório no produto com passageiros: para reativar o produto inteiro, liste todos os cancelados. Não envie em produto sem passageiros. Cada pessoa vai uma vez só: repetida, responde 422.

Responses

Request samples

Content type
application/json
Example

Reativa só um passageiro cancelado, citado pelo id da pessoa. A multa e o saldo excluído ficam enquanto houver passageiro cancelado.

{
  • "passengers": [
    ]
}

Response samples

Content type
application/json
Example

Trecho da resposta ao reativar o último passageiro cancelado: o produto volta a active, os passageiros ficam sem canceled_at, e a multa e o saldo excluído voltam a zero. Os demais campos da venda são os da consulta por ID.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "sale_number": 1024,
  • "status": "opened",
  • "insurances": [
    ]
}

Alterar item do fornecedor da venda Beta

Altera o vencimento e a descrição de um item do fornecedor da venda, como o Editar do item na aba Financeiro do Monde. Os itens e os id deles vêm em financial.vendor_items, na consulta da venda por ID. O campo omitido fica como está, e o campo desconhecido é ignorado.

O que se edita aqui

  • Só o item que ainda não está num lançamento nem foi pago direto ao fornecedor (bill e payment nulos). Com a fatura automática do fornecedor, o item ainda a faturar também se edita, como no Monde.
  • O item que já está num lançamento responde 409: o vencimento e a descrição que valem são os do lançamento, que se altera em Alterar conta a pagar ou receber.
  • O item pago direto ao fornecedor responde 409: o vencimento é o do pagamento, que se altera nos pagamentos da venda, em Alterar venda.
  • O crédito gerado para o fornecedor (generated_credit) responde 409: ele é tratado no crédito da pessoa.
  • A venda excluída responde 409. O item que não é do fornecedor desta venda, inclusive o item do cliente e o aguardando exclusão, responde 404.
  • Como no Monde, a venda fechada ou com recibo impresso não impede a alteração, e a alteração não entra no histórico da venda.

Resposta

  • A venda inteira, como na consulta por ID, com o item alterado em financial.vendor_items. A credencial sem a permissão de consultar vendas recebe só o id da venda.

Exige, na empresa da venda, a permissão de editar vendas e "Ver aba financeiro", como no Monde; sem "Ver aba financeiro", a resposta é 403 com a mensagem do Monde. Na venda de outro vendedor, exige também "Editar vendas de outros vendedores".

Authorizations:
bearerAuthentication
path Parameters
sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador da venda (UUID), o id devolvido na consulta e na criação da venda.

id
required
string <uuid>
Example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84

Identificador do item do fornecedor (UUID), o id do item em financial.vendor_items na consulta da venda.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
due_date
string <date>

Novo vencimento do item, no formato ISO 8601 (AAAA-MM-DD). O vencimento é obrigatório: null ou texto vazio responde 422.

description
string or null <= 100 characters

Nova descrição do item, com até 100 caracteres. null deixa o item sem descrição.

Responses

Request samples

Content type
application/json
Example

Muda o vencimento e a descrição do item ainda a faturar.

{
  • "due_date": "2026-12-15",
  • "description": "Faturar em dezembro"
}

Response samples

Content type
application/json
Example

Trecho da resposta: o item alterado volta em financial.vendor_items, ao lado do item que já está num lançamento. Os demais campos da venda são os da consulta por ID.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "sale_number": 1024,
  • "status": "closed",
  • "financial": {
    }
}

Gerar pagamento avulso ou sinal ao fornecedor da venda Beta

Gera a fatura do pagamento avulso ou do sinal ao fornecedor ou representante, com os itens do fornecedor em aberto da venda, como o Gerar Pagamento Avulso ou Sinal da aba Financeiro e o Sinal Fornecedor do menu do produto, no Monde. Os itens e os id deles vêm em financial.vendor_items, na consulta da venda por ID. O campo desconhecido é ignorado.

Como a fatura é gerada

  • Com a fatura automática do fornecedor ligada, e fora da venda CVC, é a fatura avulsa automática: o item sai da fatura automática em que está e vai para a nova fatura. O item que a fatura automática ainda não processou responde 409; tente de novo depois.
  • Sem a fatura automática, ou na venda CVC, é a fatura do fornecedor feita pela venda. O vencimento dela é o menor vencimento dos itens gerados, e o item sem vencimento conta como hoje.
  • Uma fatura tem uma pessoa e uma moeda só: todos os itens precisam ser do mesmo fornecedor ou representante e da mesma moeda.

Recusas

  • A venda excluída responde 409, como a fatura já fechada ou liquidada em que o item está.
  • O item de outra venda, de outro fornecedor ou moeda, que não está em aberto, repetido ou de outro produto que o de product_id responde 422, apontando o item.
  • Como no Monde, a venda fechada ou com recibo impresso não impede a geração, e a venda não ganha registro no histórico: a fatura gerada tem o histórico dela.

Resposta

Exige, na empresa da venda, a permissão de editar vendas, e na venda de outro vendedor também "Editar vendas de outros vendedores". Exige também "Ver aba financeiro", como o Gerar Pagamento Avulso ou Sinal da aba Financeiro do Monde; só o deposit com product_id, que é o Sinal Fornecedor do produto, não exige. A fatura feita pela venda, sem a fatura automática, exige também "Gerar Fatura", das contas a pagar e receber.

Authorizations:
bearerAuthentication
path Parameters
sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador da venda (UUID), o id devolvido na consulta e na criação da venda.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
kind
required
string
Enum: "advance" "deposit"

O que gerar, como no Monde:

  • advance: Gerar Pagamento Avulso ou Sinal, da aba Financeiro da venda. A fatura sai com a descrição "Pagamento Avulso".
  • deposit: Sinal Fornecedor, do menu do produto. A fatura sai com a descrição "Sinal", e o movimento de cada item é sempre o do saldo dele.
product_id
string <uuid>

Produto da venda (UUID, o id em products na consulta da venda), como o Sinal Fornecedor do menu do produto: todos os itens precisam ser desse produto. O produto que não é da venda responde 404; o de operação própria ou excluído responde 422.

required
Array of objects non-empty

Os itens do fornecedor que entram na fatura, ao menos um. Todos precisam ser desta venda, estar em aberto e ser do mesmo fornecedor ou representante e da mesma moeda, como a grade do Monde filtrada pelo fornecedor escolhido.

Responses

Request samples

Content type
application/json
Example

Gera o pagamento avulso com todo o saldo do item.

{
  • "kind": "advance",
  • "items": [
    ]
}

Response samples

Content type
application/json

Exemplo de detalhe de uma fatura de fornecedor, com os itens em items e credit_card_items vazio.

{
  • "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
  • "number": "291",
  • "transaction_kind": "debit",
  • "kind": "vendor_invoice",
  • "description": "Fatura Fornecedor Avulsa",
  • "document": null,
  • "invoice_number": null,
  • "amount": 4,
  • "final_amount": 4,
  • "issue_date": "2026-07-13",
  • "due_date": "2026-07-13",
  • "settlement_date": null,
  • "created_at": "2026-07-13T14:42:00",
  • "canceled": false,
  • "checked": false,
  • "invoice_closed": false,
  • "system_generated": false,
  • "generates_credit": false,
  • "periodicity": "without_periodicity",
  • "recurrence_kind": "non_recurrent",
  • "recurrence_group_id": null,
  • "observations": null,
  • "billet": null,
  • "check": null,
  • "card": null,
  • "sale": null,
  • "person": {
    },
  • "company": {
    },
  • "account": null,
  • "payment_method": null,
  • "operation": null,
  • "invoice_rule": null,
  • "created_by": {
    },
  • "movements": [ ],
  • "apportionments": {
    },
  • "custom_fields": [ ],
  • "attachments": [ ],
  • "categories": [ ],
  • "commissions": [ ],
  • "items": [
    ],
  • "credit_card_items": [ ]
}

Faturar Beta

Inclui o Faturar na venda, como o Faturar da aba Financeiro da venda no Monde: o pagante paga o saldo do cliente pela fatura de cliente. O campo desconhecido é ignorado; a descrição, que o Faturar não tem, também.

Como é gravado

  • Grava um item a faturar do cliente por produto, sem lançamento próprio. A fatura automática leva os itens à fatura de cliente do pagante, em segundo plano, logo depois. Por isso a resposta é 202.
  • O valor de cada produto vai com o sinal do saldo do cliente dele, como a tela do Monde mostra: negativo no produto de saldo negativo, positivo nos outros.
  • Quando o item entra na fatura, o Faturar aparece em payments.agency.to_invoice da consulta da venda, numa linha por fatura de cliente e centro de custo. Até lá, ele não aparece na venda.
  • O Faturar não muda pela alteração da venda: a lista payments não o mantém nem o remove. Ele sai pela remoção do Faturar.

Recusas

  • A venda fechada ou excluída responde 409: o Faturar só é incluído na venda aberta.
  • Sem saldo do cliente a faturar em nenhum produto, a resposta é 422, como o Monde, que só oferece o Faturar quando há saldo.
  • O produto que não é da venda, repetido, sem saldo do cliente, com o sinal trocado ou de outra moeda de venda responde 422, apontando o produto, como a soma zero e o centro de custo que o pagante não tem.

Resposta

Exige, na empresa da venda, a permissão de editar vendas, e na venda com recibo impresso também "Alterar vendas com recibo impresso".

Authorizations:
bearerAuthentication
path Parameters
sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador da venda (UUID), o id devolvido na consulta e na criação da venda.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
payer_id
string <uuid> (sale_to_invoice_payer_id)

Pagante (UUID de pessoa, o id de Consultar pessoas). Omitido, é o pagante da venda. A pessoa que não existe responde 422.

cost_center
string <= 50 characters

Centro de custo do pagante, até 50 caracteres. Com pagante pessoa jurídica, tem de ser um dos centros de custo cadastrados nela, e é gravado com o nome do cadastro. Com pagante pessoa física é recusado, a menos que a agência use centro de custo em texto livre. Omitido, o Faturar fica sem centro de custo.

required
Array of objects (sale_to_invoice_products) non-empty

Os produtos da venda e o valor de cada um, ao menos um. Cada produto aparece uma vez, tem saldo do cliente e é da mesma moeda de venda que os outros: um pagamento tem uma moeda só. A soma dos valores, com os sinais, não pode ser zero.

Responses

Request samples

Content type
application/json
Example

Fatura para o pagante da venda o saldo do cliente de um produto, sem centro de custo.

{
  • "products": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
  • "sale_number": 987,
  • "sale_date": "2026-11-15",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-11-15T10:30:00",
  • "totals": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "operation": {
    },
  • "seller": {
    },
  • "payer": {
    },
  • "intermediary": {
    },
  • "requester": {
    },
  • "approver": {
    },
  • "promoter": {
    },
  • "travel": {
    },
  • "custom_fields": [
    ],
  • "insurances": [
    ],
  • "cruises": [
    ],
  • "hotels": [
    ],
  • "airline_tickets": [
    ],
  • "train_tickets": [
    ],
  • "ground_transportations": [
    ],
  • "car_rentals": [
    ],
  • "travel_packages": [
    ],
  • "others": [
    ],
  • "excursions": [
    ],
  • "cvc_packages": [
    ],
  • "operations": [
    ],
  • "payments": {
    },
  • "commissions": [
    ],
  • "financial": {
    }
}

Devolução Faturar Beta

Inclui a Devolução Faturar na venda, como o Devolução › Faturar da aba Financeiro da venda no Monde: o valor que a agência devolve ao cliente pela fatura de cliente. O corpo é o do Faturar, com a descrição (description) no lugar do centro de custo, que é ignorado. O campo desconhecido é ignorado.

Como é gravada

  • Como o Faturar: um item a faturar do cliente por produto, sem lançamento próprio, que a fatura automática leva à fatura de cliente logo depois. Por isso a resposta é 202.
  • O valor de cada produto vai com o sinal do saldo do cliente dele: negativo no produto de saldo negativo, positivo nos outros.
  • Quando o item entra na fatura, a Devolução aparece em payments.agency.to_invoice da consulta da venda, na linha da fatura de cliente, somada com o sinal: o valor negativo é a Devolução. Ela sai pela remoção do Faturar, junto com a linha.

Recusas

  • A venda fechada ou excluída responde 409.
  • Só é aceita quando algum produto da venda tem saldo do cliente negativo, como o Monde, que só oferece a Devolução nesse caso: sem ele, a resposta é 422.
  • As regras dos produtos e da soma são as do Faturar (422).

Resposta

Exige, na empresa da venda, a permissão de editar vendas, e na venda com recibo impresso também "Alterar vendas com recibo impresso".

Authorizations:
bearerAuthentication
path Parameters
sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador da venda (UUID), o id devolvido na consulta e na criação da venda.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
payer_id
string <uuid> (sale_to_invoice_payer_id)

Pagante (UUID de pessoa, o id de Consultar pessoas). Omitido, é o pagante da venda. A pessoa que não existe responde 422.

description
string <= 100 characters

Descrição da Devolução Faturar, até 100 caracteres.

required
Array of objects (sale_to_invoice_products) non-empty

Os produtos da venda e o valor de cada um, ao menos um. Cada produto aparece uma vez, tem saldo do cliente e é da mesma moeda de venda que os outros: um pagamento tem uma moeda só. A soma dos valores, com os sinais, não pode ser zero.

Responses

Request samples

Content type
application/json

Devolve ao cliente, pela fatura de cliente, o saldo negativo de um produto.

{
  • "description": "Reembolso do seguro",
  • "products": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
  • "sale_number": 987,
  • "sale_date": "2026-11-15",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-11-15T10:30:00",
  • "totals": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "operation": {
    },
  • "seller": {
    },
  • "payer": {
    },
  • "intermediary": {
    },
  • "requester": {
    },
  • "approver": {
    },
  • "promoter": {
    },
  • "travel": {
    },
  • "custom_fields": [
    ],
  • "insurances": [
    ],
  • "cruises": [
    ],
  • "hotels": [
    ],
  • "airline_tickets": [
    ],
  • "train_tickets": [
    ],
  • "ground_transportations": [
    ],
  • "car_rentals": [
    ],
  • "travel_packages": [
    ],
  • "others": [
    ],
  • "excursions": [
    ],
  • "cvc_packages": [
    ],
  • "operations": [
    ],
  • "payments": {
    },
  • "commissions": [
    ],
  • "financial": {
    }
}

Remover linha do Faturar Beta

Remove uma linha do Faturar da venda, como o Excluir da grade de pagamentos da aba Financeiro no Monde. A linha é a de payments.agency.to_invoice da consulta da venda, apontada pela fatura de cliente (bill_id) e pelo centro de custo (cost_center).

O que é removido

  • A linha inteira: todos os itens do Faturar e da Devolução Faturar da venda naquela fatura de cliente e centro de custo. Os itens saem da fatura, e o saldo do cliente dos produtos volta.

Recusas

  • A venda excluída responde 409.
  • A venda fechada responde 409, a menos que reopen_sale venha true: aí a venda é reaberta, e a credencial precisa também da permissão "Reabrir venda" (403 sem ela).
  • A fatura de cliente fechada responde 409 sempre: reabra a fatura antes, por Reabrir fatura de cliente.
  • A fatura de cliente liquidada responde 409, a menos que remove_settlement venha true: aí a liquidação da fatura é desfeita.
  • A linha que a venda não tem, com aquela fatura e aquele centro de custo, responde 422, como a confirmação que não é true nem false.

Resposta

Exige, na empresa da venda, a permissão de editar vendas, e na venda com recibo impresso também "Alterar vendas com recibo impresso".

Authorizations:
bearerAuthentication
path Parameters
sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador da venda (UUID), o id devolvido na consulta e na criação da venda.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
bill_id
required
string <uuid>

Fatura de cliente da linha (UUID, o bill.id da linha em payments.agency.to_invoice na consulta da venda).

cost_center
string or null

Centro de custo da linha, o cost_center dela na consulta da venda. Nulo, vazio ou omitido aponta a linha sem centro de custo.

reopen_sale
boolean
Default: false

Confirma a reabertura da venda fechada, como o Monde pergunta antes de excluir. Com true, a venda fechada é reaberta e o Faturar é removido; exige também a permissão "Reabrir venda". Sem a confirmação, a venda fechada responde 409. Na venda aberta, não tem efeito.

remove_settlement
boolean
Default: false

Confirma desfazer a liquidação da fatura de cliente liquidada, como o Monde pergunta antes de excluir. Sem a confirmação, a fatura liquidada responde 409. Na fatura em aberto, não tem efeito.

Responses

Request samples

Content type
application/json
Example

Remove a linha do Faturar da fatura de cliente que não tem centro de custo.

{
  • "bill_id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819",
  • "cost_center": null
}

Response samples

Content type
application/json
Example
{
  • "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
  • "sale_number": 987,
  • "sale_date": "2026-11-15",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-11-15T10:30:00",
  • "totals": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "operation": {
    },
  • "seller": {
    },
  • "payer": {
    },
  • "intermediary": {
    },
  • "requester": {
    },
  • "approver": {
    },
  • "promoter": {
    },
  • "travel": {
    },
  • "custom_fields": [
    ],
  • "insurances": [
    ],
  • "cruises": [
    ],
  • "hotels": [
    ],
  • "airline_tickets": [
    ],
  • "train_tickets": [
    ],
  • "ground_transportations": [
    ],
  • "car_rentals": [
    ],
  • "travel_packages": [
    ],
  • "others": [
    ],
  • "excursions": [
    ],
  • "cvc_packages": [
    ],
  • "operations": [
    ],
  • "payments": {
    },
  • "commissions": [
    ],
  • "financial": {
    }
}

Consultar campos adicionais do produto Beta

Retorna os três campos adicionais do produto da venda (external_number, additional1 e additional2) com o título que a agência deu a cada um no Monde, como "Nº Pedido". Na venda, informe e leia o campo pela key: o título só serve para saber qual campo é qual, e mudar o título no Monde não muda a key. O campo sem título (active falso) não aparece no Monde, e a API ignora o valor enviado nele. Pede a permissão de consultar vendas.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Produtos

Consulte e mantenha o catálogo de produtos de viagem (seguros, cruzeiros, hotéis, passagens aéreas, operações próprias e outros) usados nas vendas, com os fornecedores de cada produto e os representantes de cada fornecedor. Fornecedores e representantes são partes do produto: são lidos com a permissão de ler produtos, e cada um tem as próprias permissões de gravar e de excluir, como no Monde.

Consultar produtos Beta

Retorna a lista de produtos disponíveis no sistema, com possibilidade de filtrar por tipo de produto.

Authorizations:
bearerAuthentication
query Parameters
kind
Array of strings
Items Enum: "insurance" "cruise" "hotel" "airline_ticket" "train_ticket" "ground_transportation" "excursion" "visa" "car_rental" "travel_package" "cvc_package" "operation" "others"
Examples:
  • kind=insurance - Filtro por um único tipo
  • kind=insurance,cruise,hotel - Filtro por múltiplos tipos

Filtra produtos por tipo. Para múltiplos tipos, separe os valores por vírgula (ex: insurance,cruise,hotel).

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo produtos de diferentes tipos.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar produto Beta

Cadastra um produto no catálogo. Como na tela de Produtos do Monde, a criação só faz produtos dos tipos others (Outros) e operation (Operação Própria): os demais tipos são produtos do sistema. Operação própria é recurso de agência e é recusada numa base de operadora (consolidadora). O tipo e o passengers são escolhidos na criação e não mudam depois. Os fornecedores entram depois, em /products/{id}/supplies. Exige a permissão de criar e editar produtos numa empresa cuja licença permita gravar.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
required
string <= 50 characters

Nome do produto

included_services
string or null

Serviços inclusos no produto

active
boolean
Default: true

Indica se o produto está ativo

nbs_code
string or null

Código NBS do produto (Nomenclatura Brasileira de Serviços)

kind
string
Default: "others"
Enum: "others" "operation"

Tipo do produto. Na criação só são aceitos:

  • others (padrão): outros produtos.
  • operation: operação própria, só em base de agência.
Não muda depois do cadastro.

passengers
boolean
Default: true

Indica se o produto tem passageiros. Padrão true. Não muda depois do cadastro.

Responses

Request samples

Content type
application/json

Exemplo de criação de um produto do tipo Outros, com passageiros e código NBS.

{
  • "name": "Passeio de Barco",
  • "included_services": "Passeio de escuna com almoço",
  • "kind": "others",
  • "passengers": true,
  • "active": true,
  • "nbs_code": "1.2501.11.00"
}

Response samples

Content type
application/json

Exemplo de resposta com um produto e seus fornecimentos, fornecedores e representantes.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "name": "Seguro Viagem",
  • "included_services": "Cobertura completa para viagens internacionais",
  • "kind": "insurance",
  • "passengers": true,
  • "system": true,
  • "active": true,
  • "nbs_code": "115022000",
  • "supplies": [
    ]
}

Consultar produto por ID Beta

Retorna os dados completos de um produto específico, incluindo seus fornecimentos com o fornecedor, os dados de comissão e os representantes.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com um produto e seus fornecimentos, fornecedores e representantes.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "name": "Seguro Viagem",
  • "included_services": "Cobertura completa para viagens internacionais",
  • "kind": "insurance",
  • "passengers": true,
  • "system": true,
  • "active": true,
  • "nbs_code": "115022000",
  • "supplies": [
    ]
}

Alterar produto Beta

Altera um produto já cadastrado, inclusive os do sistema. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. Os serviços inclusos (included_services) e o código NBS (nbs_code) enviados como nulo ficam em branco; name, kind, passengers e active não podem ser retirados, e enviados como nulo são recusados (422). O tipo e o passengers não mudam depois do cadastro: enviá-los com o valor que o produto já tem é aceito, e com outro valor é recusado. Produtos CVC são mantidos pela integração da CVC e não podem ser alterados (409). A resposta traz o produto alterado no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de produtos; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string <= 50 characters

Nome do produto

included_services
string or null

Serviços inclusos no produto

active
boolean
Default: true

Indica se o produto está ativo

nbs_code
string or null

Código NBS do produto (Nomenclatura Brasileira de Serviços)

kind
string
Default: "others"
Enum: "others" "operation"

Tipo do produto. Na criação só são aceitos:

  • others (padrão): outros produtos.
  • operation: operação própria, só em base de agência.
Não muda depois do cadastro.

passengers
boolean
Default: true

Indica se o produto tem passageiros. Padrão true. Não muda depois do cadastro.

Responses

Request samples

Content type
application/json

Exemplo de alteração que só inativa o produto, mantendo os demais campos.

{
  • "active": false
}

Response samples

Content type
application/json
Example

Exemplo de resposta com um produto e seus fornecimentos, fornecedores e representantes.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "name": "Seguro Viagem",
  • "included_services": "Cobertura completa para viagens internacionais",
  • "kind": "insurance",
  • "passengers": true,
  • "system": true,
  • "active": true,
  • "nbs_code": "115022000",
  • "supplies": [
    ]
}

Excluir produto Beta

Exclui o produto definitivamente. Produtos do sistema não podem ser excluídos, e o produto com vínculos (fornecedores, vendas, regras de faturamento ou de nota fiscal, planos de comissão, integrações) também não: para tirá-lo do catálogo, inative-o pelo PATCH (active: false) ou unifique-o com outro produto na tela de Produtos do Monde. Os dois casos respondem 409. Exige a permissão de excluir produtos.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Consultar fornecedores do produto Beta

Retorna os fornecedores (fornecimentos) do produto, cada um com as condições comerciais e os representantes. Exige a permissão de ler produtos.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de lista de fornecimentos, com os representantes de cada um.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Adicionar fornecedor ao produto Beta

Adiciona um fornecedor ao produto. A pessoa do fornecedor (supplier) é obrigatória e é referenciada pelo UUID. O mesmo fornecedor pode entrar mais de uma vez, desde que com descrições diferentes. A comissão é em percentual ou em valor: o campo do outro tipo fica zerado e, se enviado, tem de ser zero. Os campos omitidos ficam com o padrão do Monde: comissão em percentual, valores zerados e over sobre 100%. restitutes_kandir_law só se aplica aos produtos com retenção da Lei Kandir (passagem aérea, seguro viagem e transporte terrestre), e nos demais é recusado. Produtos de operação própria e produtos CVC não têm fornecedores (409). Exige a permissão "Adicionar Fornecedor" de produtos.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
required
object

Fornecedor do fornecimento.

description
string or null <= 50 characters

Descrição do fornecimento (campo opcional).

restitutes_kandir_law
boolean

Indica se o fornecimento restitui a Lei Kandir.

commission_type
string
Enum: "percentage" "amount"

Tipo da comissão — percentage (percentual) ou amount (valor).

commission_percentage
number <double>

Percentual de comissão.

commission_amount
number <double>

Valor da comissão.

over_percentage
number <double>

Percentual de over.

over_value
number <double>

Percentual aplicado sobre o over.

du_percentage
number <double>

Percentual da taxa de cartão DU.

rav_percentage
number <double>

Percentual da taxa de cartão RAV.

Responses

Request samples

Content type
application/json

Exemplo de fornecedor com comissão em percentual e over.

{
  • "supplier": {
    },
  • "description": "Tarifa net",
  • "commission_type": "percentage",
  • "commission_percentage": 10,
  • "over_percentage": 2.5,
  • "over_value": 100
}

Response samples

Content type
application/json

Exemplo de resposta de um fornecimento do produto.

{
  • "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
  • "description": "Tarifa net",
  • "commission_type": "percentage",
  • "commission_percentage": 10,
  • "commission_amount": 0,
  • "over_percentage": 2.5,
  • "over_value": 100,
  • "du_percentage": 0,
  • "rav_percentage": 0,
  • "restitutes_kandir_law": true,
  • "supplier": {
    },
  • "representations": [ ]
}

Consultar fornecedor do produto por ID Beta

Retorna um fornecimento do produto, com as condições comerciais e os representantes. O ID de um fornecimento de outro produto responde 404.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um fornecimento do produto.

{
  • "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
  • "description": "Tarifa net",
  • "commission_type": "percentage",
  • "commission_percentage": 10,
  • "commission_amount": 0,
  • "over_percentage": 2.5,
  • "over_value": 100,
  • "du_percentage": 0,
  • "rav_percentage": 0,
  • "restitutes_kandir_law": true,
  • "supplier": {
    },
  • "representations": [ ]
}

Alterar fornecedor do produto Beta

Altera um fornecimento do produto. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. A descrição enviada como nula fica em branco; o fornecedor (supplier), o restitutes_kandir_law e os campos da comissão não podem ser retirados, e enviados como nulo são recusados (422). Ao trocar o commission_type, o campo da comissão do outro tipo é zerado. Os representantes são mantidos pelo próprio caminho deles. Exige a permissão "Editar Fornecedor" de produtos. A resposta traz o fornecimento alterado quando a credencial também tem a permissão "Visualizar" de produtos; sem ela, apenas o id. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
object

Fornecedor do fornecimento.

description
string or null <= 50 characters

Descrição do fornecimento (campo opcional).

restitutes_kandir_law
boolean

Indica se o fornecimento restitui a Lei Kandir.

commission_type
string
Enum: "percentage" "amount"

Tipo da comissão — percentage (percentual) ou amount (valor).

commission_percentage
number <double>

Percentual de comissão.

commission_amount
number <double>

Valor da comissão.

over_percentage
number <double>

Percentual de over.

over_value
number <double>

Percentual aplicado sobre o over.

du_percentage
number <double>

Percentual da taxa de cartão DU.

rav_percentage
number <double>

Percentual da taxa de cartão RAV.

Responses

Request samples

Content type
application/json

Exemplo de alteração que troca a comissão para valor; o percentual de comissão fica zerado.

{
  • "commission_type": "amount",
  • "commission_amount": 35
}

Response samples

Content type
application/json
Example

Exemplo de resposta de um fornecimento do produto.

{
  • "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
  • "description": "Tarifa net",
  • "commission_type": "percentage",
  • "commission_percentage": 10,
  • "commission_amount": 0,
  • "over_percentage": 2.5,
  • "over_value": 100,
  • "du_percentage": 0,
  • "rav_percentage": 0,
  • "restitutes_kandir_law": true,
  • "supplier": {
    },
  • "representations": [ ]
}

Remover fornecedor do produto Beta

Remove o fornecimento do produto, junto com os representantes dele. Não é possível remover o fornecimento usado em vendas (unifique-o com outro fornecedor na tela de Produtos do Monde) nem o fornecedor que tem regra de faturamento para o produto: os dois casos respondem 409. Exige a permissão "Excluir Fornecedor" de produtos.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Consultar representantes do fornecedor Beta

Retorna os representantes de um fornecimento do produto, cada um com as condições comerciais próprias. Exige a permissão de ler produtos.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

supply_id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de lista de representantes.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Adicionar representante ao fornecedor Beta

Adiciona um representante ao fornecimento do produto. A pessoa do representante (representative) é obrigatória, referenciada pelo UUID, e não pode se repetir no mesmo fornecimento. A comissão segue as mesmas regras do fornecimento: em percentual ou em valor, com o campo do outro tipo zerado, e os campos omitidos com o padrão do Monde. Exige a permissão "Adicionar Representante" de produtos.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

supply_id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
required
object

Representante do fornecimento.

commission_type
string
Enum: "percentage" "amount"

Tipo da comissão — percentage (percentual) ou amount (valor).

commission_percentage
number <double>

Percentual de comissão.

commission_amount
number <double>

Valor da comissão.

over_percentage
number <double>

Percentual de over.

over_value
number <double>

Percentual aplicado sobre o over.

du_percentage
number <double>

Percentual da taxa de cartão DU.

rav_percentage
number <double>

Percentual da taxa de cartão RAV.

Responses

Request samples

Content type
application/json

Exemplo de representante com comissão em valor.

{
  • "representative": {
    },
  • "commission_type": "amount",
  • "commission_amount": 50
}

Response samples

Content type
application/json

Exemplo de resposta de um representante do fornecimento.

{
  • "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
  • "commission_type": "amount",
  • "commission_percentage": 0,
  • "commission_amount": 50,
  • "over_percentage": 0,
  • "over_value": 100,
  • "du_percentage": 0,
  • "rav_percentage": 0,
  • "representative": {
    }
}

Consultar representante do fornecedor por ID Beta

Retorna um representante do fornecimento. O ID de um representante de outro fornecimento responde 404.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

supply_id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

id
required
string <uuid>
Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a

Identificador único do representante do fornecimento (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um representante do fornecimento.

{
  • "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
  • "commission_type": "amount",
  • "commission_percentage": 0,
  • "commission_amount": 50,
  • "over_percentage": 0,
  • "over_value": 100,
  • "du_percentage": 0,
  • "rav_percentage": 0,
  • "representative": {
    }
}

Alterar representante do fornecedor Beta

Altera um representante do fornecimento. Informe apenas os campos que devem mudar: o campo omitido permanece como está. O representante (representative) e os campos da comissão não podem ser retirados, e enviados como nulo são recusados (422). Exige a permissão "Editar Representante" de produtos. A resposta traz o representante alterado quando a credencial também tem a permissão "Visualizar" de produtos; sem ela, apenas o id. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

supply_id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

id
required
string <uuid>
Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a

Identificador único do representante do fornecimento (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
object

Representante do fornecimento.

commission_type
string
Enum: "percentage" "amount"

Tipo da comissão — percentage (percentual) ou amount (valor).

commission_percentage
number <double>

Percentual de comissão.

commission_amount
number <double>

Valor da comissão.

over_percentage
number <double>

Percentual de over.

over_value
number <double>

Percentual aplicado sobre o over.

du_percentage
number <double>

Percentual da taxa de cartão DU.

rav_percentage
number <double>

Percentual da taxa de cartão RAV.

Responses

Request samples

Content type
application/json

Exemplo de alteração só do percentual de over.

{
  • "over_percentage": 1.5
}

Response samples

Content type
application/json
Example

Exemplo de resposta de um representante do fornecimento.

{
  • "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
  • "commission_type": "amount",
  • "commission_percentage": 0,
  • "commission_amount": 50,
  • "over_percentage": 0,
  • "over_value": 100,
  • "du_percentage": 0,
  • "rav_percentage": 0,
  • "representative": {
    }
}

Remover representante do fornecedor Beta

Remove o representante do fornecimento. O representante usado em vendas não pode ser removido (409). Exige a permissão "Excluir Representante" de produtos.

Authorizations:
bearerAuthentication
path Parameters
product_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do produto (formato UUID).

supply_id
required
string <uuid>
Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b

Identificador único do fornecimento do produto (formato UUID).

id
required
string <uuid>
Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a

Identificador único do representante do fornecimento (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Cabines

Consulte e mantenha os tipos de cabine cadastrados no sistema para utilizar em produtos de cruzeiro.

Consultar cabines Beta

Retorna a lista de tipos de cabine cadastrados no sistema.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo todas as cabines cadastradas.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Cadastrar cabine Beta

Cadastra uma cabine. O nome é a chave da cabine: é por ele que a cabine é consultada, alterada e excluída, e é ele que o produto de cruzeiro da venda informa em cabin_kind.

Exige a permissão "Editar" de cabines em alguma empresa que não seja somente leitura. A resposta traz a cabine cadastrada.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string [ 1 .. 30 ] characters

Nome da cabine, até 30 caracteres e sem repetir outra cabine. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia a cabine.

Responses

Request samples

Content type
application/json

Exemplo de cadastro de cabine.

{
  • "name": "Varanda"
}

Response samples

Content type
application/json

Exemplo de resposta de uma cabine.

{
  • "name": "Varanda"
}

Consultar cabine por nome Beta

Retorna a cabine pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F).

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 30 characters
Example: Varanda

Nome atual da cabine, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma cabine.

{
  • "name": "Varanda"
}

Alterar cabine Beta

Altera a cabine pelo nome atual, informado no caminho com codificação de URL. O campo omitido permanece como está. Um nome novo renomeia a cabine, e os produtos de venda que a usam passam a mostrar o nome novo, como no Monde.

O reenvio com a mesma Idempotency-Key depois de trocar o nome responde 404: o caminho antigo não existe mais.

Exige a permissão "Editar" de cabines em alguma empresa que não seja somente leitura. A resposta traz a cabine a quem também pode ler cabines; aos demais, só o nome. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 30 characters
Example: Varanda

Nome atual da cabine, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string [ 1 .. 30 ] characters

Nome da cabine, até 30 caracteres e sem repetir outra cabine. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia a cabine.

Responses

Request samples

Content type
application/json

Exemplo de alteração que renomeia a cabine.

{
  • "name": "Varanda Premium"
}

Response samples

Content type
application/json

Exemplo de resposta de uma cabine.

{
  • "name": "Varanda"
}

Excluir cabine Beta

Exclui a cabine pelo nome atual, informado no caminho com codificação de URL. A cabine usada em algum produto de venda não pode ser excluída: a resposta é 409, como no Monde.

Exige a permissão "Excluir" de cabines em alguma empresa que não seja somente leitura.

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 30 characters
Example: Varanda

Nome atual da cabine, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Navios

Consulte e mantenha os navios cadastrados no sistema para utilizar em produtos de cruzeiro.

Consultar navios Beta

Retorna a lista de navios cadastrados no sistema.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo todos os navios cadastrados.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Cadastrar navio Beta

Cadastra um navio. O nome é a chave do navio: é por ele que o navio é consultado, alterado e excluído, e é ele que o produto de cruzeiro da venda informa em ship_name.

Exige a permissão "Editar" de navios em alguma empresa que não seja somente leitura. A resposta traz o navio cadastrado.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string [ 1 .. 30 ] characters

Nome do navio, até 30 caracteres e sem repetir outro navio. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia o navio.

Responses

Request samples

Content type
application/json

Exemplo de cadastro de navio.

{
  • "name": "MSC Preziosa"
}

Response samples

Content type
application/json

Exemplo de resposta de um navio.

{
  • "name": "MSC Preziosa"
}

Consultar navio por nome Beta

Retorna o navio pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F).

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 30 characters
Example: MSC Preziosa

Nome atual do navio, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um navio.

{
  • "name": "MSC Preziosa"
}

Alterar navio Beta

Altera o navio pelo nome atual, informado no caminho com codificação de URL. O campo omitido permanece como está. Um nome novo renomeia o navio, e os produtos de venda que o usam passam a mostrar o nome novo, como no Monde.

O reenvio com a mesma Idempotency-Key depois de trocar o nome responde 404: o caminho antigo não existe mais.

Exige a permissão "Editar" de navios em alguma empresa que não seja somente leitura. A resposta traz o navio a quem também pode ler navios; aos demais, só o nome. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 30 characters
Example: MSC Preziosa

Nome atual do navio, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string [ 1 .. 30 ] characters

Nome do navio, até 30 caracteres e sem repetir outro navio. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia o navio.

Responses

Request samples

Content type
application/json

Exemplo de alteração que renomeia o navio.

{
  • "name": "MSC Preziosa II"
}

Response samples

Content type
application/json

Exemplo de resposta de um navio.

{
  • "name": "MSC Preziosa"
}

Excluir navio Beta

Exclui o navio pelo nome atual, informado no caminho com codificação de URL. O navio usado em algum produto de venda não pode ser excluído: a resposta é 409, como no Monde.

Exige a permissão "Excluir" de navios em alguma empresa que não seja somente leitura.

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 30 characters
Example: MSC Preziosa

Nome atual do navio, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Pacotes

Consulte e mantenha os pacotes turísticos usados nos produtos de pacote turístico das vendas.

Consultar pacotes Beta

Retorna a lista de pacotes cadastrados no sistema, em ordem de nome.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo todos os pacotes cadastrados.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Cadastrar pacote Beta

Cadastra um pacote. O nome é a chave do pacote: é por ele que o pacote é consultado, alterado e excluído, e é ele que o produto de pacote turístico da venda informa em package_name.

Exige a permissão "Editar" de pacotes em alguma empresa que não seja somente leitura. A resposta traz o pacote cadastrado.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string [ 1 .. 50 ] characters

Nome do pacote, até 50 caracteres e sem repetir outro pacote. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia o pacote.

services_included
string or null

Serviços inclusos no pacote. Na alteração, nulo deixa o campo em branco.

Responses

Request samples

Content type
application/json

Exemplo de cadastro de pacote.

{
  • "name": "Disney 7 noites",
  • "services_included": "Aéreo, hotel e ingressos para os parques"
}

Response samples

Content type
application/json

Exemplo de resposta de um pacote.

{
  • "name": "Disney 7 noites",
  • "services_included": "Aéreo, hotel e ingressos para os parques"
}

Consultar pacote por nome Beta

Retorna o pacote pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F).

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 50 characters
Example: Disney 7 noites

Nome atual do pacote, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um pacote.

{
  • "name": "Disney 7 noites",
  • "services_included": "Aéreo, hotel e ingressos para os parques"
}

Alterar pacote Beta

Altera o pacote pelo nome atual, informado no caminho com codificação de URL. O campo omitido permanece como está. Os serviços inclusos enviados nulos ficam em branco. Um nome novo renomeia o pacote, e os produtos de venda que o usam passam a mostrar o nome novo, como no Monde.

O reenvio com a mesma Idempotency-Key depois de trocar o nome responde 404: o caminho antigo não existe mais.

Exige a permissão "Editar" de pacotes em alguma empresa que não seja somente leitura. A resposta traz o pacote a quem também pode ler pacotes; aos demais, só o nome. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 50 characters
Example: Disney 7 noites

Nome atual do pacote, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string [ 1 .. 50 ] characters

Nome do pacote, até 50 caracteres e sem repetir outro pacote. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia o pacote.

services_included
string or null

Serviços inclusos no pacote. Na alteração, nulo deixa o campo em branco.

Responses

Request samples

Content type
application/json

Exemplo de alteração que renomeia o pacote.

{
  • "name": "Disney 8 noites"
}

Response samples

Content type
application/json

Exemplo de resposta de um pacote.

{
  • "name": "Disney 7 noites",
  • "services_included": "Aéreo, hotel e ingressos para os parques"
}

Excluir pacote Beta

Exclui o pacote pelo nome atual, informado no caminho com codificação de URL. O pacote usado em algum produto de venda não pode ser excluído: a resposta é 409, como no Monde.

Exige a permissão "Excluir" de pacotes em alguma empresa que não seja somente leitura.

Authorizations:
bearerAuthentication
path Parameters
name
required
string <= 50 characters
Example: Disney 7 noites

Nome atual do pacote, com codificação de URL

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Centros de Custo

Consulte e mantenha os centros de custo cadastrados no sistema para utilizar em lançamentos financeiros.

Consultar centros de custo Beta

Retorna a lista de centros de custo cadastrados no sistema.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo todos os centros de custo cadastrados.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir centro de custo Beta

Cadastra um centro de custo. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
required
string <= 50 characters

Descrição do centro de custo, até 50 caracteres. Obrigatória na inclusão.

Responses

Request samples

Content type
application/json

Centro de custo Marketing.

{
  • "description": "Marketing"
}

Response samples

Content type
application/json

Exemplo de resposta de um centro de custo específico.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Administrativo"
}

Consultar centro de custo por ID Beta

Retorna um centro de custo específico pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do centro de custo

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um centro de custo específico.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Administrativo"
}

Alterar centro de custo Beta

Altera a descrição do centro de custo. O campo omitido permanece como está; description não pode ser retirado, e enviado como nulo é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do centro de custo

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
string <= 50 characters

Descrição do centro de custo, até 50 caracteres. Obrigatória na inclusão.

Responses

Request samples

Content type
application/json

Altera a descrição.

{
  • "description": "Marketing digital"
}

Response samples

Content type
application/json
Example

Exemplo de resposta de um centro de custo específico.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Administrativo"
}

Excluir centro de custo Beta

Exclui o centro de custo. O centro de custo usado no rateio de algum lançamento financeiro responde 409. Não exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do centro de custo

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Moedas

Consulte e mantenha as moedas cadastradas no sistema e as cotações delas, para utilizar em produtos de venda e lançamentos financeiros.

Consultar moedas Beta

Retorna a lista de moedas cadastradas no sistema.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo todas as moedas cadastradas.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar moeda por código Beta

Retorna uma moeda específica pelo seu código ISO 4217.

Authorizations:
bearerAuthentication
path Parameters
code
required
string
Example: BRL

Código da moeda no padrão ISO 4217

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma moeda específica.

{
  • "code": "BRL",
  • "description": "Real",
  • "symbol": "R$",
  • "active": true
}

Alterar moeda Beta

Ativa ou desativa a moeda pelo código. A lista de moedas é interna e fixa: código, descrição e símbolo não mudam, e enviar nesses campos um valor diferente do atual é recusado com 422. O campo omitido permanece como está.

Exige a permissão "Editar moedas e gravar câmbios" de moedas em alguma empresa que não seja somente leitura. A resposta traz a moeda a quem também pode ler moedas; aos demais, só o código.

Authorizations:
bearerAuthentication
path Parameters
code
required
string
Example: USD

Código da moeda no padrão ISO 4217

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
code
string = 3 characters

Código da moeda. É fixo: um valor diferente do atual é recusado (422)

description
string <= 100 characters

Descrição da moeda. É fixa: um valor diferente do atual é recusado (422)

symbol
string or null <= 5 characters

Símbolo da moeda. É fixo: um valor diferente do atual é recusado (422)

active
boolean

Indica se a moeda está ativa

Responses

Request samples

Content type
application/json

Exemplo de alteração que desativa a moeda.

{
  • "active": false
}

Response samples

Content type
application/json

Exemplo de resposta de uma moeda específica.

{
  • "code": "BRL",
  • "description": "Real",
  • "symbol": "R$",
  • "active": true
}

Excluir moeda Beta

Nenhuma moeda é excluída: a lista de moedas é interna e fixa, e a resposta é sempre 409. Para deixar de usar uma moeda, desative-a em Alterar moeda.

Exige a permissão "Excluir" de moedas em alguma empresa que não seja somente leitura.

Authorizations:
bearerAuthentication
path Parameters
code
required
string
Example: USD

Código da moeda no padrão ISO 4217

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Consultar cotações da moeda Beta

Retorna o histórico de cotações da moeda, da mais recente para a mais antiga. A cotação diz quantos reais vale uma unidade da moeda; a vigente é a mais recente. Exige a permissão "Visualizar" de moedas.

Authorizations:
bearerAuthentication
path Parameters
code
required
string
Example: USD

Código da moeda no padrão ISO 4217

query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com o histórico de cotações da moeda.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Gravar cotação da moeda Beta

Grava a cotação nova da moeda, com a data e a hora do momento da gravação, como a ferramenta Atualizar Câmbios do Monde. O valor é quantos reais vale uma unidade da moeda, maior que zero, e é gravado com 4 casas decimais.

Só as moedas ativas, menos o real (BRL), recebem cotação. Quando o valor é igual ao da cotação vigente, nada é gravado e a resposta traz a vigente, com 200.

A gravação de cotações é exclusiva das operadoras: na agência a resposta é 403. Exige a permissão "Editar moedas e gravar câmbios" de moedas em alguma empresa que não seja somente leitura.

Authorizations:
bearerAuthentication
path Parameters
code
required
string
Example: USD

Código da moeda no padrão ISO 4217

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
value
required
number ( 0 .. 99999999999.9999 ]

Quantos reais vale uma unidade da moeda, maior que zero. É gravado com 4 casas decimais

Responses

Request samples

Content type
application/json

Exemplo de gravação da cotação nova da moeda.

{
  • "value": 5.4321
}

Response samples

Content type
application/json

Exemplo de resposta de uma cotação.

{
  • "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
  • "currency": {
    },
  • "value": 5.4321,
  • "quoted_at": "2026-10-14T09:30:00"
}

Consultar cotação por ID Beta

Retorna uma cotação da moeda pelo ID.

Authorizations:
bearerAuthentication
path Parameters
code
required
string
Example: USD

Código da moeda no padrão ISO 4217

id
required
string <uuid>
Example: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10

ID da cotação

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma cotação.

{
  • "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
  • "currency": {
    },
  • "value": 5.4321,
  • "quoted_at": "2026-10-14T09:30:00"
}

Atualizar câmbios Beta

Grava de uma vez a cotação nova de várias moedas, como a ferramenta Atualizar Câmbios do Monde. Cada item leva o código da moeda e o valor, quantos reais vale uma unidade dela; só as moedas ativas, menos o real (BRL), recebem cotação, e a mesma moeda não pode repetir na lista.

A gravação é de tudo ou nada: um item inválido recusa a requisição inteira com 422, e o erro traz a posição dele na lista, contada a partir de 0. A moeda cujo valor é igual ao da cotação vigente fica de fora, e a resposta traz só as cotações gravadas: 201 quando ao menos uma foi gravada, e 200 com a lista vazia quando todos os valores são iguais aos das cotações vigentes.

Exclusivo das operadoras: na agência a resposta é 403. Exige a permissão "Editar moedas e gravar câmbios" de moedas em alguma empresa que não seja somente leitura.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
required
Array of objects non-empty

As cotações novas, uma por moeda

Responses

Request samples

Content type
application/json

Exemplo de atualização das cotações do dólar e do euro.

{
  • "exchange_rates": [
    ]
}

Response samples

Content type
application/json

Exemplo de resposta em que só o dólar mudou de valor e foi gravado.

{
  • "exchange_rates": [
    ]
}

Categorias

Consulte e mantenha as categorias financeiras cadastradas no sistema, agrupadas por tipo (receita ou despesa) e grupo.

Consultar categorias Beta

Retorna a lista de categorias financeiras cadastradas no sistema.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo categorias de despesa e receita.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir categoria Beta

Cadastra uma categoria financeira num grupo. O tipo (expense ou revenue) é o do grupo informado em group_id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
required
string <= 50 characters

Descrição da categoria, até 50 caracteres. Obrigatória na inclusão.

group_id
required
string <uuid>

ID do grupo da categoria (consulte em GET /category_groups). Obrigatório na inclusão. Na alteração, só um grupo do mesmo tipo.

pass_through
boolean

Indica se a categoria é de repasse: valores que só transitam pela agência e ficam fora do resultado. Na inclusão, o padrão é false.

Responses

Request samples

Content type
application/json

Categoria de despesa no grupo Despesas Administrativas.

{
  • "description": "Aluguel",
  • "group_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "pass_through": false
}

Response samples

Content type
application/json

Exemplo de resposta de uma categoria de receita, com o grupo.

{
  • "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
  • "description": "Venda de Pacotes",
  • "kind": "revenue",
  • "pass_through": false,
  • "group": {
    }
}

Consultar categoria por ID Beta

Retorna uma categoria financeira específica pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da categoria

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma categoria de receita, com o grupo.

{
  • "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
  • "description": "Venda de Pacotes",
  • "kind": "revenue",
  • "pass_through": false,
  • "group": {
    }
}

Alterar categoria Beta

Altera a descrição, o repasse ou o grupo da categoria. A categoria só troca para outro grupo do mesmo tipo: não é permitido alterar o tipo de uma categoria, como no Monde, e o grupo de outro tipo é recusado com 422. O campo omitido permanece como está; description, group_id e pass_through não podem ser retirados, e enviados como nulo são recusados (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da categoria

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
string <= 50 characters

Descrição da categoria, até 50 caracteres. Obrigatória na inclusão.

group_id
string <uuid>

ID do grupo da categoria (consulte em GET /category_groups). Obrigatório na inclusão. Na alteração, só um grupo do mesmo tipo.

pass_through
boolean

Indica se a categoria é de repasse: valores que só transitam pela agência e ficam fora do resultado. Na inclusão, o padrão é false.

Responses

Request samples

Content type
application/json

Altera só a descrição; os demais campos ficam como estão.

{
  • "description": "Aluguel da loja"
}

Response samples

Content type
application/json
Example

Exemplo de resposta de uma categoria de receita, com o grupo.

{
  • "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
  • "description": "Venda de Pacotes",
  • "kind": "revenue",
  • "pass_through": false,
  • "group": {
    }
}

Excluir categoria Beta

Exclui a categoria. A categoria usada em algum lançamento financeiro, ou escolhida como padrão numa configuração do Monde, responde 409. Como no Monde, o grupo que fica sem categorias é excluído junto. Não exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da categoria

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Grupos de Categorias

Consulte e mantenha os grupos que organizam as categorias financeiras. Cada grupo é de despesa ou de receita, e as categorias dele herdam esse tipo. Usa as permissões de Categorias. O Monde apaga sozinho o grupo que fica sem categorias quando uma categoria é gravada por ele: cadastre o grupo junto da primeira categoria. Pela API, excluir a última categoria do grupo também apaga o grupo.

Consultar grupos de categorias Beta

Retorna os grupos de categorias, os de despesa antes dos de receita, em ordem de nome.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Grupos de despesa e de receita.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir grupo de categorias Beta

Cadastra um grupo de categorias de despesa ou de receita. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
required
string <= 50 characters

Nome do grupo, até 50 caracteres. Obrigatório na inclusão.

kind
required
string
Enum: "expense" "revenue"

Tipo do grupo: expense (despesa) ou revenue (receita). Obrigatório.

Responses

Request samples

Content type
application/json

Grupo de despesa.

{
  • "name": "Impostos",
  • "kind": "expense"
}

Response samples

Content type
application/json

Exemplo de um grupo de categorias de despesa.

{
  • "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}

Consultar grupo de categorias por ID Beta

Retorna um grupo de categorias pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91

Identificador único do grupo

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de um grupo de categorias de despesa.

{
  • "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}

Alterar grupo de categorias Beta

Altera o nome do grupo. O tipo não muda depois da inclusão: as categorias do grupo já foram lançadas com aquele sinal, e o tipo diferente é recusado com 422. O campo omitido permanece como está; name e kind não podem ser retirados, e enviados como nulo são recusados (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91

Identificador único do grupo

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string <= 50 characters

Nome do grupo, até 50 caracteres. Obrigatório na inclusão.

kind
string
Enum: "expense" "revenue"

Aceito só com o tipo atual do grupo: outro tipo é recusado com 422.

Responses

Request samples

Content type
application/json

Altera só o nome.

{
  • "name": "Tributos"
}

Response samples

Content type
application/json
Example

Exemplo de um grupo de categorias de despesa.

{
  • "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}

Excluir grupo de categorias Beta

Exclui o grupo sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. O grupo vazio é excluído. Como no Monde, a exclusão do grupo com categorias exclui também as categorias dele e pede confirmação, e por isso aqui o grupo com categorias responde 409. Nesse caso, para excluir o grupo com as categorias, use Excluir grupo de categorias com confirmação. Exige a permissão Excluir de Categorias numa empresa ativa que não seja somente leitura. Não exige Idempotency-Key: repetir responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91

Identificador único do grupo

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Excluir grupo de categorias com confirmação Beta

Exclui o grupo com a confirmação que o Monde pede antes de excluir as categorias dele. É a mesma exclusão de Excluir grupo de categorias, com as mesmas regras, permissões e respostas. A diferença é que a confirmação vai no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho. Como no Monde, a exclusão do grupo com categorias exclui também as categorias dele, e por isso pede a confirmação em delete_categories: sem ela, responde 409. Se alguma categoria for usada em lançamento financeiro ou numa configuração do Monde, nada é excluído e a resposta é 409. O grupo vazio é excluído sem a confirmação. O valor que não é true nem false responde 422. Exige a permissão Excluir de Categorias numa empresa ativa que não seja somente leitura. Exige Idempotency-Key: sem ela, a resposta é 400. Como o grupo excluído deixa de existir, o reenvio depois da exclusão responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91

Identificador único do grupo

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
delete_categories
boolean

Confirma que a exclusão do grupo exclui também as categorias dele. Sem ela, o grupo com categorias responde 409. Aceita só true ou false: outro valor responde 422.

Responses

Request samples

Content type
application/json
{
  • "delete_categories": true,
  • "name": "Despesas Administrativas",
  • "kind": "expense"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Cidades

Consulte as cidades que a agência pode usar, com estado, país e códigos oficiais (IBGE e SIAFI). São as cadastradas na agência e as da lista de cidades do Monde, que traz os municípios do IBGE e as cidades do exterior. A cidade da lista entra no cadastro da agência quando uma pessoa ou nota fiscal passa a usá-la, com o mesmo id.

Consultar cidades Beta

Retorna as cidades que a agência pode usar, as cadastradas nela e as da lista de cidades do Monde. Não pede permissão: toda credencial consulta.

Authorizations:
bearerAuthentication
query Parameters
name
string
Example: name=sao paulo

Filtra por nome, sem diferenciar maiúsculas nem acentos, como o campo Cidade do Monde: acha o início das palavras do nome (ex.: Miguel acha São Miguel do Oeste), os outros nomes da cidade na lista do Monde (ex.: New York e Nova York acham Nova Iorque), o estado e o país (ex.: Paraná traz também as cidades do Paraná). Com o filtro, a cidade cujo nome é o informado vem primeiro, depois a que tem esse nome entre os outros nomes, a que começa por ele, a que o contém e, por fim, as achadas pelo estado, pelo país ou por parte de outro nome; em cada grupo, a maior primeiro.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo cidades brasileiras e estrangeira.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar cidade por ID Beta

Retorna uma cidade específica pelo seu identificador. Não pede permissão: toda credencial consulta.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da cidade

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma cidade brasileira, com o estado e o país.

{
  • "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "name": "São Paulo",
  • "ibge": "3550308",
  • "siafi": "7107",
  • "state": {
    },
  • "country": {
    }
}

Funções

Consulte, cadastre, altere e exclua as funções de pessoa do módulo de comissões, como no cadastro de Funções do Monde: o nome da função, as empresas ou vendedores sobre cujas vendas ela é comissionada e as pessoas vinculadas a ela, com o plano de comissão, a data de início e as metas de cada uma. As funções Vendedor e Intermediário são do sistema: não mudam de nome, não comissionam sobre empresas ou vendedores e não são excluídas, mas recebem pessoas. As metas são gravadas aqui, como no "Plano e Metas" da pessoa no Monde: a lista goals de cada pessoa em people, com a permissão "Editar" de funções; o recurso Metas só as consulta. O recurso é só da agência: na instalação de operadora, todas as chamadas respondem 403. Ler exige a permissão "Visualizar" de funções; gravar, a "Editar" numa empresa que não esteja somente leitura; excluir, a "Excluir".

Consultar funções Beta

Retorna a lista de funções cadastradas, por nome, com os campos próprios de cada uma.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com uma função da agência e as duas funções do sistema.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Cadastrar função Beta

Cadastra uma função. A função cadastrada aqui não é de vendedor nem de intermediário, e por isso precisa de ao menos uma empresa ou vendedor ativo em commissioned_over. Cada pessoa aparece uma vez na função, e a que é comissionada precisa da data de início. Cada pessoa pode vir já com as metas, em goals. Exige a permissão "Editar" de funções.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
required
string <= 30 characters

Nome da função, até 30 caracteres.

Array of objects (entity_reference)

Empresas e vendedores ativos sobre cujas vendas a função é comissionada, pelo id obtido em Consultar empresas ou em Consultar vendedores, que é o da pessoa. Obrigatório no cadastro, com ao menos um item. Na alteração, a lista enviada substitui a da função.

Array of objects (person_role_person_write)

Pessoas vinculadas à função. Na alteração, a lista enviada é a final.

Responses

Request samples

Content type
application/json

Exemplo de cadastro de uma função comissionada sobre uma empresa, já com uma pessoa vinculada.

{
  • "description": "Gerente",
  • "commissioned_over": [
    ],
  • "people": [
    ]
}

Response samples

Content type
application/json

Exemplo de resposta de uma função comissionada sobre uma empresa, com uma pessoa vinculada.

{
  • "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
  • "description": "Gerente",
  • "seller": false,
  • "intermediary": false,
  • "system": false,
  • "commissioned_over": [
    ],
  • "people": [
    ]
}

Consultar função por ID Beta

Retorna uma função específica pelo seu identificador, com as empresas ou vendedores sobre cujas vendas ela é comissionada e as pessoas vinculadas, cada uma com as metas dela na função, por ano.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e

Identificador único da função

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma função comissionada sobre uma empresa, com uma pessoa vinculada.

{
  • "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
  • "description": "Gerente",
  • "seller": false,
  • "intermediary": false,
  • "system": false,
  • "commissioned_over": [
    ],
  • "people": [
    ]
}

Alterar função Beta

Altera uma função já cadastrada. Informe apenas o que deve mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). O que a função não pode ficar sem é recusado (422): description, e em cada item de people a person e o not_commissioned. O commission_plan e a start_date do item enviados como nulos são retirados. A lista enviada como nula vale como a vazia. As listas enviadas são as finais: em commissioned_over, a empresa ou vendedor que ficou de fora deixa a função; em people, o item com id mantém e atualiza aquele vínculo (só os campos enviados nele), o item sem id vincula uma pessoa nova, e o vínculo que ficou de fora é desfeito, junto com as metas da pessoa na função. Em goals de um item, a lista enviada também é a final: a meta com id fica e muda só os campos enviados nela, a sem id entra e a que ficou de fora é excluída; goals omitido mantém as metas, e goals nulo exclui todas. Trocar entre si os anos de duas metas na mesma alteração é recusado (422): faça a troca em duas alterações, passando antes por um ano livre. Na função do sistema (Vendedor, Intermediário) só people muda. Exige a permissão "Editar" de funções. A resposta traz a função alterada no mesmo formato da consulta por ID quando a credencial também pode ler funções; sem isso, a alteração é gravada e a resposta traz apenas o id.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e

Identificador único da função

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
string <= 30 characters

Nome da função, até 30 caracteres.

Array of objects (entity_reference)

Empresas e vendedores ativos sobre cujas vendas a função é comissionada, pelo id obtido em Consultar empresas ou em Consultar vendedores, que é o da pessoa. Obrigatório no cadastro, com ao menos um item. Na alteração, a lista enviada substitui a da função.

Array of objects (person_role_person_write)

Pessoas vinculadas à função. Na alteração, a lista enviada é a final.

Responses

Request samples

Content type
application/json
Example

Exemplo de alteração em que um vínculo fica sem plano e passa a não comissionado, uma pessoa nova entra e os vínculos que não vieram na lista são desfeitos.

{
  • "people": [
    ]
}

Response samples

Content type
application/json
Example

Exemplo de resposta de uma função comissionada sobre uma empresa, com uma pessoa vinculada.

{
  • "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
  • "description": "Gerente",
  • "seller": false,
  • "intermediary": false,
  • "system": false,
  • "commissioned_over": [
    ],
  • "people": [
    ]
}

Excluir função Beta

Exclui a função definitivamente, com os vínculos de pessoas e as metas deles. A função do sistema e a função que já tem comissão calculada em alguma venda não são excluídas: a resposta é 409. Exige a permissão "Excluir" de funções.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e

Identificador único da função

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Vendedores

Consulte, cadastre, altere e exclua os vendedores usados nas vendas. O vendedor é uma pessoa física já cadastrada, e o identificador dele é o da pessoa. O cadastro de vendedores é um só para o sistema inteiro, sem empresa: as permissões valem em qualquer empresa ativa em que forem concedidas, e gravar exige uma empresa que não seja somente leitura.

Consultar vendedores Beta

Retorna a lista de vendedores cadastrados no sistema (ativos e inativos).

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo vendedores ativos e inativos.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Cadastrar vendedor Beta

Torna vendedor uma pessoa física já cadastrada, informada em person_id (o id da consulta de Pessoas). O vendedor passa a ter o mesmo identificador da pessoa. Como no Monde, só pessoa física vira vendedor, e cada pessoa só uma vez. O vendedor nasce ativo, a menos que active seja enviado como false. Para cadastrar a pessoa e o vendedor numa chamada só, junto da venda, use o seller de Inserir venda. Exige a permissão "Editar" de vendedores.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
external_id
required
string <= 50 characters

Identificador único utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID.

Exemplo: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".

name
required
string <= 100 characters

Nome.

Exemplo: "Maria da Silva".

cpf
string = 11 characters

CPF, sem pontos, traços ou espaços.

Exemplo: "38107867807".

person_id
required
string <uuid>

Identificador da pessoa física que passa a ser vendedor

active
boolean
Default: true

Indica se o vendedor nasce ativo. Omitido, o vendedor nasce ativo

Responses

Request samples

Content type
application/json

Torna vendedor a pessoa física informada, já ativo.

{
  • "person_id": "f9d961b8-ea88-4346-8e52-afe94267417a"
}

Response samples

Content type
application/json

Exemplo de resposta de um vendedor específico.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "active": true,
  • "created_at": "2024-03-15T10:30:00",
  • "person": {
    },
  • "created_by": {
    }
}

Consultar vendedor por ID Beta

Retorna um vendedor específico pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do vendedor

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um vendedor específico.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "active": true,
  • "created_at": "2024-03-15T10:30:00",
  • "person": {
    },
  • "created_by": {
    }
}

Alterar vendedor Beta

Ativa ou desativa um vendedor. O vendedor inativo continua nas vendas em que já está, mas deixa de ser oferecido nas vendas novas do Monde. A pessoa do vendedor não muda: enviar em person_id outra pessoa é recusado com 422. O campo omitido permanece como está; person_id e active não podem ser retirados, e enviados como nulo são recusados (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Exige a permissão "Editar" de vendedores. A resposta traz o vendedor alterado quando a credencial também tem a permissão "Visualizar" de vendedores; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id do vendedor.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do vendedor

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
person_id
string <uuid>

Identificador da pessoa do vendedor. Opcional; se enviado, precisa ser o da própria pessoa do vendedor, que não muda

active
boolean

Indica se o vendedor fica ativo. O inativo deixa de ser oferecido nas vendas novas

Responses

Request samples

Content type
application/json

Desativa o vendedor, que deixa de ser oferecido nas vendas novas.

{
  • "active": false
}

Response samples

Content type
application/json
Example

Exemplo de resposta de um vendedor específico.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "active": true,
  • "created_at": "2024-03-15T10:30:00",
  • "person": {
    },
  • "created_by": {
    }
}

Excluir vendedor Beta

Exclui o vendedor. A pessoa continua cadastrada; só deixa de ser vendedor. O vendedor que já está em alguma venda não pode ser excluído e responde 409: desative-o com active: false. Exige a permissão "Excluir" de vendedores.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do vendedor

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Formas de Pagamento

Consulte e mantenha as formas de pagamento cadastradas no sistema para utilizar em lançamentos financeiros.

Consultar formas de pagamento Beta

Retorna a lista de formas de pagamento cadastradas no sistema. Formas de uso interno do sistema não são retornadas.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo formas de pagamento do sistema e cadastradas pelo usuário.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir forma de pagamento Beta

Cadastra uma forma de pagamento da agência. Ela nasce fora do sistema (system igual a false) e aparece na consulta. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
required
string <= 30 characters

Nome da forma de pagamento, até 30 caracteres. Obrigatório na inclusão.

Responses

Request samples

Content type
application/json

Forma de pagamento da agência.

{
  • "name": "Vale-viagem"
}

Response samples

Content type
application/json

Exemplo de resposta de uma forma de pagamento específica.

{
  • "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
  • "name": "Dinheiro",
  • "system": true
}

Consultar forma de pagamento por ID Beta

Retorna uma forma de pagamento específica pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da forma de pagamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma forma de pagamento específica.

{
  • "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
  • "name": "Dinheiro",
  • "system": true
}

Alterar forma de pagamento Beta

Altera o nome da forma de pagamento. A forma do sistema (system igual a true) não se altera e responde 409, como no Monde; a de uso interno, que não aparece na consulta, responde 404. O campo omitido permanece como está; name não pode ser retirado, e enviado como nulo é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9

Identificador único da forma de pagamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string <= 30 characters

Nome da forma de pagamento, até 30 caracteres. Obrigatório na inclusão.

Responses

Request samples

Content type
application/json

Altera o nome.

{
  • "name": "Voucher"
}

Response samples

Content type
application/json
Example

Exemplo de resposta de uma forma de pagamento específica.

{
  • "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
  • "name": "Dinheiro",
  • "system": true
}

Excluir forma de pagamento Beta

Exclui a forma de pagamento da agência. A forma do sistema responde 409, assim como a usada em lançamentos, movimentações ou regras de taxa; a de uso interno responde 404. Não exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9

Identificador único da forma de pagamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Contas e Cartões

Consulte, cadastre, altere e exclua as contas e cartões: conta caixa, conta corrente e cartão de crédito, com os dados bancários e de cartão, as empresas em que cada conta está disponível, os grupos de usuários com acesso e a cobrança dos boletos da conta corrente.

Consultar contas e cartões Beta

Retorna a lista de contas e cartões disponíveis nas empresas em que a credencial tem permissão. Contas ativas e inativas são retornadas.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo uma conta corrente e um cartão de crédito.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir conta ou cartão Beta

Cadastra uma conta caixa (cashier_account), conta corrente (checking_account) ou cartão de crédito (card_account), com as mesmas regras do cadastro do Monde. Cada tipo grava só os seus campos: o campo de outro tipo (como agency ou initial_balance num cartão, ou billing_accounts fora da conta corrente) é ignorado, como o campo que não existe, e não é gravado. A conta fica disponível nas empresas de companies, e a credencial precisa da permissão de inserir e editar contas e cartões em cada uma delas. No cartão de crédito, a fatura é gerada em invoice_company, que precisa estar entre as empresas da conta; com uma empresa só, é ela. A cobrança (billing_accounts) só existe na conta corrente.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
required
string <= 50 characters

Descrição da conta

currency
required
string

Código da moeda (ISO 4217), uma das moedas cadastradas. Não pode ser trocado depois que a conta tem movimentação.

active
boolean

Indica se a conta está ativa. A conta do recebimento padrão não pode ser desativada.

initial_balance
number <double>

Saldo inicial, com até 2 casas decimais. Não existe no cartão de crédito, em que é ignorado. Alterá-lo reabre os caixas fechados da conta e exige a permissão Reabrir Caixa.

object (entity_reference)

Referência a um registro relacionado.

object

Banco da conta corrente, pelo id de Consultar bancos. Não pode ser trocado depois que a conta tem cobrança.

agency
string

Agência da conta corrente: 4 dígitos, só números.

agency_digit
string <= 1 characters

Dígito da agência bancária

bank_operation
string

Operação da conta, só na Caixa Econômica Federal (banco 104), com 3 ou 4 dígitos.

number
string <= 10 characters

Número da conta bancária

digit
string <= 1 characters

Dígito da conta bancária

pix_key
string <= 100 characters

Chave Pix da conta

object

Operadora do cartão de crédito (pessoa), obrigatória no cartão.

bill_expiration
integer [ 1 .. 31 ]

Dia de vencimento da fatura do cartão (1 a 31), obrigatório no cartão.

bill_closing
integer [ 1 .. 31 ]

Dia de fechamento da fatura do cartão (1 a 31), obrigatório no cartão.

object

Empresa em que a fatura do cartão é gerada, uma das empresas de companies. Com uma empresa só, é ela.

required
Array of objects (entity_reference) non-empty

Empresas em que a conta fica disponível, pelo id (o mesmo que a consulta devolve). Precisa ter ao menos uma; na alteração, é a lista final.

Array of objects (entity_reference)

Grupos de usuários com acesso à conta. Sem grupo, a conta não tem restrição. Grupo com acesso total não aceita vínculo. Na alteração, é a lista final.

Array of objects (billing_account_write)

Cobranças dos boletos, só na conta corrente; nas demais contas, a lista é ignorada. Na alteração, é a lista final: a cobrança que já emitiu boletos não pode ficar de fora.

kind
required
string
Enum: "cashier_account" "checking_account" "card_account"

Tipo da conta: cashier_account (caixa), checking_account (conta corrente) ou card_account (cartão de crédito). Não muda depois de cadastrada.

Responses

Request samples

Content type
application/json
Example

Cadastra uma conta corrente disponível numa empresa, liberada a um grupo de usuários e com a cobrança pelo Monde Bancos.

{
  • "kind": "checking_account",
  • "description": "Banco do Brasil - Matriz",
  • "currency": "BRL",
  • "initial_balance": 1500,
  • "owner": {
    },
  • "bank": {
    },
  • "agency": "1412",
  • "agency_digit": "5",
  • "number": "04640",
  • "digit": "2",
  • "pix_key": "financeiro@agencia.com.br",
  • "companies": [
    ],
  • "user_groups": [
    ],
  • "billing_accounts": [
    ]
}

Response samples

Content type
application/json

Exemplo de resposta de uma conta específica.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Banco do Brasil - Matriz",
  • "kind": "checking_account",
  • "active": true,
  • "currency": "BRL",
  • "initial_balance": 1500,
  • "bank_operation": null,
  • "agency": "1412",
  • "agency_digit": "5",
  • "number": "04640",
  • "digit": "2",
  • "pix_key": "financeiro@agencia.com.br",
  • "bill_expiration": null,
  • "bill_closing": null,
  • "bank": {
    },
  • "owner": {
    },
  • "card_operator": null,
  • "companies": [
    ],
  • "invoice_company": null,
  • "user_groups": [
    ],
  • "next_bank_slip_number": 1520,
  • "billing_accounts": [
    ]
}

Consultar conta ou cartão por ID Beta

Retorna uma conta ou cartão específico pelo seu identificador, desde que disponível em uma empresa em que a credencial tem permissão.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da conta

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma conta específica.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Banco do Brasil - Matriz",
  • "kind": "checking_account",
  • "active": true,
  • "currency": "BRL",
  • "initial_balance": 1500,
  • "bank_operation": null,
  • "agency": "1412",
  • "agency_digit": "5",
  • "number": "04640",
  • "digit": "2",
  • "pix_key": "financeiro@agencia.com.br",
  • "bill_expiration": null,
  • "bill_closing": null,
  • "bank": {
    },
  • "owner": {
    },
  • "card_operator": null,
  • "companies": [
    ],
  • "invoice_company": null,
  • "user_groups": [
    ],
  • "next_bank_slip_number": 1520,
  • "billing_accounts": [
    ]
}

Alterar conta ou cartão Beta

Altera a conta ou cartão. O campo omitido fica como está, o enviado como null é retirado, e o tipo não muda. description, currency, active e initial_balance enviados como null respondem 422. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). O campo de outro tipo de conta é ignorado, como na inclusão: reenviar o que a consulta devolveu não é recusado. Cada lista enviada passa a ser a lista final da conta: em companies e user_groups, o item que ficou de fora é desvinculado; em billing_accounts, a cobrança com id é alterada (só nos campos enviados), a sem id é cadastrada e a que ficou de fora é excluída. Ligar ou desligar uma empresa exige a permissão de editar contas nela. A empresa com lançamento em aberto na conta, ou a que gera a fatura do cartão, não pode ser desligada. Alterar o saldo inicial reabre os caixas fechados da conta e, como no Monde, exige também a permissão Reabrir Caixa de Contas e Cartões numa das empresas da conta; sem ela, a resposta é 403 e nada é gravado. Reenviar o saldo gravado não pede a permissão. Trocar a empresa ou o dia de vencimento do cartão leva junto as faturas em aberto, e trocar a empresa exige a permissão de editar contas nas duas empresas. A resposta traz a conta só para quem também tem a permissão de leitura; aos demais, só o id.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da conta

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
description
string <= 50 characters

Descrição da conta

currency
string

Código da moeda (ISO 4217), uma das moedas cadastradas. Não pode ser trocado depois que a conta tem movimentação.

active
boolean

Indica se a conta está ativa. A conta do recebimento padrão não pode ser desativada.

initial_balance
number <double>

Saldo inicial, com até 2 casas decimais. Não existe no cartão de crédito, em que é ignorado. Alterá-lo reabre os caixas fechados da conta e exige a permissão Reabrir Caixa.

object (entity_reference)

Referência a um registro relacionado.

object

Banco da conta corrente, pelo id de Consultar bancos. Não pode ser trocado depois que a conta tem cobrança.

agency
string

Agência da conta corrente: 4 dígitos, só números.

agency_digit
string <= 1 characters

Dígito da agência bancária

bank_operation
string

Operação da conta, só na Caixa Econômica Federal (banco 104), com 3 ou 4 dígitos.

number
string <= 10 characters

Número da conta bancária

digit
string <= 1 characters

Dígito da conta bancária

pix_key
string <= 100 characters

Chave Pix da conta

object

Operadora do cartão de crédito (pessoa), obrigatória no cartão.

bill_expiration
integer [ 1 .. 31 ]

Dia de vencimento da fatura do cartão (1 a 31), obrigatório no cartão.

bill_closing
integer [ 1 .. 31 ]

Dia de fechamento da fatura do cartão (1 a 31), obrigatório no cartão.

object

Empresa em que a fatura do cartão é gerada, uma das empresas de companies. Com uma empresa só, é ela.

Array of objects (entity_reference) non-empty

Empresas em que a conta fica disponível, pelo id (o mesmo que a consulta devolve). Precisa ter ao menos uma; na alteração, é a lista final.

Array of objects (entity_reference)

Grupos de usuários com acesso à conta. Sem grupo, a conta não tem restrição. Grupo com acesso total não aceita vínculo. Na alteração, é a lista final.

Array of objects (billing_account_write)

Cobranças dos boletos, só na conta corrente; nas demais contas, a lista é ignorada. Na alteração, é a lista final: a cobrança que já emitiu boletos não pode ficar de fora.

next_bank_slip_number
integer [ 1 .. 2147483647 ]

Número do próximo boleto, só na alteração da conta corrente; nas demais contas, é ignorado, e o texto vazio é recusado (422) em qualquer conta. A numeração só anda para a frente: o número menor que o atual, ou que não seja maior que o último boleto emitido, responde 422. Reenviar o número atual não muda nada.

Responses

Request samples

Content type
application/json

Altera a descrição e a chave Pix e o convênio de uma cobrança existente. A lista de cobranças enviada é a final: cobrança que ficasse de fora seria excluída.

{
  • "description": "Banco do Brasil - Filial",
  • "pix_key": "filial@agencia.com.br",
  • "billing_accounts": [
    ]
}

Response samples

Content type
application/json
Example

Exemplo de resposta de uma conta específica.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Banco do Brasil - Matriz",
  • "kind": "checking_account",
  • "active": true,
  • "currency": "BRL",
  • "initial_balance": 1500,
  • "bank_operation": null,
  • "agency": "1412",
  • "agency_digit": "5",
  • "number": "04640",
  • "digit": "2",
  • "pix_key": "financeiro@agencia.com.br",
  • "bill_expiration": null,
  • "bill_closing": null,
  • "bank": {
    },
  • "owner": {
    },
  • "card_operator": null,
  • "companies": [
    ],
  • "invoice_company": null,
  • "user_groups": [
    ],
  • "next_bank_slip_number": 1520,
  • "billing_accounts": [
    ]
}

Excluir conta ou cartão Beta

Exclui a conta ou cartão de todas as empresas, então exige a permissão de excluir contas e cartões em cada empresa em que a conta está disponível. Como no Monde, não se exclui a conta com movimentações, com cobrança cadastrada, liberada a um grupo de usuários ou definida como conta do recebimento padrão (409).

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da conta

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Bancos

Consulte a tabela de bancos do Monde, a mesma usada para informar o banco de uma conta corrente. Pela API a tabela é só de consulta: o cadastro de bancos é feito no Monde.

Consultar bancos Beta

Retorna a lista de bancos, ordenada pelo nome do banco, como na escolha do banco no cadastro de conta corrente.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta contendo bancos da tabela de referência.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar banco por ID Beta

Retorna um banco específico pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: c3b7e8eb-1199-4457-9170-923c3fe56c92

Identificador único do banco

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um banco específico.

{
  • "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
  • "number": "001",
  • "name": "Banco do Brasil S.A."
}

Regras da Nota Fiscal

Consulte as regras de emissão de nota fiscal, com os campos da venda que compõem cada emissão. As regras não pertencem a nenhuma empresa: valem para a agência inteira, e só existem na base de agência.

Consultar regras da nota fiscal Beta

Retorna a lista de regras da nota fiscal cadastradas no sistema. Produto, fornecedor e pagante nulos indicam que a regra vale para todos.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo uma regra geral e uma regra restrita a produto e fornecedor.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar regra da nota fiscal por ID Beta

Retorna uma regra da nota fiscal específica pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da regra da nota fiscal

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma regra de nota fiscal específica.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Regra padrão de pacotes",
  • "representative_scope": "any",
  • "created_at": "2024-03-15T10:30:00",
  • "product": null,
  • "supplier": null,
  • "representative": null,
  • "payer": {
    },
  • "created_by": {
    },
  • "payer_rule": {
    },
  • "supplier_rule": {
    },
  • "representative_rule": {
    }
}

Tarefas

Consulte, crie, altere e exclua tarefas, com responsável, pessoa vinculada, categoria e vencimento, e comente no histórico delas. A tarefa que a credencial criou é sempre dela; a dos outros usuários pede a permissão Ver tarefas de outros usuários, como no Monde (veja as Perguntas frequentes).

Consultar tarefas Beta

Retorna a lista de tarefas das empresas em que a credencial tem permissão (tarefas sem empresa são visíveis em todas), da tarefa sem vencimento para a de vencimento mais distante. Os filtros são os da consulta de Tarefas do Monde e se combinam: responsável, quem cadastrou, pessoa, categoria, situação, vencidas, período (por vencimento, cadastro ou conclusão) e o vínculo com venda, viagem ou lançamento. Sem status, as tarefas excluídas não são retornadas. Filtro com valor inválido responde 400.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

assignee_id
string <uuid>
Example: assignee_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Retorna só as tarefas deste responsável, pelo identificador da pessoa.

created_by_id
string <uuid>
Example: created_by_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Retorna só as tarefas cadastradas por esta pessoa (o created_by da tarefa).

person_id
string <uuid>
Example: person_id=c3b7e8eb-1199-4457-9170-923c3fe56c92

Retorna só as tarefas vinculadas a esta pessoa.

category_id
string
Example: category_id=11

Retorna só as tarefas desta categoria, pelo identificador obtido em Consultar categorias de tarefa. uncategorized retorna as tarefas sem categoria.

status
Array of strings
Items Enum: "pending" "completed" "deleted"
Example: status=pending

Situações a retornar, separadas por vírgula: pending (não concluída), completed (concluída) e deleted (excluída). As situações informadas se somam, e a tarefa excluída só vem quando deleted está entre elas. Sem o parâmetro, retorna as não concluídas e as concluídas.

overdue
boolean
Example: overdue=true

true retorna só as tarefas vencidas: não concluídas e com o vencimento já passado. false retorna as que não estão vencidas. A tarefa sem vencimento nunca fica vencida.

date_field
string
Enum: "due" "created_at" "completed_at"
Example: date_field=due

Data usada no filtro de período: due (vencimento), created_at (cadastro) ou completed_at (conclusão). Obrigatório quando date_from ou date_to é informado.

date_from
string <date>
Example: date_from=2024-04-01

Início do período (inclusivo), no formato YYYY-MM-DD.

date_to
string <date>
Example: date_to=2024-04-30

Fim do período (inclusivo, o dia inteiro), no formato YYYY-MM-DD.

sale_id
string <uuid>
Example: sale_id=8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8

Retorna só as tarefas vinculadas a esta venda.

travel_id
string <uuid>
Example: travel_id=1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9

Retorna só as tarefas vinculadas a esta viagem.

bill_id
string <uuid>
Example: bill_id=5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9

Retorna só as tarefas vinculadas a este lançamento (conta a pagar ou receber).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo tarefas pendente e concluída.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar tarefa Beta

Cria uma tarefa com título e responsável; categoria e vencimento são opcionais, e a tarefa sem vencimento nunca fica atrasada. A empresa da tarefa é opcional, mas informá-la não é: envie company_identifier com o CNPJ da empresa, ou como nulo para a tarefa valer em todas as empresas; vazio é recusado. Omitir o campo é recusado, porque a empresa não é deduzida. Aceita, em history, os comentários com que a tarefa nasce. A tarefa pode nascer vinculada a uma venda (sale_id), uma viagem (travel_id) e um lançamento (bill_id), cada um opcional e sem relação obrigatória com a pessoa da tarefa (person_id). Quando vierem juntos, precisam combinar entre si: a venda tem de ser da viagem informada, e o lançamento, da venda informada. Só é aceito o registro que a credencial pode ler; os demais respondem 422 como não encontrados. O responsável é avisado por e-mail, e a tarefa nasce pendente.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
required
string or null = 14 characters ^[0-9]{14}$

CNPJ da empresa em que a tarefa será criada, só os dígitos. Nulo cria a tarefa sem empresa, valendo para todas as empresas; o campo é obrigatório e omiti-lo é recusado. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado

title
required
string <= 100 characters

Título da tarefa

description
string

Descrição da tarefa

due
string <date-time>

Data e hora de vencimento (nulo quando a tarefa não tem vencimento, e então nunca fica atrasada)

category_id
integer

Identificador da categoria da tarefa, obtido em Consultar categorias de tarefa.

assignee_id
required
string <uuid>

Identificador da pessoa responsável pela tarefa, obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde e, na tarefa de uma empresa, ter acesso às tarefas dela, como no Monde. A conferência vale em toda alteração da tarefa, também quando o responsável não muda.

person_id
string <uuid>

Identificador da pessoa vinculada à tarefa, obtido em Consultar pessoas.

sale_id
string <uuid>

Identificador da venda a vincular, obtido em Consultar vendas. Com travel_id, a venda precisa ser dessa viagem.

travel_id
string <uuid>

Identificador da viagem a vincular, obtido em Consultar viagens.

bill_id
string <uuid>

Identificador do lançamento (conta a pagar ou receber) a vincular, obtido em Consultar contas a pagar e receber. Com sale_id, o lançamento precisa ser dessa venda.

Array of objects (task_historic_create)

Comentários com que a tarefa nasce

Array of objects (custom_field)

Campos personalizados a preencher na tarefa, definidos pela agência

Responses

Request samples

Content type
application/json
Example

Exemplo de criação de uma tarefa com pessoa vinculada, comentário inicial e campo personalizado.

{
  • "company_identifier": "46598887000162",
  • "title": "Enviar voucher para o cliente",
  • "description": "Confirmar os dados do embarque antes do envio.",
  • "due": "2024-04-01T09:00:00",
  • "category_id": 11,
  • "assignee_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "person_id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
  • "history": [
    ],
  • "custom_fields": [
    ]
}

Response samples

Content type
application/json

Exemplo de consulta de uma tarefa com o histórico e os campos personalizados.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": 1042,
  • "title": "Enviar voucher para o cliente",
  • "description": "Confirmar os dados do embarque antes do envio.",
  • "due": "2024-04-01T09:00:00",
  • "completed_at": null,
  • "visualized": false,
  • "deleted": false,
  • "created_at": "2024-03-15T10:30:00",
  • "category": {
    },
  • "assignee": {
    },
  • "person": {
    },
  • "sale": {
    },
  • "travel": {
    },
  • "bill": null,
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Consultar tarefa por ID Beta

Retorna os dados de uma tarefa específica, incluindo o histórico, os campos personalizados e os anexos.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da tarefa (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de consulta de uma tarefa com o histórico e os campos personalizados.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": 1042,
  • "title": "Enviar voucher para o cliente",
  • "description": "Confirmar os dados do embarque antes do envio.",
  • "due": "2024-04-01T09:00:00",
  • "completed_at": null,
  • "visualized": false,
  • "deleted": false,
  • "created_at": "2024-03-15T10:30:00",
  • "category": {
    },
  • "assignee": {
    },
  • "person": {
    },
  • "sale": {
    },
  • "travel": {
    },
  • "bill": null,
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Alterar tarefa Beta

Altera uma tarefa já cadastrada. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado da tarefa — a descrição, o vencimento, a categoria, a pessoa e os vínculos. O title, o assignee_id e o completed não podem ser retirados: a tarefa precisa ter título e responsável, e enviá-los como nulo ou vazio é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Para concluir a tarefa envie completed como true, e para reabri-la, como false. O company_identifier omitido mantém a empresa da tarefa; com um CNPJ, leva a tarefa para aquela empresa e exige a permissão "Editar" de tarefas também nela; enviado como nulo, deixa a tarefa sem empresa, valendo para todas. Os campos personalizados não substituem: cada um enviado é gravado por cima do atual, o enviado com value nulo ou vazio é limpo (o obrigatório não se limpa: a resposta é 422), e os demais permanecem. Os vínculos com venda, viagem e lançamento (sale_id, travel_id, bill_id) seguem as regras da criação: omitido, o vínculo fica; enviado como nulo, sai da tarefa. A pessoa já preenchida da tarefa não é trocada nem retirada enquanto ela tiver vínculo: desfaça os vínculos antes, ou na mesma requisição. Preencher a pessoa da tarefa que está sem pessoa é permitido, mesmo com vínculo. Comentários são enviados em Comentar na tarefa. Exige a permissão "Editar" de tarefas. Tarefa excluída não pode ser alterada: a resposta é 409. Quem participa da tarefa é avisado por e-mail da alteração, como na alteração feita no Monde. A resposta traz a tarefa alterada no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de tarefas na empresa da tarefa; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da tarefa. Vale também para a tarefa que a própria credencial criou.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da tarefa (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
string or null = 14 characters ^[0-9]{14}$

CNPJ da empresa para onde a tarefa vai, só os dígitos. Nulo tira a tarefa da empresa, deixando-a válida para todas; omitido, mantém a empresa atual. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado. A tarefa de outro usuário exige também, na empresa de destino, "Ver tarefas de outros usuários"; sem ela, a resposta é 403 com a mensagem do Monde

title
string <= 100 characters

Título da tarefa

description
string or null

Descrição da tarefa

due
string or null <date-time>

Data e hora de vencimento. Nulo tira o vencimento, e a tarefa deixa de ficar atrasada; omitido, mantém o vencimento atual

category_id
integer or null

Identificador da categoria da tarefa, obtido em Consultar categorias de tarefa. Nulo tira a categoria; omitido, mantém a categoria atual.

assignee_id
string <uuid>

Identificador da pessoa responsável pela tarefa, obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde e, na tarefa de uma empresa, ter acesso às tarefas dela, como no Monde. A conferência vale em toda alteração da tarefa, também quando o responsável não muda.

person_id
string or null <uuid>

Identificador da pessoa vinculada à tarefa, obtido em Consultar pessoas.

sale_id
string or null <uuid>

Identificador da venda a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual.

travel_id
string or null <uuid>

Identificador da viagem a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual.

bill_id
string or null <uuid>

Identificador do lançamento a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual.

completed
boolean

true conclui a tarefa, com a data e hora da alteração; false a reabre. Concluir uma tarefa já concluída mantém a data da conclusão original.

Array of objects (custom_field)

Campos personalizados da tarefa, definidos pela agência. Não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão, então a lista vazia não muda nada e não é possível esvaziar um campo por esta operação. Envie cada campo por id e value.

Responses

Request samples

Content type
application/json
Example

Exemplo de alteração do título, do vencimento, do responsável e de um campo personalizado de uma tarefa já cadastrada.

{
  • "title": "Enviar voucher atualizado para o cliente",
  • "due": "2024-04-02T09:00:00",
  • "assignee_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "custom_fields": [
    ]
}

Response samples

Content type
application/json
Example

Exemplo de consulta de uma tarefa com o histórico e os campos personalizados.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": 1042,
  • "title": "Enviar voucher para o cliente",
  • "description": "Confirmar os dados do embarque antes do envio.",
  • "due": "2024-04-01T09:00:00",
  • "completed_at": null,
  • "visualized": false,
  • "deleted": false,
  • "created_at": "2024-03-15T10:30:00",
  • "category": {
    },
  • "assignee": {
    },
  • "person": {
    },
  • "sale": {
    },
  • "travel": {
    },
  • "bill": null,
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Excluir tarefa Beta

Exclui a tarefa. A tarefa excluída deixa de aparecer em Consultar tarefas, mas continua disponível na consulta por ID, com deleted igual a true, e não pode mais ser alterada nem receber comentário. Tarefa concluída não pode ser excluída: reabra-a antes, enviando completed como false em Alterar tarefa. Exige a permissão de excluir tarefas na empresa da tarefa. Quem participa da tarefa é avisado por e-mail da exclusão, como na exclusão feita no Monde. Não exige Idempotency-Key: repetir a requisição depois de excluída responde 409.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da tarefa (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Comentar na tarefa Beta

Acrescenta um comentário ao histórico da tarefa e devolve a tarefa com o histórico atualizado — ou apenas o id da tarefa, quando a credencial não tem a permissão "Visualizar" de tarefas na empresa da tarefa, mesmo na tarefa que ela criou. Quem participa da tarefa é avisado do comentário por e-mail, como no comentário feito no Monde. Exige a permissão "Editar" de tarefas. Tarefa excluída não recebe comentário: a resposta é 409. O comentário pode levar arquivos: envie cada um antes em Enviar anexo, com resource_type task e o id da tarefa, e informe os ids devolvidos em attachment_ids. Cada anexo fica ligado ao comentário e aparece dentro dele no Monde. Com anexos, o texto é opcional. O histórico é só acréscimo: comentário registrado não se altera nem se exclui, e as linhas de alteração que o Monde gera não são enviadas por aqui.

Authorizations:
bearerAuthentication
path Parameters
task_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da tarefa (formato UUID).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
text
string

Texto do comentário

attachment_ids
Array of strings <uuid> [ items <uuid > ]

Identificadores dos anexos a ligar ao comentário, devolvidos por Enviar anexo. Cada um precisa ser anexo desta tarefa, não excluído e ainda sem comentário; os demais respondem 422 como não encontrados.

Responses

Request samples

Content type
application/json
Example

Exemplo de comentário acrescentado ao histórico de uma tarefa existente.

{
  • "text": "Cliente confirmou os dados do embarque."
}

Response samples

Content type
application/json

Exemplo de consulta de uma tarefa com o histórico e os campos personalizados.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": 1042,
  • "title": "Enviar voucher para o cliente",
  • "description": "Confirmar os dados do embarque antes do envio.",
  • "due": "2024-04-01T09:00:00",
  • "completed_at": null,
  • "visualized": false,
  • "deleted": false,
  • "created_at": "2024-03-15T10:30:00",
  • "category": {
    },
  • "assignee": {
    },
  • "person": {
    },
  • "sale": {
    },
  • "travel": {
    },
  • "bill": null,
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Categorias de Tarefas

Consulte, crie, altere e exclua as categorias de tarefas. Cada categoria pode ser uma coluna do quadro de tarefas (kanban), e a ordem das colunas também é gravada aqui. As categorias não pertencem a nenhuma empresa: valem para a agência inteira.

Consultar categorias de tarefas Beta

Retorna a lista de categorias de tarefas cadastradas no sistema, com a marcação do quadro de tarefas e a posição de cada coluna.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta contendo categorias de tarefas, duas delas no quadro.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar categoria de tarefa Beta

Cria uma categoria de tarefa. Como na tela de Categorias do Monde, a categoria nova entra no quadro de tarefas como a última coluna; envie kanban como false para deixá-la fora do quadro, ou kanban_position para pô-la em outra posição, deslocando as demais colunas. O nome é único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado. Exige a permissão "Editar" de categorias de tarefas.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
required
string <= 30 characters

Nome da categoria de tarefa, com até 30 caracteres. É único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado.

kanban
boolean
Default: true

Indica se a categoria é uma coluna do quadro de tarefas (kanban). Omitido, a categoria entra no quadro.

kanban_position
integer >= 1

Posição da coluna no quadro de tarefas, a partir de 1, da esquerda para a direita; as demais colunas se deslocam. Vai de 1 até o número de colunas do quadro já contando esta categoria, e só é aceita para a categoria que fica no quadro. Omitida, a categoria nova entra como última coluna e a alterada mantém a posição.

Responses

Request samples

Content type
application/json

Cria a categoria e a põe na segunda coluna do quadro de tarefas.

{
  • "name": "Emissão",
  • "kanban_position": 2
}

Response samples

Content type
application/json

Exemplo de resposta com uma categoria de tarefa específica.

{
  • "id": 42,
  • "name": "Emissão",
  • "kanban": true,
  • "kanban_position": 2
}

Consultar categoria de tarefa por ID Beta

Retorna os dados de uma categoria de tarefa específica.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único da categoria de tarefa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com uma categoria de tarefa específica.

{
  • "id": 42,
  • "name": "Emissão",
  • "kanban": true,
  • "kanban_position": 2
}

Alterar categoria de tarefa Beta

Altera uma categoria de tarefa. Informe apenas os campos que devem mudar: o campo omitido permanece como está. O nome e o kanban não podem ser retirados: enviados como nulo são recusados (422), assim como o nome vazio e o kanban ou a kanban_position enviados como texto vazio. kanban_position só fica nula fora do quadro: enviada como nula na categoria que continua no quadro, é recusada (422). Renomear a categoria leva junto as tarefas dela. Com kanban_position, a coluna vai para aquela posição do quadro e as demais se deslocam; com kanban como false, a categoria sai do quadro, e as tarefas dela continuam na categoria. Exige a permissão "Editar" de categorias de tarefas. A resposta traz a categoria alterada no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de categorias de tarefas; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único da categoria de tarefa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string <= 30 characters

Nome da categoria de tarefa, com até 30 caracteres. É único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado.

kanban
boolean

Indica se a categoria é uma coluna do quadro de tarefas (kanban). Ao voltar para o quadro sem kanban_position, a coluna retoma a posição que tinha.

kanban_position
integer or null >= 1

Posição da coluna no quadro de tarefas, a partir de 1, da esquerda para a direita; as demais colunas se deslocam. Vai de 1 até o número de colunas do quadro já contando esta categoria, e só é aceita para a categoria que fica no quadro. Omitida, a categoria nova entra como última coluna e a alterada mantém a posição.

Responses

Request samples

Content type
application/json
Example

Altera só o nome da categoria; as tarefas dela acompanham.

{
  • "name": "Emissão de bilhetes"
}

Response samples

Content type
application/json
Example

Exemplo de resposta com uma categoria de tarefa específica.

{
  • "id": 42,
  • "name": "Emissão",
  • "kanban": true,
  • "kanban_position": 2
}

Excluir categoria de tarefa Beta

Exclui a categoria de tarefa definitivamente, e a coluna dela sai do quadro. Como no Monde, só a categoria sem tarefas pode ser excluída, contando também as tarefas concluídas e as excluídas: mova as tarefas para outra categoria antes. Exige a permissão "Excluir" de categorias de tarefas.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único da categoria de tarefa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Viagens

Consulte, cadastre, altere e exclua as viagens, com cliente, vendedor, situação e o período calculado a partir das vendas vinculadas, e vincule ou desvincule vendas. A viagem que a credencial cadastrou, ou com venda que ela criou, é sempre dela; a dos outros vendedores pede a permissão Consultar vendas de outros vendedores, como no Monde, também para alterar, excluir e vincular (veja as Perguntas frequentes).

Consultar viagens Beta

Retorna a lista de viagens das empresas em que a credencial tem permissão. As datas e a situação são calculadas a partir dos produtos ativos das vendas vinculadas não canceladas. Aceita filtro por data pelo início ou fim da viagem com os parâmetros date_field, date_from e date_to.

Authorizations:
bearerAuthentication
query Parameters
date_field
string
Enum: "start_date" "end_date"
Example: date_field=start_date

Campo de data usado no filtro. Valores aceitos: start_date (início da viagem) e end_date (fim da viagem), ambos calculados a partir das vendas vinculadas. Obrigatório quando date_from ou date_to é informado.

date_from
string <date>
Example: date_from=2024-01-01

Filtrar viagens cujo campo escolhido em date_field seja igual ou posterior a esta data, no formato ISO 8601 (AAAA-MM-DD).

date_to
string <date>
Example: date_to=2024-12-31

Filtrar viagens cujo campo escolhido em date_field seja igual ou anterior a esta data, no formato ISO 8601 (AAAA-MM-DD).

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo viagens a iniciar e finalizada.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar viagem Beta

Cadastra uma viagem na empresa informada em company_identifier, com as mesmas regras do Monde: descrição (até 60 caracteres), cliente (customer_id, uma pessoa) e vendedor (seller_id, um vendedor ativo) são obrigatórios. O vendedor vem no corpo porque a credencial da API não é um usuário do Monde. O número da viagem é gerado na gravação. A viagem nasce sem vendas: vincule-as depois em POST /travels/{id}/sales/{sale_id}. Exige a permissão "Editar" de Viagens na empresa. A viagem cadastrada pela credencial é dela: ela altera, exclui e vincula vendas a essa viagem sem a permissão Consultar vendas de outros vendedores. A viagem cadastrada por outra credencial segue essa permissão, como a dos outros vendedores.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
required
string = 14 characters ^[0-9]{14}$

CNPJ da empresa da viagem, só os dígitos. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado

description
required
string <= 60 characters

Descrição da viagem, com até 60 caracteres

customer_id
required
string <uuid>

ID da pessoa cliente da viagem, a mesma de GET /people. Informar o cliente exige a permissão "Ler todas as pessoas": sem ela, ele é recusado (422) como o que não existe.

seller_id
required
string <uuid>

ID do vendedor da viagem, o mesmo de GET /sellers. Precisa ser um vendedor ativo; na alteração, o vendedor atual da viagem reenviado é aceito mesmo inativo

observations
string

Observações da viagem

Array of objects (custom_field)

Campos personalizados a preencher na viagem, definidos pela agência. Os obrigatórios precisam vir na criação

Responses

Request samples

Content type
application/json

Viagem com descrição, cliente, vendedor e observações.

{
  • "company_identifier": "46598887000162",
  • "description": "Lua de mel - Cancún",
  • "customer_id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
  • "seller_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "observations": "Cliente prefere assentos na janela."
}

Response samples

Content type
application/json

Viagem recém-cadastrada, ainda sem vendas vinculadas: sem datas e sem situação.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": "000043",
  • "description": "Lua de mel - Cancún",
  • "situation": null,
  • "start_date": null,
  • "end_date": null,
  • "observations": "Cliente prefere assentos na janela.",
  • "created_at": "2024-03-15T10:30:00",
  • "customer": {
    },
  • "seller": {
    },
  • "company": {
    },
  • "created_by": null,
  • "sales": [ ],
  • "passengers": [ ],
  • "attachments": [ ],
  • "custom_fields": [ ]
}

Consultar viagem por ID Beta

Retorna uma viagem específica com seus campos escalares, os anexos e as referências às vendas e aos passageiros vinculados. Os valores por passageiro pertencem a cada venda, obtidos pelo endpoint da venda.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da viagem a ser obtida

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de viagem com referências às vendas e aos passageiros vinculados.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": "000042",
  • "description": "Lua de mel - Cancún",
  • "situation": "upcoming",
  • "start_date": "2024-05-10",
  • "end_date": "2024-05-24",
  • "observations": "Cliente prefere assentos na janela.",
  • "created_at": "2024-03-15T10:30:00",
  • "customer": {
    },
  • "seller": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "sales": [
    ],
  • "passengers": [
    ],
  • "attachments": [],
  • "custom_fields": [
    ]
}

Alterar viagem Beta

Altera uma viagem já cadastrada. Informe apenas os campos que devem mudar: o campo omitido permanece como está. A descrição, o cliente, o vendedor e a empresa, que a viagem não pode ficar sem, enviados como nulo ou como texto vazio respondem 422, como na tarefa. As observações são a exceção: enviadas como nulo, ficam em branco. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). A empresa não muda depois do cadastro, como no Monde: company_identifier só é aceito com o CNPJ da própria viagem. Exige a permissão "Editar" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores; sem ela, a viagem responde 404. A resposta traz a viagem alterada no mesmo formato da consulta por ID quando a credencial também a consulta; sem isso, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da viagem.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da viagem

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
string = 14 characters ^[0-9]{14}$

CNPJ da empresa da viagem, só os dígitos. A empresa não muda depois do cadastro: só é aceito o CNPJ da própria viagem

description
string <= 60 characters

Descrição da viagem, com até 60 caracteres

customer_id
string <uuid>

ID da pessoa cliente da viagem, a mesma de GET /people. Informar o cliente exige a permissão "Ler todas as pessoas": sem ela, ele é recusado (422) como o que não existe.

seller_id
string <uuid>

ID do vendedor da viagem, o mesmo de GET /sellers. Precisa ser um vendedor ativo; na alteração, o vendedor atual da viagem reenviado é aceito mesmo inativo

observations
string or null

Observações da viagem. Enviadas como nulo, ficam em branco; o texto vazio é gravado como está

Array of objects (custom_field)

Campos personalizados da viagem, definidos pela agência. Não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão. O campo obrigatório não pode ser enviado vazio. Envie cada campo por id e value.

Responses

Request samples

Content type
application/json

Só os campos enviados mudam.

{
  • "description": "Lua de mel - Cancún e Tulum",
  • "observations": "Incluir o passeio a Tulum."
}

Response samples

Content type
application/json
Example

Exemplo de viagem com referências às vendas e aos passageiros vinculados.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": "000042",
  • "description": "Lua de mel - Cancún",
  • "situation": "upcoming",
  • "start_date": "2024-05-10",
  • "end_date": "2024-05-24",
  • "observations": "Cliente prefere assentos na janela.",
  • "created_at": "2024-03-15T10:30:00",
  • "customer": {
    },
  • "seller": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "sales": [
    ],
  • "passengers": [
    ],
  • "attachments": [],
  • "custom_fields": [
    ]
}

Excluir viagem Beta

Exclui a viagem definitivamente. As vendas vinculadas saem da viagem antes, e cada uma registra no log o desvínculo. A viagem com anexos, inclusive os já excluídos, não é excluída (409), como no Monde: exclua os anexos definitivamente no Monde antes. Quando a empresa da viagem está configurada para aceitar só vendas cadastradas dentro de uma viagem, a viagem com vendas vinculadas não pode ser excluída pela API (409): no Monde, só o administrador a exclui. Exige a permissão "Excluir" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores; sem ela, a viagem responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da viagem

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Vincular venda à viagem Beta

Vincula a venda à viagem, como o botão Vincular venda do Monde. Como no Monde, a credencial precisa abrir a venda: a que ela criou ou, a de outro vendedor, com as permissões Visualizar e Abrir vendas de outros vendedores/intermediários de Vendas. A venda que a credencial não abre, ou de outra empresa, responde 404, como inexistente. A venda excluída, ou sem nenhum produto ativo, responde 422. A venda que já está nesta viagem responde 409. A venda que está em outra viagem é transferida para esta, como no Monde, sem conferir o acesso da credencial à viagem de origem, e a saída fica registrada no log da viagem de origem. O vínculo fica registrado no log da viagem e no da venda. Exige a permissão "Editar" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores. A resposta traz a viagem com a lista de vendas atualizada, ou apenas o id dela para a credencial que não a consulta.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da viagem

sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da venda

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Responses

Response samples

Content type
application/json
Example

Exemplo de viagem com referências às vendas e aos passageiros vinculados.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "number": "000042",
  • "description": "Lua de mel - Cancún",
  • "situation": "upcoming",
  • "start_date": "2024-05-10",
  • "end_date": "2024-05-24",
  • "observations": "Cliente prefere assentos na janela.",
  • "created_at": "2024-03-15T10:30:00",
  • "customer": {
    },
  • "seller": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "sales": [
    ],
  • "passengers": [
    ],
  • "attachments": [],
  • "custom_fields": [
    ]
}

Desvincular venda da viagem Beta

Tira a venda da viagem, e o desvínculo fica registrado no log da viagem e no da venda. A venda que não está nesta viagem, ou que a credencial não abre (como no vínculo), responde 404. Quando a empresa da viagem está configurada para aceitar só vendas cadastradas dentro de uma viagem, a venda não pode ser desvinculada pela API (409): no Monde, só o administrador desvincula; vincule-a a outra viagem para transferi-la. Exige a permissão "Editar" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da viagem

sale_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da venda

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Orçamentos

Consulte, crie, altere, duplique e exclua os orçamentos cadastrados no sistema, com validade, situação e o link público de visualização.

Consultar orçamentos Beta

Retorna a lista de orçamentos das empresas em que a credencial tem permissão.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo orçamentos ativo e desativado.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar orçamento Beta

Cria um orçamento na empresa informada em company_identifier, com as regras da tela de Orçamentos do Monde Web. O dono do orçamento (user_id) é obrigatório, porque a credencial da API não é um usuário do Monde: é ele quem vê, altera e exclui o orçamento pelo Monde, além dos administradores. Título e validade (valid_until) são obrigatórios, e a validade não pode estar no passado. Sem o cabeçalho, o orçamento nasce com o cabeçalho color, na cor principal das Configurações de Orçamentos da empresa, com o título e o subtítulo. Sem details, o conteúdo nasce do modelo de conteúdo da empresa, o salvo pelo administrador na tela de Configurações de Orçamentos do Monde Web ou, se a empresa nunca salvou as configurações, o modelo padrão. O orçamento nasce ativo, a menos que active seja enviado como false, e já com o link público em public_url. Exige a permissão de criar/editar orçamentos na empresa.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
required
string = 14 characters ^[0-9]{14}$

CNPJ da empresa em que o orçamento será criado, só os dígitos. A empresa não pode estar somente leitura. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado.

user_id
required
string <uuid>

Identificador do usuário dono do orçamento, o mesmo id da pessoa obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do orçamento.

person_id
string <uuid>

Identificador da pessoa (cliente) do orçamento, obtido em Consultar pessoas. Opcional. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe.

title
required
string

Título do orçamento

subtitle
string

Subtítulo do orçamento. Opcional.

valid_until
required
string <date>

Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado.

details
string

Conteúdo do orçamento, em HTML. O HTML é limpo antes de gravar, com as mesmas regras do conteúdo dos guias. Opcional: na criação, sem ele vale o modelo de conteúdo da empresa, o salvo pelo administrador na tela de Configurações de Orçamentos do Monde Web; enviado como texto vazio, o orçamento fica sem conteúdo.

active
boolean
Default: true

Indica se o orçamento está ativo

internal_observations
string

Observações internas (não aparecem no link público)

cover_kind
string
Enum: "color" "image" "none"

Cabeçalho do link público: color (uma cor de fundo), image (uma imagem) ou none (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, image vale só no orçamento que já tem uma. Trocar para outra opção apaga a imagem. Mandar só cover_color já escolhe color, e color sem cover_color vem com a cor principal das Configurações de Orçamentos da empresa.

cover_color
string

Cor de fundo do cabeçalho, em hexadecimal (#1f4e79). Só vale com o cabeçalho color; nos outros, fica nula. A cor fica gravada no orçamento: mudar a cor principal das Configurações de Orçamentos depois não muda o cabeçalho. O título fica preto no fundo claro e branco no escuro.

cover_show_title
boolean

Exibe o título no cabeçalho. No cabeçalho color é sempre true.

cover_show_subtitle
boolean

Exibe o subtítulo no cabeçalho. No cabeçalho image com cover_show_title e cover_show_subtitle em false, a imagem aparece inteira, sem recorte e sem texto por cima.

Responses

Request samples

Content type
application/json

Exemplo de criação de um orçamento com pessoa e observações internas.

{
  • "company_identifier": "46598887000162",
  • "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "person_id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "title": "Cancún",
  • "subtitle": "Lua de mel - 14 noites",
  • "valid_until": "2035-05-31",
  • "details": "<p>Pacote com aéreo, hospedagem all inclusive e traslados.</p>",
  • "internal_observations": "Cliente pediu retorno até sexta.",
  • "cover_color": "#1f4e79"
}

Response samples

Content type
application/json

Exemplo de resposta de um orçamento específico.

{
  • "id": 42,
  • "title": "Cancún",
  • "subtitle": "Lua de mel - 14 noites",
  • "details": "Pacote com aéreo, hospedagem all inclusive e traslados.",
  • "valid_until": "2024-05-31",
  • "active": true,
  • "internal_observations": "Cliente pediu retorno até sexta.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "cover_image_url": null,
  • "created_at": "2024-03-15T10:30:00",
  • "updated_at": "2024-03-16T08:15:00",
  • "person": {
    },
  • "company": {
    },
  • "user": {
    }
}

Consultar orçamento por ID Beta

Retorna um orçamento específico pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do orçamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um orçamento específico.

{
  • "id": 42,
  • "title": "Cancún",
  • "subtitle": "Lua de mel - 14 noites",
  • "details": "Pacote com aéreo, hospedagem all inclusive e traslados.",
  • "valid_until": "2024-05-31",
  • "active": true,
  • "internal_observations": "Cliente pediu retorno até sexta.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "cover_image_url": null,
  • "created_at": "2024-03-15T10:30:00",
  • "updated_at": "2024-03-16T08:15:00",
  • "person": {
    },
  • "company": {
    },
  • "user": {
    }
}

Alterar orçamento Beta

Altera um orçamento já cadastrado. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. A pessoa (person_id), o subtítulo (subtitle), o conteúdo (details) e as observações internas (internal_observations), opcionais, enviados como nulo ficam em branco. A cor do cabeçalho (cover_color) nula só é aceita fora do cabeçalho color. O que o orçamento não pode ficar sem — title, valid_until, active, user_id, company_identifier, cover_kind, cover_show_title e cover_show_subtitle — não pode ser retirado: enviado como nulo, é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Como na tela do Monde Web, o orçamento só é gravado com a validade de hoje em diante: o orçamento vencido precisa de uma valid_until nova em qualquer alteração. A imagem que sai do conteúdo (details) deixa de ser do orçamento e é apagada uma hora depois. Com company_identifier, o orçamento vai para aquela empresa, o que exige a permissão de criar/editar orçamentos também nela. O dono precisa ter acesso à empresa de destino: sem user_id, o orçamento só muda de empresa se o dono atual também tiver acesso a ela; se não tiver, a alteração é recusada (422) e é preciso informar em user_id um dono que tenha. Exige a permissão de criar/editar orçamentos na empresa do orçamento. A resposta traz o orçamento alterado no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os orçamentos" na empresa dele; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do orçamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
string = 14 characters ^[0-9]{14}$

CNPJ da empresa para onde o orçamento vai, só os dígitos. Omitido, mantém a empresa atual; nulo ou vazio é recusado. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado.

user_id
string <uuid>

Identificador do usuário dono do orçamento, o mesmo id da pessoa obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do orçamento.

person_id
string or null <uuid>

Identificador da pessoa (cliente) do orçamento, obtido em Consultar pessoas. Nulo tira a pessoa do orçamento, e o texto vazio é recusado (422); omitido, mantém a atual. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe.

title
string

Título do orçamento

subtitle
string or null

Subtítulo do orçamento. Opcional.

valid_until
string <date>

Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado.

details
string or null

Conteúdo do orçamento, em HTML. O HTML é limpo antes de gravar, com as mesmas regras do conteúdo dos guias. Opcional: na criação, sem ele vale o modelo de conteúdo da empresa, o salvo pelo administrador na tela de Configurações de Orçamentos do Monde Web; enviado como texto vazio, o orçamento fica sem conteúdo.

active
boolean

Indica se o orçamento está ativo

internal_observations
string or null

Observações internas (não aparecem no link público). Nulo deixa o campo em branco, e o texto vazio é gravado como está; omitido, mantém o que o orçamento tem.

cover_kind
string
Enum: "color" "image" "none"

Cabeçalho do link público: color (uma cor de fundo), image (uma imagem) ou none (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, image vale só no orçamento que já tem uma. Trocar para outra opção apaga a imagem. Mandar só cover_color já escolhe color, e color sem cover_color vem com a cor principal das Configurações de Orçamentos da empresa.

cover_color
string or null

Cor de fundo do cabeçalho, em hexadecimal (#1f4e79). Só vale com o cabeçalho color; nos outros, fica nula. A cor fica gravada no orçamento: mudar a cor principal das Configurações de Orçamentos depois não muda o cabeçalho. O título fica preto no fundo claro e branco no escuro.

cover_show_title
boolean

Exibe o título no cabeçalho. No cabeçalho color é sempre true.

cover_show_subtitle
boolean

Exibe o subtítulo no cabeçalho. No cabeçalho image com cover_show_title e cover_show_subtitle em false, a imagem aparece inteira, sem recorte e sem texto por cima.

Responses

Request samples

Content type
application/json
Example

Exemplo de alteração que muda só o subtítulo e a validade, mantendo os demais campos.

{
  • "subtitle": "Lua de mel - 10 noites",
  • "valid_until": "2035-06-15"
}

Response samples

Content type
application/json
Example

Exemplo de resposta de um orçamento específico.

{
  • "id": 42,
  • "title": "Cancún",
  • "subtitle": "Lua de mel - 14 noites",
  • "details": "Pacote com aéreo, hospedagem all inclusive e traslados.",
  • "valid_until": "2024-05-31",
  • "active": true,
  • "internal_observations": "Cliente pediu retorno até sexta.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "cover_image_url": null,
  • "created_at": "2024-03-15T10:30:00",
  • "updated_at": "2024-03-16T08:15:00",
  • "person": {
    },
  • "company": {
    },
  • "user": {
    }
}

Excluir orçamento Beta

Exclui o orçamento definitivamente, junto com as imagens dele. O link público deixa de funcionar e o orçamento não pode ser recuperado. Exige a permissão de excluir orçamentos na empresa do orçamento.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do orçamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Duplicar orçamento Beta

Cria uma cópia do orçamento, como a ação Duplicar da tela de Orçamentos do Monde Web. A cópia nasce na mesma empresa, com o mesmo subtítulo, conteúdo, imagens, cabeçalho, situação e observações internas, o título com "(cópia)" na frente e um link público novo. A pessoa e a validade não são copiadas: a validade (valid_until) é obrigatória, e a pessoa (person_id) é opcional. O dono da cópia (user_id) também é obrigatório. Exige a permissão de criar/editar orçamentos na empresa do orçamento. A resposta traz a cópia no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os orçamentos" na empresa; sem ela, a cópia é criada do mesmo jeito e a resposta traz apenas o id dela.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do orçamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
user_id
required
string <uuid>

Identificador do usuário dono da cópia, o mesmo id da pessoa obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do orçamento.

valid_until
required
string <date>

Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado.

person_id
string <uuid>

Identificador da pessoa (cliente) da cópia, obtido em Consultar pessoas. Opcional: sem ele, a cópia fica sem pessoa. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe.

Responses

Request samples

Content type
application/json

Exemplo de duplicação com a nova validade e outra pessoa.

{
  • "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "valid_until": "2035-07-31",
  • "person_id": "7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f"
}

Response samples

Content type
application/json

Exemplo de resposta com a cópia criada.

{
  • "id": 43,
  • "title": "(cópia) Cancún",
  • "subtitle": "Lua de mel - 14 noites",
  • "details": "<p>Pacote com aéreo, hospedagem all inclusive e traslados.</p>",
  • "valid_until": "2035-07-31",
  • "active": true,
  • "internal_observations": "Cliente pediu retorno até sexta.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "cover_image_url": null,
  • "created_at": "2024-04-02T11:00:00",
  • "updated_at": "2024-04-02T11:00:00",
  • "person": {
    },
  • "company": {
    },
  • "user": {
    }
}

Guias

Consulte, crie, altere, duplique e exclua os guias de viagem da agência: conteúdo em HTML com um link público de visualização, como o dos orçamentos, mas sem pessoa vinculada e sem validade. Guias são um recurso da licença Monde Pro e existem só nas empresas que a contrataram. Com a licença Monde Pro somente leitura, os guias da empresa são consultados, mas não criados, alterados, duplicados nem excluídos.

Consultar guias Beta

Retorna a lista de guias das empresas em que a credencial tem permissão, do alterado mais recentemente para o mais antigo.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo um guia ativo e um desativado.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar guia Beta

Cria um guia na empresa informada em company_identifier. O dono do guia (user_id) é obrigatório, porque a credencial da API não é um usuário do Monde: é ele quem altera e exclui o guia pelo Monde, além dos administradores. Só o título é obrigatório. Sem o cabeçalho, o guia nasce com o cabeçalho color, no tom #5f6777, com o título e o subtítulo. O guia nasce ativo, a menos que active seja enviado como false, e já com o link público em public_url. Exige a permissão de criar/editar guias na empresa.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
required
string = 14 characters ^[0-9]{14}$

CNPJ da empresa em que o guia será criado, só os dígitos. A empresa precisa ter a licença Monde Pro, e nem ela nem a licença Monde Pro podem estar somente leitura. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado.

user_id
required
string <uuid>

Identificador do usuário dono do guia, o mesmo id da pessoa obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do guia.

title
required
string

Título do guia

subtitle
string

Subtítulo do guia. Opcional.

details
string

Conteúdo do guia, em HTML. O HTML é limpo antes de gravar: passam parágrafos, títulos, listas, tabelas, links, negrito, itálico, citação e código, e o resto vira texto ou é descartado. O guia tem dois níveis de título, <h3> e <h4>: <h1> e <h2> viram <h3>, e <h5> e <h6> viram <h4>. Do estilo, só passa o alinhamento centralizado ou à direita de parágrafos e títulos. Também passam três blocos, que não vão um dentro do outro: a caixa de destaque (<div data-block="highlight">), só de texto (parágrafos, títulos e listas), em que a imagem vai para um parágrafo logo depois da caixa e o resto vai para depois dela; a seção com imagem de fundo (<div data-block="banner">), em que a primeira imagem vira o fundo e as outras são descartadas; e as colunas (<div data-block="columns"> com dois ou três <div data-block="column">). Fora desse formato, a div sai e o conteúdo dela fica. As imagens seguidas no mesmo parágrafo viram carrossel; com data-carousel="thumbnails" no parágrafo, o carrossel mostra miniaturas embaixo, no lugar das bolinhas. Outro valor de data-carousel é descartado. Imagem sem data-quote-image é descartada. Opcional: enviado vazio, ou só com o que a limpeza descarta, o guia fica sem conteúdo.

active
boolean
Default: true

Indica se o guia está ativo. O link público só abre o guia ativo. Desativado, o guia sai das viagens que o mostram no app do passageiro e não volta a elas ao ser reativado.

cover_kind
string
Enum: "color" "image" "none" "default"

Cabeçalho do link público: color (uma cor de fundo), image (uma imagem) ou none (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, image vale só no guia que já tem uma. Trocar para outra opção apaga a imagem. Mandar só cover_color já escolhe color, e color sem cover_color vem com o tom #5f6777. O antigo cabeçalho default ainda é aceito na escrita e vale como color no tom #5f6777.

cover_color
string

Cor de fundo do cabeçalho, em hexadecimal (#1f4e79). Só vale com o cabeçalho color; nos outros, fica nula. O título fica preto no fundo claro e branco no escuro.

cover_show_title
boolean

Exibe o título no cabeçalho. No cabeçalho color é sempre true.

cover_show_subtitle
boolean

Exibe o subtítulo no cabeçalho. No cabeçalho image com cover_show_title e cover_show_subtitle em false, a imagem aparece inteira, sem recorte e sem texto por cima.

hide_cover_text
boolean

Mantido para quem já usa a API: true é o cabeçalho image com cover_show_title e cover_show_subtitle em false. Na escrita, true desmarca os dois no cabeçalho image e é ignorado nos outros, e false marca os dois; cover_show_title e cover_show_subtitle enviados junto valem mais que ele.

internal_observations
string

Observações internas (não aparecem no link público)

Responses

Request samples

Content type
application/json

Exemplo de criação de um guia com observações internas.

{
  • "company_identifier": "46598887000162",
  • "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
  • "title": "Lisboa",
  • "subtitle": "Roteiro de 5 dias",
  • "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
  • "internal_observations": "Enviar junto com o voucher.",
  • "cover_color": "#1f4e79"
}

Response samples

Content type
application/json

Exemplo de resposta de um guia específico.

{
  • "id": 42,
  • "title": "Lisboa",
  • "subtitle": "Roteiro de 5 dias",
  • "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
  • "active": true,
  • "internal_observations": "Enviar junto com o voucher.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "hide_cover_text": false,
  • "cover_image_url": null,
  • "created_at": "2024-03-15T10:30:00",
  • "updated_at": "2024-03-16T08:15:00",
  • "company": {
    },
  • "user": {
    }
}

Consultar guia por ID Beta

Retorna um guia específico pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do guia

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um guia específico.

{
  • "id": 42,
  • "title": "Lisboa",
  • "subtitle": "Roteiro de 5 dias",
  • "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
  • "active": true,
  • "internal_observations": "Enviar junto com o voucher.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "hide_cover_text": false,
  • "cover_image_url": null,
  • "created_at": "2024-03-15T10:30:00",
  • "updated_at": "2024-03-16T08:15:00",
  • "company": {
    },
  • "user": {
    }
}

Alterar guia Beta

Altera um guia já cadastrado. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. O subtítulo (subtitle), o conteúdo (details) e as observações internas (internal_observations), opcionais, enviados como nulo ficam em branco. A cor do cabeçalho (cover_color) nula, sem cover_kind, é recusada no guia com o cabeçalho color; com cover_kind color, ela vira o tom padrão #5f6777. O que o guia não pode ficar sem — title, active, user_id, company_identifier, cover_kind, hide_cover_text, cover_show_title e cover_show_subtitle — não pode ser retirado: enviado como nulo, é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). A imagem que sai do conteúdo (details) deixa de ser do guia e é apagada uma hora depois. Com company_identifier, o guia vai para aquela empresa, o que exige a permissão de criar/editar guias também nela. O dono precisa ter acesso à empresa de destino: sem user_id, o guia só muda de empresa se o dono atual também tiver acesso a ela; se não tiver, a alteração é recusada (422) e é preciso informar em user_id um dono que tenha. Exige a permissão de criar/editar guias na empresa do guia. A resposta traz o guia alterado no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os guias" na empresa do guia; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id do guia.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do guia

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
string = 14 characters ^[0-9]{14}$

CNPJ da empresa para onde o guia vai, só os dígitos. Omitido, mantém a empresa atual; nulo ou vazio é recusado. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado.

user_id
string <uuid>

Identificador do usuário dono do guia, o mesmo id da pessoa obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do guia.

title
string

Título do guia

subtitle
string or null

Subtítulo do guia. Opcional.

details
string

Conteúdo do guia, em HTML. O HTML é limpo antes de gravar: passam parágrafos, títulos, listas, tabelas, links, negrito, itálico, citação e código, e o resto vira texto ou é descartado. O guia tem dois níveis de título, <h3> e <h4>: <h1> e <h2> viram <h3>, e <h5> e <h6> viram <h4>. Do estilo, só passa o alinhamento centralizado ou à direita de parágrafos e títulos. Também passam três blocos, que não vão um dentro do outro: a caixa de destaque (<div data-block="highlight">), só de texto (parágrafos, títulos e listas), em que a imagem vai para um parágrafo logo depois da caixa e o resto vai para depois dela; a seção com imagem de fundo (<div data-block="banner">), em que a primeira imagem vira o fundo e as outras são descartadas; e as colunas (<div data-block="columns"> com dois ou três <div data-block="column">). Fora desse formato, a div sai e o conteúdo dela fica. As imagens seguidas no mesmo parágrafo viram carrossel; com data-carousel="thumbnails" no parágrafo, o carrossel mostra miniaturas embaixo, no lugar das bolinhas. Outro valor de data-carousel é descartado. Imagem sem data-quote-image é descartada. Opcional: enviado vazio, ou só com o que a limpeza descarta, o guia fica sem conteúdo.

active
boolean

Indica se o guia está ativo. O link público só abre o guia ativo. Desativado, o guia sai das viagens que o mostram no app do passageiro e não volta a elas ao ser reativado.

cover_kind
string
Enum: "color" "image" "none" "default"

Cabeçalho do link público: color (uma cor de fundo), image (uma imagem) ou none (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, image vale só no guia que já tem uma. Trocar para outra opção apaga a imagem. Mandar só cover_color já escolhe color, e color sem cover_color vem com o tom #5f6777. O antigo cabeçalho default ainda é aceito na escrita e vale como color no tom #5f6777.

cover_color
string or null

Cor de fundo do cabeçalho, em hexadecimal (#1f4e79). Só vale com o cabeçalho color; nos outros, fica nula. O título fica preto no fundo claro e branco no escuro.

cover_show_title
boolean

Exibe o título no cabeçalho. No cabeçalho color é sempre true.

cover_show_subtitle
boolean

Exibe o subtítulo no cabeçalho. No cabeçalho image com cover_show_title e cover_show_subtitle em false, a imagem aparece inteira, sem recorte e sem texto por cima.

hide_cover_text
boolean

Mantido para quem já usa a API: true é o cabeçalho image com cover_show_title e cover_show_subtitle em false. Na escrita, true desmarca os dois no cabeçalho image e é ignorado nos outros, e false marca os dois; cover_show_title e cover_show_subtitle enviados junto valem mais que ele.

internal_observations
string or null

Observações internas (não aparecem no link público). Nulo deixa o campo em branco, e o texto vazio é gravado como está; omitido, mantém o que o guia tem.

Responses

Request samples

Content type
application/json
Example

Exemplo de alteração que muda só o título e o subtítulo, mantendo os demais campos.

{
  • "title": "Lisboa e Sintra",
  • "subtitle": "Roteiro de 6 dias"
}

Response samples

Content type
application/json
Example

Exemplo de resposta de um guia específico.

{
  • "id": 42,
  • "title": "Lisboa",
  • "subtitle": "Roteiro de 5 dias",
  • "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
  • "active": true,
  • "internal_observations": "Enviar junto com o voucher.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "hide_cover_text": false,
  • "cover_image_url": null,
  • "created_at": "2024-03-15T10:30:00",
  • "updated_at": "2024-03-16T08:15:00",
  • "company": {
    },
  • "user": {
    }
}

Excluir guia Beta

Exclui o guia definitivamente, junto com as imagens dele. O link público deixa de funcionar, o guia sai das viagens que o mostram no app do passageiro e não pode ser recuperado. Exige a permissão de excluir guias na empresa do guia.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do guia

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Duplicar guia Beta

Cria uma cópia do guia, como a ação Duplicar da tela de Guias do Monde Web. A cópia nasce na mesma empresa, com o mesmo subtítulo, conteúdo, imagens, cabeçalho, situação e observações internas, o título com "(cópia)" na frente e um link público novo. O dono da cópia (user_id) é obrigatório. Exige a permissão de criar/editar guias na empresa do guia. A resposta traz a cópia no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os guias" na empresa; sem ela, a cópia é criada do mesmo jeito e a resposta traz apenas o id dela.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 42

Identificador único do guia

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
user_id
required
string <uuid>

Identificador do usuário dono da cópia, o mesmo id da pessoa obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do guia.

Responses

Request samples

Content type
application/json

Exemplo de duplicação informando o dono da cópia.

{
  • "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}

Response samples

Content type
application/json

Exemplo de resposta com a cópia criada.

{
  • "id": 43,
  • "title": "(cópia) Lisboa",
  • "subtitle": "Roteiro de 5 dias",
  • "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
  • "active": true,
  • "internal_observations": "Enviar junto com o voucher.",
  • "cover_kind": "color",
  • "cover_color": "#1f4e79",
  • "cover_show_title": true,
  • "cover_show_subtitle": true,
  • "hide_cover_text": false,
  • "cover_image_url": null,
  • "created_at": "2024-04-02T11:00:00",
  • "updated_at": "2024-04-02T11:00:00",
  • "company": {
    },
  • "user": {
    }
}

Regras de Faturamento

Consulte as regras de faturamento, com a pessoa dona da regra, o período de fechamento e as condições de vencimento. As regras valem para a agência inteira, sem empresa.

Consultar regras de faturamento Beta

Retorna a lista de regras de faturamento cadastradas no sistema. Cada regra pertence a uma pessoa (ou a todas, quando nula) de um dos tipos cliente, fornecedor ou representante.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo regras de fornecedor e de cliente.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar regra de faturamento por ID Beta

Retorna uma regra de faturamento específica pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da regra de faturamento

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma regra de faturamento específica.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Faturamento semanal aéreo",
  • "person_kind": "supplier",
  • "destination": "national",
  • "movement": "to_pay",
  • "cost_center": null,
  • "closing": {
    },
  • "due_date": {
    },
  • "person": null,
  • "product": null,
  • "supplier": {
    },
  • "requester": null
}

Integrações

Consulte as integrações com fornecedores, que importam as vendas feitas no sistema do fornecedor. Os segredos do fornecedor (senha, token, chaves de API e PIN) nunca são retornados: a consulta diz só se estão preenchidos.

Consultar integrações Beta

Retorna a lista de integrações das empresas em que a credencial tem permissão (integrações sem empresa valem para todas). Os campos adicionais, com os dados de acesso ao fornecedor, ficam só na consulta por ID.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo integrações de fornecedor e de buscador.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar integração por ID Beta

Retorna uma integração específica pelo seu identificador, com os campos adicionais que o fornecedor declara. Só o endereço do serviço e a identificação da agência no fornecedor voltam com valor. Os demais campos, como usuário, senha, token, chaves de API e PIN, nunca são retornados: filled diz se estão preenchidos.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único da integração

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma integração específica, com o usuário e a senha omitidos.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "Assist Card Matriz",
  • "active": true,
  • "vendor_id": "b2359357-cff7-4d43-b6d2-99adf2ff373b",
  • "vendor_name": "Assist Card",
  • "person": {
    },
  • "company": {
    },
  • "additional_fields": [
    ]
}

Pessoas

Consulte as pessoas cadastradas no sistema, com dados de contato, documentos e informações adicionais.

Consultar pessoas Beta

Retorna a lista de pessoas cadastradas. É uma consulta enxuta: traz apenas os escalares próprios e as referências ({id, name}) das entidades fortes (naturalidade, vendedor, promotor, quem cadastrou e a cidade do endereço). As entidades fracas (contatos, marcadores, campos personalizados, anexos, cartões e retenção da Lei Kandir) só aparecem na consulta por ID (GET /people/{id}).

Authorizations:
bearerAuthentication
query Parameters
name
string
Example: name=Maria da Silva

Filtra por nome, sem diferenciar maiúsculas, acentos ou posição (busca por trecho).

cpf_cnpj
string
Example: cpf_cnpj=38107867807

Filtra por CPF ou CNPJ (casa contra qualquer um dos dois). Informe só os dígitos, sem pontos, barras, traços ou espaços.

passport_number
string
Example: passport_number=FG225776

Filtra por número do passaporte, sem diferenciar maiúsculas ou acentos (busca por trecho).

phone
string
Example: phone=11934567890

Filtra por qualquer um dos telefones (fixo, comercial ou celular). Informe só os dígitos; casa contra qualquer trecho do número gravado, independente da máscara.

kind
string
Enum: "individual" "company"
Example: kind=individual

Filtra pelo tipo da pessoa: individual (pessoa física) ou company (pessoa jurídica).

code
integer
Example: code=1024

Filtra pelo código sequencial da pessoa (valor exato).

email
string
Example: email=contato@exemplo.com

Filtra por e-mail, sem diferenciar maiúsculas ou acentos (busca por trecho).

label_id
string <uuid>
Example: label_id=2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50

Filtra as pessoas que têm o marcador informado (UUID, o id de Consultar marcadores).

birthday_from
string <date>
Example: birthday_from=2026-12-28

Início da janela de aniversário (YYYY-MM-DD). Traz as pessoas cujo dia e mês de nascimento caem entre birthday_from e birthday_to, qualquer que seja o ano, inclusive na janela que atravessa a virada do ano. Substitui a consulta Aniversariantes do Monde: para os aniversariantes de hoje, envie a data de hoje nos dois parâmetros. Informe os dois juntos; a janela vai até 366 dias.

birthday_to
string <date>
Example: birthday_to=2027-01-05

Fim da janela de aniversário (YYYY-MM-DD), inclusive. Veja birthday_from.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta da consulta contendo pessoa física e pessoa jurídica.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir pessoa Beta

Insere uma pessoa física ou jurídica. Cada requisição cria um cadastro novo: o external_id, quando informado, precisa estar livre, e o CPF/CNPJ não pode pertencer a nenhuma pessoa já cadastrada. A resposta traz a pessoa criada no mesmo formato da consulta por ID. Informar seller exige também a permissão "Alterar Vendedor", e promoter, a "Alterar Promotor", como no Monde; sem ela, a resposta é 403. Enviar credit_cards ou kandir_law exige também a permissão "Ver aba financeiro" de pessoas, e incluir cartões, a "Cadastrar Cartão de Crédito", como no Monde, em que os cartões e a Lei Kandir ficam na aba Financeiro da pessoa; sem ela, a resposta é 403 com a mensagem do Monde. Sem "Ver aba financeiro", a resposta não traz credit_cards nem kandir_law, e sem "Visualizar dados do Cartão de Crédito", não traz credit_cards: o campo não vem.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
person_kind
required
string
Enum: "individual" "company"

Define se é uma pessoa física (individual) ou jurídica (company).

external_id
string <= 50 characters

Identificador único utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID.

Exemplo: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".

name
required
string <= 100 characters

Nome ou nome fantasia, de acordo com o tipo da pessoa.

Exemplo: "Maria da Silva" ou "Epic Journey".

legal_name
string or null <= 100 characters

Razão social.

Exemplo: "Epic Journey S.A.".

gender
string or null
Enum: "female" "male" null

Gênero

birthdate
string or null <date>

Data de nascimento no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "1990-02-12".

cpf_cnpj
string [ 11 .. 14 ] characters

CPF ou CNPJ, de acordo com o tipo da pessoa, sem pontos, barras, traços ou espaços.

Exemplo: "38107867807" ou "50559280000140".

rg_ie
string or null <= 20 characters

RG ou Inscrição Estadual, de acordo com o tipo da pessoa, sem pontos, traços ou espaços.

Exemplo: "461196037" ou "123456789012".

passport_number
string or null <= 20 characters

Número do passaporte, sem pontos, traços ou espaços.

Exemplo: "FG225776".

passport_expiration_date
string or null <date>

Data de expiração do passaporte no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2035-12-01".

foreigner
boolean
Default: false

Indica se a pessoa ou empresa é estrangeira. Use true para pessoas que não têm nacionalidade brasileira ou empresas que não estão sediadas no Brasil.

foreign_identity_document
string or null <= 30 characters

Documento de identificação do estrangeiro, emitido em seu país de origem. Sem pontos, traços ou espaços.

Exemplo: "41234567".

business_phone
string or null <= 20 characters

Telefone comercial

object or null (person_birthplace)

Naturalidade: cidade em que a pessoa nasceu. Informe o código IBGE ou, na falta dele, o nome da cidade com estado e país. Sem o código IBGE, a cidade é procurada pelo nome, sem diferenciar acento nem maiúscula, entre as que a agência pode usar: no Brasil, no estado; no exterior, no país. A cidade não é cadastrada: o nome que não corresponde a nenhuma é recusado (422).

object or null (person_additional_data)

Dados adicionais da pessoa física. Ausente (null) para pessoa jurídica.

website
string or null <= 50 characters

Website (pessoa jurídica)

tax_identification_number
string or null <= 20 characters

Identificação fiscal (pessoa jurídica estrangeira)

object or null (person_tax_withholding)

Retenções de imposto da pessoa jurídica. Ausente (null) para pessoa física.

object or null (person_airline)

Dados de companhia aérea da pessoa jurídica (fornecedores). Ausente (null) para pessoa física.

email
string or null <= 200 characters

Endereço de e-mail.

Exemplo: "contato@exemplo.com".

phone_number
string or null <= 20 characters

Número de telefone, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "1134567890", "+33170180123".

mobile_number
string or null <= 20 characters

Número de telefone celular, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "11934567890", "+447911123456".

object or null

Endereço.

city_inscription
string or null <= 15 characters

Inscrição municipal

observations
string or null

Observações da pessoa

charge_billet_fee
boolean
Default: false

Indica se a taxa de boleto é cobrada da pessoa

object (entity_reference)

Vendedor responsável pela pessoa

object (entity_reference)

Promotor da pessoa (planos operadora)

Array of objects (entity_reference)

Marcadores atribuídos à pessoa.

Array of objects (person_contact)

Pessoas ligadas a este cadastro como contato. Cada pessoa informada precisa já estar cadastrada e não pode se repetir na lista.

Array of objects (person_custom_field)

Campos personalizados de pessoas, definidos pela agência. Envie cada campo por id e value. Os campos ativos marcados como obrigatórios precisam vir preenchidos.

Array of objects (person_credit_card_write)

Cartões de crédito da pessoa, física ou jurídica. O número e o código de segurança são gravados cifrados e nunca voltam na resposta, que traz só os quatro últimos dígitos. O cartão vale até o último dia do mês da validade, e o cartão vencido é recusado. Exige as permissões "Ver aba financeiro" e "Cadastrar Cartão de Crédito" de pessoas.

Array of objects (person_cost_center_write)

Centros de custo do cliente corporativo: os departamentos dele aceitos no centro de custo do passageiro e do item da fatura quando ele é o pagante. Não são os centros de custo da agência, de /cost_centers. Só pessoa jurídica tem centros de custo, e o nome não se repete na lista, sem diferenciar maiúsculas.

Array of objects (person_kandir_law_write)

Retenções da Lei Kandir (Lei 9.430/1996, art. 64) da pessoa jurídica, uma por produto, no mesmo formato da consulta por ID. Só aceitam retenção os produtos ativos Passagem Aérea, Seguro Viagem e Transporte Terrestre. O percentual omitido é zero, e o negativo é recusado. O total de cada grupo é a soma de IR, CSLL, PIS e COFINS e não se informa. Exige a permissão "Ver aba financeiro" de pessoas.

Responses

Request samples

Content type
application/json
Example

Exemplo de cadastro de pessoa física com endereço, naturalidade, documentos e filiação.

{
  • "person_kind": "individual",
  • "external_id": "CRM-4471",
  • "name": "Maria da Silva",
  • "cpf_cnpj": "38107867807",
  • "rg_ie": "461196037",
  • "gender": "female",
  • "birthdate": "1990-02-12",
  • "passport_number": "FG225776",
  • "passport_expiration_date": "2035-12-01",
  • "foreigner": false,
  • "email": "maria@exemplo.com",
  • "phone_number": "1134567890",
  • "mobile_number": "11934567890",
  • "business_phone": "1134567891",
  • "city_inscription": "123456789",
  • "observations": "Cliente preferencial.",
  • "charge_billet_fee": false,
  • "address": {
    },
  • "birthplace": {
    },
  • "additional_data": {
    },
  • "seller": {
    },
  • "labels": [
    ],
  • "contacts": [
    ],
  • "custom_fields": [
    ],
  • "credit_cards": [
    ]
}

Response samples

Content type
application/json

Exemplo da consulta completa de uma pessoa física, com os blocos agrupados e as entidades fracas.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "code": 1042,
  • "person_kind": "individual",
  • "name": "Carlos Souza",
  • "legal_name": null,
  • "cpf_cnpj": "12345678909",
  • "gender": "male",
  • "birthdate": "1985-07-22",
  • "rg_ie": "203456789",
  • "city_inscription": null,
  • "tax_identification_number": null,
  • "passport_number": "BR123456",
  • "passport_expiration_date": "2028-10-01",
  • "foreigner": false,
  • "foreign_identity_document": null,
  • "email": "carlos@exemplo.com.br",
  • "phone_number": "4133334444",
  • "mobile_number": "41999998888",
  • "business_phone": "4130302020",
  • "website": null,
  • "cvc_code": null,
  • "observations": "Cliente preferencial.",
  • "charge_billet_fee": false,
  • "created_at": "2021-11-05T10:30:00",
  • "address": {
    },
  • "additional_data": {
    },
  • "last_contacts": {
    },
  • "tax_withholding": null,
  • "airline": null,
  • "birthplace": {
    },
  • "seller": {
    },
  • "promoter": null,
  • "created_by": {
    },
  • "contacts": [
    ],
  • "labels": [
    ],
  • "custom_fields": [
    ],
  • "attachments": [],
  • "credit_cards": [
    ],
  • "cost_centers": null,
  • "kandir_law": null,
  • "invoice_rules": [
    ],
  • "photo": {
    }
}

Consultar pessoa por ID Beta

Retorna os dados completos de uma pessoa pelo seu identificador, incluindo os blocos agrupados (dados adicionais, últimos contatos, retenções e companhia aérea) e as entidades fracas (contatos, marcadores, campos personalizados, anexos, cartões de crédito (sempre mascarados), e retenção da Lei Kandir). Como a aba Financeiro do Monde, credit_cards e kandir_law só vêm com a permissão "Ver aba financeiro" de pessoas, e credit_cards, também com a "Visualizar dados do Cartão de Crédito". Sem a permissão, o campo não vem: é omitido, não vem nulo.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único (UUID) da pessoa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo da consulta completa de uma pessoa física, com os blocos agrupados e as entidades fracas.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "code": 1042,
  • "person_kind": "individual",
  • "name": "Carlos Souza",
  • "legal_name": null,
  • "cpf_cnpj": "12345678909",
  • "gender": "male",
  • "birthdate": "1985-07-22",
  • "rg_ie": "203456789",
  • "city_inscription": null,
  • "tax_identification_number": null,
  • "passport_number": "BR123456",
  • "passport_expiration_date": "2028-10-01",
  • "foreigner": false,
  • "foreign_identity_document": null,
  • "email": "carlos@exemplo.com.br",
  • "phone_number": "4133334444",
  • "mobile_number": "41999998888",
  • "business_phone": "4130302020",
  • "website": null,
  • "cvc_code": null,
  • "observations": "Cliente preferencial.",
  • "charge_billet_fee": false,
  • "created_at": "2021-11-05T10:30:00",
  • "address": {
    },
  • "additional_data": {
    },
  • "last_contacts": {
    },
  • "tax_withholding": null,
  • "airline": null,
  • "birthplace": {
    },
  • "seller": {
    },
  • "promoter": null,
  • "created_by": {
    },
  • "contacts": [
    ],
  • "labels": [
    ],
  • "custom_fields": [
    ],
  • "attachments": [],
  • "credit_cards": [
    ],
  • "cost_centers": null,
  • "kandir_law": null,
  • "invoice_rules": [
    ],
  • "photo": {
    }
}

Alterar pessoa Beta

Altera uma pessoa já cadastrada. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422), inclusive nos códigos que localizam a cidade (city_ibge, city_name, state_code, country_code) e no code de airline, que é único entre as pessoas. O objeto enviado como nulo retira tudo o que ele grava (address, birthplace, additional_data, airline), e o campo nulo dentro dele, só aquele dado; a cidade sai quando city_ibge e city_name vêm nulos. seller e promoter nulos tiram o vendedor e o promotor. Não podem ser retirados, e enviados como nulos são recusados (422): name, person_kind, foreigner, charge_billet_fee, o external_id (pode ser trocado por outro, mas não retirado), as retenções de tax_withholding e, quando a pessoa é usuário do Monde, o email. O tipo da pessoa não muda: person_kind, quando informado, precisa ser o mesmo que a pessoa já é. O external_id passa a identificar a pessoa, desde que não esteja identificando outra; o CPF/CNPJ e o código de companhia aérea não podem pertencer a outra pessoa. Como no Monde, o CPF/CNPJ gravado é conferido em toda alteração: na pessoa com documento inválido, a alteração responde 422 no campo cpf_cnpj até que ele seja enviado corrigido, ou nulo para retirá-lo. Quando a pessoa é usuário do Monde, o email também não pode ser o de outro usuário. As listas labels, contacts, credit_cards, cost_centers e kandir_law funcionam por substituição: a lista enviada passa a ser a da pessoa, a lista vazia ou nula retira todos os itens e o campo omitido mantém os atuais. Os campos personalizados não substituem: cada um enviado é gravado por cima do atual, o enviado com valor nulo ou vazio é limpo (o obrigatório é recusado), e os demais permanecem. A resposta traz a pessoa alterada no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de pessoas; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da pessoa. A pessoa que é uma empresa do sistema e o e-mail de uma pessoa que é usuário ativo do Monde só são alterados por um administrador, como no Monde: a alteração responde 403 com o motivo. Trocar ou retirar (nulo) seller exige também a permissão "Alterar Vendedor", e trocar ou retirar promoter, a "Alterar Promotor"; o reenviado igual ao atual, e o nulo na pessoa que não tem vendedor ou promotor, não pedem a permissão. Enviar credit_cards ou kandir_law com algum item, ou vazios ou nulos quando retiram o que a pessoa tem, exige também a permissão "Ver aba financeiro" de pessoas, e cada operação nos cartões, a permissão dela, como no Monde: incluir cartão (item sem id) exige "Cadastrar Cartão de Crédito"; alterar cartão (item com id e algum campo diferente do gravado, ou com number ou cvv, que contam sempre como mudança; o reenviado como a consulta o devolve não pede) exige "Visualizar dados do Cartão de Crédito" e "Editar Cartão de Crédito"; e a lista que deixa de fora um cartão que a pessoa tem, removendo-o, exige "Remover Cartão de Crédito". O cartão citado só pelo id fica como está e não pede permissão própria. Sem a permissão, a resposta é 403 com a mensagem do Monde, e nada é alterado. Na resposta, sem "Ver aba financeiro", credit_cards e kandir_law não vêm, e sem "Visualizar dados do Cartão de Crédito", credit_cards não vem: o campo é omitido, não vem nulo.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único (UUID) da pessoa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
person_kind
string
Enum: "individual" "company"

Define se é uma pessoa física (individual) ou jurídica (company).

external_id
string <= 50 characters

Identificador único utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID.

Exemplo: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".

name
string <= 100 characters

Nome ou nome fantasia, de acordo com o tipo da pessoa.

Exemplo: "Maria da Silva" ou "Epic Journey".

legal_name
string or null <= 100 characters

Razão social.

Exemplo: "Epic Journey S.A.".

gender
string or null
Enum: "female" "male" null

Gênero

birthdate
string or null <date>

Data de nascimento no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "1990-02-12".

cpf_cnpj
string [ 11 .. 14 ] characters

CPF ou CNPJ, de acordo com o tipo da pessoa, sem pontos, barras, traços ou espaços.

Exemplo: "38107867807" ou "50559280000140".

rg_ie
string or null <= 20 characters

RG ou Inscrição Estadual, de acordo com o tipo da pessoa, sem pontos, traços ou espaços.

Exemplo: "461196037" ou "123456789012".

passport_number
string or null <= 20 characters

Número do passaporte, sem pontos, traços ou espaços.

Exemplo: "FG225776".

passport_expiration_date
string or null <date>

Data de expiração do passaporte no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2035-12-01".

foreigner
boolean
Default: false

Indica se a pessoa ou empresa é estrangeira. Use true para pessoas que não têm nacionalidade brasileira ou empresas que não estão sediadas no Brasil.

foreign_identity_document
string or null <= 30 characters

Documento de identificação do estrangeiro, emitido em seu país de origem. Sem pontos, traços ou espaços.

Exemplo: "41234567".

business_phone
string or null <= 20 characters

Telefone comercial

object or null (person_birthplace)

Naturalidade: cidade em que a pessoa nasceu. Informe o código IBGE ou, na falta dele, o nome da cidade com estado e país. Sem o código IBGE, a cidade é procurada pelo nome, sem diferenciar acento nem maiúscula, entre as que a agência pode usar: no Brasil, no estado; no exterior, no país. A cidade não é cadastrada: o nome que não corresponde a nenhuma é recusado (422).

object or null (person_additional_data)

Dados adicionais da pessoa física. Ausente (null) para pessoa jurídica.

website
string or null <= 50 characters

Website (pessoa jurídica)

tax_identification_number
string or null <= 20 characters

Identificação fiscal (pessoa jurídica estrangeira)

object or null (person_tax_withholding)

Retenções de imposto da pessoa jurídica. Ausente (null) para pessoa física.

object or null (person_airline)

Dados de companhia aérea da pessoa jurídica (fornecedores). Ausente (null) para pessoa física.

email
string or null <= 200 characters

Endereço de e-mail.

Exemplo: "contato@exemplo.com".

phone_number
string or null <= 20 characters

Número de telefone, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "1134567890", "+33170180123".

mobile_number
string or null <= 20 characters

Número de telefone celular, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "11934567890", "+447911123456".

object or null

Endereço.

city_inscription
string or null <= 15 characters

Inscrição municipal

observations
string or null

Observações da pessoa

charge_billet_fee
boolean
Default: false

Indica se a taxa de boleto é cobrada da pessoa

entity_reference (object) or null

Vendedor responsável pela pessoa

entity_reference (object) or null

Promotor da pessoa (planos operadora)

Array of objects or null (entity_reference)

Marcadores da pessoa. A lista enviada substitui a atual: o marcador que não vier nela é retirado. Envie uma lista vazia ou nula para retirar todos os marcadores; omita o campo para manter os atuais. Cada marcador precisa já estar cadastrado.

Array of objects or null (person_contact)

Pessoas ligadas a este cadastro como contato. A lista enviada substitui a atual: o contato que não vier nela é desfeito. A função de cada contato é a que vier na lista: omiti-la deixa o contato sem função. Envie uma lista vazia ou nula para desfazer todos os contatos; omita o campo para manter os atuais. Cada pessoa informada precisa já estar cadastrada e não pode se repetir na lista. Os vínculos em que esta pessoa é contato de outra não são afetados.

Array of objects (person_custom_field)

Campos personalizados de pessoas, definidos pela agência. Diferente das outras listas, não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão, então a lista vazia ou nula não muda nada. O campo enviado com value nulo ou vazio é limpo, menos o obrigatório, que é recusado. Envie cada campo por id e value.

Array of objects or null (person_credit_card_write)

Cartões de crédito da pessoa. A lista enviada substitui a atual: como a leitura não devolve o número, o cartão que a pessoa já tem é citado pelo id (o mesmo da consulta por ID), com só os campos a alterar; o item sem id é um cartão novo, e o cartão que não vier na lista é excluído. Envie uma lista vazia ou nula para excluir todos; omita o campo para manter os atuais. O cartão já vencido pode ser alterado, mas não incluído. Exige a permissão "Ver aba financeiro" de pessoas e, conforme a operação, "Cadastrar Cartão de Crédito" (item sem id), "Visualizar dados do Cartão de Crédito" e "Editar Cartão de Crédito" (item com id que muda algum campo) e "Remover Cartão de Crédito" (cartão da pessoa deixado de fora da lista).

Array of objects or null (person_cost_center_write)

Centros de custo do cliente corporativo (não os da agência, de /cost_centers). A lista enviada substitui a atual: o nome que a pessoa já tem, sem diferenciar maiúsculas, mantém o centro de custo; o nome novo inclui um; o que não vier na lista é excluído. Os passageiros e itens de fatura que já gravaram um nome não mudam. Envie uma lista vazia ou nula para excluir todos; omita o campo para manter os atuais. Só pessoa jurídica tem centros de custo.

Array of objects or null (person_kandir_law_write)

Retenções da Lei Kandir da pessoa jurídica, uma por produto. A lista enviada substitui a atual: o produto identifica a retenção, então o produto que a pessoa já tem altera a retenção dele, e o grupo, a abrangência e o imposto omitidos ficam como estão (o percentual enviado nulo é recusado); o produto novo inclui uma retenção, com o percentual omitido zerado; a retenção que não vier na lista é excluída. Envie uma lista vazia ou nula para excluir todas; omita o campo para manter as atuais. Exige a permissão "Ver aba financeiro" de pessoas quando traz alguma retenção ou retira as que a pessoa tem.

Responses

Request samples

Content type
application/json

Exemplo de alteração de contato, endereço, marcadores e campos personalizados de uma pessoa já cadastrada.

{
  • "name": "Maria da Silva Souza",
  • "email": "maria.souza@exemplo.com",
  • "mobile_number": "11934567890",
  • "observations": "Cliente preferencial.",
  • "address": {
    },
  • "labels": [
    ],
  • "contacts": [
    ],
  • "custom_fields": [
    ]
}

Response samples

Content type
application/json
Example

Exemplo da consulta completa de uma pessoa física, com os blocos agrupados e as entidades fracas.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "code": 1042,
  • "person_kind": "individual",
  • "name": "Carlos Souza",
  • "legal_name": null,
  • "cpf_cnpj": "12345678909",
  • "gender": "male",
  • "birthdate": "1985-07-22",
  • "rg_ie": "203456789",
  • "city_inscription": null,
  • "tax_identification_number": null,
  • "passport_number": "BR123456",
  • "passport_expiration_date": "2028-10-01",
  • "foreigner": false,
  • "foreign_identity_document": null,
  • "email": "carlos@exemplo.com.br",
  • "phone_number": "4133334444",
  • "mobile_number": "41999998888",
  • "business_phone": "4130302020",
  • "website": null,
  • "cvc_code": null,
  • "observations": "Cliente preferencial.",
  • "charge_billet_fee": false,
  • "created_at": "2021-11-05T10:30:00",
  • "address": {
    },
  • "additional_data": {
    },
  • "last_contacts": {
    },
  • "tax_withholding": null,
  • "airline": null,
  • "birthplace": {
    },
  • "seller": {
    },
  • "promoter": null,
  • "created_by": {
    },
  • "contacts": [
    ],
  • "labels": [
    ],
  • "custom_fields": [
    ],
  • "attachments": [],
  • "credit_cards": [
    ],
  • "cost_centers": null,
  • "kandir_law": null,
  • "invoice_rules": [
    ],
  • "photo": {
    }
}

Excluir pessoa Beta

Exclui a pessoa em definitivo. Só pode ser excluída a pessoa que não tem registros vinculados — vendas (como cliente, passageiro, intermediário ou fornecedor), lançamentos financeiros, notas fiscais, orçamentos, tarefas, comissões, cartões, contas, anexos (inclusive os já removidos), entre outros — e que não é usuário do sistema nem empresa do sistema. Nesses casos a resposta é 409 e nada é alterado. Junto com a pessoa são removidos os seus contatos, marcadores e external_id, e os vínculos em que ela aparece como contato de outra pessoa; ela também deixa as regras de faturamento e os centros de custo em que estava, deixa de ser o vendedor ou o promotor de outras pessoas e deixa de estar informada nas integrações em que aparecia. A exclusão fica registrada no histórico da pessoa. Não exige Idempotency-Key: repetir a requisição depois de excluída responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único (UUID) da pessoa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Baixar foto da pessoa Beta

Devolve a foto da pessoa física (ou o logotipo da pessoa jurídica) como imagem, com o Content-Type do formato gravado. Exige a permissão de consultar pessoas. Esta chamada não exige o cabeçalho Content-Type.

Authorizations:
bearerAuthentication
path Parameters
person_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único (UUID) da pessoa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Enviar foto da pessoa Beta

Grava a foto da pessoa física (ou o logotipo da pessoa jurídica), substituindo a que já existir. A imagem vai no campo file de um multipart/form-data e precisa ser JPEG de até 150 KB, os mesmos limites do Monde, que só exibe a imagem nesse formato. Exige a permissão de alterar pessoas, numa empresa que não seja somente leitura. A troca fica registrada no histórico da pessoa.

Authorizations:
bearerAuthentication
path Parameters
person_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único (UUID) da pessoa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "multipart/form-data"
Example: multipart/form-data

Tipo de conteúdo da requisição. Deve ser multipart/form-data.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: multipart/form-data
required
file
required
string <binary>

A imagem, em JPEG, com até 150 KB.

Responses

Response samples

Content type
application/json

Exemplo da consulta completa de uma pessoa física, com os blocos agrupados e as entidades fracas.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "code": 1042,
  • "person_kind": "individual",
  • "name": "Carlos Souza",
  • "legal_name": null,
  • "cpf_cnpj": "12345678909",
  • "gender": "male",
  • "birthdate": "1985-07-22",
  • "rg_ie": "203456789",
  • "city_inscription": null,
  • "tax_identification_number": null,
  • "passport_number": "BR123456",
  • "passport_expiration_date": "2028-10-01",
  • "foreigner": false,
  • "foreign_identity_document": null,
  • "email": "carlos@exemplo.com.br",
  • "phone_number": "4133334444",
  • "mobile_number": "41999998888",
  • "business_phone": "4130302020",
  • "website": null,
  • "cvc_code": null,
  • "observations": "Cliente preferencial.",
  • "charge_billet_fee": false,
  • "created_at": "2021-11-05T10:30:00",
  • "address": {
    },
  • "additional_data": {
    },
  • "last_contacts": {
    },
  • "tax_withholding": null,
  • "airline": null,
  • "birthplace": {
    },
  • "seller": {
    },
  • "promoter": null,
  • "created_by": {
    },
  • "contacts": [
    ],
  • "labels": [
    ],
  • "custom_fields": [
    ],
  • "attachments": [],
  • "credit_cards": [
    ],
  • "cost_centers": null,
  • "kandir_law": null,
  • "invoice_rules": [
    ],
  • "photo": {
    }
}

Remover foto da pessoa Beta

Remove a foto da pessoa física (ou o logotipo da pessoa jurídica). Exige a permissão de alterar pessoas, numa empresa que não seja somente leitura. A remoção fica registrada no histórico da pessoa.

Authorizations:
bearerAuthentication
path Parameters
person_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único (UUID) da pessoa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Converter pessoa física em jurídica, ou o contrário Beta

Converte a pessoa para o tipo informado em person_kind, como a ação Converter para Pessoa Jurídica / Converter para Pessoa Física da consulta de pessoas do Monde. Os dados que só o tipo de origem tem são apagados: na conversão para pessoa jurídica, CPF, RG, sexo, telefone comercial, passaporte e sua validade, órgão emissor e data de emissão do RG e naturalidade; na conversão para pessoa física, CNPJ, inscrição estadual, razão social e site. O usuário do sistema não pode virar pessoa jurídica, e a empresa do sistema não muda de tipo. Exige a permissão de alterar pessoas, numa empresa que não seja somente leitura. O tipo não muda em Alterar pessoa, só aqui.

Authorizations:
bearerAuthentication
path Parameters
person_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único (UUID) da pessoa.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
person_kind
required
string
Enum: "individual" "company"

Tipo de destino: individual (pessoa física) ou company (pessoa jurídica). Precisa ser diferente do tipo atual.

Responses

Request samples

Content type
application/json
{
  • "person_kind": "company"
}

Response samples

Content type
application/json

Exemplo da consulta completa de uma pessoa física, com os blocos agrupados e as entidades fracas.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "code": 1042,
  • "person_kind": "individual",
  • "name": "Carlos Souza",
  • "legal_name": null,
  • "cpf_cnpj": "12345678909",
  • "gender": "male",
  • "birthdate": "1985-07-22",
  • "rg_ie": "203456789",
  • "city_inscription": null,
  • "tax_identification_number": null,
  • "passport_number": "BR123456",
  • "passport_expiration_date": "2028-10-01",
  • "foreigner": false,
  • "foreign_identity_document": null,
  • "email": "carlos@exemplo.com.br",
  • "phone_number": "4133334444",
  • "mobile_number": "41999998888",
  • "business_phone": "4130302020",
  • "website": null,
  • "cvc_code": null,
  • "observations": "Cliente preferencial.",
  • "charge_billet_fee": false,
  • "created_at": "2021-11-05T10:30:00",
  • "address": {
    },
  • "additional_data": {
    },
  • "last_contacts": {
    },
  • "tax_withholding": null,
  • "airline": null,
  • "birthplace": {
    },
  • "seller": {
    },
  • "promoter": null,
  • "created_by": {
    },
  • "contacts": [
    ],
  • "labels": [
    ],
  • "custom_fields": [
    ],
  • "attachments": [],
  • "credit_cards": [
    ],
  • "cost_centers": null,
  • "kandir_law": null,
  • "invoice_rules": [
    ],
  • "photo": {
    }
}

Marcadores

Consulte, crie, altere e exclua os marcadores usados para classificar pessoas. O cadastro de marcadores é um só para o sistema inteiro, sem empresa: as permissões valem em qualquer empresa ativa em que forem concedidas, e gravar exige uma empresa que não seja somente leitura.

Consultar marcadores Beta

Retorna a lista de marcadores cadastrados no sistema.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo todos os marcadores cadastrados.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar marcador Beta

Cria um marcador. O nome é obrigatório, tem até 38 caracteres e não pode repetir o de outro marcador. Exige a permissão "Editar" de marcadores.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
required
string <= 38 characters

Nome do marcador, com até 38 caracteres e diferente do nome dos demais marcadores

Responses

Request samples

Content type
application/json

Cria o marcador VIP.

{
  • "name": "VIP"
}

Response samples

Content type
application/json

Exemplo de resposta de um marcador específico.

{
  • "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
  • "name": "VIP"
}

Consultar marcador por ID Beta

Retorna um marcador específico pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do marcador

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de um marcador específico.

{
  • "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
  • "name": "VIP"
}

Alterar marcador Beta

Renomeia um marcador. O nome omitido permanece como está; enviado como nulo ou como texto vazio, é recusado (422), porque o marcador não fica sem nome. O novo nome segue as mesmas regras da criação, e as pessoas que têm o marcador continuam com ele. Exige a permissão "Editar" de marcadores. A resposta traz o marcador alterado quando a credencial também tem a permissão "Visualizar" de marcadores; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id do marcador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do marcador

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
name
string <= 38 characters

Nome do marcador, com até 38 caracteres e diferente do nome dos demais marcadores

Responses

Request samples

Content type
application/json

Troca o nome do marcador.

{
  • "name": "Cliente VIP"
}

Response samples

Content type
application/json
Example

Exemplo de resposta de um marcador específico.

{
  • "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
  • "name": "VIP"
}

Excluir marcador Beta

Exclui o marcador definitivamente e o retira de todas as pessoas que o tinham, como na exclusão pelo Monde. A exclusão não pode ser desfeita. Exige a permissão "Excluir" de marcadores.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

Identificador único do marcador

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Empresas

Consulte as empresas do sistema que a credencial alcança: as empresas ativas em que ela tem a permissão "Ler todas as empresas". É daqui que sai o CNPJ que as gravações pedem em company_identifier.

Consultar empresas Beta

Retorna as empresas ativas em que a credencial tem a permissão "Ler todas as empresas", em ordem alfabética do nome. A empresa somente leitura vem na lista, marcada em read_only: ela continua sendo consultada, mas recusa as gravações.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com as empresas que a credencial alcança, uma delas somente leitura.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar empresa por ID Beta

Retorna uma empresa específica pelo seu identificador. Exige a permissão "Ler todas as empresas" na própria empresa, que precisa estar ativa. A empresa fora desse alcance responde 403, também quando o id não existe.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10

Identificador único da empresa

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta de uma empresa específica.

{
  • "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10",
  • "name": "Monde Viagens",
  • "legal_name": "Monde Viagens e Turismo Ltda",
  • "cnpj": "46598887000162",
  • "read_only": false,
  • "person": {
    }
}

Contas a Pagar e Receber

Consulte e insira as contas a pagar e a receber (lançamentos financeiros) das empresas em que a credencial tem permissão. O mesmo recurso cobre os dois casos: contas a receber (transaction_kind = credit) e contas a pagar (transaction_kind = debit). Traz identificação, valores, situação, categorias, rateios, movimentações de liquidação, itens, comissões, anexos e campos personalizados. O lançamento que a credencial criou é sempre dela; o dos outros usuários pede o acesso aos lançamentos de todos os usuários, ou o recorte dele, como no Monde (veja as Perguntas frequentes).

Consultar contas a pagar e receber Beta

Retorna a lista de contas a pagar e a receber das empresas em que a credencial tem permissão. Por padrão, retorna só as contas em aberto e vencidas (não liquidadas e não canceladas); para incluir liquidadas ou canceladas, use o parâmetro status. Use os filtros para restringir por data (date_field com date_from/date_to), natureza (transaction_kind), tipo (kind) e situação (status). Cada lançamento vem resumido; o detalhe completo vem em GET /bills/{id}.

Authorizations:
bearerAuthentication
query Parameters
date_field
string
Enum: "issue_date" "due_date" "settlement_date"
Example: date_field=due_date

Campo de data usado no filtro. Valores aceitos: issue_date (emissão), due_date (vencimento) e settlement_date (liquidação). Obrigatório quando date_from ou date_to é informado. Para filtrar por settlement_date, inclua settled no parâmetro status, já que o padrão (open, overdue) não traz contas liquidadas.

date_from
string <date>
Example: date_from=2024-01-01

Filtrar contas cujo campo escolhido em date_field seja igual ou posterior a esta data, no formato ISO 8601 (AAAA-MM-DD).

date_to
string <date>
Example: date_to=2024-12-31

Filtrar contas cujo campo escolhido em date_field seja igual ou anterior a esta data, no formato ISO 8601 (AAAA-MM-DD).

transaction_kind
string
Enum: "credit" "debit"
Example: transaction_kind=credit

Filtra pela natureza do lançamento: credit (contas a receber) ou debit (contas a pagar). Quando ausente, retorna ambas.

kind
string
Enum: "normal" "sale_payment" "sale_standalone" "vendor_standalone" "vendor_invoice" "customer_invoice" "credit_card_invoice" "commission"
Example: kind=customer_invoice

Origem do lançamento.

  • normal: lançamento avulso.
  • sale_payment: pagamento de venda.
  • sale_standalone: avulso de venda.
  • vendor_standalone: avulso de fornecedor.
  • vendor_invoice: fatura de fornecedor.
  • customer_invoice: fatura de cliente.
  • credit_card_invoice: fatura de cartão de crédito.
  • commission: comissão.

status
Array of strings
Items Enum: "open" "overdue" "settled" "canceled"
Example: status=open,overdue

Filtra pela situação. Aceita um ou mais valores separados por vírgula:

  • open: não liquidada, não cancelada, com vencimento hoje ou no futuro, ou sem vencimento.
  • overdue: não liquidada, não cancelada, vencimento anterior a hoje.
  • settled: liquidada e não cancelada.
  • canceled: cancelada, independente de ter sido liquidada.
Quando ausente, a API retorna só as contas open e overdue; liquidadas e canceladas só voltam quando pedidas explicitamente.

recurrence_group_id
string <uuid>
Example: recurrence_group_id=5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f

Filtra pelos lançamentos de uma série de parcelamento ou recorrência, pelo recurrence_group_id de qualquer um deles, como o devolvido na criação. Combine com status para incluir os já liquidados.

number
string
Example: number=362

Filtra pelo número do lançamento exibido no aplicativo (um por requisição). Lançamentos parcelados têm sufixo de parcela (ex.: 362-1), então informe o número exatamente como aparece.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta contendo uma conta a receber (fatura de cliente) e uma conta a pagar (fatura de cartão).

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir conta a pagar ou receber Beta

Cria um lançamento financeiro em aberto ou já liquidado, com as mesmas regras do lançamento manual do Monde. transaction_kind define se é conta a receber (credit) ou a pagar (debit), e qualquer categoria é aceita.

Categorias e valor final. A soma com sinal das categories é o valor final (final_amount): a categoria do mesmo tipo do lançamento soma, a de tipo oposto abate (o tipo vem em kind, em Consultar categorias). Se o valor final ficar diferente de amount, a diferença é acréscimo ou desconto, sujeita ao bloqueio de acréscimo e desconto da empresa. O valor final não pode ser negativo, e a mesma categoria não pode se repetir com a mesma descrição.

Rateios. Só em agência. O rateio por centro de custo (apportionments.per_cost_center) pode ficar entre 0 e 100% do valor final; o rateio entre empresas (apportionments.per_company), quando informado, precisa somar exatamente 100% e só aceita empresas em que a credencial também pode inserir lançamentos. Na operadora, os rateios e a operação própria são recusados.

Liquidação. Para criar o lançamento já liquidado, envie settlement_date com as movements, uma por conta em que o dinheiro entrou ou saiu. Exige também a permissão "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme o lançamento, como no Monde; sem ela, a resposta é 403. Quando a soma das movimentações não fecha com o valor final, diga o que fazer com a diferença em balance_resolution, como na liquidação: com category, ela vai para uma categoria, como desconto (pago a menos) ou acréscimo (pago a mais), e o valor final passa a ser o que foi pago. A categoria vem em balance_category_id; sem ela, vale a categoria padrão da empresa para aquele caso (desconto concedido ou recebido, acréscimo cobrado ou pago), e sem padrão o pedido é recusado. A categoria precisa ser do tipo que leva o valor final ao que foi pago. Sem balance_resolution, as movimentações precisam somar exatamente o valor final; o pagamento com juros ou desconto também pode ser enviado ajustando as categorias. Com partial, o pagamento parcial, quando foi pago menos que o valor final: o lançamento é liquidado com o que foi pago e ganha o sufixo " 1/2" na descrição, e o saldo vira um novo lançamento em aberto, com o sufixo " 2/2" e as mesmas categorias na proporção do saldo. Como no Monde, os dois ficam com o mesmo número em partes: o lançamento 71 vira 71-1 e o saldo, 71-2. A parcela que já tem parte no número (72-2) mantém o dela, e o saldo fica com a próxima parte livre. Sem saldo, o pagamento parcial não gera nada; pago a mais, é recusado. O partial_payment: true continua aceito e equivale a balance_resolution: partial; enviados juntos, os dois precisam dizer o mesmo, e o partial_payment que contradiz o balance_resolution é recusado com 422. A data de liquidação não pode ser maior que a data da última movimentação, e a emissão não pode ser maior que a liquidação. Cada movimentação usa uma conta ativa vinculada à empresa, e a forma de pagamento segue o tipo da conta: conta caixa e conta de cheques aceitam dinheiro ou cheque, conta cartão de crédito aceita só cartão de crédito, e conta corrente aceita as demais. Cheque exige o número. Parcelar (installments) só em conta cartão de crédito. Em contas a receber vale o bloqueio da data de movimentação, e o caixa do dia fechado recusa a movimentação com o motivo, como O caixa do dia "10/10/2026" da conta "Caixa" está fechado.

Taxa de cartão. Na conta a receber recebida em cartão de crédito ou de débito numa conta corrente, envie a taxa da operadora em card_rate, como no Monde: amount é o que o cliente pagou, e a conta recebe amount menos a taxa. A soma das taxas vira a categoria de taxa de cartão configurada na empresa, que abate o valor final; se essa categoria já estiver em categories, a taxa entra nela, e o valor dela passa a ser a soma das taxas. Sem a categoria configurada, a taxa é recusada com 422, e também a taxa em outra forma de pagamento, em conta a pagar ou fora da conta corrente, e a taxa igual ou maior que amount. Exemplo: conta a receber de R$ 420,00 com R$ 20,00 de taxa: a movimentação tem amount 420 e card_rate 20, a conta recebe R$ 400,00 e o valor final fica R$ 400,00.

Estorno no cartão. A conta a receber também se liquida na conta cartão de crédito, só com a forma cartão de crédito: é o estorno, que entra na fatura do cartão e abate o total dela, como no Monde. Parcelado, cada parcela entra na fatura do mês dela.

Parcelamento e recorrência. Envie recurrence_kind com a periodicity. No parcelamento (installment), installments é o total de parcelas, de 2 a 200, e cada parcela repete o valor cheio do lançamento: R$ 1.500,00 em 3 vezes gera 3 lançamentos de R$ 1.500,00. As parcelas vencem uma a cada período a partir de due_date, ganham o sufixo " 1/3" na descrição e -1 no número; a descrição tem até 50 caracteres justamente para caber esse sufixo. A recorrência (recurrent) gera os lançamentos dos próximos 5 anos com o mesmo valor e descrição, e o Monde continua gerando os seguintes. A quinzena (biweekly) é de 15 dias. A série é gerada em segundo plano, como no Monde: a resposta traz o primeiro lançamento com o recurrence_group_id já preenchido, e os demais aparecem em seguida em Consultar contas a pagar e receber com o filtro recurrence_group_id. Até a série ser gerada, o lançamento consultado por ID aparece sem o recurrence_group_id, e o recurrence_status diz se ela ainda falta ou se a última tentativa falhou. Os sufixos da parcela entram na descrição e no número de todos os lançamentos quando a série é gerada, inclusive no primeiro. O pagamento parcial e o balance_resolution não se combinam com parcelamento nem recorrência: as parcelas copiam as categorias do primeiro lançamento, e a categoria da diferença é só da baixa dele.

Bloqueios da empresa. Valem como configurados na empresa: o bloqueio de vencimento e o da data de movimentação em contas a receber, e o de acréscimo e desconto. Só a credencial com a permissão "Ignorar bloqueios" na empresa do lançamento passa por eles, como no Monde.

Padrões. Sem issue_date, a emissão é a menor data entre hoje, o vencimento e a liquidação; informada, ela não pode ser maior que o vencimento. Sem account_id, o lançamento recebe a conta de previsão padrão da empresa; o lançamento da venda fica sem conta prevista, como no Monde. O lançamento é sempre em BRL. Campos fora do contrato são ignorados.

Erros. O erro de um campo de um item de lista (categories, movements, custom_fields e os rateios) traz a posição do item na lista enviada, contada a partir de 0: O campo 'movements[1] account_id' não corresponde a nenhuma conta ativa vinculada à empresa do lançamento fala da segunda movimentação. Cada item com erro tem a sua mensagem. A regra conferida sobre a lista inteira, como a soma das movimentações ou a categoria repetida, vem no nome da lista, sem posição. O erro de formato de um campo do item também traz a posição: check enviado como texto no lugar de objeto responde O campo 'movements[0] check' deve ser uma lista ou um objeto….

Lançamento da venda. Para lançar uma conta a pagar ou a receber na venda, como o botão da aba Financeiro da venda no Monde, envie o sale_id, pelo id de GET /sales. O lançamento nasce como avulso da venda (kind igual a sale_standalone), ligado a ela e na empresa dela, e aparece em financial.standalone_bills de Consultar venda por ID. Da venda vem só a empresa: pessoa, categorias, valores e os demais campos vêm do payload, como em qualquer lançamento. O company_identifier pode ser omitido; enviado, precisa ser o CNPJ da empresa da venda. A venda fechada aceita o lançamento, e a excluída responde 409. O lançamento da venda não tem operação própria, parcelamento nem recorrência: operation_id e recurrence_kind são recusados com 422. Ele pode nascer liquidado, como os demais. Exige, na empresa da venda, as permissões de inserir contas a pagar e receber descritas abaixo e a permissão "Ver aba financeiro" de vendas; a permissão de editar a venda não é exigida, porque a venda não muda. A venda precisa estar entre as que a credencial consulta: a de fora do alcance responde 422 em sale_id, como a que não existe. Como a aba Financeiro só aparece com a venda aberta, a venda de outro vendedor pede também "Abrir vendas de outros vendedores", e sem ela responde 403; pela conexão automática autorizada antes das permissões "de outros", só a venda criada pela própria conexão.

Exige a permissão "Editar" de contas a pagar e receber na empresa, que não pode estar somente leitura; pela conexão automática autorizada antes das permissões "de outros", vale também a de inserir e editar as próprias contas. O lançamento criado fica sendo da credencial. A resposta traz o lançamento criado, igual a Consultar conta a pagar ou receber por ID, mesmo para a credencial sem a permissão "Visualizar", e em generated_bills o saldo do pagamento parcial, que é criado na mesma chamada: se ele for recusado, nada é gravado. As parcelas e recorrências não vêm em generated_bills: elas são buscadas pelo recurrence_group_id. Acompanhar a série, pela consulta por ID ou pela listagem, exige a permissão de leitura de contas a pagar e receber.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
string = 14 characters ^[0-9]{14}$

CNPJ da empresa do lançamento. A credencial precisa poder inserir lançamentos nela. Obrigatório, exceto no lançamento da venda (com sale_id), que fica na empresa da venda: nele pode ser omitido e, enviado, precisa ser o CNPJ dela.

sale_id
string <uuid>

Venda em que a conta a pagar ou a receber é lançada, pelo id de GET /sales, como o botão da aba Financeiro da venda no Monde. O lançamento nasce como avulso da venda (sale_standalone), na empresa dela. Não se combina com operation_id nem com parcelamento ou recorrência.

transaction_kind
required
string
Enum: "credit" "debit"

Natureza do lançamento: credit (conta a receber) ou debit (conta a pagar).

person_id
required
string <uuid>

Pessoa do lançamento (cliente ou fornecedor), pelo id de GET /people.

description
required
string <= 50 characters

Descrição do lançamento, com até 50 caracteres. Dos 60 que o Monde guarda, 10 ficam reservados para o que o próprio sistema acrescenta, como o sufixo " 1/3" da parcela e o " 1/2" do pagamento parcial.

document
string <= 50 characters

Documento de referência, como o número da nota, com até 50 caracteres.

amount
required
number <double> decimal places <= 2 > 0

Valor do lançamento, maior que zero, com até 2 casas decimais.

currency
string = 3 characters

Código da moeda do lançamento no padrão ISO 4217, entre as moedas ativas. Omitido, o lançamento é em real (BRL). Outra moeda só é aceita quando o Monde trabalha com mais de uma: na operadora ou com multimoedas. O valor, as categorias e as movimentações vêm nela; a movimentação em conta de outra moeda é convertida pelo exchange_rate.

issue_date
string <date>

Data de emissão no formato ISO 8601 (AAAA-MM-DD). Quando omitida, é hoje, ou o vencimento ou a liquidação, quando forem anteriores. Não pode ser maior que o vencimento nem que a liquidação.

due_date
required
string <date>

Data de vencimento no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio de vencimento da empresa.

account_id
string <uuid>

Conta prevista para a liquidação, pelo id de GET /accounts. Precisa estar ativa e vinculada à empresa do lançamento, de qualquer tipo, inclusive conta cartão de crédito na conta a receber. Quando omitida, vale a conta de previsão padrão da empresa.

operation_id
string <uuid>

Operação própria, pelo id do produto de operação própria. Precisa estar ativa. Só em agência.

observations
string

Observações do lançamento.

billing_account_id
string <uuid>

Conta de cobrança do boleto, pelo id de billing_accounts em GET /accounts/{id}. Só na conta a receber. Precisa ser ativa e de conta corrente ativa da empresa do lançamento. O lançamento passa a prever a entrada na conta corrente da cobrança, e o boleto é numerado; na conta de cobrança registrada, como a do PJBank, o boleto fica pendente de registro e o Monde o envia ao banco.

billet_demonstrative
string

Demonstrativo do boleto, o texto que sai impresso nele. Só na conta a receber.

required
Array of objects (bill_category_create) non-empty

Categorias do lançamento, ao menos uma. A soma com sinal delas é o valor final.

object

Rateios do lançamento. Só em agência.

Array of objects (custom_field)

Campos personalizados do financeiro, pelo id de GET /custom_fields. Os obrigatórios precisam ser informados.

settlement_date
string <date>

Data de liquidação no formato ISO 8601 (AAAA-MM-DD), enviada junto com movements para criar o lançamento já liquidado. Não pode ser maior que a data da última movimentação.

Array of objects (bill_movement_create)

Movimentações da liquidação, enviadas junto com settlement_date. Sem balance_resolution, a soma delas precisa ser igual ao valor final.

partial_payment
boolean

Pagamento parcial, o mesmo que balance_resolution igual a partial: com true e movimentações somando menos que o valor final, o lançamento é liquidado com o que foi pago e o saldo vira um novo lançamento em aberto, referenciado em generated_bills. Não se combina com parcelamento nem recorrência. Enviado junto com balance_resolution, precisa dizer o mesmo que ele.

balance_resolution
string
Enum: "category" "partial"

O que fazer com a diferença entre o que foi pago e o valor final, no lançamento criado já liquidado: category lança a diferença numa categoria de desconto ou acréscimo; partial liquida o que foi pago e cria um lançamento em aberto com o saldo, só quando foi pago menos. Não se combina com parcelamento nem recorrência.

balance_category_id
string <uuid>

Só com balance_resolution igual a category: a categoria da diferença, pelo id de GET /categories. Sem ela, vale a categoria padrão da empresa.

recurrence_kind
string
Enum: "installment" "recurrent"

Gera a série a partir do lançamento, em segundo plano: installment (parcelamento) ou recurrent (recorrência, pelos próximos 5 anos). Exige periodicity. Os lançamentos da série se consultam pelo recurrence_group_id da resposta.

periodicity
string
Enum: "weekly" "biweekly" "monthly" "bimonthly" "quarterly" "semiannual" "annual"

Intervalo entre os lançamentos da série: weekly, biweekly (15 dias), monthly, bimonthly, quarterly, semiannual ou annual.

installments
integer [ 2 .. 200 ]

Total de parcelas do parcelamento, de 2 a 200, contando a do próprio lançamento. Cada parcela repete o valor cheio.

Responses

Request samples

Content type
application/json
Example

Conta a pagar com documento, conta prevista, duas categorias, rateio por centro de custo e entre empresas, e campo personalizado.

{
  • "company_identifier": "46598887000162",
  • "transaction_kind": "debit",
  • "person_id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
  • "description": "Aluguel escritório - Outubro/2026",
  • "document": "NF 1001",
  • "amount": 1500,
  • "issue_date": "2026-10-07",
  • "due_date": "2026-10-15",
  • "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
  • "observations": "Contrato 2026/10",
  • "categories": [
    ],
  • "apportionments": {
    },
  • "custom_fields": [
    ]
}

Response samples

Content type
application/json

Exemplo de detalhe de uma fatura de cliente, com categorias, movimentações, rateios, itens, anexos e campos personalizados.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "number": "12345",
  • "transaction_kind": "credit",
  • "kind": "customer_invoice",
  • "description": "Fatura cliente - Janeiro/2026",
  • "document": "NF 1001",
  • "invoice_number": 42,
  • "amount": 1500,
  • "final_amount": 1500,
  • "issue_date": "2026-01-10",
  • "due_date": "2026-02-10",
  • "settlement_date": null,
  • "created_at": "2026-01-10T13:45:36",
  • "canceled": false,
  • "checked": false,
  • "invoice_closed": false,
  • "system_generated": false,
  • "generates_credit": false,
  • "periodicity": "without_periodicity",
  • "recurrence_kind": "non_recurrent",
  • "recurrence_group_id": null,
  • "observations": null,
  • "billet": {
    },
  • "check": null,
  • "card": null,
  • "sale": null,
  • "person": {
    },
  • "company": {
    },
  • "account": {
    },
  • "payment_method": {
    },
  • "operation": null,
  • "invoice_rule": {
    },
  • "created_by": {
    },
  • "movements": [
    ],
  • "apportionments": {
    },
  • "custom_fields": [
    ],
  • "attachments": [],
  • "categories": [
    ],
  • "commissions": [ ],
  • "items": [
    ],
  • "credit_card_items": [ ]
}

Consultar conta a pagar ou receber por ID Beta

Retorna o detalhe completo de uma conta a pagar ou receber: boleto, categorias, rateio entre empresas, rateio de centro de custo, movimentações de liquidação, itens, cobranças da fatura de cartão, comissões, anexos e campos personalizados.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de detalhe de uma fatura de cliente, com categorias, movimentações, rateios, itens, anexos e campos personalizados.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "number": "12345",
  • "transaction_kind": "credit",
  • "kind": "customer_invoice",
  • "description": "Fatura cliente - Janeiro/2026",
  • "document": "NF 1001",
  • "invoice_number": 42,
  • "amount": 1500,
  • "final_amount": 1500,
  • "issue_date": "2026-01-10",
  • "due_date": "2026-02-10",
  • "settlement_date": null,
  • "created_at": "2026-01-10T13:45:36",
  • "canceled": false,
  • "checked": false,
  • "invoice_closed": false,
  • "system_generated": false,
  • "generates_credit": false,
  • "periodicity": "without_periodicity",
  • "recurrence_kind": "non_recurrent",
  • "recurrence_group_id": null,
  • "observations": null,
  • "billet": {
    },
  • "check": null,
  • "card": null,
  • "sale": null,
  • "person": {
    },
  • "company": {
    },
  • "account": {
    },
  • "payment_method": {
    },
  • "operation": null,
  • "invoice_rule": {
    },
  • "created_by": {
    },
  • "movements": [
    ],
  • "apportionments": {
    },
  • "custom_fields": [
    ],
  • "attachments": [],
  • "categories": [
    ],
  • "commissions": [ ],
  • "items": [
    ],
  • "credit_card_items": [ ]
}

Alterar conta a pagar ou receber Beta

Altera um lançamento financeiro, em aberto ou liquidado, com as mesmas regras do lançamento manual do Monde. Informe só os campos que devem mudar: o campo omitido permanece como está. document, observations e operation_id se esvaziam quando enviados como nulos; person_id, description, issue_date, due_date, account_id e amount são obrigatórios no lançamento, e enviá-los nulos ou vazios é recusado, assim como company_identifier nulo ou vazio. A lista enviada como nula vale como a vazia: categories nula é recusada como a lista vazia, e apportionments nulo esvazia os dois rateios (per_cost_center ou per_company nulo esvazia só aquele). Os campos personalizados não substituem: cada um enviado é gravado por cima do atual, o enviado com value nulo ou vazio é limpo, e os demais permanecem; os obrigatórios não precisam ser reenviados, mas não podem ser limpos. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).

O que se altera. Pessoa, descrição, documento, emissão, vencimento, conta prevista, operação própria, observações, campos personalizados, valor, categorias, rateios, empresa e, no lançamento liquidado, a data de liquidação e as movimentações. Esta operação não liquida nem estorna: para isso, use Liquidar conta a pagar ou receber e Desfazer a liquidação. A natureza (transaction_kind) não muda: enviada, é ignorada como qualquer campo fora do contrato.

Que lançamentos. Todo lançamento não excluído, em aberto ou liquidado, com as travas que o Monde aplica a cada tipo (kind). O excluído e a fatura inválida respondem 409.

  • Gerado por venda (sale_payment, ou com venda vinculada): pessoa, empresa e valor não mudam. No sale_standalone, só a empresa.
  • Fatura de cliente e de fornecedor (customer_invoice, vendor_invoice, vendor_standalone): pessoa, empresa e valor original não mudam; o valor vem dos itens.
  • Fatura de cartão (credit_card_invoice): vencimento, empresa e valor não mudam, e ela não tem categorias. Os rateios dividem o valor final dela, a soma das compras do cartão.
  • Comissão (commission): como o lançamento avulso, mas sem operação própria.
Em todos, a categoria gerada pelo sistema (a da venda, a da fatura) não sai nem muda de valor: reenvie-a como está, com o mesmo category_id. A operação própria só é aceita no lançamento avulso (normal) sem número de fatura, como no Monde.

Lançamento liquidado. Exige também a permissão "Editar lançamento liquidado" de contas a pagar e receber. settlement_date muda a data de liquidação, que não pode ficar vazia nem passar da data da última movimentação. Mudar a data de liquidação para uma diferente da gravada exige também a permissão "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. A mesma data reenviada não pede a permissão. Cada item de movements com id aponta uma movimentação que o lançamento já tem, e muda só a conta, a forma de pagamento, a data, o valor, a taxa de cartão, o cheque ou o cartão enviados. O item sem id é uma movimentação nova, como o Adicionar do Monde, e vem com a conta, a forma de pagamento, a data e o valor. As movimentações não enviadas ficam como estão, e não é possível retirar movimentação. Os ids das movimentações vêm em movements de Consultar conta a pagar ou receber por ID. As movimentações precisam somar exatamente o valor final: mudar o valor pede a movimentação junto. Na movimentação com taxa de cartão (card_rate), o valor é o que o cliente pagou, e a conta recebe o valor menos a taxa: mudar só a taxa mantém o que o cliente pagou e muda o que entrou na conta, como no Monde, e a categoria de taxa de cartão acompanha, assim como a taxa cartão agência dos produtos da venda e a receita dela. A forma de pagamento da movimentação com taxa gerada pelo sistema não muda para outra que não seja cartão. A conta a receber pode passar para a conta cartão de crédito, com a forma cartão de crédito: é o estorno, que entra na fatura do cartão. A empresa do lançamento liquidado não muda. O caixa fechado e, em contas a receber, o bloqueio da data de movimentação valem como no Monde. Em lançamento em aberto, uma data em settlement_date ou uma movimentação em movements é recusada: esta operação não liquida.

Conciliação bancária. A alteração que muda o valor, a data ou a conta de uma movimentação conciliada desfaz a conciliação dela e responde 409, com o mesmo aviso do Monde, a menos que o pedido traga undo_bank_reconciliation como true. Com a confirmação, a alteração é gravada, e a conciliação dessa movimentação precisará ser refeita. A alteração que não mexe nas movimentações conciliadas, como a das categorias, dos rateios ou da descrição, mantém a conciliação e é gravada sem a confirmação.

Valor e categorias. As categories enviadas substituem as do lançamento, e a soma com sinal delas é o valor final, como na inserção: a diferença para amount é acréscimo ou desconto, sujeita ao bloqueio de acréscimo e desconto da empresa. A lista não pode ficar vazia. O amount enviado sem categories segue a regra do Monde: com uma categoria só, ela acompanha o novo valor; com mais de uma, o novo valor precisa ser igual à soma delas, senão é recusado e é preciso enviar as categorias junto.

Rateios. Só em agência. Cada rateio enviado substitui o do lançamento, e o que não veio fica como está: apportionments.per_cost_center pode ficar entre 0 e 100% do valor final, e apportionments.per_company, quando informado, precisa somar exatamente 100% e só aceita empresas em que a credencial também pode inserir lançamentos. A lista vazia retira o rateio.

Empresa. company_identifier leva o lançamento para outra empresa, e exige a permissão "Editar" de contas a pagar e receber também nela, que não pode estar somente leitura. O lançamento de outro usuário exige também, na empresa de destino, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); sem ele, a resposta é 403 com a mensagem do Monde. Sem account_id, a conta prevista continua a mesma se a nova empresa também a tem; senão, vale a conta de previsão padrão da nova empresa. Como no Monde, o lançamento com boleto registrado ou emitido não muda de empresa.

Regras. A emissão não pode ser maior que o vencimento. A descrição tem até 50 caracteres, como na inserção. A conta prevista precisa estar ativa e vinculada à empresa do lançamento, e a operação própria precisa estar ativa e só é aceita em agência. Em contas a receber, o vencimento alterado está sujeito ao bloqueio de vencimento da empresa. Só a credencial com "Ignorar bloqueios" na empresa do lançamento passa pelos bloqueios.

Parcelamento e recorrência. No lançamento de uma série, a alteração vale só para ele, a menos que recurrence_scope seja this_and_following: aí ela vale também para os lançamentos seguintes da série, como a opção "Atualizar este e próximos" do Monde. Os seguintes são alterados em segundo plano, logo depois da resposta. Nunca se levam a eles a liquidação, o número, o documento e os dados do boleto; o vencimento deles segue a periodicidade da série a partir do lançamento alterado, e na recorrência a emissão também. Cada seguinte só é alterado quando a credencial poderia alterá-lo diretamente, com as regras do fim desta descrição: a permissão "Editar" na empresa dele, que não pode estar somente leitura; no de outro usuário, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, a "Editar lançamento liquidado". O seguinte que não atende a isso fica como está, sem interromper os demais. O seguinte excluído também fica como está. Em lançamento fora de uma série, this_and_following é recusado.

Exige a permissão "Editar" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura; o lançamento liquidado exige também a "Editar lançamento liquidado". A credencial altera o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. A resposta traz o lançamento alterado, igual a Consultar conta a pagar ou receber por ID, quando a credencial também tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id. Vale também para o lançamento que a própria credencial criou.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
person_id
string <uuid>

Pessoa do lançamento (cliente ou fornecedor), pelo id de GET /people. Não pode ser vazia.

description
string <= 50 characters

Descrição do lançamento, com até 50 caracteres. Não pode ser vazia.

document
string or null <= 50 characters

Documento de referência, como o número da nota, com até 50 caracteres. Nulo limpa; o texto vazio é gravado.

issue_date
string <date>

Data de emissão no formato ISO 8601 (AAAA-MM-DD). Não pode ser maior que o vencimento.

due_date
string <date>

Data de vencimento no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio de vencimento da empresa.

account_id
string <uuid>

Conta prevista para a liquidação, pelo id de GET /accounts. Precisa estar ativa e vinculada à empresa do lançamento.

operation_id
string or null <uuid>

Operação própria, pelo id do produto de operação própria. Precisa estar ativa. Só em agência e no lançamento avulso sem número de fatura. Nulo limpa.

observations
string or null

Observações do lançamento. Nulo limpa; o texto vazio é gravado.

billing_account_id
string or null <uuid>

Conta de cobrança do boleto, pelo id de billing_accounts em GET /accounts/{id}. Só na conta a receber, com as regras da inclusão. Só troca enquanto não há boleto vivo no banco: o boleto já emitido, e o registrado ou a caminho do banco, prendem a conta. Na fatura de cliente, só entra com a fatura fechada: veja close_invoice. Nulo tira a conta de cobrança.

billet_demonstrative
string or null

Demonstrativo do boleto, o texto que sai impresso nele. Só na conta a receber. Nulo ou texto vazio limpa: o Monde não grava demonstrativo vazio.

close_invoice
boolean

Confirma o fechamento da fatura de cliente aberta junto com a conta de cobrança: true fecha a fatura e grava a conta de cobrança na mesma chamada, com as regras e a permissão Fechar Fatura de Fechar fatura de cliente. Sem ela, a conta de cobrança na fatura de cliente aberta responde 409.

company_identifier
string = 14 characters ^[0-9]{14}$

CNPJ da empresa para onde o lançamento vai. A credencial precisa poder inserir lançamentos nela. Lançamento com boleto registrado ou emitido não muda de empresa.

amount
number <double> decimal places <= 2 > 0

Valor do lançamento, maior que zero, com até 2 casas decimais. Sem categories, a única categoria acompanha o novo valor; com mais de uma, ele precisa ser igual à soma delas.

Array of objects (bill_category_create) non-empty

Categorias do lançamento, ao menos uma. Substituem as atuais, e a soma com sinal delas é o valor final.

object or null

Rateios do lançamento. Só em agência. Cada um enviado substitui o atual; o que não veio fica como está.

recurrence_scope
string
Enum: "only_this" "this_and_following"

Só para lançamento de parcelamento ou recorrência: only_this (padrão) altera só este; this_and_following altera este e os lançamentos seguintes da série, em segundo plano; cada seguinte só muda quando a credencial poderia alterá-lo diretamente.

Array of objects (custom_field)

Campos personalizados do financeiro, pelo id de GET /custom_fields. Cada um enviado é gravado por cima do atual; os demais permanecem.

settlement_date
string <date>

Só em lançamento liquidado. Data de liquidação no formato ISO 8601 (AAAA-MM-DD). Não pode ficar vazia nem passar da data da última movimentação.

Array of objects (bill_movement_update)

Só em lançamento liquidado. Movimentações que o lançamento já tem, cada uma pelo id, com o que muda nela, e as novas, sem id, completas. As não enviadas ficam como estão; não é possível retirar movimentação.

undo_bank_reconciliation
boolean

Confirma a alteração que desfaz a conciliação bancária: true grava, e a conciliação da movimentação cujo valor, data ou conta mudou é desfeita. Sem ela, essa alteração responde 409; a que não mexe nas movimentações conciliadas grava sem ela.

Responses

Request samples

Content type
application/json
Example

Altera só os campos informados; os demais ficam como estão.

{
  • "description": "Aluguel escritório - Novembro/2026",
  • "document": "NF 1002",
  • "due_date": "2026-11-15",
  • "observations": "Vencimento renegociado com o locador"
}

Response samples

Content type
application/json
Example

Exemplo de detalhe de uma fatura de cliente, com categorias, movimentações, rateios, itens, anexos e campos personalizados.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "number": "12345",
  • "transaction_kind": "credit",
  • "kind": "customer_invoice",
  • "description": "Fatura cliente - Janeiro/2026",
  • "document": "NF 1001",
  • "invoice_number": 42,
  • "amount": 1500,
  • "final_amount": 1500,
  • "issue_date": "2026-01-10",
  • "due_date": "2026-02-10",
  • "settlement_date": null,
  • "created_at": "2026-01-10T13:45:36",
  • "canceled": false,
  • "checked": false,
  • "invoice_closed": false,
  • "system_generated": false,
  • "generates_credit": false,
  • "periodicity": "without_periodicity",
  • "recurrence_kind": "non_recurrent",
  • "recurrence_group_id": null,
  • "observations": null,
  • "billet": {
    },
  • "check": null,
  • "card": null,
  • "sale": null,
  • "person": {
    },
  • "company": {
    },
  • "account": {
    },
  • "payment_method": {
    },
  • "operation": null,
  • "invoice_rule": {
    },
  • "created_by": {
    },
  • "movements": [
    ],
  • "apportionments": {
    },
  • "custom_fields": [
    ],
  • "attachments": [],
  • "categories": [
    ],
  • "commissions": [ ],
  • "items": [
    ],
  • "credit_card_items": [ ]
}

Excluir conta a pagar ou receber Beta

Exclui o lançamento como o Monde exclui: ele não é apagado, fica marcado como excluído (canceled igual a true). Deixa de aparecer em Consultar contas a pagar e receber, a não ser que o parâmetro status peça as canceladas, e continua disponível na consulta por ID, com as categorias, os rateios e os anexos que tinha.

Que lançamentos. O lançamento avulso (normal) e a fatura de cliente e de fornecedor (customer_invoice, vendor_invoice, vendor_standalone). Na fatura, os itens saem dela: os de cliente voltam a ser faturados pelas regras de faturamento, os de fornecedor ficam a faturar (e voltam a ser faturados quando a agência fatura os fornecedores automaticamente), e os itens do extrato CVC lançados direto na fatura e os de venda cancelada são apagados. A fatura fica marcada como excluída, mesmo sem itens. Respondem 409, com o motivo:

  • o lançamento já excluído;
  • o gerado por venda (sale_payment, sale_standalone ou com venda vinculada): ele sai pela exclusão da venda;
  • a fatura de cartão (credit_card_invoice), que sai sozinha quando fica sem lançamentos;
  • o lançamento de comissão (commission);
  • a fatura gerada pelo Monde que ainda tem itens, a fatura fechada e a fatura cujo saldo foi levado para outro lançamento.

Sem confirmação. Esta é a exclusão sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. Por isso, o lançamento liquidado e o lançamento com movimentação conciliada respondem 409, e o recurrence_scope responde 422: no lançamento de uma série, o DELETE exclui só ele. Quando a recusa 409 pedir uma confirmação, ou para excluir também os seguintes da série, use Excluir conta a pagar ou receber com confirmação, que tem as mesmas regras e leva as confirmações no corpo.

A exclusão fica no log do lançamento, em nome da credencial.

Exige a permissão "Excluir" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura; a permissão "Editar" não basta. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", o lançamento liquidado responde 403, mesmo o que também seria recusado com 409, como o gerado por venda. A credencial exclui o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. Não exige Idempotency-Key: repetir a requisição depois de excluído responde 409.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Excluir conta a pagar ou receber com confirmação Beta

Exclui o lançamento com as respostas às perguntas que o Monde faz antes de excluir: remover a liquidação, desfazer a conciliação bancária e excluir também os seguintes da série. É a mesma exclusão de Excluir conta a pagar ou receber, com as mesmas regras, permissões e respostas. A diferença é que as confirmações vão no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho.

O lançamento não é apagado: fica marcado como excluído (canceled igual a true), como no Monde. Os lançamentos aceitos e as recusas com 409 são os do DELETE.

Lançamento liquidado. Excluir remove a liquidação, e as movimentações saem das contas, como a pergunta "Essa conta já está liquidada. Deseja remover a liquidação e excluir?" do Monde. O pedido sem remove_settlement igual a true responde 409. Exige também a permissão "Editar lançamento liquidado" de contas a pagar e receber. O caixa fechado na data de alguma movimentação, e a movimentação de cartão de uma fatura de cartão já liquidada, impedem a exclusão: a resposta é 422 com o motivo.

Conciliação bancária. O lançamento com movimentação conciliada responde 409, com o aviso do Monde, até o pedido trazer undo_bank_reconciliation igual a true. Com a confirmação, a conciliação é desfeita e precisará ser refeita.

Parcelamento e recorrência. No lançamento de uma série, a exclusão vale só para ele, a menos que recurrence_scope seja this_and_following, como a opção "Excluir este e próximos" do Monde: os lançamentos seguintes da série que não têm movimentação são apagados, em segundo plano, logo depois da resposta, e a série deixa de se repetir. Cada seguinte só é apagado quando a credencial poderia excluí-lo diretamente: com a permissão "Excluir" de contas a pagar e receber na empresa dele, que não pode estar somente leitura; no de outro usuário, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, a "Editar lançamento liquidado". O seguinte que não atende a isso fica, fora da série. Os apagados não voltam. Em lançamento fora de uma série, this_and_following é recusado.

O corpo só leva essas confirmações, e o campo omitido vale como não confirmado. O valor fora do formato responde 422, antes das recusas com 409. A exclusão fica no log do lançamento, em nome da credencial.

Exige a permissão "Excluir" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura; a permissão "Editar" não basta. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", o lançamento liquidado responde 403. A credencial exclui o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde.

Exige Idempotency-Key: sem ela, a resposta é 400. O reenvio com a mesma chave devolve a resposta da primeira exclusão, 204 com o cabeçalho X-Idempotent-Replay: true, sem excluir de novo.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
recurrence_scope
string
Enum: "only_this" "this_and_following"

Só para lançamento de parcelamento ou recorrência: only_this (padrão) exclui só este; this_and_following exclui também os seguintes da série que não têm movimentação e que a credencial poderia excluir diretamente.

remove_settlement
boolean

Confirma a exclusão do lançamento liquidado, que remove a liquidação e as movimentações dele. Obrigatório como true no lançamento liquidado.

undo_bank_reconciliation
boolean

Confirma que a conciliação bancária do lançamento será desfeita. Obrigatório como true no lançamento com movimentação conciliada.

Responses

Request samples

Content type
application/json
{
  • "remove_settlement": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Liquidar conta a pagar ou receber Beta

Liquida (dá baixa em) um lançamento em aberto, com as regras da liquidação do Monde. Envie a data de liquidação (settlement_date) e as movimentações (movements), uma por conta em que o dinheiro entrou ou saiu, com a conta, a forma de pagamento, a data e o valor, como na inserção já liquidada. Cada movimentação usa uma conta ativa vinculada à empresa do lançamento, e a forma de pagamento segue o tipo da conta: conta caixa e conta de cheques aceitam dinheiro ou cheque, conta cartão de crédito aceita só cartão de crédito, e conta corrente aceita as demais. Cheque exige o número. Parcelar (installments) só em conta cartão de crédito. A data de liquidação não pode ser maior que a data da última movimentação, e a emissão não pode ser maior que a liquidação.

Taxa de cartão e estorno. Na conta a receber recebida em cartão de crédito ou de débito numa conta corrente, card_rate é a taxa da operadora: a conta recebe amount menos a taxa, e a soma das taxas vira a categoria de taxa de cartão da empresa, que abate o valor final, como na inserção já liquidada. A conta a receber liquidada na conta cartão de crédito, com a forma cartão de crédito, é o estorno, que entra na fatura do cartão.

Valor pago diferente do valor final. Quando as movimentações não somam o valor final, diga o que fazer com a diferença em balance_resolution, como a pergunta do Monde ao liquidar:

  • category: a diferença vai para uma categoria, como desconto (pago a menos) ou acréscimo (pago a mais), e o valor final passa a ser o que foi pago. A categoria vem em balance_category_id; sem ela, vale a categoria padrão da empresa para aquele caso (desconto concedido ou recebido, acréscimo cobrado ou pago), e sem padrão o pedido é recusado. A categoria precisa ser do tipo que leva o valor final ao que foi pago: a de despesa numa conta a pagar paga a mais, por exemplo. Vale o bloqueio de acréscimo e desconto da empresa.
  • partial: só quando foi pago menos que o valor final. O lançamento é liquidado com o que foi pago e ganha o sufixo " 1/2" na descrição, e o saldo vira um novo lançamento em aberto, com o sufixo " 2/2" e as mesmas categorias na proporção do saldo. O saldo vem em generated_bills.

Sem balance_resolution, as movimentações precisam somar exatamente o valor final. Na fatura de cartão, a diferença vai sempre para a próxima fatura do mesmo cartão, sem escolha (balance_resolution não muda o destino dela): o que faltou pagar entra nela como dívida, e o que sobrou, como abatimento. Na fatura de cliente gerada pelo Monde e na fatura de fornecedor, exceto a da CVC, a API liquida só o valor total, e o pagamento menor ou maior que ele é recusado com 422. Nas demais faturas, a diferença se resolve só com category; o pagamento parcial é recusado com 422.

Que lançamentos. Todos os tipos, como no Monde: o lançamento avulso (normal), o pagamento da venda (sale_payment), o avulso da venda (sale_standalone), a comissão (commission), a fatura de cliente e de fornecedor (customer_invoice, vendor_invoice, vendor_standalone) e a fatura de cartão (credit_card_invoice). Respondem 409, com o motivo: o lançamento já liquidado (para mudar a baixa, use a alteração), o excluído e a fatura inválida. O lançamento em outra moeda se liquida como no Monde: o amount da movimentação é na moeda do lançamento e, na conta em outra moeda, entra convertido pelo câmbio (exchange_rate). A movimentação numa conta fora do real guarda o câmbio de referência da moeda da conta para o real (reference_exchange_rate). Como no Monde, os dois vêm sugeridos pela última cotação e podem ser corrigidos: omitidos, valem as cotações (sem cotação cadastrada para converter, 422); informados, valem os do banco.

Pagamento da venda. Cada pagamento feito à agência numa venda (dinheiro, cartão, boleto, cheque, depósito e outros, uma conta por parcela) é um lançamento sale_payment, e o id dele vem em payments.agency.bills de Consultar venda por ID e da resposta da inserção e da alteração da venda. Os pagamentos ao fornecedor e o crédito na agência não geram lançamento e não se liquidam. A baixa usa a forma e os dados de pagamento combinados na venda, como o "Liquidar usando dados da venda" do Monde: payment_method_id é opcional na movimentação e, ausente, vale a forma da venda; a movimentação que usa a forma da venda recebe o cartão ou o cheque informados nela, que card e check substituem quando enviados. A taxa de cartão calculada na venda passa para a primeira movimentação, quando ela é de cartão (senão, fica no lançamento), sem precisar enviar card_rate: como em toda movimentação com taxa, o amount é o que o cliente pagou, e a conta recebe o amount menos a taxa. A taxa de cartão da liquidação é rateada entre os produtos da venda, na taxa cartão agência deles, e sai da receita da venda, como no Monde. O saldo do pagamento parcial (balance_resolution igual a partial) nasce ligado à mesma venda, sem os sufixos " 1/2" e " 2/2" na descrição: ele aparece em payments.agency.bills da venda. No pagamento parcial, os itens do pagamento ficam no lançamento até o valor pago, e o item que passa dele é dividido: a parte paga fica, e o resto vai para o saldo, cada parte com a taxa cartão agência na proporção do seu valor. As categorias do saldo vêm das categorias padrão de fatura da empresa; sem elas, a liquidação é recusada com 422 e nada é gravado. Pessoa, empresa e valor do pagamento não mudam.

Regras do Monde. Em contas a receber valem o bloqueio da data de movimentação e o de acréscimo e desconto da empresa, que para a integração valem sempre. O caixa do dia fechado recusa a movimentação com o motivo, como O caixa do dia "14/10/2026" da conta "Caixa" está fechado. A liquidação e as movimentações ficam no log do lançamento, em nome da credencial.

As respostas seguem uma ordem: a permissão (403), o formato do pedido (422), a situação do lançamento (409) e as regras da liquidação e do Monde (422). Os erros de um item de movements trazem a posição dele, contada a partir de 0.

Exige a permissão "Editar" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura: liquidar é o mesmo direito de inserir o lançamento já liquidado. Exige também a permissão Liquidar conta a pagar ou Liquidar conta a receber, conforme a natureza do lançamento; sem ela, a resposta é 403 com a mensagem do Monde. A credencial liquida o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. A resposta traz o lançamento liquidado, igual a Consultar conta a pagar ou receber por ID, com o saldo do pagamento parcial em generated_bills, quando a credencial também tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento; sem ela, a liquidação é gravada do mesmo jeito e a resposta traz só o id. Vale também para o lançamento que a própria credencial criou.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
settlement_date
required
string <date>

Data de liquidação no formato ISO 8601 (AAAA-MM-DD). Não pode ser maior que a data da última movimentação, nem menor que a emissão.

required
Array of objects (bill_movement_create) non-empty

Movimentações da liquidação, ao menos uma: uma por conta em que o dinheiro entrou ou saiu. Sem balance_resolution, precisam somar o valor final.

balance_resolution
string
Enum: "category" "partial"

O que fazer com a diferença entre o que foi pago e o valor final: category lança a diferença numa categoria de desconto ou acréscimo; partial liquida o que foi pago e cria um lançamento em aberto com o saldo, só quando foi pago menos.

balance_category_id
string <uuid>

Só com balance_resolution igual a category: a categoria da diferença, pelo id de GET /categories. Sem ela, vale a categoria padrão da empresa.

Responses

Request samples

Content type
application/json
Example

Conta de R$ 420,00 paga em dinheiro na conta caixa.

{
  • "settlement_date": "2026-10-14",
  • "movements": [
    ]
}

Response samples

Content type
application/json

Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}

Desfazer a liquidação de conta a pagar ou receber Beta

Desfaz a liquidação de um lançamento, como remover a liquidação no Monde: a data de liquidação fica em branco, as movimentações saem das contas e o lançamento volta a ficar em aberto. Saem junto a taxa de cartão e a taxa de banco geradas na liquidação, menos a taxa de cartão calculada na venda, que fica no pagamento da venda. A taxa cartão agência dos produtos da venda volta a zero, e a receita da venda deixa de descontá-la, como no Monde; numa nova liquidação, a taxa é rateada pelo valor de cada produto; o acréscimo e o desconto lançados nela ficam, e o valor final continua com eles. O lançamento com o saldo de um pagamento parcial também fica. O boleto em baixa pendente volta a registrado, e o crédito gerado pela liquidação é estornado. A remoção das movimentações fica no log do lançamento, em nome da credencial.

Que lançamentos. Os mesmos que a liquidação aceita. Respondem 409, com o motivo: o lançamento em aberto, o excluído e a fatura cujo saldo foi levado para outro lançamento (a liquidação dela não é desfeita enquanto o saldo estiver lá). Na fatura de cartão, o saldo levado à próxima fatura do mesmo cartão sai de lá junto; a recusa só vem quando essa próxima fatura já está liquidada.

Sem confirmação. Este é o desfazer sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. Por isso, o lançamento com movimentação conciliada responde 409, e o recurrence_scope responde 422: no lançamento de uma série, o DELETE desfaz só a liquidação dele. Quando a recusa 409 pedir a confirmação, ou para desfazer também a liquidação dos seguintes da série, use Desfazer a liquidação com confirmação, que tem as mesmas regras e leva as confirmações no corpo.

O caixa fechado na data de alguma movimentação, e a movimentação de cartão de uma fatura de cartão já liquidada, impedem desfazer: a resposta é 422 com o motivo.

Exige as permissões "Editar" e "Editar lançamento liquidado" de contas a pagar e receber, na empresa do lançamento, que não pode estar somente leitura. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", a resposta é 403 mesmo para o lançamento que já está em aberto. A credencial desfaz a liquidação do lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. Não exige Idempotency-Key: repetir a requisição depois de desfeita responde 409.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Desfazer a liquidação com confirmação Beta

Desfaz a liquidação do lançamento com as respostas às perguntas do Monde: desfazer a conciliação bancária e desfazer também a liquidação dos seguintes da série. É o mesmo desfazer de Desfazer a liquidação de conta a pagar ou receber, com as mesmas regras, permissões e respostas. A diferença é que as confirmações vão no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho.

A data de liquidação fica em branco, as movimentações saem das contas e o lançamento volta a ficar em aberto, como no DELETE. Os lançamentos aceitos e as recusas com 409 também são os do DELETE.

Conciliação bancária. O lançamento com movimentação conciliada responde 409, com o aviso do Monde, até o pedido trazer undo_bank_reconciliation igual a true. Com a confirmação, a conciliação é desfeita e precisará ser refeita.

O caixa fechado na data de alguma movimentação, e a movimentação de cartão de uma fatura de cartão já liquidada, impedem desfazer: a resposta é 422 com o motivo. O corpo só leva as confirmações, e o campo omitido vale como não confirmado. O valor fora do formato responde 422, antes das recusas com 409.

Parcelamento e recorrência. No lançamento de uma série, desfaz só a liquidação dele, a menos que recurrence_scope seja this_and_following, como a opção "Atualizar este e próximos" do Monde: aí desfaz também a dos lançamentos seguintes da série que estão liquidados. Os seguintes em aberto, os excluídos e os anteriores ficam como estão. Cada seguinte passa pelas mesmas recusas do lançamento informado (o saldo levado a outro lançamento, a conciliação sem a confirmação de undo_bank_reconciliation) e exige que a credencial possa desfazer a liquidação dele diretamente. É tudo ou nada: se um deles não pode reabrir, nenhuma liquidação é desfeita, e a resposta é 409 com o seguinte que barrou e o motivo; o caixa fechado na data de uma movimentação de qualquer deles responde 422. Em lançamento fora de uma série, this_and_following é recusado com 422.

Exige as permissões "Editar" e "Editar lançamento liquidado" de contas a pagar e receber, na empresa do lançamento, que não pode estar somente leitura. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", a resposta é 403 mesmo para o lançamento que já está em aberto. A credencial desfaz a liquidação do lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde.

Exige Idempotency-Key: sem ela, a resposta é 400. O reenvio com a mesma chave devolve a resposta do primeiro pedido, 204 com o cabeçalho X-Idempotent-Replay: true, sem desfazer de novo.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
recurrence_scope
string
Enum: "only_this" "this_and_following"

Só para lançamento de parcelamento ou recorrência: only_this (padrão) desfaz só a liquidação deste; this_and_following desfaz também a dos seguintes da série que estão liquidados.

undo_bank_reconciliation
boolean

Confirma que a conciliação bancária do lançamento será desfeita. Obrigatório como true no lançamento com movimentação conciliada, e vale também para os seguintes da série com this_and_following.

Responses

Request samples

Content type
application/json
{
  • "recurrence_scope": "this_and_following",
  • "undo_bank_reconciliation": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Liquidar contas a pagar e receber em lote Beta

Liquida vários lançamentos em aberto numa chamada, como a liquidação dos lançamentos marcados na consulta do Monde. Envie os ids em bill_ids, até 100, sem repetir. Cada lançamento recebe a baixa do seu valor final inteiro, na mesma data (settlement_date), na mesma conta (account_id) e com a mesma forma de pagamento (payment_method_id) e os mesmos dados de cheque (check) ou de cartão (card). Para pagar só parte de um lançamento, ou dividir a baixa entre contas, use Liquidar conta a pagar ou receber.

Tudo ou nada. Se um dos lançamentos não pode ser liquidado, nenhum é, e a mensagem diz qual barrou, pelo número: Não é possível liquidar o lançamento Nº 71. O lançamento está excluído e não pode ser alterado..

Dados da venda. Com use_sale_data igual a true, cada pagamento da venda é liquidado com a forma e os dados de cheque ou cartão combinados na própria venda, como o "Liquidar usando dados da venda" do Monde. Vale só quando todos os lançamentos são pagamento da venda (sale_payment), e aí payment_method_id, check e card não são aceitos. O padrão é false.

Conta, forma e taxa de cartão. A conta precisa estar ativa e vinculada às empresas de todos os lançamentos, e a forma de pagamento segue o tipo da conta, como na liquidação de um lançamento: conta caixa e conta de cheques aceitam dinheiro ou cheque, conta cartão de crédito aceita só cartão de crédito, e conta corrente aceita as demais. Parcelar (installments) só em conta cartão de crédito. A taxa de cartão não é enviada: ela vem das categorias de cada lançamento, como no Monde, e card_rate é recusado.

Moeda. Os lançamentos precisam estar na mesma moeda. A conta em outra moeda só é aceita quando o Monde trabalha com mais de uma moeda (na operadora ou com multimoedas), como na liquidação em lote do Monde; nela, exchange_rate converte o valor de todos; omitido, vale a última cotação, e sem cotação cadastrada o pedido é recusado com 422.

Que lançamentos. Os mesmos que a liquidação de um lançamento aceita, com as mesmas recusas com 409: o lançamento já liquidado, o excluído e a fatura inválida. Valem as regras do Monde em cada um, como a emissão maior que a liquidação, os bloqueios da empresa e o caixa do dia fechado, que respondem 422 com o motivo. A liquidação e as movimentações ficam no log de cada lançamento, em nome da credencial.

As respostas seguem uma ordem: o lançamento que não existe (404, com os ids), a permissão (403), o formato do pedido (422), a situação de cada lançamento (409) e as regras da liquidação e do Monde (422).

Exige, em cada lançamento, as permissões da liquidação de um lançamento: "Editar" de contas a pagar e receber na empresa dele, que não pode estar somente leitura, e Liquidar conta a pagar ou Liquidar conta a receber, conforme a natureza dele. Basta faltar em um lançamento para a resposta ser 403 com a mensagem do Monde e nada ser liquidado. O alcance também é o mesmo: a credencial liquida os lançamentos que ela criou e, com o acesso aos lançamentos de outros usuários, os demais; o de fora desse acesso responde 404. A resposta traz em data os lançamentos liquidados, cada um igual a Consultar conta a pagar ou receber por ID, quando a credencial tem a permissão "Visualizar" de contas a pagar e receber na empresa dele; sem ela, a liquidação é gravada do mesmo jeito e vem só o id.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
bill_ids
required
Array of strings <uuid> [ 1 .. 100 ] items unique [ items <uuid > ]

Ids (UUID) dos lançamentos a liquidar, de 1 a 100, sem repetir. Todos precisam estar na mesma moeda.

settlement_date
required
string <date>

Data de liquidação no formato ISO 8601 (AAAA-MM-DD), a mesma para todos os lançamentos. É também a data das movimentações, e a emissão de cada lançamento não pode ser maior que ela.

account_id
required
string <uuid>

Conta em que o dinheiro entrou ou saiu, a mesma para todos os lançamentos: ativa e vinculada às empresas de todos eles.

use_sale_data
boolean
Default: false

Com true, cada pagamento da venda é liquidado com a forma e os dados de cheque ou cartão da própria venda, como o "Liquidar usando dados da venda" do Monde. Só vale quando todos os lançamentos são pagamento da venda, e aí payment_method_id, check e card não são aceitos.

payment_method_id
string <uuid>

Forma de pagamento, a mesma para todos os lançamentos, que segue o tipo da conta. Omitida, cada lançamento fica sem forma na movimentação. Não é aceita com use_sale_data igual a true.

installments
integer [ 1 .. 99 ]

Parcelas, de 1 a 99. Mais de uma só em conta cartão de crédito, em que cada parcela entra na fatura do mês dela.

object

Dados do cheque, só com a forma cheque, que exige o número. Não é aceito com use_sale_data igual a true.

object

Dados do cartão, só com as formas de cartão de crédito ou de débito. Não é aceito com use_sale_data igual a true.

exchange_rate
number <double> > 0

Câmbio da moeda dos lançamentos para a moeda da conta, o mesmo para todos, quando as duas são diferentes. Omitido, vale a última cotação; enviado com a conta na moeda dos lançamentos, é ignorado.

Responses

Request samples

Content type
application/json
Example

Duas contas pagas em dinheiro na conta caixa, cada uma pelo valor final.

{
  • "bill_ids": [
    ],
  • "settlement_date": "2026-10-14",
  • "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
  • "payment_method_id": "fc9f5c65-71b2-4bab-ba56-aee44fe6d998"
}

Response samples

Content type
application/json

Resposta para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa dos lançamentos: traz só o id de cada um.

{
  • "data": [
    ]
}

Restaurar conta a pagar ou receber excluída Beta

Restaura um lançamento excluído, como o Restaurar do Monde: a exclusão é lógica, e o lançamento volta às consultas como estava antes de ser excluído, com as categorias, os rateios e os anexos. A liquidação que saiu junto na exclusão não volta: o lançamento restaurado fica em aberto, e para liquidá-lo de novo use Liquidar conta a pagar ou receber. O boleto que ficou aguardando a baixa no banco por causa da exclusão volta a registrado, exceto na conta de cobrança de fintech, em que a baixa já foi pedida ao banco. A restauração fica no log do lançamento, em nome da credencial.

Que lançamentos. Só o lançamento avulso (normal), como no Monde. Respondem 409, com o motivo: o lançamento que não está excluído, o gerado por uma venda (que é restaurado pela venda), a fatura de cliente e de fornecedor, a comissão e os demais tipos. Os lançamentos seguintes de uma série apagados pelo "excluir este e próximos" não existem mais e não voltam.

Exige as permissões "Restaurar" e "Editar" de contas a pagar e receber, na empresa do lançamento, que não pode estar somente leitura. A credencial restaura o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. Não exige Idempotency-Key nem corpo: repetir a requisição depois de restaurado responde 409. A resposta traz o lançamento restaurado, igual a Consultar conta a pagar ou receber por ID, quando a credencial tem a permissão "Visualizar" de contas a pagar e receber na empresa dele; sem essa permissão, traz apenas o id. Vale também para o lançamento que a própria credencial criou.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

Identificador único da conta a pagar ou receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de detalhe de uma fatura de cliente, com categorias, movimentações, rateios, itens, anexos e campos personalizados.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
  • "number": "12345",
  • "transaction_kind": "credit",
  • "kind": "customer_invoice",
  • "description": "Fatura cliente - Janeiro/2026",
  • "document": "NF 1001",
  • "invoice_number": 42,
  • "amount": 1500,
  • "final_amount": 1500,
  • "issue_date": "2026-01-10",
  • "due_date": "2026-02-10",
  • "settlement_date": null,
  • "created_at": "2026-01-10T13:45:36",
  • "canceled": false,
  • "checked": false,
  • "invoice_closed": false,
  • "system_generated": false,
  • "generates_credit": false,
  • "periodicity": "without_periodicity",
  • "recurrence_kind": "non_recurrent",
  • "recurrence_group_id": null,
  • "observations": null,
  • "billet": {
    },
  • "check": null,
  • "card": null,
  • "sale": null,
  • "person": {
    },
  • "company": {
    },
  • "account": {
    },
  • "payment_method": {
    },
  • "operation": null,
  • "invoice_rule": {
    },
  • "created_by": {
    },
  • "movements": [
    ],
  • "apportionments": {
    },
  • "custom_fields": [
    ],
  • "attachments": [],
  • "categories": [
    ],
  • "commissions": [ ],
  • "items": [
    ],
  • "credit_card_items": [ ]
}

Gerar boleto de conta a receber Beta

Gera o boleto da conta a receber, como o Imprimir Boleto do Monde: o boleto que ainda não foi emitido é numerado e emitido, com a linha digitável e o código de barras, e o já emitido é devolvido de novo, com o mesmo número. O boleto registrado pelo PJBank é devolvido com o Pix copia e cola; enquanto ele está a caminho do banco, a resposta é 422, e é preciso esperar o registro. Para o PDF, use Baixar o PDF do boleto.

Conta de cobrança. O boleto sai pela conta de cobrança do lançamento, gravada em billing_account_id na inclusão ou na edição. Sem ela, vale a única conta de cobrança da empresa que emite sem registro; com mais de uma, a resposta é 422 com os ids delas, e a escolhida vai em billing_account_id, como o Monde pergunta. A escolhida fica gravada no lançamento.

Moeda estrangeira. O boleto sai em reais. No lançamento em outra moeda, envie o câmbio da emissão em exchange_rate: sem ele, a resposta é 422, como o Monde pergunta o câmbio.

Fatura de cliente aberta. O boleto cobra o que a fatura tem, e o Monde só o emite com a fatura fechada: ele pergunta se fecha a fatura. Pela API, a fatura de cliente aberta responde 409 até o pedido trazer close_invoice como true, que fecha a fatura e emite o boleto, com as regras e a permissão "Fechar Fatura" de Fechar fatura de cliente.

As recusas do Monde respondem 422 com a mensagem dele: a conta a pagar, a liquidada e a situação da cobrança que não permite emitir. O lançamento excluído responde 409.

Exige a permissão "Imprimir boleto" de vendas na empresa do lançamento e, no boleto que ainda não foi emitido, também "Gerar boletos" de contas a pagar e receber, com a empresa liberada para gravação, como no Monde. O alcance é o da consulta do lançamento.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da conta a receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
optional
billing_account_id
string <uuid>

Conta de cobrança do boleto, pelo id de billing_accounts em GET /accounts/{id}. Só é usada quando o lançamento não tem conta de cobrança e a empresa tem mais de uma que emite sem registro.

exchange_rate
number <double>

Câmbio da emissão, maior que zero, no lançamento em moeda estrangeira: o boleto sai em reais.

close_invoice
boolean

Confirma o fechamento da fatura de cliente aberta, para gerar o boleto dela. Sem ela, a fatura aberta responde 409.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "bill": {
    },
  • "number": 15838,
  • "our_number": "109/00015838-6",
  • "digitable_line": "34191.09008 01583.861412 04640.150005 7 16540000014935",
  • "barcode": "34197165400000149351090015838614120464015000",
  • "amount": 149.35,
  • "due_date": "2026-11-20",
  • "pix_code": null,
  • "bank": {
    }
}

Baixar o PDF do boleto Beta

Devolve o PDF do boleto já gerado, o mesmo que o Monde envia por e-mail: o recibo do pagador e a ficha de compensação, com o código de barras e, no PJBank, o QR do Pix. No lançamento em moeda estrangeira, o boleto sai com o câmbio da última geração.

O boleto que ainda não foi gerado responde 409: gere-o antes em Gerar boleto de conta a receber. A situação da cobrança que o Monde não imprime responde 422.

Exige a permissão "Imprimir boleto" de vendas na empresa do lançamento, com o alcance da consulta do lançamento.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da conta a receber.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Fechar fatura de cliente Beta

Fecha a fatura de cliente, como o Fechar Fatura do Monde: a fatura fechada não aceita alteração nos itens, para poder ser enviada ao cliente. O primeiro fechamento numera a fatura e marca a data em que ela foi faturada; a fatura que nunca tinha sido faturada passa a ter a emissão no dia do fechamento. Fechar de novo depois de reabrir mantém o número.

Só a fatura de cliente é fechada. Respondem 409, com o motivo: o lançamento excluído, o que não é fatura de cliente e a fatura já fechada. Respondem 422, como no Monde: a emissão anterior à venda mais antiga dos itens e o item que ainda aguarda exclusão.

Exige a permissão "Fechar Fatura" de contas a pagar e receber na empresa da fatura, que não pode estar somente leitura. Não exige "Editar": como no Monde, basta a credencial alcançar a fatura, com o mesmo alcance da consulta. A resposta traz a fatura fechada, ou só o id dela para a credencial que não tem a permissão "Visualizar".

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Responses

Response samples

Content type
application/json

Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}

Reabrir fatura de cliente Beta

Reabre a fatura de cliente fechada, como o Reabrir Fatura do Monde, para que os itens voltem a ser alterados. O número da fatura fica. Se a fatura já foi enviada ao cliente, considere fazer as alterações na próxima fatura.

Respondem 409, com o motivo: o lançamento excluído, o que não é fatura de cliente e a fatura que não está fechada. O item que ainda aguarda exclusão impede reabrir, com 422, como no Monde.

Exige a permissão "Reabrir Fatura" de contas a pagar e receber na empresa da fatura, que não pode estar somente leitura, com o mesmo alcance de Fechar fatura de cliente. Não exige Idempotency-Key nem corpo: repetir a requisição depois de reaberta responde 409.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Alterar conferido ou centro de custo de item da fatura Beta

Altera as duas colunas que o Monde edita na grade dos itens da fatura. checked marca ou desmarca o item como conferido, e vale na fatura de fornecedor gerada pelo Monde e no avulso de fornecedor. cost_center troca o centro de custo do item, e vale na fatura de cliente gerada pelo Monde, fora da base de operadora, que não mostra a coluna. Com pagante pessoa jurídica, o centro de custo precisa ser um dos cadastrados nele (a comparação ignora maiúsculas e espaços nas pontas, e o item fica com o nome como está no cadastro), a não ser que a agência use o centro de custo em texto livre; null limpa o centro de custo. O item que fica igual a outro da fatura é somado a ele, como no Monde.

Item somado a outro. Dois itens da fatura são iguais quando têm o mesmo produto de venda, lado, tipo e centro de custo. O item que fica igual a outro é somado a ele e deixa de existir, e o id dele passa a responder 404. Isso acontece na troca do centro de custo, em que some o item alterado e fica o outro, e quando o item entra em outra fatura, em que some o item que entrou e fica o que já estava lá. O reembolso não é somado. Depois de cada ação sobre os itens, os id que valem são os de items da resposta; para reencontrar a linha, use sale_product, side, kind e cost_center. A repetição com a mesma Idempotency-Key devolve a resposta original, com os id daquele momento: para os de agora, consulte a fatura em Consultar conta a pagar ou receber por ID.

Que faturas. As ações sobre os itens valem na fatura de cliente, na fatura de fornecedor e no avulso de fornecedor, exceto na fatura de fornecedor da CVC. Respondem 409, com o motivo: o lançamento excluído, o que não é uma dessas faturas, a fatura liquidada, a fatura fechada e o campo que não vale naquela fatura. O Monde pergunta se desfaz a liquidação ou reabre a fatura e repete a operação; pela API, desfaça a liquidação em Desfazer a liquidação de conta a pagar ou receber ou reabra a fatura em Reabrir fatura de cliente antes de repetir.

Exige a permissão "Editar" de contas a pagar e receber na empresa da fatura, com o mesmo alcance da edição do lançamento. O item que não é da fatura responde 404. A resposta traz a fatura como ficou, igual a Consultar conta a pagar ou receber por ID, ou só o id dela para a credencial que não tem a permissão "Visualizar".

Authorizations:
bearerAuthentication
path Parameters
bill_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

id
required
string <uuid>
Example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30

ID do item da fatura, o id de cada item de items em Consultar conta a pagar ou receber por ID.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
checked
boolean

Marca o item como conferido (true) ou não (false).

cost_center
string or null <= 50 characters

Centro de custo do item. null limpa o centro de custo.

Responses

Request samples

Content type
application/json
{
  • "checked": true
}

Response samples

Content type
application/json

Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}

Corrigir valores de item da fatura Beta

Corrige os valores de um item, como o Corrigir valores do Monde. Vale na fatura de cliente e na de fornecedor geradas pelo Monde, no item ligado a um produto de venda. value é o valor novo do item, com o sinal dele, e a diferença vai para a próxima fatura. Na fatura de fornecedor, a comissão, o over e as taxas de cartão (cc_du_fee e cc_rav_fee) mudam no produto da venda, e o item da fatura acompanha; a comissão e o over aceitam o percentual ou o valor, e o outro é calculado sobre a base do produto. Na fatura de cliente, só value. O campo omitido fica como está. O item corrigido continua com o mesmo id; a diferença é um item novo na próxima fatura, onde pode ser somada a um item igual.

Mudar value pede a fatura em aberto: a liquidada e a fechada respondem 409. A comissão, o over e as taxas mudam mesmo com a fatura fechada, e o acerto vai para outra fatura do fornecedor. A taxa de cartão maior que a taxa do produto responde 422, como no Monde.

Exige as permissões "Editar" e "Alterar taxa CC" de contas a pagar e receber, na empresa da fatura. Quando a correção muda de fato a comissão, o over ou as taxas do produto de uma venda fechada, exige também "Alterar dados do produto em vendas fechadas" de vendas; e, na venda com recibo impresso, "Alterar vendas com recibo impresso". Sem elas, a resposta é 403 com a mensagem do Monde.

Authorizations:
bearerAuthentication
path Parameters
bill_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

id
required
string <uuid>
Example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30

ID do item da fatura, o id de cada item de items em Consultar conta a pagar ou receber por ID.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
value
number <double>

Valor novo do item, com o sinal dele. A diferença vai para a próxima fatura.

commission_percentage
number <double>

Percentual de comissão do produto da venda. Só na fatura de fornecedor.

commission_amount
number <double>

Valor da comissão do produto da venda. Só na fatura de fornecedor.

over_percentage
number <double>

Percentual de over do produto da venda. Só na fatura de fornecedor.

over_amount
number <double>

Valor do over do produto da venda. Só na fatura de fornecedor.

cc_du_fee
number <double>

Taxa CC DU do produto da venda, que não pode passar da taxa DU. Só na fatura de fornecedor de passagem aérea.

cc_rav_fee
number <double>

Taxa CC RAV do produto da venda, que não pode passar da taxa RAV. Só na fatura de fornecedor.

Responses

Request samples

Content type
application/json
{
  • "commission_amount": 20
}

Response samples

Content type
application/json

Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}

Adicionar itens à fatura Beta

Traz para a fatura itens de outra fatura em aberto, como o Adicionar itens à fatura do Monde. Os itens que podem entrar são os que Itens que podem entrar na fatura lista: da mesma pessoa, empresa e moeda, de fatura que não está liquidada nem fechada. A fatura de cliente recebe itens de outra fatura de cliente; a fatura de fornecedor e o avulso de fornecedor, da fatura de fornecedor gerada pelo Monde e do avulso de fornecedor. O id que não pode entrar recusa a chamada inteira com 422, e nada é movido. A fatura de onde o item sai, se ficar sem itens, é excluída. O item que entra igual a um item da fatura é somado a ele: o id enviado deixa de existir, e a resposta traz o item que já estava, com a soma. Veja Item somado a outro em Alterar conferido ou centro de custo de item da fatura.

Valem as mesmas faturas e recusas de Alterar conferido ou centro de custo de item da fatura, e a mesma permissão "Editar". A resposta traz a fatura como ficou.

Authorizations:
bearerAuthentication
path Parameters
bill_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
item_ids
required
Array of strings <uuid> non-empty [ items <uuid > ]

IDs dos itens em que a ação age.

Responses

Request samples

Content type
application/json
{
  • "item_ids": [
    ]
}

Response samples

Content type
application/json

Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}

Consultar itens das faturas Beta

Lista os itens das faturas e das contas a pagar e receber, um por linha, com a venda de origem e o lançamento em que cada um está: é a composição de cada pagamento. Com date_field=settlement_date e o período, vêm os itens de tudo o que foi liquidado no mês, sem abrir fatura por fatura.

O amount tem o sinal que o Monde grava, e os itens de um lançamento somam o valor dele, negativo na conta a pagar. Numa fatura de fornecedor, o que é pago ao fornecedor sai negativo e o que é recebido do cliente, positivo. A soma fecha com o valor do lançamento, não com o valor final da baixa.

Os itens do mesmo lançamento vêm juntos, da liquidação mais recente para a mais antiga, e os de lançamento em aberto vêm no fim. O item de lançamento excluído e o que ainda não está em lançamento ficam de fora.

Exige a permissão "Visualizar" de contas a pagar e receber e alcança os mesmos lançamentos de Consultar contas a pagar e receber.

Authorizations:
bearerAuthentication
query Parameters
bill_id
string <uuid>
Example: bill_id=212b54b8-27df-4859-80a9-79ad855bcd09

ID do lançamento: só os itens dele. É o bill da movimentação em Consultar movimentação por ID.

account_id
string <uuid>
Example: account_id=6e0216e5-5536-4f4b-8c93-36371398b3cf

ID da conta do lançamento: só os itens dos lançamentos dela.

person_id
string <uuid>
Example: person_id=7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a

ID da pessoa do item.

side
string
Enum: "vendor" "customer"
Example: side=vendor

Lado do item: customer (do cliente) ou vendor (do fornecedor).

date_field
string
Enum: "settlement_date" "due_date" "issue_date"
Example: date_field=settlement_date

Data do período: settlement_date (liquidação do lançamento), due_date (vencimento do lançamento) ou issue_date (emissão do item). Obrigatório com date_from ou date_to.

date_from
string <date>
Example: date_from=2026-10-01

Início do período, inclusive (AAAA-MM-DD).

date_to
string <date>
Example: date_to=2026-10-31

Fim do período, inclusive (AAAA-MM-DD).

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Itens que podem entrar na fatura Beta

Lista os itens que Adicionar itens à fatura aceita, com a fatura em que cada um está e o vencimento dela, do vencimento mais antigo ao mais novo. Só entram as faturas que a credencial alcança. q busca, como no Monde, pelo número da fatura e da venda, pelo documento do produto, pela descrição do item, pelo fornecedor, pelo valor e pelas datas da venda e do vencimento.

Exige a permissão "Editar" de contas a pagar e receber na empresa da fatura. O lançamento excluído e o que não é fatura com itens respondem 409.

Authorizations:
bearerAuthentication
path Parameters
bill_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

query Parameters
q
string
Example: q=Hospedagem

Texto a buscar nos itens.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Remover itens da fatura ou recalcular o vencimento Beta

Manda cada item para a fatura que a regra de faturamento dele aponta, como o Monde faz em duas ações com o mesmo motor. Na fatura de cliente lançada à mão é o Remover itens da fatura: o item sai dela e vai para a fatura gerada pelo Monde. Na fatura gerada pelo Monde é o Recalcular vencimento dos itens selecionados: o item muda de fatura se a regra mudou depois do faturamento. Nas demais faturas, responde 409. O id que não é desta fatura recusa a chamada inteira com 422.

Valem as mesmas recusas de Alterar conferido ou centro de custo de item da fatura. Exige a permissão "Editar" de contas a pagar e receber, também no Recalcular vencimento, que o Monde não cobra. A resposta traz a fatura como ficou e, em reprocessed_items, onde cada item enviado ficou: a fatura (bill) e o item nela (item). O item é o próprio item ou, quando a fatura de destino já tinha um item igual, o item a que ele foi somado; o item que a regra mantém na fatura aparece com a própria fatura. A fatura que fica sem itens é excluída, e a resposta traz só reprocessed_items.

Authorizations:
bearerAuthentication
path Parameters
bill_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
item_ids
required
Array of strings <uuid> non-empty [ items <uuid > ]

IDs dos itens em que a ação age.

Responses

Request samples

Content type
application/json
{
  • "item_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "reprocessed_items": [
    ]
}

Faturar avulso os itens da fatura Beta

Leva os itens para uma fatura avulsa nova, lançada à mão, como o Faturar Avulso do Monde: avulso de fornecedor quando os itens são de fornecedor, e fatura de cliente quando são de cliente. O vencimento é o de due_date ou, sem ele, hoje, como no Monde. O item sem valor fica na fatura; sem nenhum item com valor, a resposta é 422. O id que não é desta fatura recusa a chamada inteira com 422. A fatura de onde os itens saem, se ficar sem itens, é excluída. Os itens continuam com o mesmo id na fatura nova.

Valem as mesmas faturas e recusas de Alterar conferido ou centro de custo de item da fatura, e a mesma permissão "Editar". A resposta é 201 com a fatura nova, ou só o id dela para a credencial que não tem a permissão "Visualizar".

Authorizations:
bearerAuthentication
path Parameters
bill_id
required
string <uuid>
Example: 212b54b8-27df-4859-80a9-79ad855bcd09

ID da fatura.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
item_ids
required
Array of strings <uuid> non-empty [ items <uuid > ]

IDs dos itens em que a ação age.

due_date
string <date>

Vencimento da fatura avulsa. Sem ele, vence hoje.

Responses

Request samples

Content type
application/json
{
  • "item_ids": [
    ]
}

Response samples

Content type
application/json

Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.

{
  • "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}

Movimentações

Consulte as movimentações das contas e caixas: data, valor, sentido, dados de cheque e de cartão, e as referências para a conta, a forma de pagamento e o lançamento liquidado.

Consultar movimentações Beta

Retorna as movimentações das contas das empresas em que a credencial tem permissão. Cada movimentação vem resumida, só com os dados do próprio movimento; as referências para conta, forma de pagamento, conta a pagar ou receber liquidada, fatura de cartão e conta do outro lado da transferência vêm em GET /account_movements/{id}.

Authorizations:
bearerAuthentication
query Parameters
account_id
string <uuid>
Example: account_id=f9d961b8-ea88-4346-8e52-afe94267417a

Filtra as movimentações de uma conta específica.

payment_method_id
string <uuid>
Example: payment_method_id=c3b7e8eb-1199-4457-9170-923c3fe56c92

Filtra as movimentações de uma forma de pagamento específica.

transaction_kind
string
Enum: "credit" "debit"
Example: transaction_kind=debit

Filtra pelo sentido do movimento.

  • credit: entrada de dinheiro na conta.
  • debit: saída de dinheiro da conta.
date_field
string
Value: "movement_date"
Example: date_field=movement_date

Campo de data usado no filtro. Valor aceito: movement_date (data da movimentação). Obrigatório quando date_from ou date_to é informado.

date_from
string <date>
Example: date_from=2026-10-01

Filtrar movimentações com data igual ou posterior a esta, no formato ISO 8601 (AAAA-MM-DD).

date_to
string <date>
Example: date_to=2026-10-31

Filtrar movimentações com data igual ou anterior a esta, no formato ISO 8601 (AAAA-MM-DD).

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta com uma liquidação em cartão e uma transferência entre contas.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar movimentação por ID Beta

Retorna o detalhe completo de uma movimentação pelo identificador, com as referências para conta, forma de pagamento, conta a pagar ou receber liquidada, fatura de cartão e conta do outro lado da transferência. É o endpoint que resolve as referências a movimentações devolvidas por outros recursos, como as liquidações de uma conta a pagar ou a receber.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42

Identificador da movimentação.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de movimentação que liquida uma conta a pagar em cartão de crédito.

{
  • "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
  • "date": "2026-01-26",
  • "amount": -9112.17,
  • "transaction_kind": "debit",
  • "description": null,
  • "check": null,
  • "card": {
    },
  • "account": {
    },
  • "payment_method": {
    },
  • "bill": {
    },
  • "credit_card_invoice": null,
  • "counterpart_account": null
}

Extrato e Caixa

Saldo, extrato e fechamento de caixa de uma conta corrente ou caixa, como na tela Extrato de Conta do Monde. Conta de outro tipo (cartão de crédito, cheques, investimento) responde 404. O saldo e o extrato são do recurso Saldo e Extrato, separado da leitura de Contas e Cartões, com a permissão Extrato de Conta, como no Monde. Fechar e reabrir o caixa pedem as permissões Fechar Caixa e Reabrir Caixa do recurso Contas e Cartões, uma para cada ação, como no Monde. Pela conexão automática, ler o saldo e o extrato e fechar e reabrir o caixa são exceção concedida pelo Monde na aprovação: o extrato traz todas as movimentações da conta e o fechamento vale para a conta inteira, inclusive para o que a agência lançou. Basta que uma das empresas da conta conceda a permissão. O fechamento é uma marca d'água: fechar um dia fecha todos até ele, e com o caixa fechado o Monde recusa incluir, alterar ou excluir movimentação naqueles dias.

Consultar saldo da conta Beta

Saldo da conta ao fim do dia informado: o saldo inicial da conta mais todas as movimentações até a data, inclusive. É o mesmo saldo com que o extrato fecha aquele dia.

Authorizations:
bearerAuthentication
path Parameters
account_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

ID da conta corrente ou caixa, o mesmo de Contas e Cartões.

query Parameters
date
string <date>
Example: date=2026-10-15

Data do saldo (ISO 8601, YYYY-MM-DD). Padrão: hoje.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "account": {
    },
  • "date": "2026-10-15",
  • "currency": "BRL",
  • "balance": 1849.75,
  • "cash_closed_until": "2026-10-10"
}

Consultar extrato da conta Beta

Extrato da conta no período, linha a linha como no Monde: o saldo anterior, as movimentações de cada dia (lançamentos e transferências, na ordem em que foram gravadas) e o saldo ao fim de cada dia que teve movimentação, com a indicação de caixa fechado. Não pagina: o período tem no máximo 45 dias. Como traz nome e documento das pessoas, cada consulta fica registrada no Histórico como uma exportação do Extrato de Conta.

Authorizations:
bearerAuthentication
path Parameters
account_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

ID da conta corrente ou caixa, o mesmo de Contas e Cartões.

query Parameters
date_from
required
string <date>
Example: date_from=2026-10-01

Primeiro dia do extrato (ISO 8601, YYYY-MM-DD). Obrigatório.

date_to
required
string <date>
Example: date_to=2026-10-15

Último dia do extrato (ISO 8601, YYYY-MM-DD). Obrigatório; o período tem no máximo 45 dias, como no Monde.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "account": {
    },
  • "currency": "BRL",
  • "date_from": "2026-10-01",
  • "date_to": "2026-10-15",
  • "cash_closed_until": "2026-10-10",
  • "opening_balance": 2000,
  • "closing_balance": 1849.75,
  • "data": [
    ]
}

Fechar caixa Beta

Fecha o caixa da conta até o dia informado, com as regras do Monde: não fecha dia futuro nem dia já fechado (para isso, reabra antes). Quando expected_balance vem, o fechamento é recusado se o saldo do dia mudou desde a leitura, como a conferência da tela. Só conta corrente ou caixa ativa; a empresa somente leitura não fecha. O fechamento fica no log da conta com a credencial. Exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
account_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

ID da conta corrente ou caixa, o mesmo de Contas e Cartões.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
date
required
string <date>

Dia até o qual o caixa fica fechado (ISO 8601, YYYY-MM-DD). Não pode ser futuro nem anterior ao fechamento atual.

expected_balance
number <double>

Saldo do dia conferido pelo integrador (o balance de Consultar saldo da conta na mesma data). Quando vem e o saldo mudou, o fechamento é recusado com 422.

Responses

Request samples

Content type
application/json
{
  • "date": "2026-10-15",
  • "expected_balance": 1849.75
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "cash_closed_until": "2026-10-15"
}

Reabrir caixa Beta

Reabre o caixa a partir do dia informado: ele e os dias seguintes voltam a aceitar movimentação. Só recua o fechamento; reabrir um dia que já está aberto responde 422. A reabertura fica no log da conta com a credencial. Não exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
account_id
required
string <uuid>
Example: f9d961b8-ea88-4346-8e52-afe94267417a

ID da conta corrente ou caixa, o mesmo de Contas e Cartões.

date
required
string <date>
Example: 2026-10-10

Dia a reabrir (ISO 8601, YYYY-MM-DD). O caixa volta a ficar aberto nele e nos dias seguintes.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Transferências entre Contas

Consulte, crie, altere e exclua as transferências entre as contas da agência, como na tela de Transferência do Monde. Uma transferência são duas movimentações irmãs: a saída na conta de origem (forma de pagamento Débito em conta) e a entrada na conta de destino (Depósito bancário). As duas aparecem também em Movimentações e no extrato. Só transferem contas corrente ou caixa ativas, e as duas contas precisam estar em empresas em que a credencial tem a permissão: alcançar uma das contas não basta. O caixa fechado na data recusa a gravação, a alteração e a exclusão, como no Monde. Permissões do recurso Transferências entre Contas, as do Monde: Transferência entre Contas (consultar), Editar (inserir e alterar), Excluir e Visualizar Log, que mostra o histórico das transferências em Logs (origem conta_movimento). Pela conexão automática, consultar, editar, excluir e ver o log são exceção concedida pelo Monde na aprovação: a transferência não guarda quem a lançou, então quem a lê ou grava alcança também as que a agência lançou.

Listar transferências Beta

Lista as transferências cujas duas contas estão em empresas em que a credencial pode ler transferências, da mais recente para a mais antiga. Cada transferência aparece uma vez, pela movimentação de origem.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

account_id
string <uuid>
Example: account_id=f9d961b8-ea88-4346-8e52-afe94267417a

Filtra as transferências que saem ou entram nesta conta (UUID).

date_from
string <date>
Example: date_from=2026-10-01

Data inicial da transferência (ISO 8601, YYYY-MM-DD).

date_to
string <date>
Example: date_to=2026-10-31

Data final da transferência (ISO 8601, YYYY-MM-DD).

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir transferência Beta

Cria a transferência com as regras da tela do Monde: contas corrente ou caixa ativas, diferentes entre si, valor maior que zero e descrição de até 100 caracteres. As duas contas precisam estar em empresas em que a credencial insere e edita transferências, fora das empresas somente leitura. A inclusão fica no log com a credencial. A resposta traz a transferência só para quem também pode lê-la; aos demais, só o id. Exige Idempotency-Key.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
date
required
string <date>

Data da transferência (ISO 8601, YYYY-MM-DD).

origin_account_id
required
string <uuid>

Conta de onde o valor sai: o id de uma conta corrente ou caixa ativa de Contas e Cartões.

destination_account_id
required
string <uuid>

Conta onde o valor entra: o id de uma conta corrente ou caixa ativa, diferente da de origem.

amount
required
number <double>

Valor a transferir, maior que zero e com até 2 casas decimais.

description
string or null <= 100 characters

Descrição da transferência, com até 100 caracteres.

Responses

Request samples

Content type
application/json
{
  • "date": "2026-10-15",
  • "origin_account_id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853",
  • "destination_account_id": "6e0216e5-5536-4f4b-8c93-36371398b3cf",
  • "amount": 150.25,
  • "description": "Sangria do caixa"
}

Response samples

Content type
application/json
{
  • "id": "857569b5-2721-4756-a27a-748168e00606",
  • "date": "2026-10-15",
  • "amount": 150.25,
  • "description": "Sangria do caixa",
  • "origin_account": {
    },
  • "destination_account": {
    },
  • "origin_movement": {
    },
  • "destination_movement": {
    }
}

Consultar transferência Beta

Devolve a transferência. Ela pode ser aberta pelo ID de qualquer das duas movimentações, e responde sempre pela de origem.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 857569b5-2721-4756-a27a-748168e00606

ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "id": "857569b5-2721-4756-a27a-748168e00606",
  • "date": "2026-10-15",
  • "amount": 150.25,
  • "description": "Sangria do caixa",
  • "origin_account": {
    },
  • "destination_account": {
    },
  • "origin_movement": {
    },
  • "destination_movement": {
    }
}

Alterar transferência Beta

Altera só os campos enviados; o omitido fica como está, e a description enviada nula é apagada. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). As contas continuam conferidas mesmo quando não vêm no corpo: a transferência cuja conta deixou de ser corrente ou caixa ativa só é gravada escolhendo outra. Quando uma das movimentações está na conciliação bancária, mudar a data, o valor ou a conta dela desfaz a conciliação, e essa alteração pede undo_bank_reconciliation como true, como o aviso do Monde: sem ela, a resposta é 409. Mudar só a descrição mantém a conciliação e grava sem a confirmação. A alteração fica no log com a credencial. A resposta traz a transferência só para quem também pode lê-la; aos demais, só o id. Exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 857569b5-2721-4756-a27a-748168e00606

ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
date
string <date>

Data da transferência (ISO 8601, YYYY-MM-DD).

origin_account_id
string <uuid>

Conta de onde o valor sai: o id de uma conta corrente ou caixa ativa de Contas e Cartões.

destination_account_id
string <uuid>

Conta onde o valor entra: o id de uma conta corrente ou caixa ativa, diferente da de origem.

amount
number <double>

Valor a transferir, maior que zero e com até 2 casas decimais.

description
string or null <= 100 characters

Descrição da transferência, com até 100 caracteres.

undo_bank_reconciliation
boolean

Confirma que a gravação pode desfazer a conciliação bancária de uma das movimentações. Sem ela, a exclusão da transferência conciliada e a alteração que muda a data, o valor ou a conta da movimentação conciliada respondem 409.

Responses

Request samples

Content type
application/json
{
  • "amount": 200
}

Response samples

Content type
application/json
{
  • "id": "857569b5-2721-4756-a27a-748168e00606",
  • "date": "2026-10-15",
  • "amount": 150.25,
  • "description": "Sangria do caixa",
  • "origin_account": {
    },
  • "destination_account": {
    },
  • "origin_movement": {
    },
  • "destination_movement": {
    }
}

Excluir transferência Beta

Exclui as duas movimentações da transferência, sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. Quando uma das movimentações está na conciliação bancária, a exclusão desfaz a conciliação, e por isso a resposta é 409. Nesse caso, para excluir mesmo assim, use Excluir transferência com confirmação. A exclusão não fica no log, como no Monde. Exige a permissão Excluir de Transferências entre Contas nas empresas das duas contas, que não podem estar somente leitura. Não exige Idempotency-Key: repetir responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 857569b5-2721-4756-a27a-748168e00606

ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Excluir transferência com confirmação Beta

Exclui as duas movimentações da transferência com a confirmação que o Monde pede quando uma delas está na conciliação bancária. É a mesma exclusão de Excluir transferência, com as mesmas regras, permissões e respostas. A diferença é que a confirmação vai no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho. Quando uma das movimentações está na conciliação bancária, a exclusão desfaz a conciliação: sem undo_bank_reconciliation como true, a resposta é 409; com a confirmação, a conciliação é desfeita e precisará ser refeita. O valor que não é booleano responde 422. A exclusão não fica no log, como no Monde. Exige a permissão Excluir de Transferências entre Contas nas empresas das duas contas, que não podem estar somente leitura. Exige Idempotency-Key: sem ela, a resposta é 400. Como a transferência excluída deixa de existir, o reenvio depois da exclusão responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 857569b5-2721-4756-a27a-748168e00606

ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
undo_bank_reconciliation
boolean

Confirma que a gravação pode desfazer a conciliação bancária de uma das movimentações. Sem ela, a exclusão da transferência conciliada e a alteração que muda a data, o valor ou a conta da movimentação conciliada respondem 409.

Responses

Request samples

Content type
application/json
{
  • "undo_bank_reconciliation": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Reembolsos

Consulte, lance e exclua os reembolsos das vendas: lado do reembolso, valor, datas e as referências para a venda, o produto da venda, a pessoa, a empresa e a conta a pagar ou a receber.

Consultar reembolsos Beta

Retorna os reembolsos das empresas em que a credencial tem permissão.

Authorizations:
bearerAuthentication
query Parameters
refund_type
string
Enum: "customer" "vendor"
Example: refund_type=customer

Filtra pelo lado do reembolso.

  • customer: reembolso do cliente.
  • vendor: reembolso do fornecedor ou do representante.
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta com um reembolso de fornecedor e um reembolso de cliente.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar reembolso por ID Beta

Retorna um reembolso pelo identificador. É o endpoint que resolve as referências a reembolsos devolvidas por outros recursos.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42

Identificador do reembolso.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de reembolso de fornecedor, já com conta a pagar ou a receber.

{
  • "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
  • "refund_type": "vendor",
  • "amount": -91.36,
  • "description": "Reembolso Incentivo",
  • "issue_date": "2021-06-16",
  • "due_date": "2021-06-17",
  • "sale": {
    },
  • "sale_product": {
    },
  • "person": {
    },
  • "company": {
    },
  • "bill": {
    }
}

Excluir reembolso Beta

Exclui o reembolso, como a exclusão do reembolso na venda do Monde. O reembolso ainda sem fatura sai sozinho; o que está numa fatura sai dela, e a fatura que fica vazia sai junto. O reembolso do produto e a receita da venda voltam ao que eram.

Responde 409 quando a fatura do reembolso está liquidada ou fechada (reabra-a no Monde antes) ou quando o reembolso está num lançamento que não é fatura. O reembolso ao cliente, que no Monde sai pela grade de pagamentos da venda, só é excluído na venda aberta: na venda fechada, responde 409 (reabra a venda no Monde antes).

O reembolso do fornecedor que já virou conta a pagar/receber o Monde não exclui pela venda: é o que está na conta gerada só para ele (bill no lançamento) ou, com a fatura automática de fornecedor desligada (e nos produtos importados da CVC), o que está em qualquer fatura. No Monde, ele sai excluindo a conta, depois de confirmar. Este DELETE é a exclusão sem confirmação: ele não tem corpo, e o corpo enviado é ignorado. Por isso, esse reembolso responde 409 e nada muda. Para confirmar a exclusão da conta, use Excluir reembolso com confirmação.

No Monde, excluir o reembolso é editar a venda, sem permissão própria: exige a permissão Editar de Vendas na empresa do reembolso, que não pode ser somente leitura, e, na venda que a credencial não criou, Editar vendas de outros vendedores. O reembolso do fornecedor, que no Monde sai pela aba Financeiro da venda, exige também Ver aba financeiro. Na venda com recibo impresso, o reembolso ao cliente e o do fornecedor exigem também Alterar vendas com recibo impresso.

Exige o Idempotency-Key, porque a exclusão muda o financeiro. Como o reembolso excluído deixa de existir, o reenvio com a mesma chave depois da exclusão responde 404, sem excluir nada de novo.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42

Identificador do reembolso.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Excluir reembolso com confirmação Beta

Exclui o reembolso com a confirmação que o Monde pede antes de excluir a conta a pagar/receber em que ele está. É a mesma exclusão de Excluir reembolso, com as mesmas regras, permissões e respostas. A diferença é que a confirmação vai no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho.

O reembolso ainda sem fatura sai sozinho; o que está numa fatura sai dela, e a fatura que fica vazia sai junto. O reembolso do produto e a receita da venda voltam ao que eram. As recusas com 409 do DELETE valem aqui também: a fatura liquidada ou fechada, o lançamento que não é fatura e o reembolso ao cliente na venda fechada.

O reembolso do fornecedor que já virou conta a pagar/receber o Monde não exclui pela venda: é o que está na conta gerada só para ele (bill no lançamento) ou, com a fatura automática de fornecedor desligada (e nos produtos importados da CVC), o que está em qualquer fatura. No Monde, ele sai excluindo a conta, depois de confirmar. Aqui, a confirmação vai em remove_from_bill: sem ela como true, a exclusão responde 409 e nada muda; com ela, a conta inteira é excluída, como no Monde: o reembolso sai, e os outros itens da conta não são apagados, voltam a ficar pendentes, sem fatura (com a fatura automática de fornecedor ligada, voltam para a fatura das regras de faturamento). Exemplo: a fatura de R$ 1.200,00 com este reembolso de R$ 200,00 e outro item de R$ 1.000,00 é excluída; o reembolso some, e o item de R$ 1.000,00 volta a ficar pendente. O que impede excluir a conta no Monde (como a fatura do sistema que ainda tem itens) responde 409, e nada muda.

No Monde, excluir o reembolso é editar a venda, sem permissão própria: exige a permissão Editar de Vendas na empresa do reembolso, que não pode ser somente leitura, e, na venda que a credencial não criou, Editar vendas de outros vendedores. O reembolso do fornecedor, que no Monde sai pela aba Financeiro da venda, exige também Ver aba financeiro. Na venda com recibo impresso, o reembolso ao cliente e o do fornecedor exigem também Alterar vendas com recibo impresso. Excluir com remove_from_bill a conta inteira é, no Monde, excluir o lançamento: exige também Editar e Excluir de Contas a Pagar e Receber sobre essa conta e, na conta de outro usuário, o acesso aos lançamentos dos outros usuários; sem elas, 403.

Exige o Idempotency-Key: sem ela, a resposta é 400. Como o reembolso excluído deixa de existir, o reenvio depois da exclusão responde 404, sem excluir nada de novo.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42

Identificador do reembolso.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
remove_from_bill
boolean

Confirma a exclusão do reembolso do fornecedor que já virou conta a pagar/receber: a conta inteira é excluída, e os outros itens dela voltam a ficar pendentes, sem fatura. Obrigatório como true nesse caso; nos demais, não muda nada. Valor que não é booleano responde 422.

Responses

Request samples

Content type
application/json
{
  • "remove_from_bill": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Lançar reembolso na venda Beta

Lança o reembolso de um produto da venda, como as ações Reembolso Cliente e Reembolso Fornecedor do produto no Monde. O reembolso entra no reembolso do produto e, por ele, na receita da venda.

  • customer: a agência devolve o valor ao cliente. O reembolso é lançado negativo, em nome de person_id (o pagante da venda, quando omitido), na moeda de venda do produto e com vencimento no dia.
  • vendor: o fornecedor devolve o valor à agência (credit, o padrão) ou a agência paga o fornecedor (debit), em nome do representante do produto ou, sem ele, do fornecedor, na moeda de venda do produto (na operadora, na moeda de origem).
Em billing, invoice (Faturar) manda o reembolso para a fatura pelas regras de faturamento, em segundo plano: a do cliente sempre; a do fornecedor só com a fatura automática de fornecedor ligada, e fora dos produtos da CVC. Até lá, bill volta nulo. bill (Gerar conta a pagar/receber) gera na hora uma fatura avulsa só com o reembolso, com vencimento no dia, que volta em bill.

Como no Monde, a venda pode estar aberta ou fechada, mas não excluída (409), e o produto não pode estar excluído. O reembolso ao cliente só existe na agência: na operadora, responde 403. São recusados com 422: o reembolso com o controle de crédito ligado, o reembolso do fornecedor de operação própria e o reembolso sem a categoria padrão de reembolso configurada na empresa.

No Monde, lançar o reembolso é editar a venda, sem permissão própria: exige a permissão Editar de Vendas na empresa da venda, que não pode ser somente leitura, e, na venda que a credencial não criou, Editar vendas de outros vendedores. Na venda com recibo impresso, o reembolso ao cliente e o do fornecedor exigem também Alterar vendas com recibo impresso, porque mudam a receita da venda. A resposta traz o reembolso completo só para quem também tem a permissão de ler reembolsos nessa empresa; para os demais, só o id.
Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63

Identificador da venda do produto reembolsado.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
sale_product_id
required
string <uuid>

Identificador do produto da venda reembolsado, como aparece no produto dentro da venda.

refund_type
required
string
Enum: "customer" "vendor"

Lado do reembolso.

  • customer: a agência devolve o valor ao cliente.
  • vendor: reembolso com o fornecedor ou o representante do produto.
amount
required
number <double> > 0

Valor do reembolso, positivo. O sinal sai de transaction_kind.

transaction_kind
string
Enum: "credit" "debit"

Direção do dinheiro para a agência.

  • credit: a agência recebe. Só no reembolso do fornecedor, e é o padrão dele.
  • debit: a agência paga. É o único aceito no reembolso ao cliente, e o padrão dele.
billing
required
string
Enum: "invoice" "bill"

Como o reembolso é cobrado.

  • invoice: vai para a fatura pelas regras de faturamento (Faturar).
  • bill: gera na hora uma fatura avulsa só com ele (Gerar conta a pagar/receber).
issue_date
string <date>

Data de emissão do reembolso. Quando omitida, é a data do dia.

description
string <= 100 characters

Descrição do reembolso, com até 100 caracteres.

person_id
string <uuid>

Pessoa que recebe o reembolso ao cliente. Quando omitida, é o pagante da venda. Não vale no reembolso do fornecedor. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe.

cost_center
string <= 50 characters

Centro de custo do reembolso ao cliente, só com billing igual a invoice. Para pessoa jurídica com centros de custo cadastrados, precisa ser um deles, salvo quando a agência informa o centro de custo em texto livre.

Responses

Request samples

Content type
application/json
Example

Exemplo de reembolso ao cliente que vai para a fatura do cliente.

{
  • "sale_product_id": "e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148",
  • "refund_type": "customer",
  • "amount": 1208.89,
  • "billing": "invoice",
  • "issue_date": "2022-04-09",
  • "description": "Reembolso devido ao cancelamento da viagem",
  • "person_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}

Response samples

Content type
application/json

Exemplo de reembolso de cliente ainda sem conta a pagar ou a receber.

{
  • "id": "0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40",
  • "refund_type": "customer",
  • "amount": -1208.89,
  • "description": "Reembolso devido ao cancelamento da viagem",
  • "issue_date": "2022-04-09",
  • "due_date": "2022-05-24",
  • "sale": {
    },
  • "sale_product": {
    },
  • "person": {
    },
  • "company": {
    },
  • "bill": null
}

Relatórios

Os relatórios do Monde, com a mesma consulta da tela: a API e o relatório trazem as mesmas linhas, com os mesmos filtros. Cada relatório pede a permissão dele, como no Monde, e alcança só as empresas em que a credencial tem a permissão e que têm licença. As linhas vêm paginadas por cursor. Como os relatórios trazem dados de contato e documentos das pessoas, cada página consultada fica registrada no Histórico como uma exportação do relatório.

Consultar lista de passageiros Beta

Os passageiros dos produtos vendidos, como o relatório Lista de Passageiros do Monde: uma linha por passageiro de cada produto, com os dados de contato, os documentos e o endereço dele, os trechos aéreos com o assento, os detalhes e os valores do produto e as pessoas da venda. É a mesma consulta do relatório, então a API e a tela trazem os mesmos passageiros. Pede a permissão Lista de Passageiros do recurso Lista de Passageiros, como no Monde. Sem a permissão Consultar passageiros de outros vendedores/intermediários, vêm só os passageiros das vendas que a própria integração criou. Pela conexão automática, essa permissão é exceção concedida pelo Monde na aprovação.

Os passageiros vêm em ordem de embarque e, no mesmo dia, pelo passageiro. Fica de fora o produto excluído e, sem include_canceled, o passageiro cancelado. A empresa sem a permissão na credencial ou sem licença não entra. Como no Monde, o aprovador e a operação própria só vêm na agência, e o promotor só na operadora: o campo que não é do tipo da agência não vem na resposta. Como traz contato e documentos dos passageiros, cada página consultada fica registrada no Histórico como uma exportação da Lista de Passageiros.

Authorizations:
bearerAuthentication
query Parameters
date_field
string
Enum: "departure_date" "arrival_date" "sale_date" "canceled_at"
Example: date_field=departure_date

Data que date_from e date_to filtram: departure_date (embarque ou início do produto), arrival_date (chegada ou fim do produto), sale_date (data da venda) ou canceled_at (cancelamento do passageiro). Obrigatório quando vem date_from ou date_to.

date_from
string <date>
Example: date_from=2026-11-01

Primeiro dia do período (ISO 8601, YYYY-MM-DD), inclusive.

date_to
string <date>
Example: date_to=2026-11-30

Último dia do período (ISO 8601, YYYY-MM-DD), inclusive.

status
Array of strings
Items Enum: "opened" "closed" "canceled"
Example: status=opened,closed

Situações da venda, separadas por vírgula: opened, closed e canceled. Padrão: opened,closed, como no Monde.

include_canceled
boolean

Com true, inclui os passageiros cancelados no produto. Padrão: false. O filtro pela data de cancelamento (date_field=canceled_at) já os inclui.

person_id
string <uuid>
Example: person_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só o passageiro desta pessoa.

payer_id
string <uuid>
Example: payer_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas deste pagante.

seller_id
string <uuid>
Example: seller_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas deste vendedor. Junto de intermediary_id, vêm as vendas em que a pessoa é o vendedor ou o intermediário, como no Monde.

intermediary_id
string <uuid>
Example: intermediary_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas deste intermediário. Junto de seller_id, vêm as vendas em que a pessoa é o vendedor ou o intermediário, como no Monde.

requester_id
string <uuid>
Example: requester_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas deste solicitante.

approver_id
string <uuid>
Example: approver_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas deste aprovador.

promoter_id
string <uuid>
Example: promoter_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas deste promotor.

product_id
string <uuid>
Example: product_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só os produtos deste produto do cadastro, inclusive as vendas em que ele é a operação própria, como no Monde.

supplier_id
string <uuid>
Example: supplier_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só os produtos deste fornecedor.

representative_id
string <uuid>
Example: representative_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só os produtos deste representante.

city_id
string <uuid>
Example: city_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só os passageiros que moram nesta cidade, a do cadastro da pessoa.

company_id
Array of strings <uuid> [ items <uuid > ]
Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4

Só as vendas destas empresas, separadas por vírgula.

label_id
Array of strings <uuid> [ items <uuid > ]
Example: label_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4

Só os passageiros com algum destes marcadores, separados por vírgula.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Um passageiro de passagem aérea com conexão numa venda fechada, dentro de uma viagem, com assento marcado só no primeiro trecho.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar vendas por produto Beta

Os produtos vendidos, como o relatório Vendas por Produto do Monde: uma linha por produto, com as pessoas da venda, os detalhes e os valores do produto, os passageiros, as notas fiscais e os trechos aéreos. É a mesma consulta do relatório, então a API e a tela trazem os mesmos produtos. Pede a permissão Vendas por Produto do recurso Vendas por Produto, como no Monde. Sem a permissão Consultar vendas de outros vendedores/intermediários, vêm só os produtos das vendas que a própria integração criou. Pela conexão automática, essa permissão é exceção concedida pelo Monde na aprovação. Sem a permissão Visualizar comissão, over e receitas, o objeto commission não vem.

Os produtos vêm da venda mais recente para a mais antiga e, na mesma data, pelo número da venda. Fica de fora o produto excluído. A empresa sem a permissão na credencial ou sem licença não entra. Como no Monde, com mais de uma moeda (na operadora, ou na agência com multimoedas) não vêm os abatimentos, o Adicional 1, as notas fiscais nem o over sobre, e o promotor só vem nesse caso. O Número Externo e os Adicionais sem título nas Configurações também não vêm. Como traz contato e documento do pagante, cada página consultada fica registrada no Histórico como uma exportação de Vendas por Produto.

Authorizations:
bearerAuthentication
query Parameters
date_field
string
Enum: "sale_date" "departure_date" "arrival_date" "canceled_at"
Example: date_field=sale_date

Data que date_from e date_to filtram, como o "Data de" do Monde: sale_date (data da venda), departure_date (início do produto), arrival_date (fim do produto) ou canceled_at (cancelamento do produto). Obrigatório quando vem date_from ou date_to.

date_from
string <date>
Example: date_from=2026-10-01

Primeiro dia do período (ISO 8601, YYYY-MM-DD), inclusive.

date_to
string <date>
Example: date_to=2026-10-31

Último dia do período (ISO 8601, YYYY-MM-DD), inclusive.

status
Array of strings
Items Enum: "opened" "closed" "canceled"
Example: status=opened,closed

Situações da venda, separadas por vírgula: opened, closed e canceled. Padrão: opened,closed, como no Monde.

product_status
Array of strings
Items Enum: "active" "canceled"
Example: product_status=active

Situações do produto, separadas por vírgula: active e canceled. Padrão: active, como no Monde. Com date_field=canceled_at, vêm as duas, qualquer que seja o valor enviado.

seller_id
string <uuid>
Example: seller_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas deste vendedor.

product_id
string <uuid>
Example: product_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só os produtos vendidos deste produto do cadastro.

supplier_representative_id
string <uuid>
Example: supplier_representative_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só os produtos em que esta pessoa é o fornecedor ou o representante, como o filtro Fornecedor/Representante do Monde.

own_operation_id
string <uuid>
Example: own_operation_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Só as vendas desta operação própria.

company_id
Array of strings <uuid> [ items <uuid > ]
Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4

Só as vendas destas empresas, separadas por vírgula.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Uma passagem aérea com um passageiro, uma nota fiscal e a comissão, numa agência sem multimoedas.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar vendas por vendedor Beta

Os valores das vendas somados por vendedor, como o relatório Vendas por Vendedor do Monde: uma linha por vendedor e empresa, com a quantidade de vendas e de produtos e todas as colunas de valores do relatório. É a mesma consulta do relatório, então a API e a tela somam os mesmos produtos. Quem vende em mais de uma empresa vem numa linha por empresa. Pede a permissão Vendas por Vendedor do recurso Vendas por Vendedor, como no Monde, e não existe na operadora. Sem a permissão Consultar vendas de outros vendedores/intermediários, a soma traz só as vendas que a própria integração criou. Pela conexão automática, essa permissão é exceção concedida pelo Monde na aprovação.

As linhas vêm em ordem alfabética do vendedor. Ficam de fora a venda cancelada e o produto excluído. A empresa sem a permissão na credencial ou sem licença não entra. O período da venda é obrigatório, em date_from e date_to: para somar vários anos, consulte um período de cada vez. Cada página consultada fica registrada no Histórico como uma exportação de Vendas por Vendedor.

Authorizations:
bearerAuthentication
query Parameters
date_field
string
Value: "sale_date"
Example: date_field=sale_date

Data que date_from e date_to filtram. O relatório tem uma só, a da venda (sale_date), então o parâmetro pode ser omitido.

date_from
required
string <date>
Example: date_from=2026-10-01

Primeiro dia do período da venda (ISO 8601, YYYY-MM-DD), inclusive. Obrigatório.

date_to
required
string <date>
Example: date_to=2026-10-31

Último dia do período da venda (ISO 8601, YYYY-MM-DD), inclusive. Obrigatório.

status
Array of strings
Items Enum: "opened" "closed"
Example: status=closed

Situações da venda, separadas por vírgula: opened e closed. Padrão: as duas, como no Monde. A venda cancelada não entra no relatório.

product_status
Array of strings
Items Enum: "active" "canceled"
Example: product_status=active

Situações do produto, separadas por vírgula: active e canceled. Padrão: active, como no Monde.

seller_id
Array of strings <uuid> [ items <uuid > ]
Example: seller_id=7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f

Só estes vendedores, separados por vírgula.

company_id
Array of strings <uuid> [ items <uuid > ]
Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4

Só as vendas destas empresas, separadas por vírgula.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Uma vendedora com doze vendas fechadas no mês, numa empresa.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Extrato CVC

Consulte os recibos e movimentos do extrato CVC: valores, comissões, saldos, datas e as referências para a empresa, o contratante, o vendedor, o intermediário, a venda, o produto da venda, a nota fiscal e quem cadastrou.

Consultar extrato CVC Beta

Retorna os recibos das empresas em que a credencial tem permissão. Recibo excluído não é retornado.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta com um recibo lançado em OPFAX parcial, em que o saldo consolidado do par difere do valor do movimento, e um recibo baixado.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar extrato CVC por ID Beta

Retorna um recibo pelo identificador, incluindo o recibo já excluído, que vem com o campo deleted verdadeiro. É o endpoint que resolve as referências a recibos do extrato CVC devolvidas por outros recursos.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42

Identificador do recibo do extrato CVC.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de recibo baixado, com venda, produto da venda e nota fiscal.

{
  • "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
  • "receipt_number": "89930000112199",
  • "movement_date": "2019-12-26",
  • "sale_date": "2019-12-26T18:00:00",
  • "cancellation_date": null,
  • "boarding_date": "2020-09-01",
  • "return_date": "2020-09-09",
  • "product_name": "Excursões Internacionais",
  • "package_name": "SANTIAGO",
  • "total_payments": 347.89,
  • "total_taxes": 0,
  • "total_discounts": 0,
  • "total_abatement": 0,
  • "calculated_commission": 111.33,
  • "retained_commission": 0,
  • "intermediary_commission": 0,
  • "deposit": 34.78,
  • "opfax": 0,
  • "opfax_balance": 0,
  • "balance": 76.55,
  • "imported": true,
  • "edited": false,
  • "checked": false,
  • "deleted": false,
  • "created_at": "2019-12-30T08:45:48",
  • "movement_kind": {
    },
  • "company": {
    },
  • "contractor": {
    },
  • "seller": {
    },
  • "intermediary": null,
  • "sale": {
    },
  • "sale_product": {
    },
  • "nf": {
    },
  • "created_by": {
    }
}

Master - Extrato CVC

Consulte os recibos do Master - Extrato da CVC, os de "Repasse Master Franqueado". O Master - Extrato existe só na empresa ligada como agência master franqueado, em Configurações › CVC: a empresa sem essa configuração fica fora da consulta, e a consulta por ID nela responde 403. O recibo sai no mesmo formato do Extrato CVC.

Consultar Master - Extrato CVC Beta

Retorna os recibos do Master - Extrato das empresas em que a credencial tem permissão e que estão ligadas como agência master franqueado, da movimentação mais recente para a mais antiga. Recibo excluído não é retornado.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com um recibo importado.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar recibo do Master - Extrato por ID Beta

Retorna um recibo do Master - Extrato pelo identificador, incluindo o recibo já excluído, que vem com o campo deleted verdadeiro. O recibo de outro tipo de movimento responde 404: ele é consultado pelo Extrato CVC.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84

Identificador do recibo do Master - Extrato.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Recibo digitado, sem nota fiscal.

{
  • "id": "4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84",
  • "receipt_number": "0217000001234",
  • "movement_date": "2026-09-10",
  • "sale_date": "2026-09-02T00:00:00",
  • "cancellation_date": null,
  • "boarding_date": null,
  • "return_date": null,
  • "product_name": null,
  • "package_name": null,
  • "total_payments": 4800,
  • "total_taxes": 120,
  • "total_discounts": 0,
  • "total_abatement": 0,
  • "calculated_commission": 480,
  • "retained_commission": 0,
  • "intermediary_commission": 96,
  • "deposit": 0,
  • "opfax": 0,
  • "opfax_balance": 0,
  • "balance": 384,
  • "imported": false,
  • "edited": true,
  • "checked": false,
  • "deleted": false,
  • "created_at": "2026-09-10T14:32:05",
  • "movement_kind": {
    },
  • "company": {
    },
  • "contractor": {
    },
  • "seller": {
    },
  • "intermediary": null,
  • "sale": null,
  • "sale_product": null,
  • "nf": null,
  • "created_by": null
}

Notas Fiscais

Consulte as notas fiscais de serviço: numeração, situação, datas, valores, retenções e tributos, os dados do tomador gravados na nota (com a referência para a cidade dele), os dados da NFS-e e, na consulta por ID, os itens e as referências para pessoa, empresa, produto da venda e venda.

Também é possível inserir, editar e excluir a nota fiscal avulsa e executar as ações sobre ela: emitir a NFS-e, cancelar, informar a emissão feita na prefeitura, ajustar o valor, remover a numeração, criar a cópia para reemissão e baixar o XML. As permissões são as do Monde: gravar e as ações que só mudam a nota pedem Editar, excluir pede Excluir, emitir a NFS-e e cancelar pelo e-Notas pedem Emitir NFS-e, e criar a cópia para reemissão pede Criar cópia para reemissão. As notas fiscais não existem na instalação de operadora (consolidadora): nela, a gravação responde 403.

Consultar notas fiscais Beta

Retorna as notas fiscais das empresas em que a credencial tem permissão. Notas canceladas também são retornadas: o cancelamento aparece na situação. A consulta traz apenas os campos da própria nota; para os itens e as referências, use a consulta por ID.

Authorizations:
bearerAuthentication
query Parameters
status
string
Enum: "unissued" "issued" "processing" "processing_cancellation" "awaiting_processing" "canceled" "awaiting_issue" "awaiting_cancellation"
Example: status=issued

Filtra pela situação da nota fiscal.

  • unissued: não emitida.
  • issued: emitida.
  • processing: nota transmitida, aguardando o retorno.
  • processing_cancellation: cancelamento transmitido, aguardando o retorno.
  • awaiting_processing: nota ainda não transmitida, na fila de emissão.
  • canceled: cancelada.
  • awaiting_issue: aguardando emissão.
  • awaiting_cancellation: aguardando cancelamento.
period_start
string <date>
Example: period_start=2023-01-01

Filtra as notas fiscais emitidas a partir desta data, no formato ISO 8601 (YYYY-MM-DD).

period_end
string <date>
Example: period_end=2023-12-31

Filtra as notas fiscais emitidas até esta data, no formato ISO 8601 (YYYY-MM-DD).

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de resposta com uma nota cancelada e uma nota emitida.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Inserir nota fiscal avulsa Beta

Insere uma nota fiscal avulsa, não emitida, na empresa de company_identifier. O tomador é a pessoa do cadastro (person_id), com os dados e as retenções dela, ou os dados informados em recipient, com as retenções de taxes. Natureza da operação, CFOP, código NBS e alíquotas vêm das configurações de nota fiscal da empresa quando omitidos, e a data de emissão é a de hoje. O valor da nota é a soma dos itens, e os tributos são calculados na gravação. A numeração só vem na emissão.

Cada item pode trazer um local_id, que volta na resposta ao lado do identificador que o item recebeu.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
required
string = 14 characters ^[0-9]{14}$

CNPJ da empresa emitente, apenas dígitos. Obrigatório na inserção. A empresa da nota não muda: na edição, o CNPJ da própria empresa é ignorado, e o de outra responde 422

issue_date
string <date>

Data de emissão da nota fiscal

operation_nature
string <= 30 characters

Natureza da operação declarada na nota fiscal

cfop
string <= 10 characters

Código Fiscal de Operações e Prestações (CFOP) da nota fiscal

nbs_code
string

Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal

observations
string <= 2000 characters

Observações da nota fiscal

person_id
string or null <uuid>

Identificador da pessoa do cadastro que é o tomador. Os dados do tomador e as retenções vêm do cadastro dela

object (nf_recipient_write)

Dados do tomador digitados na nota. Na inserção, vem no lugar de person_id. Na edição de uma nota ligada a uma pessoa do cadastro, o bloco só vale com person_id enviado como null, que é a escolha explícita do tomador digitado, como no Monde; sem isso, ele é ignorado. O campo omitido do bloco permanece como está.

object (nf_taxes_write)

Retenções da nota. Só valem com o tomador em recipient: com person_id, as retenções são as do cadastro da pessoa, e as enviadas são ignoradas.

required
Array of objects (nf_item_write)

Itens da nota fiscal

Responses

Request samples

Content type
application/json
Example

Insere uma nota com os dados do tomador informados, retenção de ISS e dois itens.

{
  • "company_identifier": "62046591000140",
  • "issue_date": "2026-10-16",
  • "operation_nature": "Prestação de Serviço",
  • "nbs_code": "109051200",
  • "observations": "Referente à viagem de outubro",
  • "recipient": {
    },
  • "taxes": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
Example

Nota não emitida, com o local_id de cada item enviado.

{
  • "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
  • "number": null,
  • "series": null,
  • "issue_date": "2026-10-16",
  • "status": "unissued",
  • "operation_nature": "Prestação de Serviço",
  • "cfop": null,
  • "nbs_code": "109051200",
  • "document": null,
  • "manual_emission": false,
  • "amount": 1850,
  • "service_amount": 0,
  • "net_amount": 1850,
  • "approximate_taxes_percentage": 0,
  • "approximate_taxes_amount": 0,
  • "observations": "Referente à viagem de outubro",
  • "cvc_original_data": null,
  • "printed_at": null,
  • "canceled_at": null,
  • "created_at": "2026-10-16T10:12:44",
  • "recipient": {
    },
  • "taxes": {
    },
  • "nfse": {
    },
  • "person": null,
  • "company": {
    },
  • "sale_product": null,
  • "sale": null,
  • "created_by": null,
  • "canceled_by": null,
  • "items": [
    ]
}

Consultar nota fiscal por ID Beta

Retorna uma nota fiscal pelo identificador, com os itens e as referências para as entidades relacionadas. É o endpoint que resolve as referências a notas fiscais devolvidas por outros recursos.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Exemplo de nota fiscal emitida, com um item e as referências para a venda que a originou.

{
  • "id": "5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83",
  • "number": 982677,
  • "series": "1",
  • "issue_date": "2023-01-13",
  • "status": "issued",
  • "operation_nature": "Prestação de Serviço",
  • "cfop": null,
  • "nbs_code": null,
  • "document": null,
  • "manual_emission": false,
  • "amount": 113.48,
  • "service_amount": 2613.82,
  • "net_amount": 113.48,
  • "approximate_taxes_percentage": 0,
  • "approximate_taxes_amount": 0,
  • "observations": null,
  • "cvc_original_data": null,
  • "printed_at": "2023-02-09T17:26:29",
  • "canceled_at": null,
  • "created_at": "2023-02-09T17:16:14",
  • "recipient": {
    },
  • "taxes": {
    },
  • "nfse": {
    },
  • "person": {
    },
  • "company": {
    },
  • "sale_product": {
    },
  • "sale": {
    },
  • "created_by": {
    },
  • "canceled_by": null,
  • "items": [
    ]
}

Editar nota fiscal avulsa Beta

Altera a nota fiscal não emitida; a nota em qualquer outra situação responde 409. O campo omitido permanece como está. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). A lista items, quando enviada, é a lista final: o item com id permanece e muda só o que veio nele, o item sem id é incluído, e o item da nota que não veio é retirado. A empresa da nota não muda.

Como na tela de edição, a gravação recalcula o valor e os tributos, e o tomador do cadastro é atualizado com os dados atuais da pessoa. Para trocar a data de emissão, envie só issue_date.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
issue_date
string <date>

Data de emissão da nota fiscal

operation_nature
string <= 30 characters

Natureza da operação declarada na nota fiscal

cfop
string <= 10 characters

Código Fiscal de Operações e Prestações (CFOP) da nota fiscal

nbs_code
string

Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal

observations
string <= 2000 characters

Observações da nota fiscal

person_id
string or null <uuid>

Identificador da pessoa do cadastro que é o tomador. Os dados do tomador e as retenções vêm do cadastro dela

object (nf_recipient_write)

Dados do tomador digitados na nota. Na inserção, vem no lugar de person_id. Na edição de uma nota ligada a uma pessoa do cadastro, o bloco só vale com person_id enviado como null, que é a escolha explícita do tomador digitado, como no Monde; sem isso, ele é ignorado. O campo omitido do bloco permanece como está.

object (nf_taxes_write)

Retenções da nota. Só valem com o tomador em recipient: com person_id, as retenções são as do cadastro da pessoa, e as enviadas são ignoradas.

Array of objects (nf_item_write)

Itens da nota fiscal

Responses

Request samples

Content type
application/json

Muda a data de emissão, altera o valor de um item, inclui outro e retira os que não vieram.

{
  • "issue_date": "2026-10-20",
  • "items": [
    ]
}

Response samples

Content type
application/json
Example

Nota não emitida, com o local_id de cada item enviado.

{
  • "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
  • "number": null,
  • "series": null,
  • "issue_date": "2026-10-16",
  • "status": "unissued",
  • "operation_nature": "Prestação de Serviço",
  • "cfop": null,
  • "nbs_code": "109051200",
  • "document": null,
  • "manual_emission": false,
  • "amount": 1850,
  • "service_amount": 0,
  • "net_amount": 1850,
  • "approximate_taxes_percentage": 0,
  • "approximate_taxes_amount": 0,
  • "observations": "Referente à viagem de outubro",
  • "cvc_original_data": null,
  • "printed_at": null,
  • "canceled_at": null,
  • "created_at": "2026-10-16T10:12:44",
  • "recipient": {
    },
  • "taxes": {
    },
  • "nfse": {
    },
  • "person": null,
  • "company": {
    },
  • "sale_product": null,
  • "sale": null,
  • "created_by": null,
  • "canceled_by": null,
  • "items": [
    ]
}

Excluir nota fiscal Beta

Exclui a nota fiscal não emitida. A nota emitida não se exclui (409): ela é cancelada pelo endpoint de cancelamento. A nota ligada a um lançamento financeiro também não se exclui (409).

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Emitir NFS-e Beta

Envia a nota não emitida para a emissão da NFS-e pelo e-Notas. A emissão é assíncrona: a resposta 202 traz a nota aguardando emissão (awaiting_issue), e a prefeitura responde depois. Acompanhe pela consulta da nota por ID: ela passa por processing e termina emitida (issued), com o número em nfse.number, ou volta a não emitida (unissued), com o motivo em nfse.errors.

Antes de enviar, a nota limpa os erros anteriores, recebe a alíquota de ISS das configurações, atualiza o tomador do cadastro e recalcula os tributos. A empresa precisa estar configurada no e-Notas, e a nota precisa estar não emitida (409 nos dois casos). A nota com valor negativo não é enviada (422).

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Responses

Response samples

Content type
application/json
Example

A nota enviada ao e-Notas, aguardando a resposta da prefeitura.

{
  • "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
  • "number": null,
  • "series": null,
  • "issue_date": "2026-10-16",
  • "status": "awaiting_issue",
  • "operation_nature": "Prestação de Serviço",
  • "cfop": null,
  • "nbs_code": "109051200",
  • "document": null,
  • "manual_emission": false,
  • "amount": 1850,
  • "service_amount": 0,
  • "net_amount": 1850,
  • "approximate_taxes_percentage": 0,
  • "approximate_taxes_amount": 0,
  • "observations": "Referente à viagem de outubro",
  • "cvc_original_data": null,
  • "printed_at": null,
  • "canceled_at": null,
  • "created_at": "2026-10-16T10:12:44",
  • "recipient": {
    },
  • "taxes": {
    },
  • "nfse": {
    },
  • "person": null,
  • "company": {
    },
  • "sale_product": null,
  • "sale": null,
  • "created_by": null,
  • "canceled_by": null,
  • "items": [
    ]
}

Cancelar nota fiscal Beta

Cancela a nota fiscal emitida; a nota em outra situação responde 409. Quando a empresa emite pelo e-Notas e cancela também na prefeitura, e a nota não foi emitida manualmente, a resposta é 202 e a nota fica aguardando o cancelamento (awaiting_cancellation) até a prefeitura confirmar. Nos demais casos a nota é cancelada só no Monde, na hora (200): cancele-a também na prefeitura.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Responses

Response samples

Content type
application/json

Para quem não pode ler notas fiscais na empresa, a escrita devolve só os identificadores.

{
  • "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
  • "items": [
    ]
}

Informar emissão manual de NFS-e Beta

Registra a NFS-e que a agência emitiu direto no site da prefeitura: a nota não emitida passa a emitida, com o número informado e marcada como emissão manual. Sem número, ela recebe o próximo da série do RPS. Só vale para a nota eletrônica não emitida (409).

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
nfse_number
required
string <= 20 characters

Número da NFS-e gerado pela prefeitura, com até 20 caracteres

Responses

Request samples

Content type
application/json
{
  • "nfse_number": "4521"
}

Response samples

Content type
application/json

Para quem não pode ler notas fiscais na empresa, a escrita devolve só os identificadores.

{
  • "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
  • "items": [
    ]
}

Ajustar valor da nota fiscal Beta

Aumenta ou reduz em percentual o valor de cada item da nota não emitida (409 nas demais), com arredondamento de duas casas. A nota passa a valer a soma dos itens, e os tributos são recalculados. Se o valor ficar negativo, a nota é gravada com o erro em nfse.errors.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
percentage
required
number <double>

Percentual do ajuste, diferente de zero: positivo aumenta o valor, negativo reduz (ex.: -10 reduz 10%)

Responses

Request samples

Content type
application/json

Reduz em 10% o valor de cada item da nota.

{
  • "percentage": -10
}

Response samples

Content type
application/json

Para quem não pode ler notas fiscais na empresa, a escrita devolve só os identificadores.

{
  • "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
  • "items": [
    ]
}

Remover numeração da nota fiscal Beta

Remove o número e a série da nota não emitida (409 nas demais), para ela voltar a ser numerada na emissão. Repetir a remoção não muda nada, por isso este endpoint não pede Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Criar cópia para reemissão Beta

Cria uma nota nova, não emitida, a partir da nota cancelada (409 nas demais), para reemiti-la. A cópia leva a data de emissão, o tomador e os itens da original, com as configurações de nota fiscal atuais da empresa; a pessoa do cadastro e as retenções não vêm junto, e os tributos são recalculados. A resposta traz a cópia.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Responses

Response samples

Content type
application/json
Example

Nota não emitida, com o local_id de cada item enviado.

{
  • "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
  • "number": null,
  • "series": null,
  • "issue_date": "2026-10-16",
  • "status": "unissued",
  • "operation_nature": "Prestação de Serviço",
  • "cfop": null,
  • "nbs_code": "109051200",
  • "document": null,
  • "manual_emission": false,
  • "amount": 1850,
  • "service_amount": 0,
  • "net_amount": 1850,
  • "approximate_taxes_percentage": 0,
  • "approximate_taxes_amount": 0,
  • "observations": "Referente à viagem de outubro",
  • "cvc_original_data": null,
  • "printed_at": null,
  • "canceled_at": null,
  • "created_at": "2026-10-16T10:12:44",
  • "recipient": {
    },
  • "taxes": {
    },
  • "nfse": {
    },
  • "person": null,
  • "company": {
    },
  • "sale_product": null,
  • "sale": null,
  • "created_by": null,
  • "canceled_by": null,
  • "items": [
    ]
}

Baixar XML da NFS-e Beta

Devolve o arquivo XML da NFS-e emitida, baixado do e-Notas ou, sem ele, o que ficou salvo na nota. A nota que não está emitida responde 409, e a emitida sem XML responde 404. Pede só a permissão de ler notas fiscais.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Baixar PDF da NFS-e Beta

Redireciona (302) para o PDF da NFS-e emitida ou cancelada no e-Notas, o endereço que o Monde abre no navegador pela nota. A nota que não está emitida nem cancelada responde 409, e a que não tem o endereço do PDF responde 404. Pede só a permissão de ler notas fiscais.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da nota fiscal.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Gerar Notas Fiscais

Gere as notas fiscais de serviço dos produtos vendidos a partir das regras de nota fiscal, como na tela Gerar Notas Fiscais do Monde. O fluxo tem dois passos: Consultar as notas a gerar devolve, para cada produto de venda fechada, as notas que já existem e as que a geração gravaria, com o tomador, o valor, os impostos, a regra e a fórmula; depois, Gerar notas fiscais grava as escolhidas, todas ou nenhuma. A empresa de referência (company_identifier) faz o papel da empresa em que o usuário entra no Monde: dela vêm a natureza da operação, o CFOP, as alíquotas, a data de emissão e o modelo do item de todas as notas, e cada nota fica na empresa da venda. As notas geradas ficam não emitidas, e aparecem em Consultar notas fiscais. O recurso não existe em instalações de operadora.

Consultar as notas a gerar Beta

Retorna os produtos das vendas fechadas (produto não excluído) das empresas em que a credencial consulta as notas a gerar, do mais antigo para o mais novo pela data e pelo número da venda, com as notas que as regras de nota fiscal montam para cada um. Cada produto ganha até uma nota por tomador da regra (pagante, fornecedor e representante), no valor da fórmula menos o que as notas não canceladas do mesmo produto e tomador já cobriram. O produto cujas notas já cobrem a receita fica de fora. Sem período, a consulta traz as vendas do primeiro dia do mês até hoje. Como no Monde, entram as vendas que a própria credencial criou; as dos demais vendedores entram nas empresas em que ela tem também Consultar vendas de outros vendedores/intermediários em Vendas. Cada página varre no máximo 2.000 produtos: num período em que quase tudo já tem nota, a página pode vir com menos itens que size, ou vazia, com has_next_page verdadeiro; siga pelo next_cursor até has_next_page falso. Guarde o previewed_at da resposta: ele vai no pedido de geração. As páginas seguidas pelo next_cursor devolvem o previewed_at da primeira.

Authorizations:
bearerAuthentication
query Parameters
company_identifier
required
string
Example: company_identifier=11222333000181

CNPJ da empresa de referência, de onde vêm a natureza da operação, o CFOP, as alíquotas, a data de emissão e o modelo do item das notas. Obrigatório.

date_field
string
Enum: "sale_date" "product_start"
Example: date_field=sale_date

A data que o período filtra. Obrigatório quando date_from ou date_to é informado.

  • sale_date: data da venda.
  • product_start: data de início do produto (embarque, check-in).
date_from
string <date>
Example: date_from=2026-10-01

Início do período, no formato ISO 8601 (YYYY-MM-DD).

date_to
string <date>
Example: date_to=2026-10-31

Fim do período, no formato ISO 8601 (YYYY-MM-DD).

supplier_representative_id
string <uuid>
Example: supplier_representative_id=0f3c1d52-7f0a-4a55-9a2e-1b6d1c2f3a4b

Traz só os produtos em que esta pessoa é o fornecedor ou o representante.

include_without_revenue
boolean
Default: false

Inclui os produtos sem receita, com as notas de valor zero que as regras montam para eles. Padrão: false.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "previewed_at": "2026-10-16T10:15:30.123456-03:00",
  • "pagination": {
    }
}

Gerar notas fiscais Beta

Gera as notas escolhidas na consulta das notas a gerar, identificadas pelo produto da venda (sale_product_id) e pelo tomador (recipient_kind). As notas são montadas de novo no momento da geração, com as mesmas regras, e gravadas todas ou nenhuma: se alguma nota pedida não puder ser gerada (já existe, tem erro ou a regra não a monta), nada é gravado e a resposta é 422. Se outra geração gravou nota para algum desses produtos depois do previewed_at informado, a resposta é 409 e a consulta tem de ser refeita. Produto que a consulta não mostraria (venda que a credencial não alcança, notas que já cobrem a receita ou, sem include_without_revenue, produto sem receita) também recusa o pedido inteiro com 422. A credencial precisa da permissão Gerar Notas Fiscais na empresa de referência e na empresa de cada venda. A resposta traz as notas geradas completas para quem também consulta notas fiscais na empresa delas; para os demais, só o id.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
company_identifier
required
string = 14 characters ^[0-9]{14}$

CNPJ da empresa de referência, a mesma da consulta das notas a gerar

previewed_at
required
string <date-time>

O previewed_at devolvido pela consulta que mostrou estas notas. Nota gravada depois dele para algum dos produtos recusa a geração com 409

include_without_revenue
boolean
Default: false

O mesmo valor usado na consulta: com true, as notas de valor zero dos produtos sem receita também podem ser geradas. Padrão: false

required
Array of objects [ 1 .. 500 ] items

As notas a gerar, no máximo 500 por pedido, sem repetir a mesma nota

Responses

Request samples

Content type
application/json
{
  • "company_identifier": "11222333000181",
  • "previewed_at": "2026-10-16T10:15:30.123456-03:00",
  • "include_without_revenue": false,
  • "nfs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Logs

Consulte o histórico de alterações do sistema: a ação registrada, a origem, a descrição da alteração, o momento em que ela foi gravada e, na consulta por ID, as referências para o autor e para o registro auditado.

Consultar logs Beta

Retorna o histórico de alterações do sistema, com filtros por autor, registro auditado, ação e origem. A consulta traz apenas os campos da própria linha; para o autor e o registro auditado, use a consulta por ID. O histórico é recortado por cadastro, como no Monde: o log de cada cadastro vem a quem tem "Visualizar Log" dele (vendas, pessoas, contas a pagar e receber, viagens, contas, transferências entre contas, notas fiscais, regras da nota fiscal e extrato CVC) ou, no cadastro sem essa permissão, a quem o lê. O log das cidades, que não têm mais permissão, só vem a quem lê todo o log. No log de venda, lançamento, nota fiscal e tarefa, a permissão vale na empresa do registro. No log das contas e das transferências entre contas, a permissão em qualquer empresa mostra o log de todas, como no Monde, que confere o "Visualizar Log" na empresa em que o usuário entrou, e não nas empresas das contas. O log da venda, do lançamento e da tarefa de outro usuário só vem a quem também alcança o registro, como na consulta dele: na venda, quem a abre ("Abrir vendas de outros vendedores/intermediários"); no lançamento, quem acessa os lançamentos de outros usuários (inteiro ou no recorte); na tarefa, quem vê as tarefas de outros usuários. No Monde o log fica na aba do registro, que só abre com essas permissões; por isso o log da venda, do lançamento e da tarefa já excluídos só vem a quem lê todo o log. As exportações ficam de fora. A linha que a credencial não vê responde 404 na consulta por ID.

Authorizations:
bearerAuthentication
query Parameters
person_id
string <uuid>
Example: person_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91

Filtra pelo identificador do autor da alteração.

resource_id
string <uuid>
Example: resource_id=9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118

Filtra pelo identificador do registro auditado.

kind
string
Enum: "insertion" "edition" "deletion" "custom" "export" "email"
Example: kind=edition

Filtra pela ação registrada.

  • insertion: cadastro do registro.
  • edition: alteração do registro.
  • deletion: exclusão do registro.
  • custom: ação personalizada da tela que gerou o registro.
  • export: exportação de dados.
  • email: e-mail enviado pelo registro, como o boleto ou a fatura de uma conta a pagar ou receber. A descrição traz os destinatários e os arquivos anexados.
origin
string
Example: origin=financeiro_categoria

Filtra pela origem da alteração, com o valor exato gravado no log. Um valor por chamada.

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Retorna o histórico com uma edição, uma exportação de relatório e um cadastro gravado por uma requisição da API, sem autor.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar logs por ID Beta

Retorna uma linha do histórico pelo identificador, com as referências para o autor da alteração e para o registro auditado.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83

Identificador da linha do histórico.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
Example

Retorna uma alteração feita por uma pessoa, com as referências para o autor e para o registro auditado.

{
  • "id": "5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83",
  • "kind": "edition",
  • "origin": "financeiro_categoria",
  • "description": "Valor de \"10\" para \"20\"",
  • "created_at": "2026-08-05T09:12:33",
  • "person": {
    },
  • "resource": {
    }
}

Campos Personalizados

Consulte as definições dos campos personalizados do sistema por recurso (vendas, viagens, pessoas, contas a pagar/receber e tarefas): o identificador, o nome, o tipo, se é obrigatório e as opções cadastradas. O valor de cada campo é informado na venda, na pessoa e no lançamento.

Consultar campos personalizados Beta

Retorna as definições dos campos personalizados, opcionalmente filtradas pelo recurso. Cada linha traz o identificador, o recurso, o nome, o tipo, se é obrigatório, se está ativo e, nos campos do tipo lista, as opções cadastradas. As definições não são recortadas por empresa: a credencial que tem a permissão lê todas.

Authorizations:
bearerAuthentication
query Parameters
resource
string
Enum: "sales" "travels" "people" "bills" "tasks"
Example: resource=sales

Filtra pelo recurso (origem) do campo personalizado. Um valor por chamada; ausente lista todos os recursos.

  • sales: campos de vendas.
  • travels: campos de viagens.
  • people: campos de pessoas.
  • bills: campos de contas a pagar e receber.
  • tasks: campos de tarefas.
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Retorna as definições de campos personalizados de vendas, com um campo do tipo lista e um campo de texto.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar campo personalizado por ID Beta

Retorna a definição de um único campo personalizado pelo seu identificador. Use para resolver o nome, o tipo e as opções de um campo a partir do id retornado nas demais consultas da API.

Authorizations:
bearerAuthentication
path Parameters
id
required
integer
Example: 123

Identificador do campo personalizado a consultar.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Retorna a definição de um único campo personalizado, do tipo lista, com as opções cadastradas.

{
  • "id": 123,
  • "resource": "sales",
  • "name": "Centro de custo",
  • "kind": "choices",
  • "required": true,
  • "active": true,
  • "choices": [
    ]
}

Planos de Comissão

Consulte os planos de comissão, como no cadastro de Planos de Comissão do Monde. Um plano tem faixas de meta (o percentual da meta do mês que a pessoa precisa atingir para a faixa valer); cada faixa tem a entrada de todos os produtos e, se quiser, entradas de produtos específicos; e cada entrada tem os valores de comissão de cada função: um percentual sobre campos da venda ou um valor fixo, e opcionalmente outros valores para a venda que tem intermediário. No fechamento de comissões, vale a maior faixa que a pessoa atingiu, a entrada do produto vendido (sem ela, a de todos os produtos) e a regra da função da pessoa (sem ela na entrada do produto, a da entrada de todos os produtos). O plano é ligado às pessoas no cadastro de funções do Monde. O recurso é só da agência: na instalação de operadora, todas as chamadas respondem 403. Ler exige a permissão "Visualizar" de Planos de Comissão.

Consultar planos de comissão Beta

Retorna a lista de planos de comissão, por nome.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com dois planos.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar plano de comissão por ID Beta

Retorna um plano de comissão com as faixas de meta, os produtos de cada faixa e os valores de cada função. As faixas vêm pelo percentual, a entrada de todos os produtos vem primeiro em cada faixa, e um campo do tipo que não está em uso (o valor fixo na comissão percentual, e vice-versa) vem zerado.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e

Identificador único do plano de comissão

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de plano com duas faixas: até atingir 100% da meta o vendedor recebe 3% (1,5% na venda com intermediário); a partir de 100%, 5%, e R$ 50,00 por unidade de um produto específico.

{
  • "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d",
  • "description": "Plano padrão",
  • "goal_ranges": [
    ]
}

Metas

Consulte as metas de vendas, como na tela Metas do Monde. A meta é de uma pessoa numa função, por ano, com o valor de cada mês; no fechamento de comissões, o que a pessoa vendeu no mês é comparado com a meta do mês para achar a faixa do plano de comissão. Este recurso é só de consulta: como no Monde, a meta é gravada pela função, no "Plano e Metas" da pessoa. Para cadastrar, alterar ou excluir uma meta, envie a lista goals da pessoa em people na alteração da função, com a permissão "Editar" de Funções. O recurso é só da agência: na instalação de operadora, todas as chamadas respondem 403. Ler exige a permissão "Visualizar" de Metas.

Consultar metas Beta

Retorna as metas, do ano mais recente para o mais antigo, com filtros opcionais por ano, função e pessoa.

Authorizations:
bearerAuthentication
query Parameters
year
integer
Example: year=2026

Ano da meta, com quatro dígitos

person_role_id
string <uuid>
Example: person_role_id=f453b283-750d-4c5d-a493-a6bf8064090e

Identificador da função

person_id
string <uuid>
Example: person_id=3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7

Identificador da pessoa

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo de resposta com a meta de um vendedor.

{
  • "data": [
    ],
  • "pagination": {
    }
}

Consultar meta por ID Beta

Retorna uma meta específica pelo seu identificador.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e

Identificador único da meta

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json

Exemplo da meta de um vendedor, com o plano de comissão dele.

{
  • "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
  • "person_role": {
    },
  • "person": {
    },
  • "commission_plan": {
    },
  • "year": 2026,
  • "months": {
    }
}

Conciliação Bancária

Conciliação bancária da conta corrente: envie o extrato OFX exportado do internet banking, consulte os extratos enviados com o resumo do que já foi conciliado e descarte o extrato enviado por engano. O vínculo das linhas e a conferência são feitos na tela de Conciliação Bancária do Monde Web. A permissão é a do Monde, Conciliação Bancária, numa das empresas da conta corrente. Pela conexão automática, a conciliação é exceção concedida pelo Monde na aprovação: ela alcança o extrato e as movimentações da conta inteira, de qualquer origem.

Consultar extratos enviados Beta

Retorna os extratos enviados para as contas correntes ativas das empresas em que a credencial tem a permissão Conciliação Bancária, do mais recente para o mais antigo. Filtre por conta com account_id.

Authorizations:
bearerAuthentication
query Parameters
account_id
string <uuid>

Só os extratos desta conta corrente (UUID).

cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Enviar extrato Beta

Envia o extrato OFX (.ofx ou .qfx, até 5 MB) de uma conta corrente ativa, em multipart/form-data, e já roda o casamento automático. A importação é a da tela: a linha é identificada pela conta e pelo FITID, então reenviar um período não duplica linhas, e a correção do banco (CORRECTFITID) é aplicada quando possível. Banco, agência e número da conta que não conferem com o cadastro só geram aviso em warnings; moeda diferente da conta e arquivo sem lançamentos são recusados com 422. A conta inexistente, ou que não é conta corrente ativa, também responde 422. Não pede company_identifier: o extrato é da conta corrente, que pode ser de mais de uma empresa, e basta a permissão Conciliação Bancária numa delas.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "multipart/form-data"
Example: multipart/form-data

Tipo de conteúdo da requisição. Deve ser multipart/form-data.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: multipart/form-data
required
account_id
required
string <uuid>

Conta corrente ativa a conciliar (UUID).

file
required
string <binary>

Arquivo OFX (.ofx ou .qfx) exportado do internet banking, até 5 MB.

Responses

Response samples

Content type
application/json
{
  • "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
  • "account": {
    },
  • "file_name": "extrato-janeiro.ofx",
  • "bank_code": "033",
  • "branch": "1234",
  • "account_number": "1234567890",
  • "currency": "BRL",
  • "period_start": "2025-01-01",
  • "period_end": "2025-01-31",
  • "ledger_balance": 15230.45,
  • "ledger_balance_date": "2025-01-31",
  • "lines": {
    },
  • "warnings": [ ],
  • "created_at": "2025-02-03T10:15:00",
  • "situations": {
    },
  • "pending_count": 17,
  • "reconciled_count": 28,
  • "balance": {
    }
}

Consultar extrato por ID Beta

Retorna o extrato com o resumo da conciliação: quantas linhas há em cada situação e o confronto do saldo informado pelo banco com o saldo do sistema na mesma data.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10

Identificador (UUID) do extrato enviado.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
  • "account": {
    },
  • "file_name": "extrato-janeiro.ofx",
  • "bank_code": "033",
  • "branch": "1234",
  • "account_number": "1234567890",
  • "currency": "BRL",
  • "period_start": "2025-01-01",
  • "period_end": "2025-01-31",
  • "ledger_balance": 15230.45,
  • "ledger_balance_date": "2025-01-31",
  • "lines": {
    },
  • "warnings": [ ],
  • "created_at": "2025-02-03T10:15:00",
  • "situations": {
    },
  • "pending_count": 17,
  • "reconciled_count": 28,
  • "balance": {
    }
}

Descartar extrato Beta

Descarta o extrato: apaga as linhas que ele inseriu (a linha que já existia por um envio anterior fica) e desfaz a conferência dos lançamentos vinculados a elas. Com lançamento conferido em dia de caixa fechado, nada é apagado e a resposta é 422. Não exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>
Example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10

Identificador (UUID) do extrato enviado.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Webhooks

Receba um aviso quando registros mudam, em vez de consultar as listas de tempo em tempo. A assinatura (webhook) pertence à credencial que a cadastrou e é gerenciada por esta API.

Como funciona. Toda escrita nos registros da API — feita pelo Monde Desktop, pelo Monde Web ou pela própria API — grava o evento no banco, na mesma transação. A cada minuto os eventos são agrupados e entregues: um POST por evento e assinatura, com até 100 registros; passando disso, sai mais de um POST. O aviso é fino: leva o evento e os ids, e o estado atual sai da consulta do recurso. O mesmo registro salvo várias vezes no mesmo minuto entra uma vez só.

{
  "id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d",
  "event": "sales.changed",
  "resource": "sales",
  "occurred_at": "2026-10-16T14:32:10-03:00",
  "data": [
    { "id": "b71a4c58-2f0e-4c1e-9a63-1c9a0f0b9e21", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" },
    { "id": "c92f0d13-6b1a-4f7e-8d2c-3e4f5a6b7c8d", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" }
  ]
}

Eventos. O catálogo está em Listar eventos de webhook: changed (registro criado ou alterado) e deleted de cada recurso, e os eventos de negócio (venda fechada e reaberta, produto cancelado, comissão fechada e paga, venda importada da fila de uma integração, nota fiscal emitida e cancelada, tarefa vencida, importação da integração concluída e importação dos extratos CVC concluída). Criação e alteração são um evento só: o aviso traz só o id, e a consulta diz como o registro está; se o seu sistema ainda não tem o registro, ele é novo. A alteração de um item que faz parte do registro (produto, passageiro, trecho, comissão, anexo e pagamento da venda; itens, categorias e rateio da conta; o grupo da categoria financeira) gera o changed do registro. Nos eventos de negócio, cada item traz também subresource_id, o item que provocou o evento (o produto cancelado, a comissão, a venda importada). company_id é nulo nos cadastros que não pertencem a uma empresa.

tasks.overdue é um evento de tempo: sai uma vez por vencimento, cerca de um minuto depois de o vencimento passar sem a tarefa ser concluída. A tarefa gravada já vencida, ou que venceu enquanto nenhum webhook assinava o evento, não o gera. Em cvc_statements.import_completed, o id do item é a execução da importação, consultável em Consultar logs por ID por quem tem a permissão Logs; os extratos que ela criou ou alterou mandam os avisos deles. integrations.import_completed avisa que a fila de vendas importadas da integração foi atualizada. cvc_statements.import_completed não sai da importação que falhou nem da que não achou arquivo novo. A moeda gera só o changed, quando é ativada ou desativada. Navios e cabines são identificados pelo nome: trocá-lo gera o deleted do id antigo e o changed do novo.

Ordem e repetição. A ordem entre avisos não é garantida: se a consulta de um id responder 404, o registro foi excluído. A credencial também recebe o aviso do que ela mesma gravou: quem grava de volta no Monde ao receber um aviso precisa ignorar a mudança que ele próprio fez, ou entra em ciclo.

Quem recebe. Só se assina evento de recurso que a credencial pode ler, e o aviso só sai do registro que a consulta por ID devolveria à credencial: a empresa precisa conceder a leitura do recurso e estar com a licença ativa. Credencial desativada para de receber.

Cabeçalhos e assinatura. Cada entrega traz X-Monde-Event, X-Monde-Delivery (o id da entrega, igual em todas as tentativas: use-o para descartar aviso repetido), X-Monde-Timestamp (segundos desde 1970) e X-Monde-Signature, no formato sha256=<hex>: o HMAC-SHA256 de "<timestamp>.<corpo>" com o segredo da assinatura. Confira a assinatura com o corpo exatamente como chegou e recuse horário muito antigo.

Repetição. Resposta 2xx confirma a entrega. Qualquer outra resposta, erro de conexão ou espera acima de 10 segundos é tentada de novo, com espera crescente (1, 2, 4, 8, 16, 32 e 64 minutos), num total de 8 tentativas. Redirecionamento não é seguido. A resposta 410 diz que o endereço não existe mais: a entrega desiste na hora, sem nova tentativa, e conta como esgotada. Depois de 10 entregas esgotadas seguidas a assinatura é desativada: active fica false e disabled_at e last_error dizem quando e por quê; enviar active como true religa. Enquanto o webhook está desativado não há aviso: as entregas que estavam pendentes ficam como falha no histórico, e religar não reenvia o que mudou nesse período. Depois de religar, consulte a listagem do recurso para pôr em dia o que foi alterado. O histórico de cada entrega fica 30 dias em Listar entregas do webhook.

Endereço. Só https, e nunca um endereço de rede interna, local ou reservada; a conferência é refeita antes de cada entrega.

Exige a permissão Webhooks da credencial: ler para consultar, criar e editar para cadastrar e alterar, excluir para remover.

Listar webhooks Beta

Lista os webhooks da credencial autenticada, do mais recente para o mais antigo. O segredo nunca é devolvido.

Authorizations:
bearerAuthentication
query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Criar webhook Beta

Cadastra um webhook na credencial autenticada. Envie o secret (32 a 255 caracteres; o vazio é recusado) ou omita-o para a API gerar um: o gerado vem uma única vez, nesta resposta, no campo secret. Cada evento precisa estar no catálogo e ser de um recurso que a credencial pode ler. Exige Idempotency-Key.

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
url
string <uri>

Endereço https que recebe o POST. Endereço de rede interna, local ou reservada é recusado.

description
string or null <= 255 characters

Descrição livre, até 255 caracteres.

events
Array of strings non-empty

Lista de eventos do catálogo, de recursos que a credencial pode ler. Não pode ser vazia.

active
boolean

Se o webhook recebe entregas.

secret
string [ 32 .. 255 ] characters

Chave do HMAC-SHA256 da assinatura, de 32 a 255 caracteres. Só de gravação.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
  • "description": "ERP do cliente",
  • "events": [
    ],
  • "active": true,
  • "consecutive_failures": 0,
  • "disabled_at": null,
  • "last_error": null,
  • "created_at": "2026-10-16T10:00:00-03:00",
  • "updated_at": "2026-10-16T10:00:00-03:00",
  • "secret": "aZ3kP9qX7mL2nB8vC4tY6wR1sD5fG0hJ7kL9mN3pQ2rS8tU4"
}

Consultar webhook Beta

Devolve um webhook da credencial autenticada. O webhook de outra credencial responde 404.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>

ID do webhook.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
  • "description": "ERP do cliente",
  • "events": [
    ],
  • "active": true,
  • "consecutive_failures": 0,
  • "disabled_at": null,
  • "last_error": null,
  • "created_at": "2026-10-16T10:00:00-03:00",
  • "updated_at": "2026-10-16T10:00:00-03:00"
}

Alterar webhook Beta

Altera só os campos enviados: {"active": true} religa o webhook desativado sem reenviar o segredo. A lista events enviada substitui a anterior. O secret enviado troca o segredo e não é devolvido. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Exige Idempotency-Key.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>

ID do webhook.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Idempotency-Key
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][...
Example: 550e8400-e29b-41d4-a716-446655440000

Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de Idempotência para mais detalhes.

Request Body schema: application/json
required
url
string <uri>

Endereço https que recebe o POST. Endereço de rede interna, local ou reservada é recusado.

description
string or null <= 255 characters

Descrição livre, até 255 caracteres.

events
Array of strings non-empty

Lista de eventos do catálogo, de recursos que a credencial pode ler. Não pode ser vazia.

active
boolean

Se o webhook recebe entregas.

secret
string [ 32 .. 255 ] characters

Chave do HMAC-SHA256 da assinatura, de 32 a 255 caracteres. Só de gravação.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
  • "description": "ERP do cliente",
  • "events": [
    ],
  • "active": true,
  • "consecutive_failures": 0,
  • "disabled_at": null,
  • "last_error": null,
  • "created_at": "2026-10-16T10:00:00-03:00",
  • "updated_at": "2026-10-16T10:00:00-03:00"
}

Excluir webhook Beta

Exclui o webhook e o histórico das entregas dele. As entregas ainda pendentes não são feitas.

Authorizations:
bearerAuthentication
path Parameters
id
required
string <uuid>

ID do webhook.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Listar entregas do webhook Beta

Histórico das entregas dos últimos 30 dias, da mais recente para a mais antiga: o corpo enviado, o número de tentativas, o último código de resposta e o último erro.

Authorizations:
bearerAuthentication
path Parameters
webhook_id
required
string <uuid>

ID do webhook.

query Parameters
cursor
string
Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4

Cursor da próxima página, exatamente como veio em next_cursor. Sem ele, a consulta começa pela primeira página.

size
integer [ 1 .. 50 ]
Default: 20
Example: size=10

Número de registros por página.

header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Listar eventos de webhook Beta

Catálogo dos eventos que um webhook pode assinar, com a descrição e se a credencial autenticada pode assiná-los (subscribable, quando ela pode ler o recurso).

Authorizations:
bearerAuthentication
header Parameters
Authorization
required
string
Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Credencial de acesso fornecida pela agência de viagens, no esquema Bearer.

Content-Type
required
string
Value: "application/json"
Example: application/json

Tipo de conteúdo da requisição. Deve ser application/json.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Perguntas frequentes

As dúvidas que mais chegam sobre a API v3, com a resposta curta e o link para a seção que detalha o assunto.

Acesso e credenciais

Qual a diferença entre a API v2 e a API v3?

A v2 continua funcionando, mas é legada e não recebe mais atualizações: toda integração deve usar a v3, que é a desta documentação. A v3 autentica com a credencial gerada pela agência; a v2 usa login e senha de um usuário do Monde e tem documentação própria.

Como acesso a API? O token expira?

Envie a credencial no cabeçalho Authorization com o esquema Bearer, como mostra a seção Autenticação. A credencial não expira, mas a agência pode revogá-la a qualquer momento.

Onde a agência gera a credencial?

No Monde, em Cadastros > Integrações, na integração API Monde. É ali que a agência escolhe as permissões da credencial, por empresa e por recurso, e de lá repassa a credencial a quem vai integrar.

Dá para ter um acesso só de leitura?

Sim. Ao gerar a credencial, a agência concede só as permissões de leitura dos recursos que quiser liberar. As gravações respondem 403.

Uma credencial atende várias empresas ou lojas?

Sim. Uma credencial acessa todas as empresas da agência que receberam permissão nela. Toda empresa com licença ativa do Monde pode ser usada pela API, sem licença à parte. A empresa somente leitura só é consultada: as gravações nela respondem 403 com "A empresa está somente leitura: os registros dela podem ser consultados pela API, mas não gravados.".

A credencial vê e altera os registros de outros usuários?

Como no Monde, cada permissão vale para o que a própria credencial criou, e as permissões "de outros" estendem o alcance aos demais: em vendas, Consultar, Abrir e Editar vendas de outros vendedores; em contas a pagar e receber, Acessar lançamentos de todos os usuários e do sistema ou um dos recortes (faturas de clientes, de fornecedores, de cartão, lançamentos com operação própria e com venda); em tarefas, Ver tarefas de outros usuários. A viagem é da credencial quando ela a cadastrou ou criou uma venda dela, e as demais seguem Consultar vendas de outros vendedores. Listar e consultar pedem a permissão "Visualizar" do recurso também no que a própria credencial criou, como no Monde, em que sem ela não se abre o cadastro; a resposta da alteração sem essa permissão traz só os identificadores, e a da criação traz o registro criado inteiro. O registro de outro usuário fora do alcance responde 404; o que ela lê mas não pode alterar responde 403 com a mensagem do Monde. A credencial gerada antes dessas permissões continua alcançando todos os registros, como antes.

Recebi o erro 403. O que falta?

Falta a permissão daquele recurso na credencial, a empresa não tem licença ativa do Monde ou está somente leitura numa gravação, ou o recurso exige a licença Monde Pro, como os Guias. A mensagem da resposta diz qual é a causa. Quando é permissão, não é preciso gerar uma nova credencial: basta a agência marcar a permissão na credencial existente.

Sou um sistema parceiro que atende várias agências. Como me conecto?

Pela Conexão automática. A agência autoriza o parceiro no próprio Monde, sem compartilhar uma credencial, e as permissões são as definidas na aprovação do parceiro.

Uso e limites

Existe ambiente de testes (sandbox)?

Por enquanto, não: a API atende a base de produção da agência. Durante o desenvolvimento, comece pelas consultas, com uma credencial só de leitura, e use a idempotência nas gravações para não duplicar registros ao repetir uma requisição.

Qual o limite de requisições? Tem cota diária?

O limite é por janela curta de tempo, contado por IP, e não existe cota diária ou mensal. Os valores e o que fazer ao receber 429 estão em Limites de requisição.

Como funciona a paginação?

Por cursor, com até 50 registros por página. Repita a consulta enviando o next_cursor da resposta anterior enquanto has_next_page for true. Veja Paginação.

Os dados são em tempo real?

Sim. A API lê e grava a mesma base que a agência usa no Monde, sem cópia nem atraso de sincronização.

A API avisa quando algo muda (webhooks)?

Sim, na credencial criada pela própria agência: cadastre um endereço https em Webhooks e receba um POST assinado quando registros mudam. A permissão Webhooks não é oferecida na Conexão automática: ali a integração consulta a API periodicamente. Em vendas, o filtro updated_since traz só o que mudou desde a última consulta, inclusive quando a mudança foi numa parte da venda, como um produto, passageiro ou pagamento.

Como sou avisado das mudanças na API?

Pelo Changelog, que registra cada mudança com a data, e marca em destaque as que alteram o contrato. A API está em fase beta, então campos e endpoints ainda podem mudar. A etiqueta de cada endpoint diz se ele já pode ser usado: veja Disponibilidade dos endpoints.

Posso usar a API com Power BI, planilhas ou agentes de IA?

Sim. Qualquer ferramenta que faça requisições HTTP com o cabeçalho de autenticação consegue consumir a API. Para o agente de IA que gera código, a documentação também está disponível em texto em https://web.monde.com.br/llms.txt.

Consulta de vendas

Como filtro as vendas por período?

Em Consultar vendas, escolha a data em date_field (data da venda, de embarque ou de retorno) e informe o intervalo em date_from e date_to.

Como busco só o que mudou desde a última consulta?

Use updated_since em Consultar vendas, com data ou data e hora. Ele também traz a venda lançada com data retroativa, porque considera quando a venda foi alterada, e não a data dela, e traz a venda quando muda uma das partes que aparecem em Consultar venda por ID, como produtos, passageiros, pagamentos e contas vinculadas. A lista completa está na descrição do filtro. Guarde o instante em que a consulta começou, antes da primeira página, e na consulta seguinte parta dele com uma folga de alguns minutos para trás. Regrave cada venda pelo id, e envie status=opened,closed,canceled para receber também as exclusões. Hoje esse filtro existe só em vendas.

Como filtro as vendas de um cliente ou de um vendedor?

Use people_id com o ID da pessoa, que pode ser buscado em Consultar pessoas. O filtro traz a venda em que a pessoa aparece em qualquer papel: pagante, passageiro, vendedor, fornecedor. Para separar por vendedor ou por empresa, use o seller e a company que vêm em Consultar venda por ID.

Por que a lista não traz os produtos da venda?

A consulta de vendas traz os dados principais e os totais de cada venda. Produtos, pagamentos, comissões, anexos e campos personalizados vêm em Consultar venda por ID.

Por que as vendas excluídas não aparecem?

Por padrão, a consulta traz só as vendas abertas e fechadas. Para as excluídas, envie status=canceled.

A venda traz só o ID do fornecedor. Como pego o nome?

Fornecedores, representantes, pagantes e passageiros são cadastros de pessoa. Consulte-os em Consultar pessoa por ID e guarde o resultado para não repetir a mesma consulta a cada venda.

Existem campos de faturamento, markup ou rentabilidade?

Não com esses nomes. A venda traz o valor de cada produto, as taxas, as comissões e o over, a receita e os totais, e cada integração monta os indicadores dela a partir desses valores.

A API tem relatórios prontos, como vendas por vendedor ou por produto?

Não. A API entrega os registros, e o relatório é montado do lado de quem integra, a partir das vendas consultadas.

Como leio o financeiro (contas a pagar e receber)?

Em Contas a Pagar e Receber, Movimentações, Reembolsos e Notas Fiscais. A venda também traz, no detalhe, as contas que gerou.

Gravação

Dá para criar vendas pela API?

Sim, em Inserir venda, uma venda por requisição. Os produtos aceitos e os campos obrigatórios estão na descrição da operação.

Dá para enviar ou alterar várias vendas numa requisição só?

Não. Cada requisição grava uma venda. Para volume, envie uma após a outra, respeitando os limites de requisição.

Como evito venda duplicada ao repetir uma requisição?

Envie o cabeçalho Idempotency-Key, obrigatório em Inserir venda. Enquanto a chave vale, repeti-la devolve a resposta da primeira requisição, sem gravar de novo. A chave expira depois de pelo menos um dia. Veja Idempotência.

Como evito cadastrar o mesmo fornecedor ou cliente duas vezes?

Na venda, cada pessoa é procurada pelo external_id que a sua integração enviou antes e, sem esse vínculo, pelo CPF ou CNPJ. Só quando nenhum dos dois encontra a pessoa é que ela é cadastrada. Envie sempre o CPF ou o CNPJ para reaproveitar o cadastro que já existe no Monde.

O que mais dá para gravar além de vendas?

Pessoas, tarefas, anexos e contas a pagar e receber. A etiqueta de cada operação diz se ela já está disponível, e o Changelog registra cada nova operação.

Dá para criar viagens pela API?

Sim. Em Viagens, a integração cadastra, altera e exclui viagens e vincula ou desvincula as vendas delas, com as permissões Editar e Excluir de Viagens. A viagem cadastrada pela credencial é dela: alterar, excluir e vincular vendas a ela não pedem Consultar vendas de outros vendedores, que a viagem dos outros vendedores e das outras credenciais pede.

Changelog

A API v3 está em fase beta: já disponível para uso, mas ainda em fase de testes e ajustes — campos e endpoints podem sofrer alterações. Acompanhe esta seção para as mudanças.

2026-11-15

Orçamentos e guias: três colunas

  • O details dos guias e dos orçamentos passa a aceitar as colunas com dois ou três <div data-block="column">. Antes, só com dois.

2026-11-13

Orçamentos e guias: miniaturas no carrossel

  • O details dos guias e dos orçamentos passa a aceitar data-carousel="thumbnails" no parágrafo das imagens do carrossel, que mostra miniaturas embaixo, no lugar das bolinhas. Outro valor, ou o atributo em outra tag, é descartado.
  • As imagens seguidas no mesmo parágrafo formam o carrossel mesmo com espaço (&nbsp;) entre elas.

2026-11-12

Orçamentos: capa e campos opcionais

  • Os orçamentos passam a devolver a capa do link público: cover_kind (color, image ou none), cover_color, cover_show_title, cover_show_subtitle e cover_image_url.
  • Criar orçamento e Alterar orçamento aceitam cover_kind, cover_color, cover_show_title e cover_show_subtitle. A imagem da capa só se escolhe pelo Monde Web. Sem a capa, o orçamento novo nasce com a capa color, na cor principal das Configurações de Orçamentos da empresa.
  • subtitle e details deixam de ser obrigatórios: na criação podem ser omitidos, e na alteração o nulo os deixa em branco.

Vendas: vendedor inativo

  • Em Inserir venda e Alterar venda, o seller que é um vendedor inativo no Monde passa a ser recusado com 422, como no Monde, em vez de responder 500. A credencial sem a permissão de editar Vendedores continua recebendo 403, como para o vendedor ainda não cadastrado. Na alteração, o vendedor que a venda já tem continua aceito, mesmo inativo.

Guias: capa nova e conteúdo opcional

  • A capa dos guias passa a ser color, image ou none, como a dos orçamentos, e os guias devolvem também cover_show_title, cover_show_subtitle e cover_image_url. Os guias que tinham a capa default passaram para color, no tom #5f6777.
  • Criar guia e Alterar guia aceitam cover_show_title e cover_show_subtitle. O hide_cover_text continua aceito e vale pelos dois, e a capa default continua aceita e vale como color no tom #5f6777. Sem a capa, o guia novo nasce com a capa color nesse tom.
  • details deixa de ser obrigatório: na criação pode ser omitido, e na alteração o nulo o deixa em branco.

2026-11-11

Orçamentos: blocos no conteúdo

  • O details dos orçamentos passa a aceitar os três blocos dos guias: caixa de destaque, seção com imagem de fundo e duas colunas, como <div data-block>. Antes eles viravam texto comum.

2026-11-10

Guias: imagem na caixa de destaque e na seção com imagem de fundo

  • No details dos guias, a caixa de destaque passa a ser só de texto: a imagem vai para um parágrafo logo depois dela, e a tabela, a citação, o código e a linha divisória vão para depois dela. A seção com imagem de fundo fica só com a primeira imagem, e as outras são descartadas.

Logs: envio de e-mail com ação própria

  • O kind de Consultar logs e de Consultar logs por ID passa a trazer email para o e-mail enviado pelo registro, como o boleto ou a fatura de uma conta a pagar ou receber. A description traz os destinatários e os arquivos anexados. O filtro kind de Consultar logs passa a aceitar email.
  • Atenção, mudança no contrato: essas linhas vinham com o kind em texto livre, fora do conjunto documentado (Enviado por e-mail). Quem lia esse valor passa a receber email.

Faturas: o item que é somado a outro e o destino do item removido

  • Atenção, mudança no contrato: Remover itens da fatura ou recalcular o vencimento passa a trazer reprocessed_items: para cada item enviado, a fatura em que ele ficou (bill) e o item nela (item), que é outro quando a fatura de destino já tinha um item igual e os dois foram somados. Quando todos os itens saem e a fatura é excluída, a resposta deixa de ser 204 sem corpo e passa a ser 200 só com reprocessed_items.
  • A documentação das ações sobre os itens da fatura passa a dizer o que acontece com o id do item que é somado a outro igual, em Alterar conferido ou centro de custo de item da fatura: ele deixa de existir, e os id que valem são os de items da resposta. Nada muda no comportamento dessas ações.
  • Atenção, mudança no contrato: quando a ação tira o último item e a fatura é excluída, o reenvio com a mesma Idempotency-Key passa a repetir a resposta original, com X-Idempotent-Replay: true, em vez de 404. Vale para Remover itens da fatura ou recalcular o vencimento e para Faturar avulso os itens da fatura. Uma chave nova na fatura excluída continua respondendo 404.

2026-11-09

Vendas: Devolução Conta a Pagar nos pagamentos

  • Novo campo overpayment_return no Outros da agência (payments[].agency.others), em Inserir venda e na inclusão de pagamento por Alterar venda: com true, o pagamento é a Devolução › Gerar Conta a Pagar do Monde, que devolve ao cliente o que ele pagou a mais. Só é aceita com algum produto de saldo do cliente negativo antes dela. O amount de cada produto vai com o sinal do saldo do cliente nele (negativo no de saldo negativo, positivo nos outros), e o sinal que não bate é recusado com 422. Grava um lançamento em aberto, de débito quando a soma é negativa, com as categorias de pagamento e de recebimento do cliente. Não aceita description nem details. Vale também na operadora. Pede a mesma permissão de editar vendas.

Exclusões com confirmação passam a ser POST de ação

2026-11-06

Vendas: Faturar e Devolução Faturar como ações da venda

  • Novo endpoint Faturar, o Faturar da aba Financeiro da venda no Monde: o pagante (payer_id, ou o da venda), o centro de custo e o valor de cada produto, com o sinal do saldo do cliente dele. Responde 202: os itens a faturar ficam gravados, e a fatura automática os leva à fatura de cliente logo depois.
  • Novo endpoint Devolução Faturar, o Devolução › Faturar do Monde: o valor que a agência devolve ao cliente pela fatura de cliente, com descrição. Só é aceita quando algum produto tem saldo do cliente negativo.
  • Novo endpoint Remover linha do Faturar, o Excluir da grade de pagamentos do Monde: remove a linha inteira da fatura de cliente, e o saldo do cliente volta. A venda fechada só com reopen_sale e a permissão "Reabrir venda"; a fatura liquidada só com remove_settlement; a fatura fechada, reaberta antes.
  • Os três pedem a permissão de editar vendas na empresa da venda, e na venda com recibo impresso também "Alterar vendas com recibo impresso".
  • Atenção, mudança no contrato: payments[].agency.to_invoice sai da criação e da alteração da venda e passa a ser ignorado, como campo desconhecido. Na alteração, a lista payments não mantém nem remove o Faturar e a Devolução Faturar: eles só mudam pelos endpoints acima.
  • Atenção, mudança no contrato: payments.agency.to_invoice da consulta da venda é só leitura e muda de forma. Cada item é uma linha do Faturar que já entrou numa fatura de cliente, por fatura e centro de custo: bill, cost_center, amount (com o sinal; negativo é Devolução Faturar) e products (sale_product e amount). Saem id, due_date, description, payer, bills e o id dos produtos: o pagante e o vencimento são os da fatura. O Faturar que ainda não entrou em fatura não aparece. A Devolução Faturar, antes só referenciada pela fatura em payments.agency.bills, passa a aparecer na linha.

2026-11-05

Vendas: produto Visto

  • Novo produto Visto (visas[]) em Inserir venda, Alterar venda e Consultar venda por ID. É um produto do sistema, como a Excursão: não é preciso informar o produto, e ele passa a valer na primeira venda. Campos próprios: visa_type (tipo do visto, obrigatório, até 50 caracteres, como "Turismo") e destination_country (país do visto, obrigatório, código ISO 3166-1 alpha-2, como "US"; código fora do cadastro de países é recusado com 422).
  • Não há campo próprio para a taxa consular nem para a taxa de serviço: a taxa consular de cada solicitante vai em passengers[].fees, e a taxa de serviço da agência em agency_service_fee do produto.
  • O filtro kind de Consultar vendas e de Produtos passa a aceitar visa, e o kind dos produtos passa a trazer visa.

Faturas: composição dos itens e movimentações por período

  • Os itens da fatura, em Consultar conta a pagar ou receber por ID e nos itens que podem entrar na fatura, passam a trazer o lado do item (side: customer ou vendor), o tipo (kind), o documento do produto da venda (document), a emissão (issue_date) e a pessoa (person). Com eles, o pagamento de uma fatura de fornecedor se abre em cada venda: o que foi pago ao fornecedor e o que foi recebido do cliente.
  • Consultar movimentações passa a filtrar pela data da movimentação, com date_field=movement_date e date_from/date_to.

Faturas: consulta dos itens de todas as faturas

  • Novo endpoint Consultar itens das faturas: os itens das faturas e das contas a pagar e receber numa listagem só, cada um com o lançamento, a liquidação dele e a venda. Filtra por lançamento (bill_id), conta, pessoa, lado (side) e período (date_field = settlement_date, due_date ou issue_date). Com ele, a composição dos pagamentos do mês sai numa consulta, sem uma chamada por fatura. Pede a permissão "Visualizar" de contas a pagar e receber, já concedida a quem lê os lançamentos.

Contas a Pagar e Receber: rateio da fatura de cartão

  • Alterar conta a pagar ou receber passa a aceitar apportionments na fatura de cartão (credit_card_invoice), como a aba Rateios do Monde. O rateio divide o valor final da fatura, que é a soma das compras do cartão. As categorias continuam recusadas.
  • A fatura de cartão com rateio gravado no Monde deixa de ser recusada com rateio inválido ao ser alterada. Quando o valor da fatura muda depois do rateio, porque uma compra entrou ou saiu, a alteração seguinte responde 422 até o rateio ser reenviado, como no Monde.

Relatórios: Vendas por Vendedor

  • Novo endpoint Consultar vendas por vendedor, o relatório Vendas por Vendedor do Monde: uma linha por vendedor e empresa, com a quantidade de vendas e de produtos, os valores somados, a comissão, o over e as receitas. Pede o período da venda (date_from e date_to) e filtra também por situação da venda e do produto, vendedor e empresa.
  • Novas permissões da credencial, as do Monde, no recurso Vendas por Vendedor: "Vendas por Vendedor" (sales_by_sellers.read_all) e "Consultar vendas de outros vendedores/intermediários" (sales_by_sellers.read_from_other_sellers), desmarcadas nas credenciais que já existem.

2026-11-04

Limites de requisição: IPv6 contado por rede /64

  • Em IPv6, o limite de requisições passa a ser contado por rede /64, e não por endereço: todos os endereços da mesma rede /64 somam no mesmo limite. Em IPv4 nada muda.

Contas a Pagar e Receber: bloqueio de acréscimo e desconto na diferença

  • Na liquidação e em Inserir conta a pagar ou receber já liquidada, a diferença enviada com balance_resolution: category passa pelo bloqueio de acréscimo e desconto da empresa, como no Monde. Acima do limite, o pedido é recusado com 422.

Relatórios: Vendas por Produto

  • Novo endpoint Consultar vendas por produto, o relatório Vendas por Produto do Monde: uma linha por produto vendido, com as pessoas da venda, os detalhes, os valores e a comissão do produto, os passageiros, as notas fiscais, os trechos aéreos e os campos personalizados. Filtra por data, situação da venda e do produto, vendedor, produto, fornecedor ou representante, operação própria e empresa.
  • Novas permissões da credencial, as do Monde, no recurso Vendas por Produto: "Vendas por Produto" (sales_by_products.read_all), "Consultar vendas de outros vendedores/intermediários" (sales_by_products.read_from_other_sellers) e "Visualizar comissão, over e receitas" (sales_by_products.view_commission_columns), desmarcadas nas credenciais que já existem.
  • Os relatórios passam a ficar juntos, na seção Relatórios. A Lista de Passageiros saiu da seção própria e entrou nela; o endpoint não mudou.

Relatórios e Gerar Notas Fiscais: sem o filtro de texto livre

Conciliação bancária: confirmação só quando a alteração a desfaz

  • Em Alterar conta a pagar ou receber e Alterar transferência, undo_bank_reconciliation passa a ser exigido só quando a alteração muda o valor, a data ou a conta de uma movimentação conciliada, como o aviso do Monde. A alteração que não mexe nas movimentações conciliadas (categorias, rateios, descrição e demais dados) é gravada sem a confirmação e mantém a conciliação. Quem já envia a confirmação continua gravando como antes.

Vendas

  • Mudança no contrato: em Inserir venda e Alterar venda, o external_id deixou de ser aceito nos produtos da venda e nos products[] dos pagamentos. O produto identifica-se só por local_id (obrigatório, até 50 caracteres e único na venda), e o pagamento aponta o produto por sale_product_local_id ou sale_product_id. O produto sem local_id e o item de pagamento sem referência ao produto são recusados com 422.

Contas a Pagar e Receber: fatura de cartão de crédito

2026-11-03

Guias: blocos no conteúdo

  • O details dos guias aceita três blocos: caixa de destaque, seção com imagem de fundo e duas colunas, como <div data-block>. O formato está na descrição do campo. Nos orçamentos, nada muda.

Guias: capa e subtítulo opcional

  • Os guias passam a devolver a capa do link público: cover_kind (default, image ou color), cover_color, hide_cover_text e cover_image_url.
  • Criar guia e Alterar guia aceitam cover_kind, cover_color e hide_cover_text. A imagem da capa só se escolhe pelo Monde Web.
  • O subtitle deixa de ser obrigatório. Na alteração, enviado como nulo, tira o subtítulo. Nada muda para quem já envia o subtítulo.

Vendas: campos adicionais do produto

  • Todo produto da venda passa a aceitar e devolver os três campos adicionais que o Monde mostra na tela do produto: external_number, additional1 e additional2, com até 20 caracteres cada. Cada agência dá a esses campos o título que quiser (por exemplo, "Nº Pedido").
  • Novo endpoint Consultar campos adicionais do produto, que diz o título de cada campo. Pede a permissão de consultar vendas.
  • O campo sem título não aparece no Monde: a API ignora o valor enviado nele e não o devolve na consulta.

Lista de Passageiros

  • Novo endpoint Consultar lista de passageiros, o relatório Lista de Passageiros do Monde: uma linha por passageiro de produto vendido, com contato, documentos, endereço, os trechos aéreos com o assento do passageiro, os detalhes e os valores do produto, as pessoas da venda e os campos personalizados. Filtra por data, situação da venda, pessoas, produto, fornecedor, representante, cidade, marcador, empresa e texto livre.
  • Novas permissões da credencial, as do Monde, no recurso Lista de Passageiros: "Lista de Passageiros" (passenger_lists.read_all) e "Consultar passageiros de outros vendedores/intermediários" (passenger_lists.read_from_other_sellers), desmarcadas nas credenciais que já existem.

Planos de Comissão: novas partes da receita no calculated_on

  • Nos planos de comissão, o calculated_on pode trazer customer_refund, vendor_refund, agency_card_rate, supplier_fine e deleted_balance, quando o plano é calculado sobre esses valores.

Contas a Pagar e Receber: liquidação em lote

  • Novo endpoint Liquidar contas a pagar e receber em lote, que liquida até 100 lançamentos numa chamada, cada um pelo valor final, na mesma data e na mesma conta, como a liquidação dos lançamentos marcados no Monde. Vai tudo ou nada. Com use_sale_data, cada pagamento da venda leva a forma e os dados de cheque ou cartão da própria venda.
  • Pede, em cada lançamento, as mesmas permissões da liquidação de um lançamento. Nada muda para as credenciais que já liquidam.

Moedas: só ativar e desativar, em todas as agências

  • Alterar moeda só ativa ou desativa a moeda, em todas as agências: código, descrição e símbolo não mudam (422). Antes, isso valia só com multimoedas.
  • Excluir moeda passa a responder sempre 409: desative a moeda que você não usa.

2026-10-30

Remoção: configuração do sistema, administração e processos internos

  • Atenção: a API v3 deixa de oferecer o que não cabe numa API de integração. As rotas abaixo passam a responder 404:
    • Configurações: todo o /settings (as abas, e-mail, e-Notas e o certificado, Bloqueios, Segurança, CVC, licenças, configurações de orçamento e de roteiro e o cadastro da empresa em /settings/company, que o Alterar pessoa já cobre) e o /payment_method_details.
    • Integrações: a inclusão, a alteração e a exclusão em /integrations, o /integration_vendors, os vínculos de produto e de pessoa, o /integration_credentials e o /supplier_authorizations. A consulta das integrações continua.
    • Regras da nota fiscal e de faturamento: a inclusão, a alteração e a exclusão. A consulta continua.
    • Campos personalizados: a inclusão e a alteração das definições. A consulta continua, e o valor do campo segue informado na venda, na pessoa e no lançamento.
    • Conciliação bancária: o casamento, as linhas com os candidatos e os vínculos, e a conferência. O envio do extrato OFX, a lista, o detalhe e o descarte continuam.
    • Comissões: /commissions, /commission_closings e /commission_payments, e a inclusão, a alteração e a exclusão de planos de comissão. A consulta dos planos continua.
    • CVC: em /cvc_statements e /cvc_master_statements, tudo menos a lista e o detalhe; e os fechamentos de extrato, o /cvc_imports e o /cvc_deposit_checks.
  • As permissões da credencial que só serviam a essas rotas deixam de ser oferecidas. A credencial que já as tem continua valendo para o resto, e salvar a credencial no Monde as retira.

Contas a Pagar e Receber: moeda do lançamento

  • Em Incluir conta a pagar ou receber, o lançamento passa a aceitar a moeda (currency), entre as ativas, quando o Monde trabalha com mais de uma: na operadora ou com multimoedas. Omitida, continua em real. As movimentações da liquidação feita na criação passam a aceitar exchange_rate e reference_exchange_rate, como a liquidação.
  • A leitura e a lista de lançamentos passam a trazer a moeda (currency).

Notas Fiscais: PDF da NFS-e

  • Novo endpoint Baixar PDF da NFS-e, que redireciona para o PDF da nota emitida ou cancelada no e-Notas, como o Monde o abre.

Contas a Pagar e Receber: movimentação nova na edição e anexo renomeado

  • Em Alterar conta a pagar ou receber, o item de movements sem id passa a incluir uma movimentação nova no lançamento liquidado, como o Adicionar do Monde, com as parcelas (installments) na conta cartão de crédito. Antes, toda movimentação precisava do id.
  • Novo endpoint Renomear anexo, com a permissão de anexar do cadastro dono.

Contas a Pagar e Receber: boleto e conta de cobrança

  • Em Incluir conta a pagar ou receber e Alterar conta a pagar ou receber, a conta a receber passa a aceitar a conta de cobrança (billing_account_id) e o demonstrativo do boleto (billet_demonstrative), como a aba Boleto do Monde. Na fatura de cliente aberta, a conta de cobrança responde 409 até o pedido trazer close_invoice como true, que fecha a fatura junto.
  • Novos endpoints: Gerar boleto de conta a receber, que emite o boleto e devolve a linha digitável, o código de barras e, no PJBank, o Pix (na fatura de cliente aberta, com close_invoice como true, que a fecha antes, como o Monde), e Baixar o PDF do boleto.
  • Novas permissões da credencial, as do Monde: "Imprimir boleto" (sales.print_billet) e "Gerar boletos" (bills.generate_billet), desmarcadas nas credenciais que já existem.

Contas a Pagar e Receber: fechar e reabrir a fatura de cliente

  • Novos endpoints, como os botões Fechar Fatura e Reabrir Fatura do Monde: Fechar fatura de cliente e Reabrir fatura de cliente.
  • Novas permissões da credencial, as do Monde: "Fechar Fatura" (bills.close_invoice) e "Reabrir Fatura" (bills.reopen_invoice), desmarcadas nas credenciais que já existem.

Contas a Pagar e Receber: ações sobre os itens da fatura

Contas a Pagar e Receber: liquidar o avulso da venda e a comissão

  • Em Liquidar conta a pagar ou receber e Desfazer a liquidação, o avulso da venda (sale_standalone) e a comissão (commission) passam a ser liquidados e reabertos como o lançamento avulso, como no Monde. Antes, respondiam 409. As permissões são as mesmas do avulso.
  • O avulso da venda pede a forma de pagamento: os dados de pagamento da venda valem só para o pagamento da venda. No pagamento parcial, o saldo fica num lançamento novo do mesmo tipo, preso à mesma venda no avulso; na comissão, as comissões pagas continuam no lançamento original.
  • A conciliação bancária passa a oferecer e a liquidar os dois tipos.

2026-10-29

Vendas: documento do passageiro de hospedagem, cruzeiro e locação

  • Em Consultar venda por ID, o passageiro de hotels, cruises e car_rentals passa a trazer o document, a identificação do passageiro no produto, como o número do quarto ou da cabine.
  • Em Inserir venda e Alterar venda, esses passageiros passam a aceitar o document (até 30 caracteres). Antes ele era descartado. Atenção: na alteração, o passageiro enviado sem document fica sem ele, como nos demais produtos; reenvie o valor lido para mantê-lo.

Inclusões e alterações: o texto vazio é um valor de texto

  • Em toda inclusão (POST) e alteração (PATCH), o texto vazio ("") passa a seguir uma regra só: no campo de texto, é gravado como foi enviado; no campo de texto obrigatório, é recusado (422); em campo de outro tipo (objeto, lista, número, booleano, data, opção ou referência por id), é recusado (422). Para retirar um valor na alteração, envie null. A regra está na introdução desta documentação.
  • Atenção: antes, o "" variava por endpoint. Na inclusão, valia como campo não enviado. Na alteração, conforme o campo, limpava o valor como o null, era ignorado (inclusive objetos e listas, como seller e payer da venda, que respondiam 200 sem mudar nada) ou deixava o valor como estava. A integração que envia "" esperando que nada aconteça passa a gravar o texto vazio ou a receber 422.

Pessoas: documento inválido na alteração

  • Alterar pessoa passou a devolver 422 no campo cpf_cnpj quando o CPF/CNPJ gravado na pessoa não é válido, qualquer que seja o campo alterado, como no Monde, que confere o documento a cada gravação. Para destravar, envie o cpf_cnpj corrigido, ou nulo para retirá-lo. Antes, a alteração estourava erro interno (500).

Vendas: pagamento avulso e sinal ao fornecedor

  • Novo endpoint Gerar pagamento avulso ou sinal ao fornecedor da venda: gera a fatura do pagamento avulso (advance) ou do sinal (deposit) com os itens do fornecedor em aberto de financial.vendor_items, cada um com o valor a gerar, como o Gerar Pagamento Avulso ou Sinal e o Sinal Fornecedor do Monde. O valor menor que o do item divide o item, e a sobra fica em aberto. Responde 201 com a fatura gerada. Pede a permissão de editar vendas, "Ver aba financeiro" (menos no deposit com product_id, o Sinal Fornecedor do produto) e "Gerar Fatura" quando a fatura automática do fornecedor está desligada ou a venda é da CVC.
  • Nova permissão "Gerar Fatura" (bills.generate_supplier_invoice) na credencial.

Vendas: itens do fornecedor

  • Em Consultar venda por ID, novo campo financial.vendor_items: os itens do fornecedor da venda, como na aba Financeiro do Monde, cada um com id, kind, description, due_date, amount, currency, o produto (sale_product), o fornecedor ou representante (person), o lançamento em que está (bill) e o pagamento direto ao fornecedor que o quita (payment). Vem com "Ver aba financeiro", como o resto de financial.
  • Novo endpoint Alterar item do fornecedor da venda: muda o vencimento e a descrição do item que ainda não está num lançamento nem foi pago direto, como o Editar do item no Monde, e responde com a venda inteira. O item num lançamento, pago direto ou de crédito gerado, e a venda excluída, respondem 409; vencimento nulo ou vazio responde 422. Pede a permissão de editar vendas e "Ver aba financeiro".

Contas a Pagar e Receber: conta a pagar ou a receber da venda

  • Em Inserir conta a pagar ou receber, novo campo sale_id: lança a conta a pagar ou a receber na venda, como o botão da aba Financeiro da venda no Monde. O lançamento nasce como avulso da venda (kind igual a sale_standalone), na empresa dela, e aparece em financial.standalone_bills de Consultar venda por ID. Com sale_id, o company_identifier pode ser omitido e, enviado, precisa ser o CNPJ da empresa da venda. Exige também a permissão "Ver aba financeiro" de vendas, na empresa da venda. A venda fechada aceita o lançamento, e a excluída responde 409. operation_id e recurrence_kind são recusados com 422 no lançamento da venda, e sem account_id ele fica sem conta prevista, como no Monde.
  • Na descrição de Alterar, Excluir e Liquidar conta a pagar ou receber, os tipos de lançamento passam a aparecer com os valores que o kind traz: sale_standalone, vendor_standalone e customer_invoice. A API não mudou.

Tarefas: anexos no comentário

  • Em Comentar na tarefa, novo campo attachment_ids: os anexos já enviados à tarefa em Enviar anexo ficam ligados ao comentário e aparecem dentro dele no Monde. Com anexos, o texto é opcional. O anexo de outra tarefa, excluído ou já ligado a outro comentário responde 422. Pede a mesma permissão de comentar.
  • Em Consultar tarefa por ID, cada item de history passa a trazer os anexos dele em attachments. Atenção: o text do comentário com anexo feito no Monde passa a vir sem a marcação (att:<id>) que o Monde guarda no lugar do arquivo.

Contas e Cartões: próximo número de boleto

  • Em Consultar conta ou cartão por ID, novo campo next_bank_slip_number: o número do próximo boleto que a conta corrente emitir. Vem nulo nas demais contas.
  • Em Alterar conta ou cartão, o mesmo campo muda a numeração dos boletos da conta corrente, como o botão Alterar do cadastro de conta do Monde, e a mudança entra no log da conta. A numeração só anda para a frente: o número menor que o atual, ou que não seja maior que o último boleto emitido, responde 422. Nas demais contas, o campo é ignorado. Pede a permissão Editar de Contas e Cartões.

Regras de Faturamento: recalcular os vencimentos em aberto

  • Em Alterar regra de faturamento, novo campo recalculate_open_invoices. Com true, depois de gravar a alteração, os vencimentos das faturas em aberto que caem nas regras da pessoa são recalculados em segundo plano, como no botão Recalcular vencimentos do Monde. Omitido ou false, nada muda: só a regra é gravada. Valor que não é booleano responde 422.

Grupos de Categorias: excluir o grupo com as categorias

  • Excluir grupo de categorias passa a excluir o grupo com categorias junto com as categorias dele, como no Monde, quando o pedido confirma com delete_categories: true. Sem a confirmação, a resposta continua 409. Se alguma categoria for usada em lançamento financeiro ou numa configuração do Monde, nada é excluído (409). Valor que não seja true ou false responde 422.
  • Excluir categoria passa a excluir também o grupo que fica sem categorias, como no Monde.

Vendas: o passageiro é a pessoa no produto

  • Em Alterar venda, a lista passengers de um produto passa a alterar o mesmo passageiro, como no Monde, em vez de apagar e recriar a lista. O passageiro é identificado pela pessoa: a que já é passageiro ativo tem o mesmo passageiro alterado, a nova entra e o ativo que não vier sai.
  • O passageiro cancelado fica, venha ou não na lista. Reenviado igual ao lido, nada muda; antes, ele voltava como um passageiro ativo novo e era cobrado de novo. Com algum valor diferente, a resposta é 422: o cancelado só muda pela reativação. A lista com só passageiros cancelados também responde 422.
  • Em Inserir venda e Alterar venda, a mesma pessoa duas vezes nos passageiros de um produto passa a responder 422. Atenção: antes ela entrava duas vezes.
  • O passageiro passa a aceitar a pessoa já cadastrada só pelo person.id, como a consulta da venda devolve, além dos dados da pessoa com o external_id. A pessoa apontada pelo id não é alterada, e o id exige a permissão de ler pessoas; sem ela, ou com uma pessoa jurídica, a resposta é 422.

2026-10-28

Vendas: alterar um pagamento da venda

  • Em Alterar venda, o pagamento enviado com o id e a forma com que ele foi incluído passa a ser alterado, como no Monde, em vez de ser recusado. Mudam o pagante, o vencimento, a descrição e os dados da forma (cartão, cheque, details, observations e o cost_center do Faturar), e só o que foi enviado; o id do pagamento continua o mesmo.
  • O valor e a forma não mudam: products, a conta e a liquidação na alteração são recusados com 422, e outra forma também. Para mudá-los, retire o pagamento da lista e inclua um novo, como antes.
  • As travas são as do Monde: o pagamento liquidado ou faturado não se altera (422), e a venda fechada só se altera reaberta (409). O Retido pelo Intermediário não se altera por aqui (422).

Notas Fiscais: dados originais da CVC

  • Em Consultar notas fiscais e Consultar nota fiscal por ID, novo campo cvc_original_data, só de leitura: os dados originais da nota importada do arquivo da CVC, que o Monde mostra na aba CVC da nota fiscal. Vem nulo quando a nota não veio desse arquivo. Vem também em toda resposta que traz a nota, como as gravações em /nfs e a geração de notas, e pede a mesma permissão de ler notas fiscais.

Vendas: Dinheiro, Cheque e Outros

  • Novas formas de pagamento em Inserir venda e na inclusão de pagamento por Alterar venda, como no Monde: em agency, cash (Dinheiro), check (Cheque) e others (Outros); em vendor, check (Cheque direto ao fornecedor). Cada pagamento em cheque é um cheque, com check_number obrigatório, bank_code e o CPF/CNPJ em document.
  • Dinheiro e Cheque geram o lançamento na conta de Dinheiro ou de Cheque das configurações de Vendas, que não vem no payload, e seguem a liquidação automática configurada ali. O Outros gera um lançamento em aberto, sem conta, com details nas observações. O Cheque direto ao fornecedor não gera lançamento.
  • O vencimento das quatro formas não pode ser anterior à data da venda. Nenhuma delas é aceita na operadora (422), como no Monde.

Anexos: viagens, tarefas e exclusão

  • Enviar anexo passa a aceitar resource_type travel (viagem) e task (tarefa). Como no Monde, anexar pede Adicionar anexos e a permissão de editar a viagem ou a tarefa, na empresa dela.
  • Novo endpoint Excluir anexo, para os anexos de vendas, contas a pagar e receber, pessoas, viagens e tarefas: o anexo vai para a lixeira do registro, de onde é restaurado no Monde. Como no Monde, pede só Excluir anexos do recurso, com o mesmo alcance de anexar.
  • Novas permissões Adicionar anexos em Viagens e em Tarefas e Excluir anexos em Vendas, Contas a Pagar e Receber, Pessoas, Viagens e Tarefas, as do Monde. A credencial alcança a viagem e a tarefa que criou; as demais pedem Consultar vendas de outros vendedores/intermediários (viagem) ou Ver tarefas de outros usuários (tarefa). As credenciais existentes não as recebem: é preciso marcá-las.

Planos de Comissão e Metas

  • Novo recurso Planos de Comissão, com consulta, cadastro, alteração (PATCH) e exclusão, e as regras do cadastro de planos do Monde. O plano traz as faixas da meta atingida, os produtos de cada faixa e os valores de cada função. Na alteração, como no Monde, só muda o que foi enviado: a faixa, o produto e a regra com id continuam os mesmos, os sem id entram e os que ficaram fora da lista saem. O plano em uso por alguém numa função não é excluído (409).
  • Novo recurso Metas, só de consulta. Como no Monde, a meta é gravada pela função: a lista goals de cada pessoa em people de Funções, com a permissão Editar de Funções. A consulta de funções passa a trazer as metas de cada pessoa.
  • Os dois recursos são só da agência: na instalação de operadora, respondem 403.
  • Novos recursos de permissão Planos de Comissão (Visualizar, Editar e Excluir, do Monde) e Metas (Visualizar). Pela conexão automática, gravar e excluir planos de comissão é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: o plano vale para a agência inteira.

Webhooks

  • Novos eventos no catálogo de Webhooks: changed e deleted de navios, cabines, categorias de tarefa e categorias financeiras; currencies.changed (a moeda só avisa a alteração); a tarefa vencida (tasks.overdue); e a importação concluída (integrations.import_completed e cvc_statements.import_completed).

Integrações: campo não documentado é ignorado

  • Mudança de comportamento: na gravação de Integrações (integração e vínculos de produto e de pessoa) e de Credenciais de Integração, o campo que o endpoint não documenta passa a ser ignorado, como no resto da API. Antes a gravação era recusada com 422. Na alteração, o vendor_id da integração e o user_id e o integration_id da credencial, que não mudam depois do cadastro, também são ignorados.

2026-10-27

Configurações: Bloqueios, Segurança e CVC

  • Novo endpoint /settings/payment_blocks, para consultar e alterar os Bloqueios de Contas a Pagar e Receber (acréscimo e desconto, dias de movimentação e de vencimento), com a permissão Configurar bloqueios, a mesma do Monde, que a permissão da aba Contas a Pagar e Receber não abre. Toda alteração fica no log da empresa, campo a campo.
  • Novos endpoints para as abas que no Monde só o administrador abre, só para consulta e com permissão própria da API: /settings/security, que diz se o Monde pede o código por e-mail ao entrar num computador novo (Configurações - Segurança); e /settings/cvc, com os recursos da CVC e o FTP dos extratos, sem a senha (só ftp_password_configured), cuja alteração é sempre recusada (409), porque no Monde só quem tem acesso total altera a aba CVC (Configurações - CVC).
  • Como as demais permissões de Configurações, estas não são oferecidas na Conexão automática.

Vendas: o updated_since considera as partes da venda

  • Em Consultar vendas, o filtro updated_since passa a trazer a venda também quando muda uma parte dela, e não só o cabeçalho: produtos, passageiros, trechos e assentos, comissões, anexos, pagamentos e a inclusão, o cancelamento ou a exclusão das contas vinculadas. Vale para a alteração feita pelo Monde, pela API e por qualquer outro meio. A liquidação de uma conta só traz a venda quando muda a taxa cartão agência dos produtos ou quando é parcial e gera a conta do saldo. Atenção: a sincronização passa a receber vendas que antes ficavam de fora.
  • Recomendação nova no filtro: guardar o instante em que a consulta começou, antes da primeira página, partir dele na consulta seguinte com uma folga de alguns minutos para trás e regravar cada venda pelo id. Para acompanhar também as exclusões, enviar status=opened,closed,canceled junto.

Notas Fiscais

  • Novos endpoints Inserir nota fiscal avulsa, Editar nota fiscal avulsa e Excluir nota fiscal, com as regras da tela de Notas Fiscais. O tomador é a pessoa do cadastro (person_id) ou os dados informados em recipient; o valor é a soma dos itens, e os tributos são calculados na gravação. Só a nota não emitida é editada ou excluída (409 nas demais). Na edição, a lista items enviada é a final: o item com id permanece, o sem id entra e o que não veio sai. Cada item novo pode trazer um local_id, devolvido na resposta ao lado do id gerado.
  • Novas ações sobre a nota: Emitir NFS-e, assíncrona (responde 202 com a nota aguardando emissão; o andamento se acompanha pela consulta da nota por ID), Cancelar (202 quando o cancelamento vai à prefeitura pelo e-Notas), Informar emissão manual, Ajustar valor, Remover numeração, Criar cópia para reemissão e Baixar XML da NFS-e. A data de emissão se troca pela edição.
  • Novas permissões em Notas Fiscais, as do Monde: Editar (gravação, emissão manual, ajuste de valor, numeração e cancelamento só no Monde), Excluir, Emitir NFS-e (emissão e cancelamento pelo e-Notas) e Criar cópia para reemissão. Pela conexão automática, elas são exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: a nota vale para a agência inteira. Baixar o XML pede só a de ler. Na instalação de operadora (consolidadora), onde as notas fiscais não existem, a gravação responde 403.
  • A consulta da nota por ID passa a trazer o id de cada item, usado para manter o item na edição.
  • Na edição de uma nota ligada a uma pessoa do cadastro, recipient só vale com person_id enviado como null, a escolha explícita do tomador digitado, como no Monde; sem isso, ele é ignorado, e reenviar o corpo lido não desliga a pessoa.
  • A nota inserida, copiada ou cancelada pela API não grava a pessoa da credencial em created_by nem em canceled_by: quem gravou é a credencial, registrada no log.

Gerar Notas Fiscais

  • Novo recurso Gerar Notas Fiscais, o mesmo da tela Gerar Notas Fiscais do Monde: Consultar as notas a gerar mostra, para cada produto de venda fechada, as notas que as regras de nota fiscal montam, e Gerar notas fiscais grava as escolhidas, todas ou nenhuma. O pedido aceita só os produtos que a consulta mostraria.
  • A credencial ganhou a permissão Gerar Notas Fiscais (nf_generations.access), a mesma do Monde, que consulta e gera. Como no Monde, ela alcança as vendas que a própria credencial criou; as dos demais vendedores pedem também Consultar vendas de outros vendedores/intermediários em Vendas.
  • Na Conexão automática, Gerar Notas Fiscais é exceção: o parceiro só a recebe com o motivo informado na aprovação, mostrado em destaque no consentimento.

Regras da Nota Fiscal

  • Novos endpoints Criar regra da nota fiscal, Alterar regra da nota fiscal e Excluir regra da nota fiscal, com as regras do cadastro do Monde. O corpo segue o formato da consulta: product, payer, supplier e representative por { "id": ... }, representative_scope, e as notas de cada destinatário em payer_rule, supplier_rule e representative_rule, com recipient, revenues e discounts. A alteração só muda o que foi enviado, e a lista enviada é a lista final. A mesma aplicação só tem uma regra e o mesmo valor só entra na nota de um destinatário (422). A base de operadora, que não tem o cadastro de regras, responde 403 à gravação.
  • Reenviar na alteração o que a consulta devolveu não responde 422: o valor que a regra já tem e que o destinatário não pode receber, gravado fora da tela, é aceito e sai da regra, como na tela.
  • A regra gravada pela API fica sem autor (created_by nulo); o log da regra diz qual credencial a gravou.
  • Informar produto ou pessoa na regra exige a permissão "Visualizar" de Produtos ou de Pessoas; sem ela, a resposta é a do id que não existe. O que a regra já usa pode ser reenviado sem essa permissão.
  • Novas permissões Editar e Excluir em Regras da Nota Fiscal, oferecidas na credencial da API. Na Conexão automática, as duas são exceção (acesso ampliado): a regra vale para a agência inteira.
  • Os campos de lista de valores simples, como revenues e discounts, recusam com 422 a lista enviada como texto ou objeto e o item que é lista ou objeto, como os demais campos.
  • Mudança no contrato: em Consultar regras da nota fiscal e Consultar regra da nota fiscal por ID, o representative_scope passa a vir como a tela do Monde abre a regra: a regra gravada sem a marca de representante e sem representante, que não alcança venda nenhuma, vem none (antes vinha any), e a que tem o representante escolhido vem specific mesmo sem a marca (antes podia vir none).

Regras de Faturamento

  • Regras de faturamento passam a ser gravadas pela API: Criar regra de faturamento, Alterar regra de faturamento e Excluir regra de faturamento. A regra informa o tipo e a pessoa dona (person_kind e person_id), e a gravação segue as mesmas regras da tela do Monde. Como no Monde, criar, alterar e tirar a regra de uma pessoa que tem outras exigem a permissão Editar de Regras de Faturamento; excluir a última regra da pessoa, que leva junto o cadastro de regras dela, exige Excluir. Na Conexão automática, gravar e excluir regras de faturamento é exceção concedida pelo Monde na aprovação, porque elas valem para a agência inteira.

Cadastros financeiros

  • Categorias: novos endpoints para inserir, alterar e excluir categorias. A categoria só troca para outro grupo do mesmo tipo, e a usada em lançamentos ou numa configuração do Monde não se exclui (409).
  • Novo recurso Grupos de Categorias, com consulta, inclusão, alteração e exclusão. O tipo do grupo (expense ou revenue) não muda depois da inclusão, e o grupo com categorias não se exclui (409). Usa as permissões de Categorias.
  • Centros de Custo: novos endpoints para inserir, alterar e excluir. O centro de custo usado no rateio de um lançamento não se exclui (409).
  • Formas de Pagamento: novos endpoints para inserir, alterar e excluir a forma de pagamento da agência. A forma do sistema não se altera nem se exclui (409), e a de uso interno responde 404.
  • Novo recurso Informações das Formas de Pagamento: os textos pré-cadastrados que o pagamento da venda copia, com consulta, inclusão, alteração e exclusão, e as permissões próprias do Monde: Editar, que também deixa consultar, e Excluir.
  • Novas permissões Editar e Excluir em Categorias, Centros de Custo, Formas de Pagamento e Informações das Formas de Pagamento, oferecidas na credencial da API. Na Conexão automática, gravar e excluir esses cadastros é exceção, porque eles valem para a agência inteira. Toda gravação exige Idempotency-Key, e o campo que o endpoint não documenta é ignorado, como no resto da API.

Fechamento de Comissões

  • Novo recurso Fechamento de Comissões, com o cálculo e as regras das telas Fechar Comissões e Pagar Comissões do Monde: Apurar comissões, Fechar comissões (com a comissão vista por pessoa: se ela mudou, o fechamento é recusado), consultar e excluir comissões fechadas, Pagar comissões e excluir o pagamento.
  • Novas permissões da credencial, as do Monde: Fechar Comissões (com Fechar comissões de Vendedores, de Intermediários e de Outras Funções) e Pagar Comissões (com Excluir). Pagar pede também o Editar de Contas a Pagar e Receber, e excluir o pagamento, o Excluir de Contas a Pagar e Receber.
  • Na Conexão automática, as permissões de Fechar Comissões e de Pagar Comissões são exceções: alcançam as comissões de todos os vendedores da agência e só são concedidas com o motivo.

Extrato CVC

  • O Extrato CVC passou a aceitar gravação, nas agências CVC: Lançar recibo (POST /cvc_statements), Alterar recibo (PATCH, o campo omitido permanece), Excluir recibo (exclusão lógica) e Restaurar recibo. As ações do recibo viraram sub-recursos: vincular e desvincular a venda pelo número do recibo, processar a baixa de OPFAX e fechar a venda. As permissões são as do Monde: lançar o recibo, vincular a venda, processar a OPFAX e fechar a venda pedem só a consulta do Extrato (as duas últimas, também a de fechar vendas); alterar pede as novas Editar registros ou Editar registros importados, e excluir, restaurar e desvincular a venda pedem Excluir, Restaurar e Desvincular Venda do Recibo, a empresa com os recursos para lojas CVC ligados e não existe em base de operadora.
  • Em Consultar extrato CVC por ID, o tipo do movimento (movement_kind) passou a trazer também o código da CVC (code), que é o que o lançamento informa em movement_kind_code.
  • Na Conexão automática, as permissões do Extrato CVC, inclusive a consulta, que lança recibos e vincula vendas, são exceção concedida pelo Monde na aprovação, e o modelo "Somente leitura" deixa a consulta de fora: o recibo não tem quem o criou (vem da importação ou do lançamento no Monde), e quem o grava alcança os que a agência cadastrou.

Master - Extrato CVC

  • Novo recurso Master - Extrato CVC, com os recibos de "Repasse Master Franqueado": consultar, consultar por ID, inserir, alterar, excluir e gerar a nota fiscal do recibo, com as regras do Master - Extrato do Monde. Vale só na empresa ligada como agência master franqueado, em Configurações › CVC.
  • Permissões, como no Monde: consultar e excluir pedem Visualizar e Excluir de Master - Extrato CVC, novas na credencial; incluir e alterar pedem também Editar registros de Extrato CVC (o recibo importado, Editar registros importados), e gerar a nota, Editar de Notas Fiscais, as três novas na credencial.
  • Na Conexão automática, todo o Master - Extrato CVC, inclusive a consulta, Editar registros e Editar registros importados de Extrato CVC e Editar de Notas Fiscais são exceção (acesso ampliado): esses registros valem para a agência inteira.

Fechamento de Extrato CVC

Conferência Depósito CVC

  • Novo recurso Conferência Depósito CVC, só leitura, como a tela Conferência Depósito do Monde: GET /cvc_deposit_checks e GET /cvc_deposit_checks/{id}, com o depósito de cada movimento do extrato ao lado do faturado, retido e recebido do cliente e do saldo. Filtros period_start, period_end e only_closed_sales (padrão true, como no Monde). Exige a nova permissão Conferência Depósito CVC.
  • Na Conexão automática, as permissões Fechamento de Extrato CVC, Master - Fechamento de Extrato CVC e Conferência Depósito CVC são acesso ampliado, inclusive para consultar: alcançam o extrato da agência inteira, e a Monde só as concede ao parceiro com o motivo.

Importação de Extratos CVC

Webhooks

  • Novo recurso Webhooks: cadastre um endereço https e receba um POST assinado (HMAC-SHA256) quando registros mudam: um aviso por evento, com até 100 ids e a empresa de cada um. Endpoints para listar, criar, consultar, alterar (PATCH) e excluir webhooks, o histórico das entregas (GET /webhooks/{webhook_id}/deliveries) e o catálogo de eventos (GET /webhook_events): changed (criado ou alterado) e deleted de cada recurso e os eventos de negócio da venda e da nota fiscal. Entrega com repetição e espera crescente, e desativação depois de falhas seguidas.
  • Nova permissão Webhooks (ler, criar e editar, excluir) na credencial da API.
  • A permissão Webhooks não é oferecida na Conexão automática: só a credencial criada pela própria agência pode recebê-la.

Integrações

  • Integrações passaram a ser gravadas pela API: Inserir integração, Alterar integração e Excluir integração, com as regras da tela de Integrações. Os campos adicionais de cada fornecedor vão em additional_fields, e a consulta por ID passou a trazê-los, com valor só no endereço do serviço e na identificação da agência; usuário, senha, token, chaves de API e PIN nunca são retornados (filled diz se estão preenchidos). A consulta passou a trazer também o vendor_id.
  • Novo Consultar fornecedores de integração, com o catálogo de fornecedores e os campos que cada um pede.
  • Novos vínculos de produto e de pessoa da integração, em /integrations/{integration_id}/product_links e /integrations/{integration_id}/person_links, com consulta, inclusão, alteração e exclusão. Como o vínculo vale para todas as integrações do fornecedor, gravar e excluir exigem a permissão de inserir e editar integrações em cada uma delas.
  • Novas permissões Editar e Excluir em Integrações, oferecidas na credencial da API.

Credenciais de Integração

  • Novo recurso Credenciais de Integração, com o login e a senha de cada usuário no fornecedor das integrações que autenticam por usuário: consulta, inclusão, alteração e exclusão. A senha nunca é retornada (password_filled diz se está preenchida). Ler exige a nova permissão Ver Aba Usuário em Pessoas, como a aba Usuário do cadastro de pessoa no Monde; incluir, alterar e excluir exigem também Editar em Pessoas.
  • As permissões Editar e Excluir em Integrações e Ver Aba Usuário em Pessoas não são oferecidas na Conexão automática: só a credencial criada pela própria agência pode recebê-las.

2026-10-26

Integrações de parceiros

Conexão automática

  • Nova forma de conectar: a agência inicia a conexão pela tela de Integrações do Monde, e o parceiro recebe cada conexão nova, já com o token, ao consultar POST /oauth/connections com o client_id e o client_secret. A resposta traz as conexões em data e o nó pagination da API. Cada conexão é entregue uma única vez e espera a consulta por 72 horas; depois disso, a integração é excluída na conta da agência. O parceiro só aparece para a agência depois de marcar Conexão iniciada pela agência na área do parceiro. Veja o passo 7 da Conexão automática.

Configurações

  • Novo recurso Configurações, com as abas da tela de Configurações do Monde por empresa: consulta e alteração em /settings/{tab} para Geral, Vendas, Recebimento, Contas a Pagar e Receber, Comissão, Metas, Fatura Cliente, Fatura Fornecedor, Notas Fiscais e Exportação Cartão Passagem. A alteração grava só os campos enviados, com as regras da tela, e fica no log da empresa. Cada aba pede a permissão do Monde para ela (como Configurações - Geral), que libera consultar e alterar a aba.
  • Novo endpoint /settings/email, para consultar e alterar o servidor e o remetente dos e-mails da empresa, com a permissão Configurações - E-mail (Geral) do Monde. A senha do servidor só se grava.
  • Novo endpoint /settings/company, para consultar e alterar o cadastro da empresa (nome, razão social, inscrições, contatos e endereço; o CNPJ não muda), e /settings/licenses, para consultar as licenças das empresas. Exigem a nova permissão Cadastro da Empresa e Licenças.
  • Novo endpoint /settings/enotas, para consultar e alterar a emissão de NFS-e pelo e-Notas da empresa (regime, alíquotas, série e RPS, ambiente de teste e o acesso à prefeitura), e /settings/enotas/certificate, para enviar o certificado digital em multipart. Usuário, senha, token e certificado só se gravam: a consulta diz apenas se estão configurados e o vencimento do certificado. Exige a permissão da aba Notas Fiscais, a configuração de NF do Monde.
  • As permissões das abas de Configurações e a de Cadastro da Empresa e Licenças não são oferecidas na Conexão automática: só a credencial criada pela própria agência pode recebê-las.

2026-10-24

Cidades: busca pelos outros nomes

  • O filtro name de Consultar cidades passa a achar a cidade também pelos outros nomes dela na lista de cidades do Monde: ?name=New York e ?name=Nova York acham Nova Iorque, ?name=Asunción acha Assunção. Acha também pelo início das palavras, pelo estado e pelo país, como o campo Cidade do Monde. O trecho em qualquer posição do nome continua achando.
  • Mudança no contrato: com o filtro name, a lista deixa de vir em ordem alfabética: a cidade cujo nome é o informado vem primeiro, depois a que tem esse nome entre os outros nomes, a que começa por ele, a que o contém e, por fim, as demais; em cada grupo, a maior primeiro. Sem o filtro, a ordem continua pelo nome. O cursor de uma busca só vale para o mesmo name.

2026-10-23

Mensagens de erro: posição do item na lista

  • Em Inserir venda, Alterar venda, Inserir pessoa, Alterar pessoa, Inserir tarefa e Alterar tarefa, o erro de um item de lista passa a trazer a posição do item na lista enviada, contada a partir de 0, em cada nível. Antes, O campo 'insurances passengers person name' é obrigatório não dizia de qual seguro nem de qual passageiro; agora vem O campo 'insurances[0] passengers[2] person name' é obrigatório. Vale para os produtos da venda, passengers, segments, seats, payments e os products deles, commissions, contacts, history e custom_fields. Dois itens com o mesmo erro passam a ter uma mensagem cada. Atenção: quem compara o texto da mensagem precisa considerar a posição.
  • O erro de formato de um campo de item de lista, em todas as rotas, também passa a trazer a posição: O campo 'movements[0] check' deve ser uma lista ou um objeto…. O item que não é objeto passa a ser apontado pela posição: O campo 'labels[1]' deve ser um objeto….
  • O erro geral de um item que é uma frase completa sai com o caminho do item antes: 'credit_cards[1]': Não é possível cadastrar um cartão vencido., no lugar de O campo 'credit_cards[1]' Não é possível…. Vale para credit_cards, cost_centers e kandir_law da pessoa.
  • Comissões: a venda que não fica fechada responde uma vez, na lista: O campo 'commissions' só pode ser enviado em venda fechada…, e não mais uma mensagem por comissão. A comissão de intermediário sem intermediário na venda responde O campo 'commissions[0]' é de intermediário, e a venda não tem intermediário informado.
  • O item nulo ou em branco dentro de uma lista ("contacts": [null] ou [""]) passa a responder 422. Antes ele era ignorado, e os itens seguintes mudavam de posição. A lista inteira enviada como null continua valendo como antes.

Cidades: consulta sem permissão

  • Consultar cidades e Consultar cidade por ID deixam de pedir a permissão de Cidades: toda credencial consulta. As cidades vêm da lista do Monde e não têm mais permissão no Monde.
  • As permissões de Cidades (consultar e consultar o histórico) deixam de ser oferecidas na credencial. A já gravada continua aceita, sem efeito. O histórico das cidades em Consultar logs fica só com a credencial que lê todo o histórico.

Pessoas: a cidade não é mais cadastrada

  • Em Inserir pessoa, Alterar pessoa e nas pessoas enviadas com a venda (Inserir venda e Alterar venda), a cidade do endereço e da naturalidade (birthplace) não é mais cadastrada. Sem o city_ibge, o city_name é procurado entre as cidades da agência e as da lista de cidades do Monde (Consultar cidades), sem diferenciar acento nem maiúscula: no Brasil, no estado do state_code; no exterior, no país do country_code.
  • A cidade do exterior enviada com state_code é procurada primeiro como "Nome, UF", a forma em que a API cadastrava essas cidades antes, e depois só pelo nome no país.
  • O nome que não corresponde a nenhuma cidade responde 422 em city_name, e nada é gravado. Antes, a cidade era cadastrada com o nome enviado.

Vendas: taxa do cartão da agência

  • Em Inserir venda e Alterar venda, o pagamento com cartão de crédito da agência (agency.credit_card) passa a lançar a taxa do cartão, como no Monde. Sem taxa no payload, vale a "Taxa cartão de crédito" das configurações de Vendas. Para enviar outra, use card_rate_percentage (%) ou card_rate (valor), um dos dois. A taxa é rateada no agency_card_rate dos produtos pagos e abate o valor final do lançamento na categoria de taxa de cartão da empresa. Sem essa categoria configurada, a taxa maior que zero responde 422. Atenção: quem já envia esse pagamento passa a ter a taxa padrão da empresa lançada quando ela estiver configurada; para manter o lançamento sem taxa, envie card_rate_percentage igual a 0.
  • Na alteração da venda, o pagamento retirado leva a taxa dele junto: o agency_card_rate dos produtos é refeito com os pagamentos que ficam.

Vendas

  • Novo endpoint Cancelar produto da venda, com as regras do cancelamento do Monde: cancela o produto inteiro ou parte dos passageiros, com as opções de excluir o saldo pendente do cliente, excluir o saldo em aberto do fornecedor com multa e manter o produto na meta dos planos de comissão. O cancelamento é sempre pela lista passengers, com a pessoa (person.id) e a data de cancelamento de cada passageiro; o produto fica cancelado quando a lista cancela os que faltavam. O produto sem passageiros é cancelado sem a lista, na data do dia. O produto cancelado continua somando no valor da venda. Exige, na empresa da venda, a permissão de editar vendas e a permissão "Cancelar produto", nova na credencial, como no Monde; a credencial existente começa sem ela.
  • Novo endpoint Reativar produto da venda, que desfaz o cancelamento do produto inteiro ou só de parte dos passageiros, como o descancelamento do Monde, pela lista passengers com a pessoa de cada passageiro que volta. Reativando todos os passageiros cancelados, devolve ao financeiro o que o cancelamento tinha excluído; reativando só parte, a multa e o saldo excluído ficam. Com a fatura automática do fornecedor, responde 409 enquanto a multa do cancelamento ainda está sendo lançada na fatura: repita em alguns segundos. Exige as mesmas permissões do cancelamento.
  • Em Alterar venda, a lista de passageiros vazia (ou nula) num produto em que o passageiro não é obrigatório e que tem passageiro cancelado passa a responder 422: ela tiraria todos os passageiros ativos e deixaria o produto ativo só com passageiros cancelados. Envie ao menos um passageiro ativo, ou cancele os passageiros pelo cancelamento do produto.
  • Na agência, o valor a faturar ao fornecedor do produto, em Inserir venda e Alterar venda passa a ter a mesma conta do Monde, que é também a do descancelamento: os produtos, as taxas e as taxas de cartão da DU e da RAV, menos a comissão, o over e os abatimentos. Antes o over, os abatimentos e a taxa de cartão da DU ficavam de fora. As vendas já criadas pela API não mudam sozinhas: na alteração, entra na fatura só a diferença do que mudou, e a troca de fornecedor recalcula o valor inteiro.
  • Listar vendas ganha o filtro kind, pelo tipo de produto: a venda entra quando tem algum produto não excluído de um dos tipos informados.
  • A passagem aérea (airline_tickets) passa a aceitar observations na criação e na alteração, e passa a recusar com 422 o destino cruise: como no Monde, ela é national ou international. A passagem que a API gravou antes com cruise continua vindo assim na consulta e só é alterada com o destino trocado para national ou international: o cruise é recusado também quando o destino é omitido.
  • Mudança de valor: na agência, Alterar venda passa a manter fora do total do cliente, do valor total, do faturamento e da base da comissão os abatimentos que o produto já tinha no Monde, como o Monde faz. Antes, a alteração pela API recalculava o produto como se ele não tivesse abatimento, e o total subia.
  • Mudança de valor: Inserir venda e Alterar venda passam a reter a Lei Kandir (IR, CSLL, PIS e COFINS) e, na passagem aérea, o ISS quando o pagante tem retenção cadastrada para o produto, como o Monde: o retido sai do valor total do produto e vira um lançamento a receber do fornecedor. Exemplo: seguro de R$ 1.000,00 para um pagante com 4,65% de retenção sai com valor total de R$ 953,50 e R$ 46,50 a receber do fornecedor; antes, saía com R$ 1.000,00 e sem o lançamento. A troca do pagante refaz a retenção de todos os produtos da venda, e a alteração de um produto que já tinha retenção deixa de devolver o retido ao valor total.
  • Na operadora (consolidadora), Inserir venda e Alterar venda passam a gravar o promotor da venda (promoter) como o Monde: é o promotor do cadastro do intermediário, copiado quando a venda é criada e a cada troca de intermediário. O promotor não é enviado no payload.
  • Novo campo reservation_due_date (data de vencimento da reserva) nos produtos da venda, exclusivo da operadora: gravado em Inserir venda e Alterar venda e devolvido na consulta. Na agência, é recusado com 422 e vem nulo na consulta.
  • Na operadora, a operação própria (operation e operation_id) passa a ser recusada com 422, como no Monde, em que ela é exclusiva da agência.
  • Na operadora, o aprovador (approver) enviado com valor em Inserir venda e Alterar venda passa a ser recusado com 422, como no Monde, em que a venda da operadora não tem aprovador. Enviado como null na alteração, ele é retirado da venda.
  • Inserir venda e Alterar venda passam a aceitar três formas de pagamento à agência sem lançamento: agency.credit (Crédito na Agência), agency.to_invoice (Faturar, com vencimento, centro de custo e descrição, que entra na fatura de cliente pela fatura automática) e agency.retained_by_intermediary (Retido pelo Intermediário, só na agência e em venda com intermediário). O Crédito na Agência e o Retido pelo Intermediário respondem 422 na operadora. Sem payer, o Faturar fica no pagante da venda, também na operadora, como no Monde.
  • Com o controle de crédito do Monde ativo, o Crédito na Agência e o Crédito no Fornecedor (vendor.credit) passam a conferir o saldo do pagante, somando os pagamentos com crédito da requisição, e a consumi-lo ao gravar a venda; sem saldo suficiente, a resposta é 422 com o saldo disponível. Retirados da venda na alteração, o crédito usado volta ao pagante. Como no Monde, o Crédito no Fornecedor usa, para o valor todo do pagamento, o saldo de um fornecedor e representante só: os do primeiro produto do pagamento, por ordem alfabética do representante e, depois, do fornecedor, mesmo quando o pagamento paga também produtos de outro fornecedor.
  • A alteração da venda passa a retirar o Crédito na Agência que fica de fora de payments, devolvendo o crédito usado. Antes, ele só saía pelo Monde.
  • Mudança no contrato: na consulta da venda, o Faturar sai na nova lista payments.agency.to_invoice, com id próprio, e as faturas em bills. A fatura de cliente do Faturar deixa de aparecer em payments.agency.bills, e o id dela deixa de manter o pagamento na alteração: use o id do Faturar. O Faturar que ainda não entrou em fatura passa a aparecer.
  • Na consulta da venda, cada produto do Faturar e do Retido pelo Intermediário (products[]) ganha o id do item gravado para ele. A alteração mantém a linha pelo id dela ou pelo de qualquer um desses itens: quando um pagamento igual incluído depois entra na mesma linha e troca o id dela, o id guardado antes continua valendo.
  • Mudança no contrato: o Retido pelo Intermediário (payments.agency.retained_by_intermediary) ganha id, e os dois passam a ser mantidos ou retirados pela lista payments da alteração: a alteração que envia payments sem o id deles os retira, o que antes não acontecia. O Faturar em fatura de cliente fechada ou liquidada não sai.
  • Quando o item do Faturar entra na fatura de cliente, ele passa a ter o vencimento da fatura, e a parte que entrou pode virar outra linha, com outro id, como no Monde. Como no Monde, que só tira essa parte quando o usuário exclui aquela linha, a alteração não a retira por ficar de fora de payments enquanto a lista mantém outra linha do mesmo Faturar (mesmo pagante, centro de custo e descrição); ela sai quando nenhuma linha do Faturar fica na lista. Para manter o Faturar inteiro depois da divisão, envie o id de cada linha dele (ou de cada item em products).
  • Mudança no contrato: como no Monde, o pagante da venda não muda enquanto a venda tem Faturar ou Retido pelo Intermediário: a alteração que troca o payer sem tirá-los de payments responde 422. Antes, o pagante mudava e os itens ficavam no nome do pagante anterior.
  • As observações da venda (observations) passam a ser aceitas na criação e na alteração, também na venda fechada, como no Monde. A alteração vai para o histórico da venda.

Reembolsos

  • Novo endpoint Lançar reembolso na venda, para o reembolso de um produto da venda ao cliente (customer) ou com o fornecedor (vendor), com as regras das ações Reembolso Cliente e Reembolso Fornecedor do Monde: o reembolso vai para a fatura pelas regras de faturamento (invoice) ou gera na hora uma fatura avulsa só com ele (bill), e entra no reembolso do produto e na receita da venda. O reembolso ao cliente só existe na agência: na operadora, responde 403. Como no Monde, lançar o reembolso é editar a venda: exige a permissão Editar de Vendas (na venda que a credencial não criou, também Editar vendas de outros vendedores; na venda com recibo impresso, também Alterar vendas com recibo impresso, no reembolso ao cliente e no do fornecedor) e o Idempotency-Key.
  • Novo endpoint Excluir reembolso, que tira o reembolso da venda e da fatura em que ele estiver. A fatura liquidada ou fechada responde 409, e o reembolso ao cliente na venda fechada também. O reembolso do fornecedor que já virou conta a pagar/receber (a conta gerada só para ele ou, com a fatura automática de fornecedor desligada, qualquer fatura) só é excluído com remove_from_bill como true, como a confirmação do Monde ao excluir a conta: sem ela, responde 409; com ela, a conta inteira é excluída, como no Monde: o reembolso sai, e os outros itens da conta voltam a ficar pendentes, sem fatura. Exige as mesmas permissões do lançamento (inclusive Alterar vendas com recibo impresso na venda com recibo impresso), mais Ver aba financeiro no reembolso do fornecedor, e o Idempotency-Key. Excluir a conta inteira com remove_from_bill exige também Editar e Excluir de Contas a Pagar e Receber sobre ela (e, na conta de outro usuário, o acesso aos lançamentos dos outros usuários), como excluir o lançamento no Monde; sem elas, 403.

Viagens

  • Novos endpoints Criar viagem, Alterar viagem e Excluir viagem, com as regras do Monde: descrição (até 60 caracteres), cliente e vendedor ativo obrigatórios, número gerado na gravação e empresa que não muda depois do cadastro. Na alteração, descrição, cliente, vendedor e empresa enviados como nulo ou vazio respondem 422, como na tarefa, e o vendedor atual reenviado é aceito mesmo inativo. Exigem as permissões Editar e Excluir de Viagens, as mesmas do Monde, novas na credencial da API e na conexão automática. A viagem que a credencial cadastrou, ou com venda que ela criou, é dela. Na viagem de outro vendedor ou de outra credencial, alterar e excluir pedem também Consultar vendas de outros vendedores, como a consulta; fora desse alcance, a viagem responde 404. A viagem com anexos não é excluída (409), como no Monde.
  • Novos endpoints Vincular venda à viagem e Desvincular venda da viagem, com a permissão Editar de Viagens. Como no Monde, a credencial precisa abrir a venda: a que ela criou ou, a de outro vendedor, com Abrir vendas de outros vendedores/intermediários; a venda fora desse alcance, ou de outra empresa, responde 404. A venda vinculada não pode estar excluída e precisa ter um produto ativo; a que está em outra viagem é transferida, sem conferir o acesso à viagem de origem, como no Monde. Na empresa configurada para aceitar só vendas cadastradas dentro de uma viagem, a API não desvincula venda nem exclui viagem com vendas (409): no Monde, só o administrador faz isso.
  • A consulta da viagem por ID passou a trazer os campos personalizados em custom_fields.

Conciliação Bancária

  • Novo recurso Conciliação Bancária, com as regras da tela de Conciliação Bancária do Monde Web: enviar o extrato OFX de uma conta corrente (POST /bank_reconciliations, em multipart/form-data), consultar e descartar os extratos enviados, refazer o casamento automático, consultar as linhas da conciliação com a situação de cada uma, consultar os candidatos de uma linha, vincular a linha (PATCH, com a lista final de movimentações e as contas a pagar ou receber em aberto a liquidar na data da linha), recusar a sugestão e conferir ou desfazer a conferência de cada movimentação.
  • Nova permissão Conciliação Bancária na credencial da API, a mesma do Monde: ela libera consultar, enviar e descartar extratos e vincular as linhas, numa empresa da conta corrente. Conferir a movimentação, inclusive no vínculo que já sai conferido, exige também Editar lançamento, como no Monde.
  • Liquidar uma conta em aberto pelo vínculo segue Liquidar conta a pagar ou receber: aceita as mesmas contas (inclusive o pagamento da venda), recusa as outras, como a comissão, com a mesma mensagem e exige as mesmas permissões, Editar lançamento e Liquidar conta a pagar ou Liquidar conta a receber.
  • Pela conexão automática, a conciliação é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: ela alcança o extrato e as movimentações da conta inteira, de qualquer origem.

Contas a Pagar e Receber: lançamento em outra moeda

  • Liquidar conta a pagar ou receber passa a liquidar o lançamento em outra moeda, como o Monde. O amount da movimentação é na moeda do lançamento; na conta em outra moeda, ele entra convertido pela última cotação, e sem cotação cadastrada a movimentação responde 422. Antes, o lançamento fora do real respondia 422. Pelo vínculo da conciliação bancária, a conta em aberto na moeda da conta corrente também se liquida.
  • A movimentação gravada numa conta fora do real (na liquidação, na inserção já liquidada, na troca de conta da alteração e no vínculo da conciliação) guarda o câmbio de referência, que converte a moeda da conta para o real, pela última cotação da moeda da conta, como o Monde. Antes, guardava 1. Muda o valor gravado: na conta em dólar com a cotação de 5,25, a movimentação passa a guardar o câmbio de referência 5,25, e não mais 1. A conta em real, ou a moeda sem cotação cadastrada, continua com 1.
  • Como no Monde, o câmbio sugerido pode ser corrigido pelo usado no banco. Em Liquidar conta a pagar ou receber, cada movimentação aceita exchange_rate, que converte a moeda do lançamento na da conta (só na conta em outra moeda; com ele, a falta de cotação cadastrada deixa de responder 422), e reference_exchange_rate, o câmbio de referência da conta fora do real. No vínculo da conciliação, cada conta em aberto de open_bills aceita reference_exchange_rate na conta corrente fora do real. Os dois são opcionais, maiores que zero e gravados com 6 casas decimais; omitidos, valem as últimas cotações, e enviados onde não se aplicam são ignorados.

Extrato e Caixa

  • Novo endpoint Consultar saldo da conta: o saldo de uma conta corrente ou caixa ao fim de uma data, o mesmo com que o extrato fecha o dia.
  • Novo endpoint Consultar extrato da conta: o extrato de até 45 dias, linha a linha como no Monde, com o saldo anterior, as movimentações e o saldo de cada dia com a indicação de caixa fechado.
  • Novos endpoints Fechar caixa e Reabrir caixa, com as regras do Monde.
  • Novo recurso de permissão Saldo e Extrato, com a permissão Extrato de Conta do Monde. Fechar e reabrir o caixa pedem as permissões Fechar Caixa e Reabrir Caixa, do Monde, em Contas e Cartões. Pela conexão automática, ler o saldo e o extrato e fechar e reabrir o caixa é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: o extrato traz todas as movimentações da conta e o fechamento vale para a conta inteira, inclusive para o que a agência lançou.

Transferências entre Contas

  • Novos endpoints para listar, consultar, inserir, alterar e excluir transferências entre contas, com as regras da tela de Transferência do Monde.
  • Novo recurso de permissão Transferências entre Contas, com as permissões do Monde: Transferência entre Contas (consultar), Editar (inserir e alterar), Excluir e Visualizar Log. O log das transferências em Logs (origem conta_movimento) passa a pedir Visualizar Log de Transferências entre Contas, como no Monde, e não mais ler as Movimentações. Pela conexão automática, consultar, editar, excluir e ver o log das transferências é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: a transferência não guarda quem a lançou, então quem as lê ou grava alcança também as que a agência lançou.

Orçamentos

  • Novos endpoints Criar orçamento, Alterar orçamento, Excluir orçamento e Duplicar orçamento, com as regras da tela de Orçamentos do Monde Web. Exigem as novas permissões de orçamentos da credencial: Criar e editar (criar, alterar e duplicar) e Excluir.
  • Novo endpoint Consultar configurações de orçamento, por empresa (company_identifier): cor, redes sociais, condições gerais, modelo de conteúdo e logotipo. Alterar configurações de orçamento responde sempre 409, sem gravar nada: como no Monde, só o administrador altera as configurações, pela tela do Monde Web.
  • A consulta de orçamentos passou a trazer updated_at, e a consulta por ID, também o dono do orçamento em user.
  • Informar a pessoa (person_id) ao criar, alterar ou duplicar um orçamento exige a permissão Ler todas as pessoas. Sem ela, a pessoa é recusada (422) com a mesma mensagem da pessoa que não existe.
  • Informar o cliente da viagem (customer_id) ao criá-la ou alterá-la e a pessoa do reembolso ao cliente (person_id) também exige Ler todas as pessoas, com a mesma recusa.

Guias

  • Novo endpoint Duplicar guia, com a permissão de criar e editar guias.
  • Novo endpoint Consultar configurações de guia, por empresa (company_identifier): o rodapé da página pública dos guias. Alterar configurações de guia responde sempre 409, sem gravar nada: como no Monde, só o administrador altera as configurações, pela tela do Monde Web.
  • Alterar guia que leva o guia para outra empresa (company_identifier) sem informar o dono (user_id) passa a responder 422 quando o dono atual não tem acesso à empresa de destino, pedindo um dono que tenha. Antes, o guia mudava de empresa e ficava com um dono que não o alcança. Quando o dono atual tem acesso às duas empresas, nada muda.

Contas e Cartões

  • Contas e Cartões passa a aceitar escrita, com Inserir conta ou cartão, Alterar conta ou cartão e Excluir conta ou cartão: conta caixa, conta corrente e cartão de crédito, com as empresas em que a conta fica disponível (companies), os grupos de usuários com acesso (user_groups) e a cobrança da conta corrente (billing_accounts, Monde Bancos e CobreBem). Exigem as novas permissões Editar e Excluir de Contas e Cartões, como no Monde.
  • O campo que não é do tipo da conta (como agency ou initial_balance num cartão, ou billing_accounts fora da conta corrente) é ignorado, como o campo que não existe: não é gravado e não responde 422.
  • Em Alterar conta ou cartão, mudar o saldo inicial (initial_balance) reabre os caixas fechados da conta e exige também a nova permissão Reabrir Caixa de Contas e Cartões, como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. Reenviar o saldo gravado não pede a permissão.
  • Na cobrança pelo CobreBem, registered é gravado como a tela permite; no Monde Bancos, ele sai da carteira escolhida, e o valor enviado é ignorado.
  • Consultar conta ou cartão por ID ganha os campos invoice_company, user_groups e billing_accounts.
  • Pela conexão automática, gravar e excluir contas e cartões e reabrir o caixa delas é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: as contas valem para a agência inteira, como os produtos.

Bancos

Contas a pagar e receber: pagamento parcial com itens

  • Em Liquidar conta a pagar ou receber com balance_resolution igual a partial, no lançamento com itens (como o pagamento da venda), o item dividido entre a conta paga e a do saldo passa a repartir a taxa cartão agência na proporção do valor de cada parte. Antes, a parte que ia para o saldo levava a taxa inteira do item, e a taxa cartão agência do produto ficava contada duas vezes até o saldo ser liquidado.
  • Na mesma liquidação, a empresa sem as categorias padrão de fatura, de onde a conta do saldo tira as categorias, passa a responder 422 com a mensagem do Monde, e nada é gravado. Antes a resposta era 500.

2026-10-22

Contas a pagar e receber: pagamento da venda

  • Liquidar conta a pagar ou receber e Desfazer a liquidação passam a aceitar o pagamento da venda (sale_payment), cujo id vem em payments.agency.bills da venda. A baixa usa a forma e os dados de pagamento da venda: payment_method_id fica opcional na movimentação, e a taxa de cartão calculada na venda passa para a movimentação sem precisar enviar card_rate. Como em toda movimentação com taxa, amount é o que o cliente pagou, e a conta recebe amount menos a taxa. Ao desfazer, a taxa de cartão fica no lançamento.
  • Liquidar conta a pagar ou receber, Alterar conta a pagar ou receber e Desfazer a liquidação passam a ratear a taxa de cartão das movimentações entre os produtos da venda, na taxa cartão agência deles, e a recalcular a receita da venda, como no Monde. Antes, a taxa mudava só o lançamento, e a receita da venda não a descontava. Desfazer a liquidação volta a taxa cartão agência dos produtos a zero.

Pacotes, Navios e Cabines

  • Novo recurso Pacotes: consulta, cadastro, alteração e exclusão dos pacotes usados no produto de pacote turístico (package_name), com os serviços inclusos.
  • Navios e Cabines passam a ter consulta por nome, cadastro, alteração e exclusão. O nome é a chave do registro e vai no caminho com codificação de URL (/ships/MSC%20Preziosa). Renomear leva o nome novo para os produtos de venda que usam o registro, e o registro usado em produto de venda não é excluído (409).
  • Cada recurso ganhou as permissões Editar e Excluir na credencial da API.

Moedas

  • Alterar moeda e Excluir moeda, com as regras da tela de Moedas: com a lista interna de moedas (multimoedas) só se ativa ou desativa a moeda, e nenhuma é excluída. Fora dela, como no Monde, a moeda com cotação gravada não é excluída (409): desative-a.
  • Consultar cotações da moeda e Consultar cotação por ID.
  • Operadoras: Gravar cotação da moeda e Atualizar câmbios, que grava a cotação de várias moedas de uma vez, como a ferramenta Atualizar Câmbios do Monde. As duas respondem 201 quando gravam e 200 quando o valor é igual ao da cotação vigente e nada é gravado (no lote, com a lista vazia). Na agência, as duas respondem 403.
  • Moedas ganhou as permissões Editar moedas e gravar câmbios e Excluir na credencial da API.

Alterações (PATCH): o campo nulo é retirado

  • Em todas as alterações, o campo omitido continua como está, e o enviado como null passa a ser retirado do registro, em vez de valer como omitido. O que o registro não pode ficar sem enviado como null responde 422. A lista enviada como null vale como a vazia, e o item de custom_fields com value nulo ou vazio limpa aquele campo (o obrigatório responde 422). A criação não muda. Alterar venda já seguia essa regra.
  • Alterar pessoa: textos, address, birthplace, additional_data, airline, seller, promoter e as listas se esvaziam. name, person_kind, external_id, foreigner, charge_billet_fee, as retenções, o e-mail de usuário do Monde, os dados obrigatórios do cartão e os percentuais da Lei Kandir respondem 422.
  • Alterar tarefa: descrição e pessoa se esvaziam, como já acontecia com vencimento, categoria e vínculos; title, assignee_id e completed respondem 422.
  • Alterar guia: internal_observations fica em branco; title, subtitle, details, active, user_id e company_identifier respondem 422.
  • Alterar conta a pagar ou receber: apportionments nulo esvazia os rateios, e per_cost_center ou per_company nulo esvazia só aquele; company_identifier nulo responde 422.
  • Alterar função: people nulo desfaz todos os vínculos; person e not_commissioned nulos num item de people respondem 422.
  • Alterar marcador, Alterar vendedor, Alterar categoria de tarefa e Alterar campo personalizado: nenhum campo pode ser retirado, e o nulo responde 422. As exceções são kanban_position, aceito nulo quando a categoria sai do quadro, e choices, em que o nulo vale como lista vazia.

Produtos

  • Produtos passam a ser gravados pela API: criar (POST /products, tipos others e operation), alterar (PATCH /products/{id}) e excluir (DELETE /products/{id}). Produto CVC não se altera, e produto do sistema ou com vínculos não se exclui: os dois casos respondem 409. Exigem as novas permissões Editar e Excluir de produtos.
  • Fornecedores do produto em /products/{product_id}/supplies e representantes de cada fornecedor em /products/{product_id}/supplies/{supply_id}/representations, com consulta em lista, consulta por ID, criação, alteração (PATCH) e exclusão. A consulta usa a permissão de ler produtos; a gravação e a exclusão têm permissões próprias, como no Monde: Adicionar Fornecedor, Editar Fornecedor, Excluir Fornecedor, Adicionar Representante, Editar Representante e Excluir Representante.
  • Na alteração de produto, fornecedor e representante, o campo omitido fica como está e o enviado como null é retirado. O campo que não pode ficar vazio (como name, active, supplier e os da comissão) enviado como null responde 422.
  • A consulta de produto por ID passa a trazer o id de cada fornecimento e de cada representante.
  • Pela conexão automática, gravar e excluir produtos, fornecedores e representantes é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: esses cadastros valem para a agência inteira, como os campos personalizados, as categorias de tarefa, os marcadores e as funções.

Vendas

  • Alterar venda passou a reabrir a venda fechada com status: opened, como o Monde: a venda reabre antes de o resto do pedido ser aplicado, e a alteração vale por inteiro ou nada muda. Reabrir só muda a situação da venda; as comissões e o financeiro ficam como estão. Exige a permissão "Reabrir venda", nova na credencial e conferida na empresa da venda, como no Monde; "Fechar venda" não reabre. A venda excluída continua respondendo 409.

Permissões espelhadas do Monde

  • Em Inserir pessoa e Alterar pessoa, enviar credit_cards ou kandir_law com algum item, ou retirando os da pessoa, passou a exigir a permissão "Ver aba financeiro" de pessoas, como no Monde, em que os cartões e a Lei Kandir ficam na aba Financeiro da pessoa. Cada operação nos cartões pede também a permissão dela: incluir cartão (item sem id), "Cadastrar Cartão de Crédito"; alterar cartão (item com id e algum campo a mudar), "Visualizar dados do Cartão de Crédito" e "Editar Cartão de Crédito"; deixar de fora da lista um cartão que a pessoa tem, "Remover Cartão de Crédito". Sem a permissão, a resposta é 403 com a mensagem do Monde, e nada é gravado.
  • Em Consultar pessoa por ID e na resposta da inserção e da alteração, credit_cards e kandir_law só vêm com "Ver aba financeiro", e credit_cards, também com "Visualizar dados do Cartão de Crédito". Sem a permissão, o campo não vem: é omitido, não vem nulo.
  • Em Alterar pessoa, retirar o vendedor ou o promotor (seller ou promoter nulos, na pessoa que tem) passou a exigir "Alterar Vendedor" ou "Alterar Promotor", como trocar já exigia.
  • Em Alterar conta a pagar ou receber, mudar a settlement_date do lançamento liquidado para uma data diferente da gravada passou a exigir também "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, como no Monde. Reenviar a mesma data não pede a permissão.
  • Em Inserir venda, commissions com alguma comissão passou a exigir "Ver aba comissões" e "Adicionar comissões". Em Alterar venda, enviar commissions, mesmo vazia ou nula, passou a exigir também "Ver aba comissões", além de "Adicionar comissões" e "Excluir comissões".
  • Enviar anexo na venda, na conta a pagar ou receber e na pessoa passou a exigir, além da permissão de adicionar anexos, a "Editar" do recurso (vendas, contas a pagar e receber, pessoas), como no Monde, em que anexar grava o cadastro.
  • Fornecedores e representantes do produto têm permissões separadas para incluir, alterar e excluir, com os nomes do Monde: Adicionar fornecedor ao produto exige "Adicionar Fornecedor", Alterar fornecedor do produto exige "Editar Fornecedor" e Remover fornecedor do produto exige "Excluir Fornecedor"; nos representantes, "Adicionar Representante", "Editar Representante" e "Excluir Representante".
  • Em Consultar logs e Consultar logs por ID, o log de cidades (cidade) passou a vir a quem tem "Visualizar Log" de cidades, em vez de a quem lê as cidades.
  • Consultar e listar vendas, contas a pagar e receber, tarefas e viagens passaram a pedir a permissão "Visualizar" do recurso também no registro que a própria credencial criou, como no Monde, em que sem "Visualizar" não se abre o cadastro. O registro de outra origem continua pedindo também a permissão "de outros". Sem "Visualizar", a resposta da alteração traz só os identificadores, mesmo no registro que a credencial criou: o id e, na venda, também o id e o local_id dos produtos e pagamentos enviados; o mesmo vale para a liquidação e a restauração do lançamento e para o comentário na tarefa. Uma alteração sem nenhum campo não serve de consulta. A criação continua devolvendo o registro criado inteiro, com os campos protegidos ocultos conforme as permissões de campo. O download de anexo segue a consulta do registro dono dele, com a mesma regra.
  • A credencial ainda gravada no catálogo anterior, de antes das permissões espelhadas do Monde, continua fazendo o que fazia: nela, "Ver aba financeiro" e "Visualizar dados do Cartão de Crédito" valem pela "Visualizar" ou pela "Editar" de pessoas, as de cadastrar, editar e remover cartão e as de retirar vendedor e promotor, pela "Editar" de pessoas; a de liquidar, pela "Editar" de contas a pagar e receber; e "Ver aba comissões", pela "Visualizar" ou pela "Editar" de vendas. A inserção de venda com comissões e o envio de anexo seguem sem a exigência nova, e ela continua consultando, alterando com a resposta inteira e baixando os anexos do que ela mesma criou com qualquer permissão do recurso, como fazia a conexão automática.

2026-10-21

Permissões "de outros", como no Monde

  • Cada permissão de vendas, contas a pagar e receber, tarefas e viagens vale para o que a própria credencial criou, e as permissões "de outros" do Monde estendem o alcance aos demais registros: Consultar, Abrir e Editar vendas de outros vendedores; Acessar lançamentos de todos os usuários e do sistema e os recortes dele; Ver tarefas de outros usuários. A viagem dos outros vendedores segue Consultar vendas de outros vendedores.
  • A credencial sempre lê o que criou: qualquer permissão do recurso na empresa basta para listar e consultar o próprio registro. Isso vale também pela conexão automática, que passa a listar e consultar as vendas, os lançamentos e as tarefas que o parceiro criou.
  • O registro de outro usuário fora do alcance responde 404. O que a credencial lê mas não pode alterar responde 403 com a mensagem do Monde, inclusive pela conexão automática, que antes recebia 404 na venda e 403 sem mensagem no lançamento.
  • Liquidar conta a pagar ou receber passa a exigir Liquidar conta a pagar ou Liquidar conta a receber, conforme a natureza do lançamento.
  • O download de anexo segue a consulta do registro dono dele, e o envio de anexo na venda e no lançamento de outro usuário pede o mesmo alcance.
  • Alterar conta a pagar ou receber que leva o lançamento de outro usuário para outra empresa passa a exigir, também na empresa de destino, o acesso aos lançamentos de outros usuários, como a venda exige "Editar vendas de outros vendedores" lá. O mesmo vale para Alterar tarefa que leva a tarefa de outro usuário para outra empresa: exige "Ver tarefas de outros usuários" no destino.
  • Consultar logs aplica o mesmo alcance: o log da venda, do lançamento e da tarefa de outro usuário só vem a quem alcança o registro (abrir as vendas de outros vendedores, acessar os lançamentos de outros usuários, ver as tarefas de outros usuários), como no Monde, em que o log fica na aba do registro.
  • A credencial gerada antes dessas permissões continua como antes: a própria ação (ler, editar, excluir, liquidar, anexar) alcança qualquer registro da empresa.
  • A tela da credencial passa a oferecer todas as permissões, com os nomes do Monde, e a credencial salva por ela vale pelas regras acima. Ao abrir uma credencial antiga, a tela já marca as permissões que dão o mesmo alcance que ela tinha, então salvar não tira acesso. A tela recusa a permissão que ela não oferece.
  • A conexão automática autorizada a partir de agora também vale pelas regras acima: o parceiro alcança só o que criou, e o acesso aos registros de outras origens é exceção concedida na homologação, mostrada em destaque no consentimento.

Contas a Pagar e Receber

  • Em Inserir conta a pagar ou receber, criar o lançamento já liquidado passou a exigir a permissão "Liquidar conta a pagar" ou "Liquidar conta a receber", como no Monde; sem ela, a resposta é 403. A credencial que já existia continua criando liquidado com "Editar".
  • Nova permissão "Ignorar bloqueios" em Contas a Pagar e Receber: a credencial que a tem na empresa do lançamento passa pelos bloqueios de vencimento, de data de movimentação e de acréscimo e desconto, como o usuário do Monde. Sem ela, os bloqueios continuam valendo como antes.
  • Novo endpoint Liquidar conta a pagar ou receber, para dar baixa num lançamento em aberto com as regras da liquidação do Monde: a data de liquidação e as movimentações, como na inserção já liquidada. Quando o pago não fecha com o valor final, balance_resolution diz o que fazer com a diferença: category a lança numa categoria de desconto ou acréscimo (a de balance_category_id ou a padrão da empresa), e partial liquida o que foi pago e cria um lançamento em aberto com o saldo, que vem em generated_bills. Liquida o lançamento avulso, as faturas de cliente e de fornecedor e a fatura de cartão com a edição liberada; o pagamento e o avulso da venda e a comissão respondem 409. Exige Idempotency-Key, a permissão "Editar" de contas a pagar e receber e a "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, as mesmas da inserção já liquidada.
  • Novo endpoint Desfazer a liquidação de conta a pagar ou receber, como remover a liquidação no Monde: as movimentações saem das contas e o lançamento volta a ficar em aberto, com o acréscimo e o desconto lançados na liquidação. A fatura cujo saldo foi levado para outro lançamento responde 409, e o lançamento conciliado só é reaberto com undo_bank_reconciliation como true. Exige também a permissão Editar lançamento liquidado. Não exige Idempotency-Key.
  • Pela conexão automática, o parceiro só liquida e desfaz a liquidação do lançamento que ele mesmo criou, salvo a exceção concedida na homologação: o de outra origem responde 404, ou 403 quando o parceiro consegue lê-lo.

Vendas

  • Em Alterar venda, o que o Monde protege com permissão própria passou a exigir essa permissão, na empresa da venda: alterar a data da venda, a empresa, o vendedor (em venda aberta e em venda fechada), o solicitante e os campos personalizados da venda fechada, tirar um produto da lista, enviar comissões e alterar a venda com recibo impresso. Sem a permissão, a resposta é 403 com o nome dela, e nada é alterado; o campo reenviado igual ao gravado não pede permissão, menos commissions, cuja lista sempre substitui as comissões manuais. As comissões passaram a exigir "Adicionar comissões" e "Excluir comissões", no lugar de "Fechar venda". Excluir venda com recibo impresso passou a exigir também "Alterar vendas com recibo impresso". A credencial que já existia continua fazendo o que fazia: "Editar" vale também pelas permissões novas da alteração, "Fechar venda" pelas das comissões, e "Excluir" pela do recibo impresso.
  • Em Inserir venda e Alterar venda, a pessoa, o vendedor, o navio e a cabine que a venda cria junto passaram a exigir a permissão "Editar" em Pessoas, Vendedores, Navios e Cabines, como no Monde, em que cada um nasce na tela dele. Trocar a pessoa de um passageiro na venda com recibo impresso passou a exigir "Trocar passageiro em vendas fechadas ou com recibo impresso".
  • Em Consultar venda por ID, comissão, over e receitas só vêm com "Visualizar comissão, over e receitas"; payments e financial, com "Ver aba financeiro"; e commissions, com "Ver aba comissões". Sem a permissão, o campo não vem. Na resposta da inserção e da alteração, sem "Ver aba financeiro", payments traz só o id e o local_id dos pagamentos enviados.
  • A credencial que já existia continua com o que fazia: "Editar" vale também para os cadastros que a venda cria junto e para trocar passageiro, e a leitura de vendas vale pelas colunas e abas.

Logs

  • Consultar logs passou a recortar o histórico por cadastro, como no Monde: o log de cada cadastro vem a quem tem "Visualizar Log" dele ou, no cadastro sem essa permissão, a quem o lê; no log de venda, lançamento, nota fiscal e tarefa, a permissão vale na empresa do registro, e as exportações ficam de fora. A linha que a credencial não vê responde 404 em Consultar logs por ID. A credencial que já tinha a leitura de todo o log continua vendo tudo.

Pessoas

  • Em Inserir pessoa e Alterar pessoa, informar ou trocar o vendedor (seller) passou a exigir a permissão "Alterar Vendedor", e o promotor (promoter), a "Alterar Promotor", como no Monde; sem ela, a resposta é 403. A credencial que já existia continua com o que fazia: "Editar" vale também por essas permissões.
  • Alterar pessoa passou a recusar, com 403 e a mensagem do Monde, o que o Monde reserva aos administradores: alterar a pessoa que é uma empresa do sistema e trocar o e-mail de uma pessoa que é usuário ativo do Monde. Os demais campos do usuário continuam alteráveis, e o e-mail reenviado igual ao gravado não é recusado.

Tarefas

  • Em Criar tarefa e Alterar tarefa, o responsável precisa ter acesso às tarefas da empresa da tarefa, como no Monde; sem ele, a resposta é 422 em assignee_id. A conferência vale em toda alteração, não só quando o responsável ou a empresa mudam. A tarefa sem empresa não confere.

Conexão automática

  • A seção Conexão automática abre com um resumo do fluxo em três passos e deixa claro que ele é OAuth 2.0 de autorização, e não login único (SSO) nem OpenID Connect: o token dá acesso à API da agência e não identifica quem autorizou.

Contas a Pagar e Receber

  • A movimentação de Inserir conta a pagar ou receber já liquidada, de Liquidar conta a pagar ou receber e de Alterar conta a pagar ou receber ganha card_rate, a taxa de cartão, com as regras do Monde: só na conta a receber, em conta corrente e com a forma cartão de crédito ou de débito. amount é o que o cliente pagou, a conta recebe amount menos a taxa, e a soma das taxas vira a categoria de taxa de cartão configurada na empresa, que abate o valor final; sem essa categoria, a taxa responde 422. Na alteração, mudar só a taxa mantém o que o cliente pagou.
  • As mesmas operações passam a aceitar a conta cartão de crédito na conta a receber, só com a forma cartão de crédito: é o estorno no cartão, que entra na fatura do cartão como no Monde. Antes, a conta cartão era recusada nas movimentações da conta a receber.

Movimentações

  • Consultar movimentação por ID passa a trazer card_rate, a taxa de cartão da movimentação.

  • Nova Restaurar conta a pagar ou receber excluída (POST /bills/{id}/restoration), com as regras do Restaurar do Monde: só o lançamento avulso volta, em aberto, e a liquidação que saiu na exclusão não volta. O lançamento da venda, a fatura e a comissão respondem 409. Exige as permissões Restaurar e Editar de contas a pagar e receber na empresa do lançamento. O lançamento de outro usuário pede também Acessar dados de outros usuários, como nas demais ações.

  • Desfazer a liquidação ganha recurrence_scope, como a alteração e a exclusão: no lançamento de uma série, this_and_following desfaz também a liquidação dos seguintes que estão liquidados, com as mesmas recusas e a mesma permissão de cada um. Se um deles não pode reabrir, nenhuma liquidação é desfeita, e a resposta 409 diz qual barrou. O padrão continua sendo desfazer só o lançamento informado.

2026-10-20

Empresas, Vendedores e Marcadores

  • Novo recurso Empresas, com Consultar empresas e Consultar empresa por ID: as empresas ativas que a credencial alcança, com nome, razão social, CNPJ (o valor de company_identifier nas gravações) e se a empresa está somente leitura. Exige a nova permissão "Ler todas as empresas", concedida em cada empresa que deve aparecer.
  • Vendedores ganham Cadastrar vendedor, Alterar vendedor e Excluir vendedor. Como no Monde, só uma pessoa física já cadastrada vira vendedor, a pessoa do vendedor não muda e o vendedor que está em alguma venda não se exclui (409): desative-o com active: false. Exigem as novas permissões de vendedores "Editar" e "Excluir".
  • Marcadores ganham Criar marcador, Alterar marcador e Excluir marcador. O nome tem até 38 caracteres e não repete o de outro marcador, e excluir retira o marcador de todas as pessoas. Exigem as novas permissões de marcadores "Editar" e "Excluir".

Cidades

  • Consultar cidades e Consultar cidade por ID passam a trazer também as cidades da lista de cidades do Monde que a agência ainda não usa, com os municípios do IBGE e as cidades do exterior. A cidade da lista entra no cadastro da agência, com o mesmo id, quando uma pessoa ou nota fiscal passa a usá-la.
  • Em Inserir pessoa, Alterar pessoa e Inserir venda, o city_ibge e o nome da cidade do endereço e da naturalidade passam a achar também a cidade da lista. Quando o nome se repete, vem a cidade maior. Antes, a cidade do exterior que a agência não tinha era criada de novo, sem relação com a da lista. A cidade do exterior enviada com state_code continua sendo procurada como "Nome, UF" e, sem par, criada com esse nome.

Campos Personalizados

  • Novos Criar campo personalizado e Alterar campo personalizado, com as mesmas regras da tela de Campos Personalizados: nome único dentro do recurso, opções (choices) só no tipo lista, e recurso e tipo fixos depois de criados. Não há exclusão: o campo que não se usa mais é desativado com active: false. Exige a nova permissão Criar e editar de campos personalizados.

Categorias de Tarefas

Funções

  • Novo recurso Funções, com Consultar funções, Consultar função por ID, Cadastrar função, Alterar função e Excluir função: o cadastro de funções do módulo de comissões, com as empresas ou vendedores sobre cujas vendas a função é comissionada e as pessoas vinculadas a ela. Só na agência, e exige as novas permissões de Funções da credencial. A inclusão, a alteração e a exclusão da função, das pessoas vinculadas e das empresas e vendedores de commissioned_over ficam no log da função, em nome da credencial.

Pessoas

  • Cadastrar pessoa e Alterar pessoa passam a gravar credit_cards (cartões de crédito), cost_centers (centros de custo do cliente corporativo) e kandir_law (retenções da Lei Kandir), no mesmo formato da consulta por ID. Na alteração, a lista enviada substitui a atual, como contacts e labels: o cartão que a pessoa já tem é citado pelo id, o centro de custo pelo nome e a retenção pelo produto. O número e o código de segurança do cartão são gravados cifrados e nunca voltam na resposta, que traz só os quatro últimos dígitos. Centros de custo e retenções só valem para pessoa jurídica, e a retenção só para Passagem Aérea, Seguro Viagem e Transporte Terrestre, com o total de cada grupo calculado pela soma de IR, CSLL, PIS e COFINS. Cada inclusão, alteração e exclusão entra no histórico da pessoa.
  • Consultar pessoa por ID passa a trazer o id de cada cartão em credit_cards e a lista cost_centers.

2026-10-19

Pessoas

  • Consultar pessoas ganha o filtro de aniversário, que substitui a consulta Aniversariantes do Monde: birthday_from e birthday_to (YYYY-MM-DD, juntos, até 366 dias) trazem quem faz aniversário na janela, sem olhar o ano e atravessando a virada do ano. Ganha também o filtro label_id, para as pessoas de um marcador.
  • Nova Converter pessoa física em jurídica, ou o contrário (POST /people/{person_id}/conversion), com as regras da conversão do Monde: apaga os dados que só o tipo de origem tem e recusa o usuário do sistema e a empresa do sistema. Exige a permissão de alterar pessoas.
  • Novas Baixar foto da pessoa, Enviar foto da pessoa e Remover foto da pessoa. A foto (o logotipo, na pessoa jurídica) é JPEG de até 150 KB, como no Monde.
  • Consultar pessoa por ID ganha os campos photo (tipo e tamanho da foto, ou nulo) e invoice_rules (as regras de faturamento próprias da pessoa).

Pessoas e Vendas

  • Em Alterar pessoa, a pessoa que é usuário do Monde e recebe o email de outro usuário passa a responder 422 em email, e nada é gravado. Antes a resposta era 500. Vale também para a pessoa já cadastrada, citada em Inserir venda ou em Alterar venda, que é usuário sem e-mail e receberia o de outro usuário. A pessoa que não é usuário continua aceitando qualquer e-mail, inclusive o de um usuário, e Inserir pessoa não muda: a pessoa criada ainda não é usuário.

Tarefas

  • Consultar tarefas ganhou os filtros da consulta de Tarefas do Monde: assignee_id (responsável), created_by_id (quem cadastrou), person_id, category_id (ou uncategorized, para as tarefas sem categoria), status (pending, completed e deleted, separados por vírgula), overdue (vencidas), o período por date_field (due, created_at ou completed_at) com date_from e date_to, e o vínculo com venda, viagem e lançamento (sale_id, travel_id, bill_id). Sem status, a lista continua sem as tarefas excluídas. Filtro com valor inválido responde 400.
  • A tarefa pode ser vinculada a uma venda, uma viagem e um lançamento (conta a pagar ou receber): sale_id, travel_id e bill_id em Criar tarefa e Alterar tarefa, e sale, travel e bill em Consultar tarefa por ID. Os vínculos não têm relação obrigatória com a pessoa da tarefa; quando vierem juntos, precisam combinar entre si: a venda tem de ser da viagem informada, e o lançamento, da venda informada. Na alteração, o vínculo enviado como nulo é desfeito, e a pessoa já preenchida da tarefa não é trocada enquanto ela tiver vínculo; preencher a pessoa da tarefa que está sem pessoa é permitido.

Contas a Pagar e Receber

  • Em Alterar conta a pagar ou receber com recurrence_scope igual a this_and_following, cada lançamento seguinte da série só recebe a alteração quando a credencial poderia alterá-lo diretamente: com a permissão "Editar" na empresa dele, que não pode estar somente leitura; no de outro usuário, também o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, também a "Editar lançamento liquidado". O seguinte que não atende a isso fica como está, e a resposta continua 200.
  • No mesmo this_and_following, o lançamento seguinte excluído (canceled igual a true) fica como está e não recebe mais a alteração da série.
  • Em Excluir conta a pagar ou receber com recurrence_scope igual a this_and_following, cada lançamento seguinte da série só é apagado quando a credencial poderia excluí-lo diretamente: com a permissão "Excluir" na empresa dele, que não pode estar somente leitura; no de outro usuário, também o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, também a "Editar lançamento liquidado". O seguinte que não atende a isso continua lá, fora da série, e a resposta continua 204.

2026-10-17

Cidades

  • Mudança no contrato: Consultar cidades e Consultar cidade por ID deixam de devolver o campo setec. O código SETEC não era usado pelo Monde em nenhuma emissão de nota e foi removido do cadastro de cidades.

Contas a Pagar e Receber

  • Inserir conta a pagar ou receber passa a aceitar balance_resolution e balance_category_id no lançamento criado já liquidado, como a liquidação: com category, a diferença entre o pago e o valor final vai para a categoria informada ou, sem ela, para a categoria padrão da empresa; com partial, o saldo vira um lançamento em aberto. O partial_payment: true continua aceito e equivale a balance_resolution: partial; o partial_payment que contradiz o balance_resolution é recusado com 422. O balance_resolution não se combina com parcelamento nem recorrência.

2026-10-16

Contas a Pagar e Receber

  • Novo endpoint Liquidar conta a pagar ou receber, para dar baixa num lançamento em aberto com as regras da liquidação do Monde: a data de liquidação e as movimentações, como na inserção já liquidada. Quando o pago não fecha com o valor final, balance_resolution diz o que fazer com a diferença: category a lança numa categoria de desconto ou acréscimo (a de balance_category_id ou a padrão da empresa), e partial liquida o que foi pago e cria um lançamento em aberto com o saldo, que vem em generated_bills. Liquida o lançamento avulso, as faturas de cliente e de fornecedor e a fatura de cartão com a edição liberada; o pagamento e o avulso da venda e a comissão respondem 409. Exige Idempotency-Key e a permissão de inserir e editar contas a pagar e receber, a mesma da inserção já liquidada.
  • Novo endpoint Desfazer a liquidação de conta a pagar ou receber, como remover a liquidação no Monde: as movimentações saem das contas e o lançamento volta a ficar em aberto, com o acréscimo e o desconto lançados na liquidação. A fatura cujo saldo foi levado para outro lançamento responde 409, e o lançamento conciliado só é reaberto com undo_bank_reconciliation como true. Exige também a permissão Editar liquidadas. Não exige Idempotency-Key.
  • Pela conexão automática, o parceiro só liquida e desfaz a liquidação do lançamento que ele mesmo criou: o de outra origem responde 403, ou 404 quando o parceiro não tem a permissão de ler contas a pagar e receber.
  • As movimentações das contas a pagar e receber passam a ficar no log do lançamento, em nome da credencial, quando são criadas, alteradas ou removidas pela API.

2026-10-15

Contas a Pagar e Receber

  • Novo endpoint Excluir conta a pagar ou receber, com as regras do Monde. A exclusão é lógica: o lançamento fica com canceled igual a true e continua na consulta por ID. Exclui o lançamento avulso e a fatura de cliente e de fornecedor, cujos itens voltam a ser faturados; o gerado por venda, a fatura de cartão, o lançamento de comissão e a fatura gerada pelo Monde com itens respondem 409 com o motivo. O lançamento liquidado só é excluído com remove_settlement como true, que remove a liquidação, e o conciliado com undo_bank_reconciliation como true. Num parcelamento ou recorrência, recurrence_scope com this_and_following apaga também os lançamentos seguintes sem movimentação, como a opção "Excluir este e próximos" do Monde. Não exige Idempotency-Key.
  • Nova permissão Excluir em Contas a Pagar e Receber, oferecida na credencial da API; o lançamento liquidado exige também Editar liquidadas, e sem ela responde 403 antes de qualquer recusa com 409. Pela conexão automática, o parceiro recebe Excluir as próprias contas e só exclui o lançamento que ele mesmo criou: o de outra origem responde 403, ou 404 quando o parceiro não tem a permissão de ler contas a pagar e receber.

2026-10-14

Vendas

  • Mudança no contrato: em Inserir venda e Alterar venda, cada produto pago de payments[].*.products[] passou a apontar o produto por sale_product_local_id (um produto enviado na mesma requisição) ou por sale_product_id (um produto que a venda já tem, só na alteração), no lugar de local_id, external_id e id. O valor destinado ao produto passou a se chamar amount, no lugar de payment_amount, como na consulta da venda. Por enquanto, local_id, external_id e payment_amount seguem aceitos, para não quebrar quem já os envia: migre para os nomes novos. Como o sale_product_local_id aponta só o valor, dois produtos da venda não podem mais usar o mesmo valor como chave, nem um em local_id e o outro em external_id.
  • Mudança no contrato: cada item de payments passou a ter uma única forma de pagamento: agency ou vendor, com uma só forma dentro. Para pagar com duas formas, envie dois pagamentos. Assim cada pagamento enviado volta com um id só.
  • Mudança no contrato: em Inserir venda e Alterar venda, o local_id passou a ser obrigatório em cada pagamento novo de payments e único entre os pagamentos novos da requisição; o pagamento sem ele é recusado com 422. É ele que volta na resposta, dentro do pagamento, ao lado do id gerado, que você usa para manter o pagamento na próxima alteração. O pagamento mantido pelo id não precisa dele.

Licença e permissão

  • A API deixou de exigir a licença de API: toda empresa com licença ativa do Monde pode ser usada, desde que a credencial tenha as permissões concedidas nela. A empresa sem licença ativa do Monde responde 403 com "A empresa não tem licença ativa do Monde. Contate o nosso time de suporte para mais informações.".
  • As gravações seguem a licença da própria empresa: na empresa com licença somente leitura, a consulta continua respondendo e a gravação responde 403.
  • Guias passam a exigir a licença Monde Pro na empresa do guia. Sem ela, a resposta é 403 com "Este recurso exige a licença Monde Pro. Contate o nosso time de suporte para mais informações."; com a licença Monde Pro somente leitura, os guias são consultados, mas não gravados. O public_url fica nulo quando a empresa está somente leitura, não tem a licença Monde Pro ou tem a licença Monde Pro somente leitura.
  • A Conexão automática deixou de exigir licença para qualquer permissão: o consentimento oferece todas as empresas ativas da agência, e nenhuma é recusada por licença.
  • A gravação em empresa somente leitura passa a responder 403 com mensagem própria, "A empresa está somente leitura: os registros dela podem ser consultados pela API, mas não gravados.", no lugar de "Sua licença não dá acesso a esta ação.". Vale para toda gravação: vendas, tarefas e o histórico delas, pessoas, contas a pagar e receber, anexos e guias, inclusive pela Conexão automática, e para a troca de empresa da tarefa ou do guia para uma empresa somente leitura. "Sua licença não dá acesso a esta ação." fica só para a licença Monde Pro somente leitura, nos guias. A consulta segue liberada.

Contas a Pagar e Receber

  • Inserir conta a pagar ou receber: a conta prevista (account_id) passa a aceitar qualquer conta ativa vinculada à empresa, inclusive conta cartão de crédito na conta a receber, como no Monde. A conta cartão continua fora das movimentações da conta a receber.
  • Inserir conta a pagar ou receber passa a recusar operação própria (operation_id) inativa.
  • Novo endpoint Alterar conta a pagar ou receber, para todo tipo de lançamento, em aberto ou liquidado, com as regras do lançamento manual do Monde. Só os campos informados mudam: pessoa, descrição, documento, emissão, vencimento, conta prevista, operação própria, observações, campos personalizados, valor (amount), categorias, rateios por centro de custo e entre empresas e a empresa do lançamento (company_identifier). As categorias e cada rateio enviados substituem os atuais; o valor enviado sem as categorias segue a regra do Monde: com uma categoria só, ela acompanha o novo valor; com mais de uma, ele precisa ser igual à soma delas. Levar o lançamento para outra empresa exige a permissão de inserir e editar também nela, e o lançamento com boleto registrado ou emitido não muda de empresa. Num parcelamento ou recorrência, recurrence_scope com this_and_following leva a alteração também aos lançamentos seguintes da série, em segundo plano, como a opção "Atualizar este e próximos" do Monde.
  • Travas por tipo, como no Monde: no gerado por venda, pessoa, empresa e valor não mudam; na fatura de cliente e de fornecedor, pessoa, empresa e valor original não mudam; na fatura de cartão, vencimento, empresa e valor não mudam, e ela não aceita categorias nem rateios. A categoria gerada pelo sistema é reenviada como está. A operação própria só é aceita no lançamento avulso sem número de fatura. O lançamento excluído e a fatura inválida respondem 409, e a fatura de cartão também, enquanto a edição dela não estiver liberada para a agência.
  • No lançamento liquidado, mudam também a data de liquidação (settlement_date) e as movimentações que ele já tem (movements, cada uma pelo id), sem acrescentar nem retirar movimentação, sem liquidar e sem estornar. As movimentações precisam somar o valor final, e a empresa do lançamento liquidado não muda. Exige, além de Inserir e editar, a nova permissão Editar liquidadas em Contas a Pagar e Receber, oferecida na credencial da API. O lançamento com movimentação conciliada responde 409, com o aviso do Monde, até o pedido trazer undo_bank_reconciliation como true; com a confirmação, a conciliação da movimentação alterada é desfeita.
  • Pela conexão automática, o parceiro recebe Inserir e editar as próprias contas no lugar de Inserir e editar e só cria e altera o lançamento que ele mesmo criou: o de outra origem responde 403, ou 404 quando o parceiro não tem a permissão de ler contas a pagar e receber. Na alteração do lançamento que ele criou, a resposta traz o lançamento completo mesmo sem a permissão de leitura.

Anexos

  • Enviar anexo passou a aceitar bill em resource_type: informe o resource_id da conta a pagar ou receber de destino e o anexo entra no lançamento, aparecendo na consulta da conta por ID e no download. Exige, em Contas a Pagar e Receber, a permissão Adicionar anexos, que passou a ser oferecida na credencial da API, concedida na empresa do lançamento, que não pode ser somente leitura. O restante do envio não muda: um arquivo por requisição, as mesmas extensões, o mesmo limite de 12 MB e o mesmo Idempotency-Key.
  • Pela conexão automática, o parceiro só envia anexo na venda e na conta a pagar ou receber que ele mesmo criou: a de outra origem responde 422 como registro não encontrado quando ele não tem a permissão de ler o recurso, e 403 quando tem. Em vendas, a de outra origem respondia sempre 403. Em compensação, ele baixa o anexo da venda e da conta que criou também só com Adicionar anexos, sem a permissão de leitura.

Vendas

  • A documentação do exchange_rate dos produtos e do payment_amount dos pagamentos de Criar venda passou a explicar como o câmbio é aplicado: cada valor é convertido e arredondado em 2 casas separadamente, e o total do produto é a soma desses valores. O cálculo não mudou; quem soma na moeda de origem e converte uma vez só pode chegar a centavos de diferença e ter o fechamento recusado por saldo pendente.

2026-10-13

Guias

Contas a Pagar e Receber

  • Inserir conta a pagar ou receber passa a gerar mais de um lançamento a partir de uma só chamada: o parcelamento (recurrence_kind: installment, com periodicity e o total de installments), a recorrência (recurrence_kind: recurrent, pelos próximos 5 anos) e o pagamento parcial (partial_payment: true), em que o saldo vira um novo lançamento em aberto. A série é gerada em segundo plano, como no Monde: a resposta traz o recurrence_group_id, e os lançamentos da série se consultam pelo novo filtro recurrence_group_id de Consultar contas a pagar e receber. O saldo do pagamento parcial vem na hora, em generated_bills.
  • Consultar conta a pagar ou receber por ID ganha o campo recurrence_status: pending enquanto a série do parcelamento ou da recorrência não foi gerada, generated quando já foi, e retrying quando a última tentativa falhou e o Monde vai tentar de novo.

Especificação OpenAPI

  • Toda operação ganhou um operationId estável (por exemplo listSales, createSale e getPerson), que geradores de SDK e ferramentas de agentes de IA usam como nome da função.
  • A disponibilidade de cada endpoint fica só na etiqueta (Beta ou Em desenvolvimento, no x-badges): o aviso que se repetia no começo de toda descrição saiu.
  • Toda resposta em JSON, inclusive as de erro, traz um exemplo do corpo.
  • A especificação também está em https://web.monde.com.br/api/v3/openapi.yaml, com Content-Type: application/yaml. O endereço /api/v3/documentation/file continua valendo.

2026-10-12

Orçamentos

2026-10-09

Perguntas frequentes

  • Nova seção Perguntas frequentes, com as dúvidas que mais chegam sobre acesso, limites, consulta de vendas e gravação, cada uma com a resposta curta e o link para a seção que detalha o assunto.

Consultas por ID, Marcadores e Categorias de Tarefas

Contas a Pagar e Receber

  • Em Inserir conta a pagar ou receber, a recusa feita pelo banco, como o caixa do dia fechado, passa a vir como o Monde a mostra: sem a marca ValidationError: e com a data formatada (O caixa do dia "10/10/2026" da conta "Caixa" está fechado. no lugar de ValidationError: O caixa do dia "#Date(2026-10-10)#"…).

2026-10-08

Vendas

  • Mudança de comportamento: Inserir venda passou a respeitar a configuração Não permitir cadastrar vendas fora de viagens, por empresa. Com ela ligada na empresa do company_identifier, a criação é recusada com 422 e a mensagem informa a empresa, como no Monde, que não deixa cadastrar venda fora de uma viagem nessa empresa. Antes a venda era criada solta. A API ainda não cria venda dentro de uma viagem; quem integra com essa empresa precisa desligar a configuração ou usar outra empresa.

Categorias

  • Consultar categorias e Consultar categoria por ID passaram a trazer o tipo da categoria (kind): expense (despesa) ou revenue (receita), herdado do grupo. Num lançamento financeiro, a categoria revenue soma ao valor do lançamento credit (a receber) e abate do lançamento debit (a pagar); a categoria expense faz o contrário.

Contas a Pagar e Receber

  • Nova operação Inserir conta a pagar ou receber (POST /bills), em aberto, com as regras do lançamento manual do Monde: a soma com sinal das categorias forma o valor final, o rateio por centro de custo fica entre 0 e 100%, o rateio entre empresas fecha 100%, e os bloqueios de vencimento e de acréscimo e desconto da empresa valem sempre. Exige a nova permissão de inserir e editar contas a pagar e receber e a chave de idempotência.
  • Inserir conta a pagar ou receber também cria o lançamento já liquidado, com settlement_date e as movements: a soma das movimentações fecha com o valor final, a forma de pagamento segue o tipo da conta, e o bloqueio da data de movimentação e o caixa fechado valem como no Monde. A liquidação parcial ainda não é aceita. Sem issue_date, a emissão passa a ser hoje ou o vencimento ou a liquidação, quando forem anteriores, em vez de recusar o vencimento já passado. O erro de um item de lista do lançamento traz a posição do item, a partir de 0, como em 'movements[1] account_id'.

Todas as gravações

  • A lista enviada como objeto de posições numeradas (como "labels": { "0": { "id": "<id>" } } no lugar de "labels": [{ "id": "<id>" }]) passa a responder 422, com o nome do campo, e nada é gravado. Antes ela podia responder 500.

Vendas

  • Mudança no contrato: em Inserir venda, quem recebe cada comissão do array commissions passou a vir no objeto person, com os mesmos campos do intermediário, no lugar do external_id. Como nos passageiros, a pessoa é procurada pelo external_id e, sem vínculo, pelo CPF/CNPJ; não achando, é cadastrada. Antes o external_id precisava já estar vinculado a uma pessoa, e a comissão não cadastrava ninguém. Como no Monde, o kind não restringe quem recebe: a comissão de vendedor pode ir para qualquer pessoa. Sem description, seller e intermediary gravam "Comissão Vendedor" e "Comissão Intermediário". A comissão que ainda mandar só o external_id é recusada com 422.

2026-10-07

Vendas

  • Operadora: a venda passou a seguir as regras de cálculo da operadora, como no Monde. Na criação, a comissão, o over e a comissão do intermediário ficam na moeda de origem do produto, calculados sobre o total dos produtos nessa moeda, e a receita e o faturamento do produto seguem as fórmulas da operadora. O intermediário (intermediary) passou a ser obrigatório, com a venda aberta ou fechada, e é ele quem deve a fatura do cliente, pelo total do cliente já descontada a comissão do intermediário. Ao excluir a venda, o saldo que volta a ser devido também fica com o intermediário, e não com o pagante. O que se deve ao fornecedor fica na moeda de origem do produto. Os valores convertidos são arredondados em 2 casas. Pagamento ao fornecedor (payments.vendor) de produto com moeda de origem diferente de BRL é recusado com 422. Na agência nada muda.
  • Mudança na consulta, na operadora: em Consultar venda por ID, commission_amount, over_amount, intermediary_commission_amount e intermediary_over_amount vinham na moeda de origem do produto, sem indicação. Passaram a vir na moeda final da venda, como os demais valores, e a receita da venda (totals.revenue) também. Na agência os valores não mudam.
  • Os produtos da venda passaram a trazer commission_amount_origin_currency, over_amount_origin_currency, intermediary_commission_amount_origin_currency e intermediary_over_amount_origin_currency, o valor na moeda de origem, como já acontecia com a taxa de serviço e o desconto.
  • Operadora: Inserir venda passou a aceitar a moeda de venda por produto, no novo campo sale_currency (padrão BRL). Como no Monde, currency é a moeda de origem, em que o fornecedor recebe, e exchange_rate converte a origem na moeda de venda: com moedas iguais o câmbio é 1, com moedas diferentes ele é obrigatório, inclusive quando a origem é BRL. A fatura do cliente e os pagamentos (payments) saem na moeda de venda, e cada pagamento só agrupa produtos com a mesma moeda de venda. O pagamento ao fornecedor (payments.vendor) passa a ser recusado com 422 quando a moeda de origem é diferente da moeda de venda, e não mais quando ela é diferente de BRL. Na consulta, currency devolve a moeda de venda do produto. Na agência, moeda de venda diferente de BRL é recusada com 422.
  • No pagamento à agência (payments.agency) com settlement_date, a conta bancária pode estar em outra moeda que a do pagamento, como no Monde. A liquidação converte pelo novo campo settlement_exchange_rate, da moeda do pagamento para a moeda da conta, ou, quando ele é omitido, pela razão entre as últimas cotações das duas moedas; sem a cotação de alguma delas, a resposta é 422. Antes o valor entrava na conta sem conversão. Com a conta na moeda do pagamento, settlement_exchange_rate deve ser 1 ou omitido. O boleto (bank_slip) passa a aceitar só produtos com moeda de venda BRL, com 422 nas demais.

2026-10-06

Vendas

  • Nova operação Excluir venda (DELETE /sales/{id}). Como no Monde, a venda não é apagada: passa a ter status igual a canceled, e o Monde desfaz logo depois o que ela gerou no financeiro. As mesmas regras do Monde impedem a exclusão (venda fechada, produto cancelado, conta liquidada, item já faturado para o fornecedor, reembolso, fatura de cliente fechada), com resposta 409 e o motivo. A venda com recibo impresso é excluída. Exige a nova permissão de excluir vendas. Na conexão automática, o parceiro com a permissão de excluir as próprias vendas exclui só as vendas que a integração criou.
  • Nova operação Alterar venda (PATCH /sales/{id}). Altera a venda aberta: o campo omitido permanece como está, e cada lista enviada substitui a atual (os produtos de cada tipo, os passageiros e trechos de cada produto enviado, payments e commissions). O campo enviado como null é retirado da venda (intermediary, approver, requester, operation_id e operation; a operation_id só sai junto do produto de operação própria que a sustenta), e o campo personalizado enviado em branco é limpo, menos o obrigatório. No produto alterado, o que o payload não traz, inclusive passageiros e trechos, permanece, e a lista de passageiros ou de trechos enviada vazia é recusada. No transporte terrestre e no bilhete de trem, cujos trechos ficam no texto dos serviços inclusos, os segments reenviados exigem o included_services junto, que grava como veio. A lista enviada como null equivale à lista vazia, com as mesmas travas; nos campos personalizados, que não são substituídos, ela não altera nada. Vale também para as listas de dentro de um item: os seats de um trecho enviado podem ir omitidos, vazios ou como null, e o pagamento novo com products vazio ou null é recusado. O produto que a venda já tem é apontado pelo id da consulta por ID; o produto sem id é incluído, e o que não vier na lista do seu tipo é excluído. Em payments, o pagamento enviado só com o id fica como está, o sem id é incluído e o que não vier é removido; no pagamento novo, o produto pago é apontado por sale_product_local_id, para um produto da mesma requisição, ou por sale_product_id, para um produto que a venda mantém. Os totais são recalculados, e o saldo do pagante e o valor a faturar ao fornecedor são ajustados pela diferença. O que já foi conciliado no financeiro não sai: a remoção de pagamento liquidado ou em fatura de cliente fechada responde 422, assim como valor do fornecedor em fatura fechada, liquidada ou avulsa e comissão paga. A venda excluída não pode ser alterada (409). Na venda fechada, como no Monde, só mudam o vendedor, o solicitante, o aprovador, os campos personalizados e as comissões, e o status só aceita closed (o resto responde 409). As comissões vêm no mesmo formato da criação, com quem recebe no objeto person. A venda pode ir para outra empresa em que a credencial também possa alterar venda, com as travas do Monde. Cada campo alterado vai para o log da venda. Exige a permissão "Criar e editar" na empresa da venda, ou "Criar e editar as próprias vendas" para a venda que a própria credencial criou.
  • Inserir venda e Alterar venda passaram a trazer, em cada produto e pagamento enviado, o local_id com que ele veio ao lado do id gerado. A credencial sem permissão de leitura recebe só esses identificadores, no mesmo formato da venda, em vez de só o id da venda. Na consulta da venda, o pagamento ao fornecedor e os pagamentos à agência em credit e legacy passaram a trazer o id.
  • Inserir venda e Alterar venda passaram a gravar o vendedor da venda como vendedor responsável no cadastro do pagante, como a tela de vendas do Monde faz.

Vendas, Contas a Pagar e Receber e Notas Fiscais

  • Em Consultar vendas, Consultar contas a pagar e receber e Consultar notas fiscais, o filtro status enviado como lista ou valor aninhado (como ?status[]=open) continua respondendo 400, mas a mensagem passa a dizer que o parâmetro não aceita listas nem valores aninhados, como na paginação. Antes a mensagem dizia apenas que o valor não era válido. Em vendas e em contas a pagar e receber, para filtrar por mais de uma situação, envie os valores separados por vírgula (como ?status=open,overdue em contas).

2026-10-05

Vendas

  • Inserir venda passou a aceitar o centro de custo do passageiro (passengers[].cost_center, até 50 caracteres), em todos os produtos com passageiros. Como no Monde, quando o pagante é pessoa jurídica o centro de custo precisa ser um dos cadastrados nele, sem diferenciar maiúsculas de minúsculas, e é gravado com o nome como está no cadastro; fora do cadastro, a resposta é 422 e nada é gravado. Com pagante pessoa física, ou com a configuração de vendas Informar o centro de custo em texto livre ligada, aceita qualquer texto. Antes o campo só vinha na consulta e era ignorado na criação.
  • Inserir venda passou a gravar o assento por trecho da passagem aérea, em airline_tickets[].segments[].seats. Cada assento aponta o passageiro pelo ticket_number, que precisa ser o bilhete de exatamente um dos passageiros do produto: o bilhete que não é de nenhum passageiro, ou que é de mais de um, responde 422 e nada é gravado. O mesmo passageiro não pode ter dois assentos no mesmo trecho. O seat_number aceita até 3 caracteres e é gravado em maiúsculas. Antes o campo era só documentado e ficava fora do que a API processava.
  • Consultar venda por ID passou a trazer os assentos em cada trecho da passagem aérea (segments[].seats), no mesmo formato da criação. O assento informado no Monde para um passageiro ainda sem bilhete vem com o ticket_number nulo. O passageiro continua sem o seat.

Idempotência

  • A chave de idempotência passou a expirar: depois de pelo menos um dia da primeira requisição, ela é descartada na limpeza seguinte, que roda uma vez por dia, e reenviar a mesma chave é processado como uma requisição nova. Antes, a chave de uma requisição concluída devolvia a resposta em cache (X-Idempotent-Replay: true) para sempre.

Vendas e Tarefas

  • Em Inserir venda, Criar tarefa e Alterar tarefa, o company_identifier de uma empresa em que a credencial não tem permissão nenhuma passou a ser respondido como CNPJ não encontrado (422, com erro no campo), igual ao CNPJ que não é empresa da agência. Antes a resposta era 403, o que deixava qualquer credencial descobrir quais CNPJs são empresas ativas da agência. Na empresa em que a credencial tem alguma permissão, mas não a da operação, a resposta continua 403.

2026-10-02

Vendas

  • Criar venda passou a aceitar o produto Outros no campo others (lista; a venda pode ter vários). O produto é informado por product_id, entre os produtos Outros do catálogo da agência (GET /products?kind=others). Conforme a configuração do produto, os valores vão por passengers ou por quantity × unit_price (com unit_fee e a taxa de serviço oculta agency_fee). O fornecedor (supplier) é obrigatório e o representante (representative) é opcional. Também aceita destination (national ou international).
  • Nos produtos sem passageiros (Outros e operação própria), unit_fee passou a ser em reais (BRL), como no Monde: o total de taxas é quantity × unit_fee, sem aplicar o câmbio do produto. Antes, a taxa unitária era multiplicada pelo câmbio. Em produto em BRL nada muda.
  • O produto Outros e a operação própria (operation.product_id e operation_id) precisam estar ativos no catálogo, como no Monde, que só oferece os produtos ativos na venda. O produto inativo, que aparece em GET /products com active: false, é recusado com 422. Antes a operação própria inativa era aceita.
  • Em Outros e na operação própria, quantity aceita no máximo 2147483647. Acima disso a resposta é 422, com o nome do campo, e nada é gravado. Antes essa quantidade dava 500. O total da linha que a quantidade gera ainda não é conferido, como nos demais valores calculados.
  • Consultar venda por ID passou a trazer, em Outros, agency_fee e agency_fee_origin_currency, a taxa de serviço oculta da linha, como na operação própria. Vêm nulos no produto com passageiros, em que a taxa vem em cada passageiro.
  • Inserir venda passou a aceitar excursões no array excursions, uma ou mais por venda. A excursão é um produto do sistema, então não se informa qual produto está sendo vendido. São obrigatórios o document (até 40 caracteres), a data de partida (departure_date), a moeda, o fornecedor e ao menos um passageiro. A data de chegada (arrival_date) é opcional e não pode ser anterior à partida. Também entram as observações (observations), os serviços inclusos, o representante e os valores do produto (comissão, comissão do intermediário, taxa de serviço, desconto e câmbio). O passageiro recebe valor, taxas, taxa RAV e o desconto dela, taxa de serviço oculta e documento. Se o produto Excursão estiver inativo no Monde, ele é ativado ao criar a venda, como acontece ao vendê-lo pelo sistema.

2026-10-01

Vendas

  • Inserir venda passou a aceitar passagem aérea no array airline_tickets, com os trechos em segments e os passageiros. A companhia aérea é identificada pelo código IATA/ICAO em airline_code ou pelo CNPJ: quando já existe uma companhia com aquele código, ela é reaproveitada; senão, é criada. A taxa DU de cada passageiro (du_fee), menos o desconto dela (du_fee_discount), entra no total do passageiro e no do produto. O desconto de DU só pode ser informado quando o du_fee for maior que zero, como no Monde. As taxas CC DU e CC RAV (cc_du_fee, cc_rav_fee) ficam no produto e são descontadas da receita da agência. A origem e o destino de cada trecho precisam ser um aeroporto cadastrado; um código IATA desconhecido é recusado. Espaços antes ou depois dos códigos de companhia e de aeroporto são descartados, e o tamanho máximo vale para o código sem eles. O flight_number aceita só números, e o emission_name aceita até 50 caracteres. O assento por trecho (segments[].seats), que aponta o passageiro pelo ticket_number, e o original_ticket_number do passageiro estão apenas documentados, pois o sistema ainda não os processa.

  • Na consulta de vendas, o passageiro do aéreo deixou de trazer o seat. O assento é de cada trecho, e não do passageiro, e passará a vir nos trechos quando o sistema gravá-lo por trecho.

  • Na consulta de vendas, o class do trecho aéreo deixou de vir com espaço no final quando a classe tem uma letra só ("A" em vez de "A ").

2026-09-30

Vendas

  • Inserir venda passou a respeitar a configuração Validar cadastro do pagante: com ela ligada, o payer sem os campos que o Monde exige para salvar a venda (endereço completo, documento, contato e, conforme o tipo de pessoa, data de nascimento ou razão social) é recusado com 422, com um erro por campo faltante, e nada é gravado. Vale o cadastro como fica depois da requisição, inclusive o que ela cria ou completa. Antes a venda era criada mesmo com o cadastro incompleto. Com a configuração desligada, o padrão, nada muda.

Tarefas

Viagens

  • Consultar viagem por ID passou a trazer attachments, com os anexos da viagem, no mesmo formato da venda. O anexo que também pertence a uma tarefa ou a uma venda não entra na lista, porque o download dele exige a permissão desse outro registro.

Anexos

  • Baixar anexo passou a constar na documentação. É o endereço que vem em download_url. Ele exige a permissão de leitura do registro dono do anexo: "Ler todas as tarefas", "Ler todas as vendas", "Ler todas as viagens", "Ler todas as contas a pagar e receber" ou "Ler todas as pessoas".

Pessoas e Vendas

  • Em Inserir pessoa, Alterar pessoa e Inserir venda, o city_ibge do endereço e da naturalidade (birthplace) passa a definir a cidade, que precisa estar cadastrada. O código que não corresponde a nenhuma cidade responde 422 em city_ibge, mesmo com nome, estado e país informados, e nada é gravado. Antes a resposta era de sucesso: a pessoa ficava sem a naturalidade, ou a cidade era criada com o código inválido. Para cadastrar uma cidade nova, envie city_name, state_code e country_code sem o city_ibge: a cidade é criada sem código IBGE.
  • Com o city_ibge, o state_code enviado diferente do estado da cidade responde 422 em state_code, e o country_code enviado diferente de BR responde 422 em country_code. O city_name não é conferido.
  • Na venda, a recusa do endereço do pagante ou de outra pessoa recusa a venda inteira, como as demais validações da pessoa.

2026-09-29

Vendas

  • Consultar venda por ID passou a trazer a moeda de origem de cada produto. currency é a moeda final da venda (BRL nas vendas criadas pela API), e os valores continuam nela, sem mudança. Entrou origin_currency, com a moeda em que o produto é originalmente comercializado, e exchange_rate passou a trazer o câmbio gravado no produto, no lugar do 1 fixo.
  • Cada valor que o Monde grava nas duas moedas ganhou um par com o sufixo _origin_currency, na moeda de origem: nos produtos (agency_service_fee, deductions, discount_amount), nos totals e nos passageiros (ex.: amount e amount_origin_currency). Comissão, over e os valores do intermediário não têm par. Isso corrige a regra da entrada de 2026-08-11, em que currency e exchange_rate devolviam sempre BRL e 1.
  • Na operação própria sem passageiros, agency_fee passa a vir na moeda final da venda, como os demais valores, e ganhou o par agency_fee_origin_currency. Antes vinha na moeda de origem. No envio nada muda: agency_fee continua sendo informado na moeda de origem.

2026-09-28

Conexão automática

  • A seção Conexão automática passou a trazer os exemplos completos de requisição e resposta da homologação, da troca do code pelo token e da revogação, o que chega na redirect_uri quando a agência aprova ou recusa (com o state), e os erros de cada etapa.
  • A revogação pelo parceiro, em POST /oauth/revoke, passou a estar documentada: ela exclui a conexão com a agência na hora.

Pessoas, Vendas, Tarefas e Cidades

  • Em Inserir pessoa, Alterar pessoa, Inserir venda, Criar tarefa, Alterar tarefa e Comentar na tarefa, o campo enviado num formato diferente do documentado passa a responder 422, com o nome do campo, e nada é gravado. Antes o campo era ignorado e a resposta era de sucesso, sem aquele dado. Vale para a lista ou o objeto enviado como texto, número ou booleano (como "labels": "..."), para o item de lista que não é objeto (como "labels": ["<id>"] no lugar de "labels": [{ "id": "<id>" }]) e para o valor simples enviado como lista ou objeto. O campo nulo ou com texto vazio continua valendo como não enviado.

  • Em Consultar pessoas e Consultar cidades, o filtro enviado como lista ou valor aninhado (como ?name[]=Ana) passa a responder 400, com o nome do parâmetro. Antes o filtro era ignorado e a consulta devolvia a lista sem ele.

2026-09-25

Cidades

  • Consultar cidades passou a aceitar o filtro name, que busca pelo nome da cidade por trecho, sem diferenciar maiúsculas, acentos nem a posição do trecho no nome (ex.: ?name=sao paulo). O filtro combina com a paginação e a ordenação por nome.

Tarefas

  • Alterar tarefa passou a estar disponível: altera title, description, due, category_id, assignee_id, person_id e custom_fields de uma tarefa já cadastrada. Informe apenas o que deve mudar — o campo omitido, ou enviado como nulo ou como texto vazio, permanece como está. A exceção é o title: a tarefa precisa ter título, e enviá-lo como texto vazio é recusado. Os campos personalizados enviados são gravados por cima dos atuais, e os demais permanecem.

  • completed conclui a tarefa (true) ou a reabre (false), e company_identifier leva a tarefa para outra empresa, o que exige a permissão Criar e editar em Tarefas também na empresa de destino.

  • A alteração exige a permissão Criar e editar em Tarefas e o cabeçalho Idempotency-Key. Quem participa da tarefa é avisado por e-mail, como na alteração feita no Monde.

  • Excluir tarefa passou a estar disponível: exclui a tarefa, que deixa de aparecer em Consultar tarefas e continua disponível na consulta por ID, com deleted igual a true. Tarefa concluída ou já excluída responde 409, e nada é alterado. Responde 204 sem corpo e não exige Idempotency-Key. Exige a permissão Excluir em Tarefas, que passou a ser oferecida na credencial da API, concedida na empresa da tarefa com licença de API que grave. Quem participa da tarefa é avisado por e-mail.

  • Tarefa excluída não pode ser alterada nem receber comentário: Alterar tarefa e Comentar na tarefa respondem 409.

  • Alterar tarefa e Comentar na tarefa respondem apenas com o id da tarefa quando a credencial não tem a permissão Ler todas as tarefas na empresa da tarefa. A gravação acontece do mesmo jeito, com o mesmo status. Quem tem a permissão de ler continua recebendo a tarefa completa, no mesmo formato da consulta por ID.

Pessoas

  • Alterar pessoa passa a responder apenas com o id da pessoa quando a credencial não tem a permissão "Ler todas as pessoas". A alteração é gravada do mesmo jeito, com o mesmo status 200. Quem tem a permissão de ler continua recebendo a pessoa completa, no mesmo formato da consulta por ID.

2026-09-24

Tarefas

  • Criar tarefa passou a estar disponível: informe company_identifier, title, due, category_id e assignee_id, e opcionalmente description, person_id e custom_fields. O responsável precisa ser um usuário ativo do Monde e é avisado por e-mail. A tarefa nasce pendente. Aceita Idempotency-Key para reenvio seguro.

  • A tarefa pode nascer com os primeiros comentários: envie history, uma lista de { "text": "..." }, no mesmo corpo da criação.

  • Comentar na tarefa acrescenta um comentário ao histórico de uma tarefa existente e devolve a tarefa com o histórico atualizado. Quem participa da tarefa é avisado por e-mail. O histórico é só acréscimo: não há como alterar nem excluir um comentário já registrado.

  • As duas escritas exigem a permissão Criar e editar em Tarefas, que passou a ser oferecida na credencial.

  • Na consulta de tarefas, due e completed_at passaram a sair sem o fuso horário, no mesmo formato de created_at e dos demais campos de data e hora da API: 2026-04-01T09:00:00 no lugar de 2026-04-01T09:00:00-03:00. O horário é o mesmo.

Pessoas

  • Na consulta de pessoas, last_contacts.last_task_update_at passou a sair sem o fuso horário, no mesmo formato das demais datas de last_contacts e dos outros campos de data e hora da API: 2026-07-01T15:12:00 no lugar de 2026-07-01T15:12:00-03:00. O horário é o mesmo.

Conexão automática

  • A seção Credenciamento de fornecedores passou a se chamar Conexão automática e vale para qualquer parceiro, não só para quem cria vendas.
  • As permissões do parceiro passam a ser definidas na homologação, e a agência vê essa lista no consentimento antes de autorizar. O parceiro homologado antes disso continua com a criação de vendas.
  • Criar vendas pela integração não exige licença de API. Permissões fora de Vendas exigem licença de API na empresa escolhida.
  • O parceiro com a criação de vendas não lê vendas: a venda criada volta completa na resposta do POST /sales. Anexos só entram na venda que o próprio parceiro criou.

2026-09-22

Pessoas

  • Excluir pessoa passou a estar disponível: exclui em definitivo a pessoa que não tem registros vinculados (vendas, lançamentos financeiros, notas fiscais, orçamentos, tarefas, anexos, entre outros) e que não é usuário nem empresa do sistema. Nesses casos a resposta é 409, com o motivo, e nada é alterado. Responde 204 sem corpo e não exige Idempotency-Key. Exige a permissão "Excluir" em Pessoas, que passou a ser oferecida na credencial da API, concedida numa empresa com licença de API que grave.

Logs

  • A descrição de todo log gravado por uma requisição da API passa a começar com a ação e o rótulo da credencial que a fez: Inserido via API pela credencial "...", Editado via API pela credencial "..." ou Excluído via API pela credencial "...". As linhas seguintes, com os campos alterados, não mudaram. Vale para tudo o que a requisição grava: o registro, os vínculos gravados junto com ele (como os marcadores e os contatos da pessoa) e os lançamentos que a venda gera no financeiro, inclusive os da fatura do fornecedor. Em Consultar logs o person desses logs continua nulo, porque a credencial não é uma pessoa.
  • O log separado com a descrição Registro cadastrado via API, que a API gravava junto de cada cadastro, deixou de existir: quem cadastrou passou a ser a primeira linha do log do próprio registro. Em Consultar logs o cadastro feito pela API passa a trazer um log a menos.

2026-09-21

Pessoas

  • Alterar pessoa passou a estar disponível: altera uma pessoa já cadastrada com os mesmos campos de Inserir pessoa. Informe apenas o que deve mudar — o campo omitido, ou enviado como nulo ou como texto vazio, permanece como está, e um campo de texto não é esvaziado por esta operação. O tipo da pessoa não muda, o external_id passa a identificá-la desde que não esteja identificando outra, e o CPF/CNPJ e o código de companhia aérea não podem pertencer a outra pessoa. Marcadores e contatos funcionam por substituição: a lista enviada passa a ser a da pessoa, a lista vazia retira todos os itens e o campo omitido mantém os atuais. Os campos personalizados não substituem: cada um enviado é gravado por cima do atual e os demais permanecem. Exige a permissão "Inserir e editar" em Pessoas e o cabeçalho Idempotency-Key.

Vendas

  • Os totais da venda passaram a considerar o desconto da taxa RAV e a segunda taxa do passageiro (other_fees, tip). Antes, o desconto informado no passageiro era gravado mas não abatia total nenhum, e a segunda taxa não entrava no total de taxas. Com isso o valor do produto, o total de descontos, as receitas, o faturamento e o saldo da venda passam a bater com o que o Monde calcula na tela.
  • rav_fee_discount só é aceito quando rav_fee for maior que zero. Enviar o desconto sem a taxa passa a responder 422, como o Monde já recusa na tela.

Anexos

  • Enviar anexo recusado com 422 passa a liberar a Idempotency-Key: reenviar o mesmo anexo com a mesma chave volta a ser processado, em vez de responder 409 indefinidamente.

2026-09-18

Licença e permissão

  • As respostas 403 passaram a apontar a causa certa em toda a API. A licença de API é cobrada na empresa em que a credencial trabalha — a empresa do registro consultado, ou a empresa em que a permissão foi concedida —, e não em qualquer empresa da base. Quem tem a permissão numa empresa sem licença de API passa a receber "Você não possui licença de API", no lugar de "Você não tem permissão para executar essa ação". A falta de licença é sempre relatada antes da falta de permissão.

Anexos

  • Enviar anexo passou a aceitar person em resource_type: informe o resource_id da pessoa de destino e o anexo entra no cadastro dela, aparecendo na consulta da pessoa por ID e no download. Exige, em Pessoas, a permissão Adicionar anexos, que passou a ser oferecida na credencial da API, concedida numa empresa com licença de API que grave. O restante do envio não muda: um arquivo por requisição, as mesmas extensões, o mesmo limite de 12 MB e o mesmo Idempotency-Key.

  • Enviar anexo deixou de exigir a permissão de consultar o recurso de destino: anexar numa venda pede apenas a permissão de anexo em vendas. A resposta muda junto: a venda em que a credencial não pode anexar passa a responder 403, no lugar do 422 "Recurso não encontrado" que saía quando faltava a permissão de consultar vendas. O 422 fica para o resource_id que não existe.

  • O limite de 10 requisições a cada 3 segundos do envio de anexo passa a contar toda tentativa, inclusive a que é recusada por autenticação, por permissão, por licença, por arquivo grande ou por requisição malformada. Uma sequência de tentativas recusadas agora chega ao 429.

Pessoas

  • Inserir pessoa passou a estar disponível: insere pessoa física ou jurídica com endereço, naturalidade, documentos e filiação, inscrição municipal, identificação fiscal, observações, cobrança de taxa de boleto, retenção de impostos, dados de companhia aérea, vendedor, promotor, marcadores, contatos e campos personalizados. O external_id é opcional e, quando informado, precisa estar livre; o CPF/CNPJ não pode pertencer a nenhuma pessoa já cadastrada. Exige a permissão "Inserir e editar" em Pessoas e o cabeçalho Idempotency-Key.

  • Em Consultar pessoa por ID, cada item de custom_fields passou a trazer o id da definição e deixou de trazer o name, como já acontecia na venda e no lançamento financeiro. O nome, o tipo e as opções vêm de Consultar campo personalizado por ID.

Vendas

  • Os campos installments (cartão de crédito e boleto) e installment_period (boleto) saíram dos pagamentos destinados à agência em Criar venda. Eles não parcelavam nada: a venda sempre nasceu com um lançamento só, no vencimento informado. Seguem sendo aceitos no corpo da requisição e ignorados, então quem já os envia continua criando vendas do mesmo jeito.

  • Para parcelar um pagamento à agência, envie um pagamento por parcela no array payments, todos com a mesma forma de pagamento, conta bancária e pagante, cada um com o seu due_date e a sua parte do valor em products[].payment_amount. Cada pagamento vira um lançamento financeiro.

  • Em vendor.credit_card o installments não mudou: segue sendo informado na criação e devolvido na consulta da venda.

  • Os nós de pessoa da criação de venda (payer, intermediary, approver, requester, supplier, representative, o person de cada passageiro e o payer de cada pagamento) passaram a aceitar os mesmos campos do cadastro de pessoas: business_phone, website, city_inscription, tax_identification_number, observations, charge_billet_fee, birthplace, additional_data, tax_withholding e airline. Cada campo é aceito no tipo de pessoa a que pertence, e o payload que já era enviado não muda. O charge_billet_fee descreve o cadastro inteiro e só vale quando a venda cria a pessoa: quando o external_id ou o documento já identifica alguém, ele é ignorado. Vendedor, promotor, marcadores, contatos e campos personalizados da pessoa são aceitos apenas em Inserir pessoa.

2026-09-15

Vendas

  • O campo que traz o documento do produto passou a se chamar document nos produtos em que o Monde escreve "Documento" na tela de cadastro: locação de veículo e pacote de viagem (antes booking_number), seguro viagem (antes voucher_code), bilhete de trem, transporte terrestre e excursão (antes locator). Em pacote CVC o mesmo campo passou a se chamar receipt_number, o "Recibo Nº" da tela.

  • Os produtos cujo rótulo na tela já era outro não mudaram: bilhete aéreo segue com locator ("Localizador"), hospedagem segue com booking_number ("Reserva"), cruzeiro segue com booking_number ("Booking"), e outros e operação própria já usavam document.

  • Na criação de vendas, o documento do passageiro passou a ser informado em document, no lugar de ticket_number, nos produtos em que o Monde tem esse campo: seguro viagem, transporte terrestre, bilhete de trem, pacote de viagem e operação própria. O ticket_number continua sendo o número do bilhete do passageiro do aéreo, na leitura e na criação, e o ticket_number de cada assento em ground_transportations[].segments[].seats[] não mudou.

  • O document do produto passou a aceitar 40 caracteres em todos os produtos, o mesmo tamanho que o Monde grava. Em transporte terrestre e bilhete de trem o limite era de 20.

  • Os nomes antigos seguem aceitos na criação de vendas e seguem saindo na leitura, mas saíram da documentação, que passa a descrever só o nome novo. Eles serão removidos em uma etapa seguinte, com tempo para as integrações existentes se ajustarem.

2026-09-14

Vendas

  • Em Criar venda, o campo travel_agent passou a se chamar seller, o mesmo nome que a consulta da venda já usa e o mesmo termo do Monde.

  • Na consulta de vendas, o passageiro de Outros, Excursão e Operação Própria passou a trazer o document, que já é preenchido no Monde mas não era devolvido. Nesses mesmos três produtos, o other_fees saiu da resposta, porque eles não têm uma segunda taxa por passageiro. Em Operação Própria também saíram rav_fee, rav_fee_discount e agency_fee, que o produto não cobra do passageiro. Locação de Veículo não mudou.

2026-09-11

Produtos

  • O kind dos produtos passou a trazer excursion (excursão) e cvc_package (pacote CVC). Os pacotes CVC vinham sem tipo na resposta.

  • O filtro ?kind= passou a aceitar cvc_package e excursion, e é descrito como lista de valores: vários tipos separados por vírgula, como em ?kind=insurance,cruise. A chamada não muda.

  • Em Consultar produto por ID, o campo restitutes_lei_kandir de cada fornecimento passou a se chamar restitutes_kandir_law. O valor não muda.

  • Os produtos de sistema passaram a aparecer nos exemplos com system: true, e a descrição do campo foi corrigida: produto de sistema não pode ser excluído, mas pode ser editado.

Vendas

  • Criar venda: o cargo da comissão no array commissions passou a ser informado pelo campo kind (seller, intermediary ou person), em vez de job_title_id (UUID). seller e intermediary gravam o cargo de sistema correspondente; person grava sem cargo. O external_id do destinatário continua obrigatório.

  • Na criação de vendas, o campo ticket_number do passageiro passou a ser aceito em operação própria, bilhete de trem e pacote de viagem, gravando o documento do passageiro — a mesma coluna que a consulta desses produtos devolve em document.

  • O filtro ?status= passou a ser descrito como lista de valores: vários status separados por vírgula, como em ?status=opened,closed. A chamada não muda.

Contas a pagar e receber

  • O filtro ?status= passou a ser descrito como lista de valores: vários status separados por vírgula, como em ?status=open,overdue. A chamada não muda.

2026-09-10

Anexos

  • Enviar anexo passou a estar disponível: envie um arquivo por requisição em multipart/form-data, informando resource_type (por ora sale) e o resource_id da venda de destino, além de file e um description opcional. Valida a extensão (pdf, imagens, arquivos office, txt, csv), o tamanho máximo de 12 MB e o conteúdo real do arquivo. O anexo passa a aparecer na consulta da venda e no download. Aceita Idempotency-Key para reenvio seguro.

2026-09-09

Vendas

  • O campo payer de cada pagamento passou a aceitar um objeto de pessoa completo, o mesmo do pagante da venda, e cria a pessoa quando ela ainda não existe. Antes, só referenciava por external_id alguém já cadastrado. Repetir o external_id do pagante da venda resolve para a mesma pessoa. Quando omitido, o pagamento segue herdando o pagante da venda.

2026-09-08

Autenticação

  • A autenticação passou a usar o esquema Bearer no cabeçalho Authorization. A credencial é a mesma e não precisa ser reemitida, então as integrações em produção seguem funcionando. Use Bearer daqui em diante.

Vendas

  • Em Criar venda, o external_id dos produtos passou a se chamar local_id, e o mesmo vale para cada item de payments[].*.products[]. O local_id é uma chave de correlação válida apenas dentro da requisição: precisa ser único entre os produtos daquela venda, não é armazenado e pode ser reutilizado em vendas seguintes. Ele aceita apenas texto.

  • Na leitura de Listar vendas e Obter venda por ID, os produtos deixaram de trazer o external_id. O identificador do produto na leitura é o id.

2026-09-03

Todas as consultas

  • As consultas de lista passaram a paginar por cursor. A resposta traz next_cursor no nó pagination, e para pedir a próxima página basta devolvê-lo no parâmetro cursor, enquanto has_next_page for verdadeiro. Veja a seção de Paginação. O parâmetro page continua funcionando como antes para quem já integrou, mas não é mais a forma divulgada: pelo page o custo de cada página cresce com a profundidade da varredura, e pelo cursor não cresce. Quem pagina por cursor não recebe mais page no nó pagination.

2026-09-02

Credenciamento de fornecedores

  • O fornecedor passou a receber as credenciais numa página própria no Monde (o e-mail traz só o link para ela); o client_secret é exibido uma única vez e não é mais enviado por e-mail. A página também traz o snippet do botão "Conectar com o Monde".
  • O credenciamento ganhou um passo de homologação: confirme suas credenciais em POST /oauth/homologation (HTTP Basic com client_id e client_secret). Enquanto pendente, a autorização não funciona; ao responder 200, passa a ativo. Veja a seção Credenciamento de fornecedores.

2026-09-01

Vendas

  • Criar venda passou a aceitar o campo payer em cada pagamento (cartão de crédito, boleto e depósito na agência; cartão, crédito e outros no fornecedor), referenciando por external_id a pessoa que efetivamente paga aquele pagamento — tipicamente o responsável financeiro informado na venda. Na agência, a Conta a Receber gerada usa esse pagante como Pessoa; no fornecedor, o pagante vai no lançamento da Conta a Pagar. Quando omitido, o pagamento herda o pagante da venda. Um external_id que não corresponde a nenhuma pessoa cadastrada devolve 422.

2026-08-31

Vendas

  • Criar venda passou a aceitar o requester (solicitante), para registrar quem pediu a venda junto da criação. É pessoa física, campo opcional, resolvido por external_id (find-or-create), como os demais papéis.

2026-08-28

Vendas

  • Criar venda passou a aceitar o array commissions, para gravar comissões manuais (vendedor, intermediário ou outra função) junto da venda. O destinatário é referenciado por external_id, o mesmo informado no vendedor/intermediário; o cargo vai em job_title_id. Só é aceito quando status é closed; comissão de cargo intermediário exige que a venda tenha intermediário.

2026-08-27

Vendas

  • Criar venda passou a devolver 422 quando o CPF/CNPJ de uma pessoa da venda (pagador, fornecedor, passageiro) já pertence a outra pessoa da base, com o erro no campo cpf_cnpj. Antes, o conflito de documento estourava erro interno (500).

2026-08-26

Credenciamento de fornecedores

  • Fornecedores homologados pelo Monde passaram a criar vendas na API v3 em nome da agência via OAuth 2.0 (Authorization Code + PKCE), sem a agência compartilhar senha de credencial. Veja o passo a passo (autorização na URL raiz, troca do code pelo token e uso do Bearer na URL fixa da v3) na seção Credenciamento de fornecedores. A agência revoga o acesso a qualquer momento e a revogação invalida o token na hora.

2026-08-24

Vendas

  • Criar venda passou a herdar os serviços inclusos cadastrados no produto. Quando o campo included_services do produto da venda não é enviado, o texto do cadastro do produto é gravado; quando é enviado, o texto informado é acrescentado ao do cadastro. Antes, o campo do produto da venda ficava com apenas o que a requisição enviava.

2026-08-21

Vendas

  • Consultar vendas passou a filtrar por number (um por requisição): informe o número exibido no aplicativo e a consulta devolve a venda correspondente sem precisar traduzir número em UUID antes. Número não inteiro devolve 400.
  • Consultar vendas passou a filtrar por updated_since (data ou data-hora ISO 8601, ex.: 2026-08-01 ou 2026-08-01T14:30:00; sem fuso, considera Brasília): devolve as vendas atualizadas nesse instante ou depois, para reprocessar só o que mudou desde a última consulta, inclusive no mesmo dia. Um valor inválido devolve 400.

Viagens

  • Consultar viagens passou a filtrar por data com date_field + date_from/date_to: escolha a data em date_field (start_date ou end_date, o início e o fim da viagem calculados a partir das vendas vinculadas) e informe o intervalo fechado inclusivo em date_from/date_to (ISO YYYY-MM-DD, ambos opcionais). date_field é obrigatório quando há alguma data; data em formato inválido, intervalo invertido (date_from maior que date_to) ou date_field fora da lista devolvem 400. Viagem sem vendas vinculadas não tem datas calculadas e nunca aparece em um intervalo de datas.

Contas a pagar e receber

  • Consultar contas a pagar e receber passou a filtrar por number (um por requisição): informe o número do lançamento exibido no aplicativo. Lançamentos parcelados têm sufixo de parcela (ex.: 362-1), então informe o número exatamente como aparece.
  • Consultar contas a pagar e receber passou a filtrar por data com date_field + date_from/date_to: escolha a data em date_field (issue_date = emissão, due_date = vencimento, settlement_date = liquidação) e informe o intervalo fechado inclusivo em date_from/date_to (ISO YYYY-MM-DD, ambos opcionais). date_field é obrigatório quando há alguma data; data em formato inválido, intervalo invertido (date_from maior que date_to) ou date_field fora da lista devolvem 400. Filtrar por settlement_date traz só contas liquidadas (as não liquidadas não têm data de liquidação e ficam de fora do intervalo); como o status padrão (open, overdue) exclui liquidadas, inclua settled no parâmetro status ao usar settlement_date.

2026-08-20

Vendas

  • Criar venda passou a aceitar o campo status. O padrão continua opened; envie closed para já criar a venda fechada. O fechamento respeita todas as regras existentes (sem saldo pendente, e na base consolidadora o intermediário é obrigatório) e exige a permissão de fechar venda na credencial. Se a venda não puder ser fechada, a criação inteira é recusada com 422 e nada é gravado.

2026-08-17

Vendas

  • Consultar vendas passou a filtrar por data com date_field + date_from/date_to: escolha a data em date_field (sale_date, departure_date ou return_date) e informe o intervalo fechado inclusivo em date_from/date_to (ISO YYYY-MM-DD, ambos opcionais). Substitui period_start/period_end, que foram removidos. date_field é obrigatório quando há alguma data; data em formato inválido, intervalo invertido (date_from maior que date_to) ou date_field fora da lista devolvem 400.

  • Na resposta da venda, period_start e period_end viraram departure_date e return_date — mesmos valores (início e fim da viagem, calculados pela menor e maior data dos produtos).

2026-08-14

Vendas

  • Consultar venda por ID passou a trazer o array excursions.
  • Na criação de vendas, o campo de taxa do passageiro (fees) passou a ser aceito em todos os produtos com passageiros — seguro viagem, cruzeiro, hospedagem, transporte terrestre, aluguel de carro, trem, pacote de viagem e operação própria —, alinhado ao que a leitura já usa. rav_fee, rav_fee_discount e agency_fee passaram a ser aceitos nos mesmos produtos, exceto operação própria, cujo passageiro só tem valor e taxa; other_fees (hospedagem, aluguel de carro, pacote de viagem) e tip (cruzeiro) também passaram a ser aceitos. Nos produtos que tinham nome próprio para a taxa principal — service_fee (hospedagem e transporte terrestre) e booking_fee (trem) —, os nomes antigos continuam aceitos por enquanto, mas saem da documentação em favor de fees.
  • Corrigido totals.balance: vendas criadas pela Criar venda vinham sempre com saldo 0 na leitura, mesmo tendo saldo em aberto real. Passa a refletir o saldo correto tanto na consulta em lista quanto na consulta por ID.

Pessoas

  • Consultar pessoa por ID ganhou o nó kandir_law: a retenção de imposto por produto (valor, taxa de embarque, taxa DU/RAV e taxa de serviço, cada uma com o detalhamento por imposto — IR, CSLL, PIS e COFINS — e o total, nos regimes nacional e internacional), com a referência ao produto. Só existe para pessoa jurídica; vem null para pessoa física.
  • city_inscription e tax_identification_number voltaram para o nível raiz da pessoa. Estavam dentro de additional_data, que só existe para pessoa física, mas os dois são dados de pessoa jurídica.

Regras de faturamento

  • Em closing.period_kind, o valor separate virou standalone. "Avulso" é o fechamento que deixa cada venda em uma fatura própria, e standalone é como a API já nomeia esse mesmo conceito no kind do lançamento financeiro.

Contas a pagar e receber, e notas fiscais

Nomenclatura

  • Os schemas de Produtos e de Tarefas passaram a seguir a convenção do restante da API: o schema da consulta em lista ganhou o sufixo _summary, e o nome sem sufixo passou a ser o da consulta por ID.

Nomenclatura

2026-08-13

Ajuste do padrão de leitura em vários endpoints, na mesma direção da entrada de 2026-08-11: a consulta em lista traz os campos do próprio registro, e as associações — referências e dados de outras entidades — ficam na consulta por ID.

Pessoas

  • Consultar pessoas passou a trazer todos os campos da própria pessoa, que antes só existiam na consulta por ID: rg_ie, passport_number, passport_expiration_date, foreigner, foreign_identity_document, business_phone, website, cvc_code, observations, charge_billet_fee, registered_at e os nós additional_data, last_contacts, tax_withholding e airline.
  • Entraram gender e birthdate, nas duas leituras.
  • Consultar pessoa por ID ficou com o que é associação: birthplace, seller, promoter, registered_by, contacts, labels, custom_fields, attachments e credit_cards.
  • Os contatos e os cartões de crédito não trazem id: são dados que só existem dentro da pessoa.
  • Nos cartões de crédito, masked_number virou last_digits e passou a trazer só os quatro últimos dígitos, sem a máscara.

Contas a pagar e receber

  • Consultar contas a pagar e receber passou a trazer billet, check e card, que antes só existiam na consulta por ID. São dados do próprio lançamento.
  • Em credit_card_items, o id — que era o identificador da movimentação, não da linha — deu lugar à referência movement, resolvida em Consultar movimentação por ID.

Notas fiscais

Cidades, categorias, contas e cartões

Logs

  • kind passou a declarar os valores possíveis: insertion, edition, deletion, custom e export. Não há outros.
  • A descrição de person passou a indicar Consultar pessoa por ID, o endpoint que resolve a referência.

Vendas, produtos, tarefas e regras de nota fiscal

  • Consultar venda por ID passou a trazer a referência travel, resolvida em Consultar viagem por ID. O vínculo existia só no sentido inverso.
  • Produtos passou a trazer active, e Tarefas, deleted.
  • Nas regras de nota fiscal, dentro de payer_rule, supplier_rule e representative_rule, o recipient passou a vir antes de revenues e discounts.

2026-08-12

  • Consultar vendas ganhou o filtro people_id: retorna as vendas em que a pessoa informada participa em qualquer papel (pagante, vendedor, intermediário, solicitante, aprovador, promotor, passageiro, fornecedor, representante ou quem cadastrou a venda). Aceita vários identificadores separados por vírgula — a venda entra quando qualquer uma das pessoas participa.

  • Novos endpoints de leitura das definições de campos personalizados: Consultar campos personalizados e Consultar campo personalizado por ID. A consulta lista os campos personalizados por recurso (sales, travels, people, bills e tasks), com o identificador, o nome, o tipo, se é obrigatório, se está ativo e as opções cadastradas dos campos do tipo lista, e aceita o filtro resource; a consulta por ID resolve a definição de um campo a partir do id. As definições não são recortadas por empresa. O identificador de cada campo é numérico (não é um UUID como no resto da API).

  • O nó pagination deixou de trazer total e total_pages, e passou a trazer has_next_page. Para percorrer uma consulta inteira, peça a próxima página enquanto has_next_page for verdadeiro. O pedido não muda: page e size funcionam como antes. Contar o total exigia percorrer todos os registros que atendiam ao filtro a cada requisição, o que em bases grandes custava mais do que buscar a própria página.

2026-08-11

Toda leitura passou a ter duas formas: uma consulta em lista, enxuta, para extrair volume, e uma consulta por ID, com o registro completo. As associações não vêm mais embutidas: vêm como referência, só com o identificador. A descrição de cada referência indica o endpoint que a resolve, e referências e coleções aparecem apenas na consulta por ID. As mudanças estão agrupadas por endpoint.

As consultas por ID novas estão documentadas antes de existirem: cada uma leva a etiqueta Em desenvolvimento até o código entrar. As consultas em lista que já existiam seguem em Beta, disponíveis para uso.

Vendas

  • Consultar vendas devolve só os campos escalares da venda e os totais. Os produtos, os pagamentos, as comissões, os anexos, os campos personalizados e o nó financial saíram da lista e continuam em Consultar venda por ID, que é também onde ficam as referências: pagante, vendedor, empresa, intermediário, solicitante, aprovador, promotor, operação e quem cadastrou.
  • sale_id virou id. travel_agent virou seller, e a referência aponta para Consultar vendedor por ID — o id é o mesmo de antes, porque o vendedor compartilha o identificador da pessoa; para os dados de pessoa, use o mesmo id em Consultar pessoa por ID.
  • Saíram três campos: company_identifier, que era o CNPJ copiado da empresa e dá lugar à referência company (na criação continua obrigatório), totals.payments e o role das comissões.
  • Nas comissões, value, retained_value e leftover viraram amount, retained_amount e balance; nos totais, final_value virou final_amount; nos repasses ao fornecedor, value virou amount.
  • Os pagamentos mudaram de forma. payments deixou de ser lista e virou um objeto com agency e vendor. Em agency, bills e refunds são listas de referência, resolvidas em Consultar conta a pagar ou receber por ID e em Consultar reembolso por ID; credit, retained_by_intermediary e legacy vêm embutidos, porque não geram lançamento financeiro. Em vendor, há uma lista por forma: credit_card, check, credit e others.
  • Com isso saíram os nós por forma do lado da agência (cash, check, credit_card, debit_card, bank_slip, bank_deposit, others, custom e invoice). Todos eles geram um lançamento, e é o lançamento que traz a forma de pagamento, a conta, a liquidação, o boleto e os produtos cobertos. Um lançamento liquidado em várias formas aparece uma vez, e cada liquidação vem em movements, no próprio lançamento.
  • Cada item de products traz agora amount e a referência sale_product, no lugar de external_id e payment_amount. Todo pagamento embutido ganhou payer, que pode ser diferente do pagante da venda.
  • No nó financial, vendor virou vendor_bills e bills virou standalone_bills — as duas agora listas de referência aos lançamentos. Os itens e valores vêm do próprio lançamento.
  • O campo operation da venda é a referência à operação própria do cabeçalho, e o detalhe do produto de operação própria fica na coleção operations, junto dos demais produtos. Na entrada de 2026-08-07 esse campo passou a trazer o produto inteiro quando havia linha; agora ele é sempre referência.
  • Cada produto da venda passou a trazer o próprio id, o que torna resolvível a referência sale_product do lançamento, da nota fiscal, do reembolso e do extrato CVC. Nos tipos others, operation e cvc_package, saíram product_name e product_with_passengers e entrou a referência product; nos outros oito tipos existe um único produto de sistema por tipo, e o nome do array já identifica qual é.
  • currency é um código ISO (texto) na criação e na consulta; o objeto currency completo ficou exclusivo de Moedas. Nos produtos da venda, currency e exchange_rate são campos de criação: na consulta devolvem sempre BRL e 1, e os valores vêm convertidos para Real.
  • Em custom_fields, cada campo passou a trazer o id da definição e deixou de trazer o name. O nome, o tipo e as opções vêm da consulta de definições de campos personalizados.
  • A resposta de Inserir venda passou a ser a mesma da consulta por ID. O corpo da requisição não muda.
  • Criar venda passou a aceitar o campo opcional description nos pagamentos de agência (cartão de crédito, boleto e depósito). Quando informado, o texto é gravado no lançamento financeiro; quando omitido, continua sendo usado "Pagamento venda". Máximo de 60 caracteres.

Contas a pagar e receber

  • Consultar conta a pagar ou receber por ID ganhou os blocos check e card, com os dados de cheque e de cartão informados no cadastro. Antes eles só apareciam na venda, e ficavam inacessíveis enquanto o pagamento não fosse liquidado.
  • No kind, sale_separate e vendor_separate viraram sale_standalone e vendor_standalone. O filtro kind aceita os novos valores.
  • Em custom_fields, cada campo passou a trazer o id da definição e deixou de trazer o name, como na venda.

Pessoas

  • Novo Consultar pessoa por ID, com os contatos, os marcadores, os campos personalizados, os anexos e os cartões de crédito. Consultar pessoas ficou enxuta.
  • A cidade do endereço, a naturalidade, o vendedor, o promotor e quem cadastrou vêm como referência.
  • external_id passou a constar na consulta: a resposta já trazia o identificador que você atribuiu à pessoa, mas ele não estava documentado. Vem nulo quando a credencial que consulta não tem identificador externo para aquela pessoa.
  • Listar pessoas passou a aceitar filtros por name, cpf_cnpj, passport_number, phone, kind (individual ou company), code e email. Todos são opcionais e combináveis (E lógico entre eles): name, passport_number e email casam por trecho, ignorando maiúsculas e acentos; cpf_cnpj e phone aceitam só os dígitos (a máscara é ignorada) e code é valor exato. Sem nenhum filtro, o comportamento é o mesmo de antes.

Produtos

  • Novo Consultar produto por ID, com os fornecimentos em supplies: cada um traz o fornecedor, os dados de comissão e os representantes.
  • Nos fornecimentos, commission_value virou commission_amount, e commission_type passou a aceitar amount em vez de value.

Tarefas

Viagens

  • Novo Consultar viagem por ID, com as referências às vendas e aos passageiros vinculados. Os valores por passageiro pertencem a cada venda e saem pelo endpoint da venda.
  • client virou customer, e seller passou a apontar para o endpoint de vendedores.

Extrato CVC

Orçamentos

Anexos

  • attachment_id virou id.

Demais cadastros

Cadastros novos na leitura

2026-08-10

  • Criar venda passou a aceitar campos personalizados no campo custom_fields (array de {id, value}). O id é o mesmo retornado por Consultar campos personalizados; o value deve corresponder ao tipo do campo (número inteiro para numérico, número para monetário, data ISO 8601, texto para os demais). ⚠️ Campos ativos e obrigatórios do módulo de vendas passam a ser exigidos: o create devolve 422 se um deles não vier com valor.

  • Na leitura de vendas e de lançamentos financeiros, cada item de custom_fields passou a ser {id, value}: traz o id do campo (a referência) e o value, e deixou de trazer o name. O nome, o tipo e o restante da definição são obtidos em Consultar campo personalizado por ID ou em Consultar campos personalizados, para o consumidor sempre ler a referência e não um dado projetado que pode desatualizar.

2026-08-07

  • Criar venda passou a aceitar o produto de operação própria no campo operation (objeto único; no máximo um por venda). O produto é informado por product_id e, conforme a configuração dele, os valores vão por passengers ou por quantity × unit_price (com unit_fee e a taxa de serviço oculta agency_fee, um valor único da linha); o fornecedor é a própria empresa da venda.

  • Na leitura (Listar vendas e Obter venda por ID), o campo operation passou a trazer o detalhe completo do produto de operação própria; antes trazia só id e name.

  • Novos endpoints de leitura do histórico de alterações: Consultar logs e Consultar logs por ID. A consulta traz a ação registrada, a origem, a descrição da alteração e o momento em que ela foi gravada, com filtros por autor, registro auditado, ação e origem; a consulta por ID acrescenta as referências para o autor e para o registro auditado. O histórico não é recortado por empresa.

2026-08-04

  • Os itens de Obter conta a pagar ou receber por ID mudaram: customer_items e vendor_items foram substituídos por um único items, que traz todos os itens do lançamento, inclusive os de pagamento de venda, que antes não saíam em array nenhum. O item passou a trazer só as próprias colunas (description, cost_center, checked, amount) mais as referências sale, sale_product e cvc_statement; os dados do produto da venda saíram, e a fonte deles é Obter venda por ID.

  • Cada linha de credit_card_items passou a trazer id e a referência bill, e perdeu description e person. O id é o da movimentação, então dá para consultá-la em Obter movimentação por ID.

  • Cada linha de commissions ganhou a referência person, e o campo leftover passou a se chamar balance.

  • O lançamento perdeu sale_number, balance, status, overdue_days e settled_late, e ganhou canceled, checked, invoice_closed, system_generated e recurrence_group_id. A visualização por ID ganhou as referências sale e invoice_rule. No filtro status, o valor paid passou a settled.

2026-07-31

  • Novos endpoints de leitura do extrato CVC: Consultar extrato CVC e Consultar extrato CVC por ID. A consulta traz o número do recibo, as datas de movimentação, venda, cancelamento, embarque e retorno, o nome do produto, o nome do pacote, os totais, as comissões, o depósito, os saldos e as marcas de importado, editado, conferido e excluído; a visualização por ID acrescenta o tipo do movimento e as referências para empresa, contratante, vendedor, intermediário, venda, produto da venda, nota fiscal e quem cadastrou. Recibo excluído fica fora da consulta, mas continua acessível por ID. Escopo por empresa.

  • Novos endpoints de leitura de notas fiscais: Consultar notas fiscais e Consultar notas fiscais por ID. A consulta traz numeração, situação, natureza da operação, datas, valores, os dados do tomador gravados na nota com a referência para a cidade dele, as retenções e tributos e os dados da NFS-e, com filtros de situação e de período de emissão; a visualização por ID acrescenta os itens da nota e as referências para pessoa, empresa, produto da venda, venda e quem cadastrou ou cancelou. Escopo por empresa.

  • Novos endpoints de leitura de reembolsos: Consultar reembolsos e Consultar reembolsos por ID. Trazem o lado do reembolso (cliente ou fornecedor), o valor, a descrição, a emissão e o vencimento, e a visualização acrescenta as referências para venda, produto da venda, pessoa, empresa e conta a pagar ou a receber, com escopo por empresa.

2026-07-29

  • Novos endpoints de leitura de movimentações: Consultar movimentações e Consultar movimentação por ID. A consulta traz data, valor, sentido (crédito ou débito), observação e os dados de cheque e de cartão; a consulta por ID acrescenta as referências para conta, forma de pagamento, conta a pagar/receber, fatura de cartão e conta do outro lado da transferência. Escopo por empresa.

2026-07-28

  • Novos endpoints de leitura de contas a pagar e receber: Consultar contas a pagar e receber e Consultar conta a pagar ou receber por ID. Trazem identificação, valores, situação, boleto, recorrência, categorias, rateios, movimentações de liquidação, itens de fatura (cliente, fornecedor ou cartão), comissões, anexos e campos personalizados, com escopo por empresa.

2026-07-17

  • Os endpoints Consultar vendas e Consultar venda por ID passaram a incluir os anexos da venda no campo attachments: cada anexo traz id, description, extension, content_type e download_url, com o conteúdo acessível por um link de download temporário.

2026-07-16

2026-07-15

  • Os endpoints Consultar vendas e Consultar venda por ID passaram a incluir as comissões da venda no campo commissions: o rateio por pessoa e função (vendedor, intermediário e outros), com valor da comissão, valor retido e saldo.

2026-07-14

  • Os endpoints Consultar vendas e Consultar venda por ID passaram a incluir os dados financeiros da venda no campo financial: observações financeiras, os repasses aos fornecedores e os lançamentos de contas a pagar e a receber vinculados à venda.

Conexão automática

Além da credencial gerada pela agência, um parceiro aprovado pelo Monde pode acessar a API v3 em nome de uma agência de viagens, via OAuth 2.0 (Authorization Code + PKCE), sem que a agência compartilhe a senha de uma credencial. O que o parceiro pode fazer é definido pelo Monde na aprovação, e a agência vê e aprova essa lista ao autorizar.

Em resumo

  1. A agência clica em "Conectar com o Monde" no seu sistema, entra no Monde e autoriza o seu sistema.
  2. O Monde devolve a agência para a sua redirect_uri com um code.
  3. O seu backend troca o code por um token e usa o token para chamar a API em nome daquela agência.
O fluxo é OAuth 2.0 de autorização (Authorization Code + PKCE). Ele não é login único (SSO) nem OpenID Connect: o token dá acesso à API da agência e não identifica a pessoa que autorizou. O Monde não devolve id_token nem dados do usuário.

Todos os endpoints desta seção ficam em https://web.monde.com.br.

Cadastro e credenciais

  • Cadastre o parceiro em https://web.monde.com.br/partners/signup e confirme o e-mail. O Monde analisa o cadastro, define as permissões e aprova.
  • Na aprovação, o Monde envia por e-mail um link para a sua página de conexão automática. O client_id e o client_secret aparecem nessa página; o secret é exibido uma única vez, então guarde-o na hora. Se precisar vê-lo de novo, solicite a regeneração ao Monde.
  • Guarde o client_secret só no seu backend. Ele nunca vai para o navegador nem para o app do usuário.

1. Habilitar a conexão automática

Na área do parceiro (https://web.monde.com.br/partners/integration), informe a redirect_uri e a URL da política de privacidade, que a agência vê ao autorizar. A conexão fica habilitada assim que o cadastro está aprovado e as duas estão informadas, sem nenhum outro passo. Enquanto falta uma delas, a autorização não funciona.
  • A redirect_uri é uma só por parceiro e precisa usar https. Ela precisa ser idêntica, caractere por caractere, na autorização e na troca do token (uma barra no fim já é diferença). Endereços http, inclusive localhost e 127.0.0.1, não são aceitos.
  • Depois de habilitada, você pode trocar as duas URLs, mas não deixá-las em branco.

2. Autorização

A cada tentativa de conexão, gere no backend um state e um code_verifier novos e guarde os dois na sessão do usuário. O code_verifier é um texto aleatório de 43 a 128 caracteres; o code_challenge é BASE64URL(SHA256(code_verifier)), sem o = no fim. PKCE é obrigatório e só aceita S256: ele é o que impede outro sistema de trocar um code interceptado.
code_verifier=$(openssl rand -base64 64 | tr -d '=+/\n' | cut -c1-64) code_challenge=$(printf '%s' "$code_verifier" | openssl dgst -sha256 -binary | openssl base64 | tr '+/' '-_' | tr -d '=\n')
Redirecione o usuário da agência para a URL de autorização, com os valores codificados para URL:
GET https://web.monde.com.br/oauth/authorize?response_type=code&client_id=SEU_CLIENT_ID&redirect_uri=SUA_REDIRECT_URI&state=STATE&code_challenge=CODE_CHALLENGE&code_challenge_method=S256
  • Não envie scope: o que o parceiro pode fazer são as permissões definidas na aprovação.
  • Se o client_id não é de um parceiro ativo e aprovado, se a conexão ainda não está habilitada (falta a redirect_uri ou a política de privacidade), se a redirect_uri não é a cadastrada, ou se falta o code_challenge ou o code_challenge_method não é S256, o Monde responde 400 numa página própria e não volta para a redirect_uri.
A agência faz login, escolhe a empresa e consente. Só um administrador da agência pode autorizar.

3. Retorno na redirect_uri

Quando a agência aprova, o navegador volta para a redirect_uri com o code e o mesmo state que você enviou:
SUA_REDIRECT_URI?code=agencia%7CujES3JCJylJRoM3j_kGeavaD2hFqz2oqw1Lazq_u0rs&state=STATE
Quando a agência recusa:
SUA_REDIRECT_URI?error=access_denied&error_description=O+dono+do+recurso+ou+o+servidor+de+autoriza%C3%A7%C3%A3o+negou+a+requisi%C3%A7%C3%A3o.&state=STATE
  • Compare o state com o da sessão. Se for diferente ou faltar, descarte a resposta.
  • O code é opaco. Use o valor decodificado da URL do jeito que veio, sem cortar nem trocar caracteres. Ele vale 10 minutos e só pode ser trocado uma vez.
  • Nada volta para a redirect_uri quando quem entrou não é administrador da agência. Nesse caso o usuário vê a explicação numa página do Monde. O consentimento oferece todas as empresas ativas da agência, e nenhuma é recusada por licença.

Botão "Conectar com o Monde"

Coloque na sua plataforma um botão no padrão de "Entrar com o Google", com o texto "Conectar com o Monde". O href aponta para a URL de autorização que você monta no seu backend a cada acesso, com um code_challenge PKCE novo (passo 2 acima), nunca um link estático. O símbolo do Monde é hospedado por nós: https://web.monde.com.br/logo-monde-conectar.svg (colorido, para fundo claro) e https://web.monde.com.br/logo-monde-conectar-branco.svg (branco, para fundo azul). Três variações:

1. Negativo (fundo azul)

Monde Conectar com o Monde
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0 20px 0 14px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600 14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar-branco.svg" alt="Monde" style="height:22px"> Conectar com o Monde</a>

2. Colorido (fundo branco)

Monde Conectar com o Monde
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0 20px 0 14px;background:#fff;color:#344050;border:1px solid #d8e2ef;border-radius:6px;font:600 14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar.svg" alt="Monde" style="height:22px"> Conectar com o Monde</a>

3. Só texto

Conectar com o Monde
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;height:40px;padding:0 20px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600 14px 'Open Sans',Arial,sans-serif;text-decoration:none">Conectar com o Monde</a>

4. Troca do code pelo token

Faça a troca no backend, nunca no navegador. O corpo vai em application/x-www-form-urlencoded; o mesmo corpo em JSON (application/json) também é aceito.
curl -X POST https://web.monde.com.br/oauth/token -H "Content-Type: application/x-www-form-urlencoded" --data-urlencode "grant_type=authorization_code" --data-urlencode "code=CODE" --data-urlencode "redirect_uri=SUA_REDIRECT_URI" --data-urlencode "client_id=SEU_CLIENT_ID" --data-urlencode "client_secret=SEU_CLIENT_SECRET" --data-urlencode "code_verifier=CODE_VERIFIER"
Resposta 200:
{ "access_token": "YWdlbmNpYXw2ZjFj...", "token_type": "Bearer", "scope": "full_access", "created_at": 1790602784 }
O access_token não expira e não vem refresh_token. Guarde-o no backend, um por agência conectada, e trate-o como senha.
  • 400 com {"error":"invalid_grant","error_description":"..."}: code vencido ou já trocado, code_verifier que não corresponde ao code_challenge, ou redirect_uri diferente da usada na autorização. Recomece pela autorização.
  • 400 com {"error":"invalid_request","error_description":"..."}: o code_verifier não foi enviado.
  • 401 com {"error":"invalid_client","error_description":"..."}: client_id ou client_secret errado.
  • 404 com corpo vazio: o code chegou alterado.

5. Uso na API v3

A URL da API v3 não muda: chame https://web.monde.com.br/api/v3 com o token no cabeçalho Authorization (o token já carrega a agência).
Authorization: Bearer SEU_ACCESS_TOKEN
Para confirmar que a conexão funciona sem criar dado, chame GET /api/v3/sales com o token:
curl https://web.monde.com.br/api/v3/sales -H "Authorization: Bearer SEU_ACCESS_TOKEN" -H "Content-Type: application/json"
  • 200 com a lista das vendas que o parceiro alcança (as que ele criou e, quando o Monde concedeu na aprovação o acesso a outras origens, também as demais; sem essa exceção, a lista vem vazia numa conexão nova): o token é válido e a integração está pronta.
  • 403 com {"errors":["Você não tem permissão para executar essa ação."]}: o token é válido, mas o parceiro não tem a permissão "Visualizar" de vendas na empresa.
  • 401 com {"errors":["Credenciais de acesso não são válidas."]}: o token é inválido ou a conexão foi excluída. Recomece pela autorização.
  • O parceiro só acessa a empresa que a agência escolheu, com as permissões que ela aprovou. Em vendas, contas a pagar e receber, tarefas e viagens, cada permissão alcança só o que o parceiro criou, e listar e consultar pedem a permissão "Visualizar" do recurso também no que ele criou; o acesso aos registros de outras origens é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento. Também são exceção as permissões sobre o que vale para a agência inteira, porque quem grava alcança o que a agência cadastrou: criar e editar campos personalizados; criar, editar e excluir categorias de tarefa, marcadores, funções, regras de faturamento, regras da nota fiscal, produtos (com os fornecedores e os representantes deles), contas e cartões (e reabrir o caixa delas), categorias financeiras, centros de custo, formas de pagamento e informações das formas de pagamento; gravar, excluir, emitir e copiar notas fiscais e gerar notas fiscais, porque a nota é documento fiscal da agência; fechar e pagar comissões, que alcançam as de todos os vendedores; consultar, lançar, alterar, excluir e restaurar recibos do Extrato CVC; todo o Master - Extrato CVC, o Fechamento de Extrato CVC, o Master - Fechamento de Extrato CVC e a Conferência Depósito CVC, inclusive a consulta; e a importação de extratos CVC, que grava as vendas e os cadastros da empresa vindos da CVC, de qualquer origem.
  • A conexão não exige licença à parte para nenhuma permissão. As regras de cada recurso continuam valendo: a empresa somente leitura não recebe gravação, e os Guias exigem a licença Monde Pro.
  • A venda criada volta completa na resposta do POST /sales.
  • A agência pode excluir a conexão a qualquer momento; o acesso cai na hora e a API passa a responder 401.

6. Desconectar (revogação)

Quando o usuário desconectar na sua plataforma, ou se o token vazar, revogue o token no backend:
curl -X POST https://web.monde.com.br/oauth/revoke --data-urlencode "token=SEU_ACCESS_TOKEN" --data-urlencode "client_id=SEU_CLIENT_ID" --data-urlencode "client_secret=SEU_CLIENT_SECRET"
A resposta é 200 com {}. A conexão com a agência é excluída na hora e o token para de funcionar. Para conectar de novo, recomece pela autorização.
  • 403 com {"error":"unauthorized_client",...}: client_id ou client_secret errado, ou o token não pertence a este client_id. Nada é revogado.

7. Conexão iniciada pela agência

Opcional. O caminho padrão é o botão Conectar com o Monde (passos 2 a 4), que toda integração precisa ter. Implemente este passo só depois do botão, se quiser oferecer a conexão também pela tela de Integrações do Monde Web. Ele não substitui o botão. A agência também pode conectar com o parceiro sem sair do Monde: na tela de Integrações, um administrador escolhe o parceiro e a empresa, vê as permissões e confirma. Não é um fluxo OAuth e não passa pela redirect_uri: o seu backend consulta as conexões novas e recebe cada uma já com o token, sem ninguém copiar chave.
  • Para aparecer na tela de Integrações, marque Conexão iniciada pela agência na área do parceiro (https://web.monde.com.br/partners/integration), só depois que a consulta abaixo estiver implementada. A conexão automática precisa estar habilitada (passo 1).
  • O consentimento é dado pela agência dentro do Monde, com as mesmas permissões do passo 2. A conexão pela autorização (passos 2 a 4) continua valendo; as duas convivem.
Consulte as conexões novas no backend, de tempos em tempos (recomendamos a cada 1 a 5 minutos), com o client_id e o client_secret em HTTP Basic:
curl -X POST https://web.monde.com.br/oauth/connections -u "SEU_CLIENT_ID:SEU_CLIENT_SECRET"
O client_id e o client_secret também podem ir no corpo, como na troca do token, mas nunca na URL: na query string eles são ignorados e a resposta é 401. Resposta 200:
{ "data": [ { "id": "5b0f3c2e-8a51-4f6e-9a3d-2f4f1f0c9e11", "access_token": "YWdlbmNpYXw2ZjFj...", "token_type": "Bearer", "company": { "name": "Agência Exemplo", "cnpj": "12345678000190" }, "authorized_at": "2026-10-19T14:32:05.000-03:00" } ], "pagination": { "size": 50, "has_next_page": false, "next_cursor": null } }
  • Cada conexão é entregue uma única vez. Guarde o access_token no backend antes de qualquer outro passo: ele não volta numa próxima consulta. Se ele se perder, a agência exclui a integração e conecta de novo. Use o id para não processar a mesma conexão duas vezes do seu lado.
  • O access_token é igual ao do passo 4: não expira, não tem refresh_token, é usado na API v3 do mesmo jeito (passo 5) e revogado do mesmo jeito (passo 6).
  • A company é a empresa da agência que foi conectada. Use o CNPJ para ligar a conexão ao cliente certo na sua plataforma.
  • Cada consulta entrega até 50 conexões, da mais antiga para a mais nova, no nó data. O nó pagination tem o formato da paginação da API, mas a fila não usa cursor: com has_next_page igual a true, consulte de novo em seguida, sem parâmetro, e o next_cursor vem sempre nulo. Sem conexão nova, a lista vem vazia. Com duas consultas ao mesmo tempo, uma delas pode vir com a lista vazia e has_next_page igual a true: consulte de novo.
  • A conexão espera a sua consulta por 72 horas. Depois disso ela não é mais entregue, e a integração é excluída na conta da agência, que precisa conectar de novo. A conexão que a agência excluir antes da sua consulta também não é entregue.
  • A resposta vem com Cache-Control: no-store: não a guarde em cache nem em log, porque ela leva os tokens.
  • 401 com {"error":"invalid_client","error_description":"..."}: client_id ou client_secret errado, ou a conexão automática não está habilitada. Nada é entregue.