API docs by Redocly

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.

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.

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 e download de anexos associados a recursos.

Enviar anexo Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

  • 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.

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"

Recurso que irá receber o anexo: "sale" para uma venda, "person" para uma pessoa.

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
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "extension": "string",
  • "content_type": "string",
  • "download_url": "http://example.com"
}

Baixar anexo Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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: "Ler todas as tarefas";
  • anexo de venda: "Ler todas as vendas";
  • anexo de viagem: "Ler todas as viagens";
  • anexo de conta a pagar e receber: "Ler todas as contas a pagar e receber";
  • anexo de pessoa: "Ler todas as pessoas".

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.

Consultar vendas Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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.

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

  • 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 e a permissão de fechar venda. Sem esse campo a venda nasce aberta.
  • 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. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado.

Exemplo: "86452403000197".

sale_date
required
string <date> (sale_date)

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

Exemplo: "2026-10-08".

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) e a permissão de fechar venda. Se não puder fechar, a criação inteira é recusada com 422.

operation_id
string (operation_id)

ID da operação própria associada a essa venda. A operação precisa estar ativa.

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)

Vendedor que fez a negociação do produto com o cliente e é responsável pela venda.

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.

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.

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.

Array of objects (others)

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

Array of objects (payment)

Lista de pagamentos realizados na venda. Cada pagamento pode ser distribuído entre um ou mais produtos através da correspondência do local_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.

Responses

Request samples

Content type
application/json
Example
{
  • "company_identifier": "46598887000162",
  • "sale_date": "2026-10-08",
  • "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-10-08",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-10-08T10: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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

Retorna os dados de uma venda específica.

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
{
  • "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
  • "sale_number": 987,
  • "sale_date": "2026-10-08",
  • "status": "closed",
  • "observations": "Venda finalizada.",
  • "printed_receipt": true,
  • "created_at": "2026-10-08T10: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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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.

Exige a permissão de excluir vendas na empresa da venda. Ela basta também para a venda com recibo impresso. Na conexão automática, a permissão de excluir as próprias vendas alcança só a venda que a própria integração criou; a venda de outra origem responde 404. 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": [
    ]
}

Produtos

Consulte os produtos de viagem disponíveis (seguros, cruzeiros, hotéis, passagens aéreas, operações próprias e outros) para utilizar em suas vendas.

Consultar produtos Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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" "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": {
    }
}

Consultar produto por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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": [
    ]
}

Cabines

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

Consultar cabines Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Navios

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

Consultar navios Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Centros de Custo

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

Consultar centros de custo Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar centro de custo por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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"
}

Moedas

Consulte as moedas cadastradas no sistema para utilizar em produtos de venda e lançamentos financeiros.

Consultar moedas Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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 Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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
}

Categorias

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

Consultar categorias Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar categoria por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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": {
    }
}

Cidades

Consulte as cidades cadastradas no sistema, com estado, país e códigos oficiais (IBGE, SIAFI e SETEC).

Consultar cidades Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

Retorna a lista de cidades cadastradas no sistema.

Authorizations:
bearerAuthentication
query Parameters
name
string
Example: name=sao paulo

Filtra por nome, sem diferenciar maiúsculas, acentos ou posição (busca por trecho).

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 Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

Retorna uma cidade específica pelo seu identificador.

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",
  • "setec": null,
  • "state": {
    },
  • "country": {
    }
}

Vendedores

Consulte os vendedores cadastrados no sistema para utilizar em suas vendas.

Consultar vendedores Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar vendedor por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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": {
    }
}

Formas de Pagamento

Consulte as formas de pagamento cadastradas no sistema para utilizar em lançamentos financeiros.

Consultar formas de pagamento Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar forma de pagamento por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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
}

Contas e Cartões

Consulte as contas e cartões cadastrados no sistema, com os dados bancários e de cartão de crédito e as empresas em que cada conta está disponível.

Consultar contas e cartões Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar conta ou cartão por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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": null,
  • "card_operator": null,
  • "companies": [
    ]
}

Regras da Nota Fiscal

Consulte as regras de emissão de nota fiscal cadastradas no sistema, com os campos da venda que compõem cada emissão.

Consultar regras da nota fiscal Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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 Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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.

Consultar tarefas Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

Retorna a lista de tarefas das empresas em que a credencial tem permissão (tarefas sem empresa são visíveis em todas). Tarefas excluídas 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 tarefas pendente e concluída.

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

Criar tarefa Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

Cria uma tarefa com responsável, categoria e vencimento. 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. Omitir o campo é recusado, porque a empresa não é deduzida. Aceita, em history, os comentários com que a tarefa nasce. 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
required
string <date-time>

Data e hora de vencimento

category_id
required
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.

person_id
string <uuid>

Identificador da pessoa vinculada à tarefa, obtido em Consultar pessoas.

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": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Consultar tarefa por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Alterar tarefa Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

Altera uma tarefa já cadastrada. Informe apenas os campos que devem mudar: o campo omitido, ou enviado como nulo ou como texto vazio, permanece como está, então um campo não é esvaziado por esta operação. O title é exceção: a tarefa precisa ter título, e enviá-lo como texto vazio é recusado. Para concluir a tarefa envie completed como true, e para reabri-la, como false. O company_identifier é a exceção à regra acima: omitido, mantém a empresa da tarefa; com um CNPJ, leva a tarefa para aquela empresa e exige a permissão de criar/editar 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, e os demais permanecem. Comentários são enviados em Comentar na tarefa. Exige a permissão de criar/editar 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 "Ler todas as tarefas" na empresa da tarefa; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da tarefa.

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

title
string <= 100 characters

Título da tarefa

description
string

Descrição da tarefa

due
string <date-time>

Data e hora de vencimento

category_id
integer

Identificador da categoria da tarefa, obtido em Consultar categorias de tarefa.

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.

person_id
string <uuid>

Identificador da pessoa vinculada à tarefa, obtido em Consultar pessoas.

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": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Excluir tarefa Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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 "Ler todas as tarefas" na empresa da tarefa. Quem participa da tarefa é avisado do comentário por e-mail, como no comentário feito no Monde. Exige a permissão de criar/editar tarefas. Tarefa excluída não recebe comentário: a resposta é 409. 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
required
string

Texto do comentário

Responses

Request samples

Content type
application/json

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": {
    },
  • "company": {
    },
  • "created_by": {
    },
  • "history": [
    ],
  • "custom_fields": [
    ],
  • "attachments": []
}

Categorias de Tarefas

Consulte as categorias de tarefas cadastradas no sistema.

Consultar categorias de tarefas Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

Retorna a lista de categorias de tarefas 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

Exemplo de resposta contendo categorias de tarefas.

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

Consultar categoria de tarefa por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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"
}

Viagens

Consulte as viagens cadastradas no sistema, com cliente, vendedor, situação e o período calculado a partir das vendas vinculadas.

Consultar viagens Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar viagem por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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": []
}

Orçamentos

Consulte os orçamentos cadastrados no sistema, com validade, situação e o link público de visualização.

Consultar orçamentos Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar orçamento por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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,
  • "public_url": "https://suaviagem.app/a1B2c3-cancun",
  • "internal_observations": "Cliente pediu retorno até sexta.",
  • "created_at": "2024-03-15T10:30:00",
  • "person": {
    },
  • "company": {
    }
}

Regras de Faturamento

Consulte as regras de faturamento cadastradas no sistema, com a pessoa dona da regra, o período de fechamento e as condições de vencimento.

Consultar regras de faturamento Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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 Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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 cadastradas no sistema. As credenciais das integrações nunca são retornadas.

Consultar integrações Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

Retorna a lista de integrações das empresas em que a credencial tem permissão (integrações sem empresa valem para todas). Os dados de acesso da integração (usuários, senhas e tokens) nunca são retornados.

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 representante e buscador.

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

Consultar integração por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

Retorna uma integração específica pelo seu identificador.

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.

{
  • "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
  • "description": "BRT Consolidadora",
  • "active": true,
  • "vendor_name": "BRT",
  • "person": null,
  • "company": {
    }
}

Pessoas

Consulte as pessoas cadastradas no sistema, com dados de contato, documentos e informações adicionais.

Consultar pessoas Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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).

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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.

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 que ainda não estiver cadastrada é criada.

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.

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": [
    ]
}

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": [
    ],
  • "kandir_law": null
}

Consultar pessoa por ID Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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).

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": [
    ],
  • "kandir_law": null
}

Alterar pessoa Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

Altera uma pessoa já cadastrada. Informe apenas os campos que devem mudar: o campo omitido, ou enviado como nulo ou como texto vazio, permanece como está — um campo de texto não é esvaziado por esta operação. O name é exceção: a pessoa precisa ter nome, então enviá-lo como texto vazio é recusado. 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. As listas labels e contacts 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. A resposta traz a pessoa alterada no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todas as pessoas"; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da pessoa.

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 que ainda não estiver cadastrada é criada.

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 da pessoa. A lista enviada substitui a atual: o marcador que não vier nela é retirado. Envie uma lista vazia para retirar todos os marcadores; omita o campo para manter os atuais. Cada marcador precisa já estar cadastrado.

Array of objects (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 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 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

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": [
    ],
  • "kandir_law": null
}

Excluir pessoa Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": [
    ]
}

Marcadores

Consulte os marcadores cadastrados no sistema para classificar pessoas.

Consultar marcadores Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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": {
    }
}

Consultar marcador por ID Em desenvolvimento

⚠️ Esse endpoint ainda não está disponível — está documentado apenas como referência do que temos planejado.

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"
}

Contas a Pagar e Receber

Consulte 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.

Consultar contas a pagar e receber Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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.

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": {
    }
}

Consultar conta a pagar ou receber por ID Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": [ ]
}

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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.

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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
}

Reembolsos

Consulte 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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

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.

Consultar notas fiscais Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": {
    }
}

Consultar nota fiscal por ID Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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,
  • "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": [
    ]
}

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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 não é recortado por empresa: a credencial que tem a permissão lê todas as linhas.

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"
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.

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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.

Consultar campos personalizados Beta

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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

⚠️ Esse endpoint já pode ser utilizado, mas, por estar em fase de testes (beta), ainda pode sofrer alterações.

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": [
    ]
}

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-10-08

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.

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.

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.

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 do Basic Auth, 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.

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, nem quando a empresa não tem a licença de API que as permissões do parceiro exigem. Nesses casos o usuário vê a explicação numa página do Monde.

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"
  • 403 com {"errors":["Você não tem permissão para executar essa ação."]}: o token é válido e a integração está pronta. O parceiro cria vendas, mas não as lê.
  • 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.
  • 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.
  • 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.