Bem-vindo a API da Monde! Essa documentação detalha os endpoints disponíveis para você integrar seu sistema conosco.
https://web.monde.com.br/api/v3. string, integer, float, boolean, etc. .) como separador decimal, apenas nas últimas duas casas. Exemplo: 99999.99. required. "") é um valor de texto: no campo de texto, é gravado como foi enviado, e no campo de texto obrigatório é recusado (422). Em campo de outro tipo (objeto, lista, número, booleano, data, opção ou referência por id), "" é recusado (422). PATCH), o campo omitido fica como está, e o enviado como null tem o valor retirado. O campo que o registro não pode ficar sem recusa o null (422). Cada endpoint tem uma etiqueta que indica se você já pode utilizá-lo:
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
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.
550e8400-e29b-41d4-a716-446655440000).X-Idempotent-Replay: true.409 Conflict.422 Unprocessable Content), a chave volta a ficar disponível: reenviar a mesma requisição com a mesma chave é processado de novo.422 Unprocessable Content.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.
/64: todos os endereços da mesma rede /64 somam no mesmo limite.429 Too Many Requests e uma mensagem de erro.429, aguarde antes de tentar novamente e use um tempo de espera crescente entre as tentativas (backoff exponencial). 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.
cursor.has_next_page for true, repita a requisição enviando cursor com o valor de next_cursor da resposta anterior.has_next_page for false, next_cursor vem nulo e a varredura terminou.size define quantos registros vêm por página: de 1 a 50. Sem o parâmetro, são 20.400.429.
Idempotency-Key e aplique backoff exponencial.
422 como não encontrado quando a credencial tem a permissão de adicionar anexos mas não o lê, e 403 quando lê ou quando não tem a permissão de adicionar anexos.
403 com a mensagem do Monde.
| 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. |
| resource_type required | string Enum: "sale" "person" "bill" "travel" "task" Recurso que irá receber o anexo: "sale" para uma venda, "person" para uma pessoa, "bill" para uma conta a pagar ou receber, "travel" para uma viagem, "task" para uma tarefa. |
| resource_id required | string <uuid> ID do recurso que irá receber o anexo. |
| file required | string <binary> Arquivo binário a ser anexado.
|
| 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 (-). |
{ "resource_type": "sale", "resource_id": "c52a1c51-80e2-4a28-925e-2102a7b5d4e1", "file": "@voucher.pdf", "description": "voucher" }
{- "id": "0685f968-4afb-4574-be1b-3a1e5fc10d94",
- "description": "voucher",
- "extension": "pdf",
- "content_type": "application/pdf",
}Troca o nome do anexo, como o Renomear do Monde. Só o nome muda: o arquivo e o cadastro dono ficam como estão. O nome em branco é recusado com 422. Exige as mesmas permissões de anexar no cadastro dono: "Adicionar anexos" e "Editar" dele, com o alcance aos registros de outras origens que a credencial tem. O anexo de um registro que a credencial não alcança responde 404.
| id required | string <uuid> Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 Identificador do anexo. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description required | string Nome novo do anexo. Não pode ficar em branco. |
{- "description": "Comprovante de pagamento"
}{- "id": "0685f968-4afb-4574-be1b-3a1e5fc10d94",
- "description": "voucher",
- "extension": "pdf",
- "content_type": "application/pdf",
}Manda o anexo para a lixeira do registro, como no Monde, de onde ele pode ser restaurado. O anexo excluído some da consulta do registro e não é mais baixado.
Como no Monde, excluir pede só a permissão "Excluir anexos" do recurso dono do anexo, na empresa do registro (a pessoa, que não pertence a empresa, vale em qualquer empresa que grave), e o mesmo alcance de anexar:
404.| id required | string <uuid> Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 Identificador do anexo. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}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:
| id required | string <uuid> Example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 Identificador do anexo. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}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.
A venda que a credencial criou é sempre dela; a dos outros vendedores pede as permissões Consultar, Abrir e Editar vendas de outros vendedores, como no Monde (veja as Perguntas frequentes).
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.
| 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:
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:
Filtrar vendas pela pessoa participante, informando o identificador (UUID) dela. A venda é retornada quando a pessoa aparece em qualquer papel: pagante, vendedor, intermediário, solicitante, aprovador, promotor, passageiro, fornecedor, representante ou quem cadastrou a venda. Para vários identificadores, separe-os por vírgula — a venda é retornada quando qualquer uma das pessoas participa dela. |
| number | integer Example: number=1024 Filtrar vendas pelo número exibido no aplicativo (ex.: 1024). Um número por requisição. |
| updated_since | string <date-time> Example: updated_since=2026-08-01T14:30:00 Filtrar vendas atualizadas neste instante ou depois dele, no formato ISO 8601. Aceita data (AAAA-MM-DD, cai no início do dia) ou data-hora (AAAA-MM-DDTHH:MM:SS). Sem fuso no valor, considera o horário de Brasília. Útil para reprocessar apenas o que mudou desde a última consulta, inclusive no mesmo dia. A venda volta quando muda o cabeçalho ou uma destas partes dela, que aparecem em Consultar venda por ID: produtos, passageiros, trechos e assentos, comissões, anexos, pagamentos e as contas vinculadas (inclusão, cancelamento e exclusão). A liquidação de uma conta só traz a venda quando muda a taxa cartão agência dos produtos (baixa ou estorno com taxa de cartão) ou quando é parcial e gera a conta do saldo. A mudança num cadastro que a venda só referencia (pessoa, produto do catálogo, fornecedor, função do comissionado) não traz a venda: esses dados se consultam nos endpoints de cada cadastro. A listagem traz o resumo da venda, e o detalhe vem de Consultar venda por ID. Para acompanhar também as vendas excluídas, envie |
| kind | Array of strings Items Enum: "insurance" "cruise" "hotel" "airline_ticket" "train_ticket" "ground_transportation" "excursion" "visa" "car_rental" "travel_package" "cvc_package" "operation" "others" Example: kind=airline_ticket Filtrar vendas pelo tipo de produto, com os mesmos tipos de |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}local_id. Dê a cada produto e a cada pagamento um local_id, um nome seu, único na requisição. Na resposta, cada um volta com o id gerado ao lado desse local_id. Guarde o par: para alterar a venda depois, você aponta cada produto e pagamento pelo id. O local_id não é gravado e não volta na consulta da venda. Exemplo: você envia "insurances": [{ "local_id": "seguro-1", ... }] e recebe "insurances": [{ "id": "5d7e2a91-…", "local_id": "seguro-1", ... }]; na alteração, aponta esse seguro por { "id": "5d7e2a91-…" }. Vale igual para cada pagamento.
status: closed para já criar a venda fechada, respeitando as regras de fechamento. Sem esse campo a venda nasce aberta.
commissions com alguma comissão exige também as permissões "Ver aba comissões" e "Adicionar comissões" de vendas, na empresa da venda, como no Monde; sem elas, a resposta é 403 com a mensagem do Monde, e a venda não é criada.
company_identifier, a criação é recusada com 422, como no Monde, que não deixa cadastrar venda fora de uma viagem nessa empresa. A API ainda não cria venda dentro de uma viagem.
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.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| 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. |
| sale_date required | string <date> (sale_date) Data da venda no formato ISO 8601 (AAAA-MM-DD). |
| status | string Default: "opened" Enum: "opened" "closed" Situação da venda na criação. Padrão |
| observations | string or null Observações gerais da venda, em texto livre e sem limite de tamanho. |
| operation_id | string (operation_id) ID da operação própria associada a essa venda. A operação precisa estar ativa. Exclusiva da agência; na operadora (consolidadora), o campo é recusado com 422. |
Array of objects (custom_field) Campos personalizados da venda, definidos pela agência. Na criação, envie cada campo por | |
required | object (seller_create) Dados para cadastrar um vendedor. |
required | object (individual_or_company) Contratante do produto, responsável pelo pagamento. Pode ser uma pessoa física ou jurídica. Mesmo que a negociação envolva múltiplos pagantes, informe apenas o pagante principal ou a pessoa que fez a negociação do produto com o vendedor. |
individual_or_company (object) or null | |
individual_person (object) or null Pessoa física que solicitou a venda. | |
individual_or_company (object) or null Pessoa que aprovou a venda. Exclusivo da agência. A venda da operadora (consolidadora) não tem aprovador, e o campo enviado com valor é recusado com 422. | |
Array of objects (insurance) Seguro viagem. | |
Array of objects (cruise) Cruzeiro. | |
Array of objects (hotel) Diárias de hospedagem. | |
Array of objects (airline_ticket) Passagem aérea. | |
Array of objects (train_ticket) Bilhete de trem. | |
Array of objects (ground_transportation) Transporte terrestre. | |
Array of objects (car_rental) Locação de veículos. | |
Array of objects (travel_package) Pacotes turísticos. | |
Array of objects (excursion) Passeios (excursões) da venda. A excursão é um produto do sistema: não é preciso informar qual produto está sendo vendido. | |
Array of objects (visa) Vistos consulares da venda, um por pedido de visto. O visto é um produto do sistema: não é preciso informar qual produto está sendo vendido. Cada passageiro é um solicitante do visto. | |
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 | |
Array of objects (others) Outros produtos da venda, que podem ou não ter passageiros. | |
Array of objects or objects (payment) Lista de pagamentos realizados na venda. Cada pagamento tem uma única forma e pode ser distribuído entre um ou mais produtos, apontados por | |
Array of objects (commission_create) Comissões a gravar na venda. Só é aceito quando |
{- "company_identifier": "46598887000162",
- "sale_date": "2026-11-15",
- "seller": {
- "external_id": "a8a41bec-e2a2-4d6a-b2f9-8fbc29169e46",
- "name": "João da Silva",
- "cpf": "83115137168"
}, - "payer": {
- "person_kind": "individual",
- "external_id": "cce45f2c-30e3-43a6-bbf1-af340188a04c",
- "name": "Márcio da Veiga",
- "legal_name": null,
- "gender": "male",
- "birthdate": "1990-02-12",
- "cpf_cnpj": "50957153848",
- "rg_ie": "202571476",
- "passport_number": "BC826174",
- "passport_expiration_date": "2030-07-15",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "contato@marcio.com",
- "phone_number": "11999990001",
- "mobile_number": "11999990002",
- "address": {
- "postal_code": "08330410",
- "street": "Avenida Andrômeda",
- "street_number": "100",
- "neighborhood": "Cidade Satélite Santa Bárbara",
- "additional_info": "Apartamento 501",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "intermediary": {
- "person_kind": "individual",
- "external_id": "8a9de5ce-dac6-4721-851b-7366bf9ff5b0",
- "name": "Isabel Ribas",
- "legal_name": null,
- "gender": "female",
- "birthdate": "1984-03-22",
- "cpf_cnpj": "05619249883",
- "rg_ie": "417277556",
- "passport_number": "XM468760",
- "passport_expiration_date": "2035-07-22",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "contato@isabel.com",
- "phone_number": "11999990003",
- "mobile_number": "11999990004",
- "address": {
- "postal_code": "12239420",
- "street": "Rua Maria Martins Ottoboni",
- "street_number": "100",
- "neighborhood": "Campo dos Alemães",
- "additional_info": "Sala 7",
- "city_ibge": "3549904",
- "city_name": "São José dos Campos",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "approver": {
- "person_kind": "individual",
- "external_id": "b7f3c1a2-9d84-4e60-8c15-2a6f0e3d4b91",
- "name": "Renata Furtado",
- "legal_name": null,
- "gender": "female",
- "birthdate": "1979-11-08",
- "cpf_cnpj": "68432197807",
- "rg_ie": "331948027",
- "passport_number": "YK517293",
- "passport_expiration_date": "2032-04-30",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "contato@renata.com",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "13070170",
- "street": "Rua Antônio Lapa",
- "street_number": "100",
- "neighborhood": "Cambuí",
- "additional_info": "Sala 3",
- "city_ibge": "3509502",
- "city_name": "Campinas",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "requester": {
- "external_id": "9f2c7a41-8b53-4e06-a1d9-63f0e2b5c748",
- "name": "Beatriz Nogueira",
- "gender": "female",
- "birthdate": "1988-06-19",
- "cpf": "47690215858",
- "rg": "289104537",
- "passport_number": "RT902184",
- "passport_expiration_date": "2033-09-10",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "contato@beatriz.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310100",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "Conjunto 4",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "insurances": [
- {
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "intermediary_commission_amount": 25.04,
- "agency_service_fee": 100,
- "discount_amount": 10,
- "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "document": "9921508090000",
- "amount": 625.95,
- "fees": 31.3,
- "rav_fee": 15,
- "rav_fee_discount": 5,
- "agency_fee": 10,
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "cruises": [
- {
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "intermediary_commission_amount": 417.94,
- "agency_service_fee": 100,
- "discount_amount": 100,
- "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "amount": 8358.77,
- "fees": 209,
- "tip": 50,
- "rav_fee": 40,
- "rav_fee_discount": 10,
- "agency_fee": 20,
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "hotels": [
- {
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "intermediary_commission_amount": 281.54,
- "agency_service_fee": 100,
- "discount_amount": 50,
- "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "document": "HTL-55821",
- "amount": 5630.73,
- "fees": 281.54,
- "other_fees": 30,
- "rav_fee": 60,
- "rav_fee_discount": 15,
- "agency_fee": 563.07,
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "airline_tickets": [
- {
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "intermediary_commission_amount": 68.04,
- "agency_service_fee": 100,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "supplier": {
- "airline_code": "AA",
- "airline_number": "001",
- "name": "American Airlines",
- "legal_name": "American Airlines Inc.",
- "cnpj": "73765430000178",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@americanairlines.com.br",
- "phone_number": "11999990023",
- "mobile_number": "11999990024",
- "address": {
- "postal_code": "04543013",
- "street": "Avenida Brigadeiro Faria Lima",
- "street_number": "2232",
- "neighborhood": "Jardim Paulistano",
- "additional_info": "9° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:34:59",
- "seats": [
- {
- "seat_number": "A27",
- "ticket_number": "99526874895"
}
]
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "original_ticket_number": "99526874894",
- "emission_name": "Maria da Silva",
- "amount": 1360.67,
- "boarding_fee": 136.06,
- "rav_fee": 204.01,
- "du_fee": 104.01,
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "train_tickets": [
- {
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "intermediary_commission_amount": 7.5,
- "agency_service_fee": 100,
- "discount_amount": 5,
- "segments": [
- {
- "railway_operator": "SNCF",
- "origin": "Paris Gare de Lyon",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "Nice-Ville",
- "arrival_date": "2026-11-20T21:34:59"
}
], - "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "amount": 240.5,
- "fees": 24.05,
- "rav_fee": 10,
- "rav_fee_discount": 2,
- "agency_fee": 5,
- "document": "RE9988777",
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "ground_transportations": [
- {
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "intermediary_commission_amount": 4.28,
- "agency_service_fee": 100,
- "discount_amount": 5,
- "segments": [
- {
- "coach_company": "Viação UTIL",
- "service_class": "LE",
- "origin": "Terminal Rodoviário Novo Rio",
- "departure_date": "2026-11-18T15:34:59",
- "destination": "Terminal Rodoviário de Santos",
- "arrival_date": "2026-11-18T21:34:59",
- "seats": [
- {
- "seat_number": "27",
- "ticket_number": "0001234567"
}
]
}
], - "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "amount": 121.95,
- "fees": 12.19,
- "rav_fee": 5,
- "rav_fee_discount": 1,
- "agency_fee": 3,
- "document": "0001234567",
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "car_rentals": [
- {
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "intermediary_commission_amount": 17.5,
- "agency_service_fee": 100,
- "discount_amount": 10,
- "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "document": "LOC-77310",
- "amount": 350,
- "fees": 17.5,
- "other_fees": 8,
- "rav_fee": 7,
- "rav_fee_discount": 2,
- "agency_fee": 5,
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "travel_packages": [
- {
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "intermediary_commission_amount": 125,
- "agency_service_fee": 100,
- "discount_amount": 25,
- "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "amount": 2500,
- "fees": 125,
- "other_fees": 25,
- "rav_fee": 50,
- "rav_fee_discount": 10,
- "agency_fee": 30,
- "document": "PCT2024050001",
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "excursions": [
- {
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T08:00:00",
- "arrival_date": "2026-11-20T18:00:00",
- "observations": "Saída do hotel às 8h.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "intermediary_commission_amount": 17.5,
- "agency_service_fee": 20,
- "discount_amount": 5,
- "supplier": {
- "external_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
- "name": "Epic Journey Turismo",
- "legal_name": "Epic Journey Turismo S.A.",
- "cnpj": "11402447000103",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourney.com.br",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "1000",
- "neighborhood": "Bela Vista",
- "additional_info": "10° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "representative": {
- "external_id": "028ea1ef-3f8e-4c7f-93da-463794a5afda",
- "name": "Epic Journey Operadora",
- "legal_name": "Epic Journey Operadora Ltd.",
- "cnpj": "18258223000119",
- "ie": "1234567890",
- "foreigner": false,
- "email": "contato@epicjourneyoperadora.com",
- "phone_number": "11999990007",
- "mobile_number": "11999990008",
- "address": {
- "postal_code": "01310932",
- "street": "Avenida Paulista",
- "street_number": "5000",
- "neighborhood": "Bela Vista",
- "additional_info": "7° andar",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "passengers": [
- {
- "amount": 350,
- "fees": 17.5,
- "rav_fee": 10,
- "rav_fee_discount": 2,
- "agency_fee": 5,
- "document": "EXC2024060034",
- "person": {
- "external_id": "322ff2c2-43e0-4376-bea5-20f88b673b6d",
- "name": "Maria da Silva",
- "gender": "female",
- "birthdate": "1990-10-01",
- "cpf": "38107867807",
- "rg": "461196037",
- "passport_number": "FG225776",
- "passport_expiration_date": "2035-12-01",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "maria.silva@example.com",
- "phone_number": "11999990009",
- "mobile_number": "11999990010",
- "address": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308",
- "city_name": "São Paulo",
- "state_code": "SP",
- "country_code": "BR"
}
}
}
]
}
], - "payments": [
- {
- "local_id": "pagamento-1",
- "agency": {
- "credit_card": {
- "due_date": "2026-12-15",
- "settlement_date": "2026-11-15",
- "card_brand": "mastercard",
- "card_last_digits": "5678",
- "authorization": "ABC123",
- "bank_account": {
- "bank_code": "237",
- "agency_number": "1234",
- "agency_digit": "5",
- "account_number": "56789",
- "account_digit": "0"
}, - "products": [
- {
- "sale_product_local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "amount": 264.55
}
]
}
}
}, - {
- "local_id": "pagamento-2",
- "agency": {
- "bank_slip": {
- "due_date": "2026-12-15",
- "settlement_date": "2026-11-15",
- "bank_account": {
- "bank_code": "237",
- "agency_number": "1234",
- "agency_digit": "5",
- "account_number": "56789",
- "account_digit": "0"
}, - "products": [
- {
- "sale_product_local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "amount": 350
}
]
}
}
}, - {
- "local_id": "pagamento-3",
- "agency": {
- "bank_deposit": {
- "due_date": "2026-12-15",
- "settlement_date": "2026-11-15",
- "observations": "TED",
- "bank_account": {
- "bank_code": "237",
- "agency_number": "1234",
- "agency_digit": "5",
- "account_number": "56789",
- "account_digit": "0"
}, - "products": [
- {
- "sale_product_local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "amount": 6475.34
}, - {
- "sale_product_local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "amount": 625.95
}
]
}
}
}, - {
- "local_id": "pagamento-4",
- "vendor": {
- "credit_card": {
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "products": [
- {
- "sale_product_local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "amount": 8358.77
}
]
}
}
}, - {
- "local_id": "pagamento-5",
- "vendor": {
- "others": {
- "details": "Fatura",
- "payer": {
- "person_kind": "individual",
- "external_id": "cce45f2c-30e3-43a6-bbf1-af340188a04c",
- "name": "Márcio da Veiga"
}, - "products": [
- {
- "sale_product_local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "amount": 2500
}
]
}
}
}, - {
- "local_id": "pagamento-6",
- "vendor": {
- "credit": {
- "products": [
- {
- "sale_product_local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "amount": 134.14
}
]
}
}
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e"
}, - "operation": {
- "id": "8936058a-2906-4239-9a7f-e22ccc2c195e"
}, - "seller": {
- "id": "7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "intermediary": {
- "id": "d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8"
}, - "requester": {
- "id": "b17c5e38-6a90-4d21-9f43-8e2b70c5a916"
}, - "approver": {
- "id": "95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4"
}, - "promoter": {
- "id": "6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30"
}, - "travel": {
- "id": "7c1d9f30-5a2b-4e68-9d47-2f8b6c0a1e35"
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião comercial"
}
], - "insurances": [
- {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 25.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 417.94,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 100,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 281.54,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 50,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 281.54,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "amount": 5630.73,
- "customer_amount": 6475.34,
- "total_amount": 6475.34,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 68.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:34:59"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "boarding_fee": 136.06,
- "other_fees": 0,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "agency_fee": 0,
- "amount": 1360.67,
- "customer_amount": 1804.75,
- "total_amount": 1804.75,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 7.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 240.5,
- "customer_amount": 264.55,
- "total_amount": 264.55,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4.28,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 121.95,
- "customer_amount": 134.14,
- "total_amount": 134.14,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 17.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 25,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "intermediary_commission_percentage": 2,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 50,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-20T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 20,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:34:59",
- "arrival_date": "2026-12-07T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "commission_percentage": 12,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": 2,
- "unit_price": 1500,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:34:59",
- "arrival_date": "2026-11-22T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "discount_amount": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Retorna os dados de uma venda específica. Como as colunas e abas que o Monde esconde, comissão, over e receitas (nos produtos e em totals.revenue) só vêm com a permissão "Visualizar comissão, over e receitas"; payments e financial, com "Ver aba financeiro"; e commissions, com "Ver aba comissões". Sem a permissão, o campo não vem na resposta. Vale também para a resposta de Inserir e Alterar venda: sem "Ver aba financeiro", payments traz só o id e o local_id dos pagamentos enviados.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da venda (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e"
}, - "operation": {
- "id": "8936058a-2906-4239-9a7f-e22ccc2c195e"
}, - "seller": {
- "id": "7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "intermediary": {
- "id": "d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8"
}, - "requester": {
- "id": "b17c5e38-6a90-4d21-9f43-8e2b70c5a916"
}, - "approver": {
- "id": "95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4"
}, - "promoter": {
- "id": "6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30"
}, - "travel": {
- "id": "7c1d9f30-5a2b-4e68-9d47-2f8b6c0a1e35"
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião comercial"
}
], - "insurances": [
- {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 25.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 417.94,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 100,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 281.54,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 50,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 281.54,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "amount": 5630.73,
- "customer_amount": 6475.34,
- "total_amount": 6475.34,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 68.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:34:59"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "boarding_fee": 136.06,
- "other_fees": 0,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "agency_fee": 0,
- "amount": 1360.67,
- "customer_amount": 1804.75,
- "total_amount": 1804.75,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 7.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 240.5,
- "customer_amount": 264.55,
- "total_amount": 264.55,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4.28,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 121.95,
- "customer_amount": 134.14,
- "total_amount": 134.14,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 17.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 25,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "intermediary_commission_percentage": 2,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 50,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-20T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 20,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:34:59",
- "arrival_date": "2026-12-07T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "commission_percentage": 12,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": 2,
- "unit_price": 1500,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:34:59",
- "arrival_date": "2026-11-22T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "discount_amount": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}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:
A venda com recibo impresso exige também a permissão "Alterar vendas com recibo impresso", como no Monde; sem ela, a resposta é 403.
Não exige Idempotency-Key: repetir a requisição depois de excluída responde 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da venda (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}null é retirado (intermediary, approver, requester, operation_id e operation). seller e payer não podem ser retirados. Os campos personalizados enviados são gravados por cima dos atuais, e os demais ficam. O texto vazio é gravado como está (o valor vazio de um campo personalizado limpa o campo); no campo obrigatório, e em campo que não é texto, é recusado (422).insurances, hotels etc.), em segments, payments e commissions: o item com id fica ou é alterado, o sem id é incluído (com um local_id), e o que não vier sai. A lista omitida fica como está. A venda não fica sem produtos, nem o produto sem passageiros.id da consulta, e mudam só os campos enviados. Não sai o produto com pagamento, com passageiro cancelado ou com o valor do fornecedor já faturado; produto cancelado não é alterado. No transporte terrestre e no trem, reenvie included_services junto com os segments.person.id (como a consulta devolve) ou pelo external_id, e a mesma pessoa aparece uma vez só no produto: repetida na lista, a resposta é 422. A pessoa que já é passageiro ativo tem o mesmo passageiro alterado; a nova entra; o passageiro ativo que não vier sai. O cancelado fica, venha ou não na lista: reenviado igual ao lido, nada muda, e com algum valor diferente a resposta é 422, porque o passageiro cancelado só muda pela reativação. A lista com só passageiros cancelados também responde 422.id, o da resposta que o criou ou o da consulta. O payer só muda se a venda ficar sem pagamentos.status: closed para fechar a venda ao final da alteração, com as regras de fechamento do Monde. Na venda fechada, status: opened reabre a venda antes de aplicar o resto do pedido: a alteração vale por inteiro, e se alguma parte for recusada nada muda e a venda continua fechada. Reabrir só muda a situação da venda; comissões e financeiro ficam como estão. Fechar exige a permissão "Fechar venda"; reabrir exige a permissão própria "Reabrir venda", conferida na empresa da venda, e "Fechar venda" sozinha não reabre.company_identifier. É recusado quando a venda tem pagamento lançado, valor do fornecedor faturado ou está vinculada a uma viagem.commissions (mesmo vazia ou nula), mais "Adicionar comissões" para a lista com alguma comissão e "Excluir comissões" quando a venda já tem comissões manuais, e "Alterar vendas com recibo impresso" para qualquer alteração na venda com recibo impresso, mais "Trocar passageiro em vendas fechadas ou com recibo impresso" para trocar a pessoa de um passageiro dela. A pessoa, o vendedor, o navio e a cabine que a venda cria junto exigem "Editar" em Pessoas, Vendedores, Navios e Cabines, como na criação. Sem ela, a resposta é 403 com o nome da permissão, e nada é alterado. O campo reenviado igual ao gravado não pede permissão; commissions é a exceção, porque a lista enviada sempre substitui as comissões manuais.local_id ao lado do id de cada produto e pagamento enviado. Quando a credencial não pode consultar a venda, vêm só o id da venda e o id e o local_id do que você enviou, no mesmo formato. Consultar pede a permissão "Visualizar" de vendas na empresa da venda, também na venda que a própria credencial criou, e, na venda de outro vendedor, também a de abrir as vendas de outros vendedores: uma alteração sem nenhum campo não serve de consulta.| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da venda (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier | string CNPJ da empresa da venda. Com outro CNPJ, a venda passa para essa empresa, se as regras da troca permitirem. |
| sale_date | string <date> (sale_date) Data da venda no formato ISO 8601 (AAAA-MM-DD). |
| status | string Enum: "opened" "closed" Envie closed para fechar a venda ao final da alteração, respeitando as regras de fechamento. Na venda aberta, opened a mantém aberta; na fechada, opened a reabre antes de aplicar o resto da alteração e closed a mantém fechada. |
| operation_id | string (operation_id) ID da operação própria associada a essa venda. A operação precisa estar ativa. Exclusiva da agência; na operadora (consolidadora), o campo é recusado com 422. |
| observations | string or null Observações gerais da venda. Substitui o texto atual; envie nulo para limpá-lo. Muda também na venda fechada, como no Monde, e a alteração vai para o histórico da venda. |
Array of objects (custom_field) Campos personalizados da venda. Não substitui: cada campo enviado é gravado por cima do valor atual e os demais permanecem. Enviado em branco ou como nulo, o campo é limpo, a não ser que seja obrigatório. | |
object (seller_create) Dados para cadastrar um vendedor. | |
object (individual_or_company) Pagante da venda. Só muda quando, depois da requisição, não sobra pagamento nos produtos da venda. Não pode ser enviado como nulo. | |
object (intermediary) Intermediário da venda. Pessoa ou empresa que conecta as partes envolvidas na venda do produto, facilitando a negociação e, geralmente, recebendo uma comissão pela intermediação. É obrigatório na operadora, em que é ele quem deve a fatura do cliente. | |
object (individual_person) Pessoa física que solicitou a venda. | |
object (individual_or_company) Pessoa que aprovou a venda. Exclusivo da agência. A venda da operadora (consolidadora) não tem aprovador, e o campo enviado com valor é recusado com 422. | |
Array of objects Lista que substitui os produtos deste tipo (insurances). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (cruises). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (hotels). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (airline_tickets). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (train_tickets). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (ground_transportations). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (car_rentals). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (travel_packages). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (excursions). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (others). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
Array of objects Lista que substitui os produtos deste tipo (visas). O produto com id é alterado, o sem id é incluído e o que não vier é excluído da venda. Omitida, mantém os produtos deste tipo; vazia ou nula, exclui todos, desde que a venda continue com ao menos um produto e que nenhum deles esteja impedido de sair. | |
object Operação própria da venda. Com id, altera a que a venda já tem; sem id, inclui. Enviada como nula, o produto de operação própria sai da venda, que precisa continuar com ao menos um produto. | |
Array of objects or objects or objects (payment_update) Lista final dos pagamentos dos produtos da venda. Com id (o da resposta que o criou ou o da consulta da venda), o pagamento fica como está e não aceita a forma de pagamento junto; sem id, é incluído; o que não vier é removido. Para alterar um pagamento, retire-o e inclua outro. Vazia ou nula, retira todos; se algum não puder sair, a alteração é recusada. No produto de um pagamento novo, use sale_product_local_id para um produto enviado nesta requisição ou sale_product_id para um produto que a venda mantém. | |
Array of objects (commission_create) Lista que substitui as comissões informadas manualmente, no mesmo formato da criação. Vale para a venda que a requisição fecha ou que já está fechada. Vazia ou nula, retira todas; com comissão paga, a lista não pode ser substituída. Enviá-la, mesmo vazia ou nula, exige a permissão "Ver aba comissões" de vendas, além de "Adicionar comissões" para a lista com alguma comissão e "Excluir comissões" quando a venda já tem comissões manuais. |
Só os campos enviados mudam: produtos, passageiros e pagamentos ficam como estão. O aprovador é exclusivo da agência: na operadora (consolidadora), envie só o campo personalizado.
{- "approver": {
- "person_kind": "individual",
- "external_id": "b7f3c1a2-9d84-4e60-8c15-2a6f0e3d4b91",
- "name": "Renata Furtado",
- "legal_name": null,
- "gender": "female",
- "birthdate": "1979-11-08",
- "cpf_cnpj": "68432197807",
- "rg_ie": "331948027",
- "passport_number": "YK517293",
- "passport_expiration_date": "2032-04-30",
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "contato@renata.com",
- "phone_number": "11999990005",
- "mobile_number": "11999990006",
- "address": {
- "postal_code": "13070170",
- "street": "Rua Antônio Lapa",
- "street_number": "100",
- "neighborhood": "Cambuí",
- "additional_info": "Sala 3",
- "city_ibge": "3509502",
- "city_name": "Campinas",
- "state_code": "SP",
- "country_code": "BR"
}
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião anual"
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e"
}, - "operation": {
- "id": "8936058a-2906-4239-9a7f-e22ccc2c195e"
}, - "seller": {
- "id": "7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "intermediary": {
- "id": "d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8"
}, - "requester": {
- "id": "b17c5e38-6a90-4d21-9f43-8e2b70c5a916"
}, - "approver": {
- "id": "95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4"
}, - "promoter": {
- "id": "6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30"
}, - "travel": {
- "id": "7c1d9f30-5a2b-4e68-9d47-2f8b6c0a1e35"
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião comercial"
}
], - "insurances": [
- {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 25.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 417.94,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 100,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 281.54,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 50,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 281.54,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "amount": 5630.73,
- "customer_amount": 6475.34,
- "total_amount": 6475.34,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 68.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:34:59"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "boarding_fee": 136.06,
- "other_fees": 0,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "agency_fee": 0,
- "amount": 1360.67,
- "customer_amount": 1804.75,
- "total_amount": 1804.75,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 7.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 240.5,
- "customer_amount": 264.55,
- "total_amount": 264.55,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4.28,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 121.95,
- "customer_amount": 134.14,
- "total_amount": 134.14,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 17.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 25,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "intermediary_commission_percentage": 2,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 50,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-20T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 20,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:34:59",
- "arrival_date": "2026-12-07T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "commission_percentage": 12,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": 2,
- "unit_price": 1500,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:34:59",
- "arrival_date": "2026-11-22T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "discount_amount": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}O produto só fica cancelado quando todos os passageiros dele estão cancelados. Cancelar só parte dos passageiros deixa o produto
active, com esses passageiros marcados emcanceled_at. O produto sem passageiros é cancelado direto. As opçõescalculate_commission,delete_supplier_balanceesupplier_finesó valem quando o pedido deixa todos os passageiros cancelados, isto é, quando a lista cancela os que ainda faltavam.delete_customer_balancevale também no cancelamento de parte dos passageiros.
Cancela um produto da venda, ou parte dos passageiros dele, quando o cliente desiste do que foi vendido. Cancelar não é excluir: o produto excluído (que sai da lista de produtos no PATCH /sales/{id}) é o lançado por engano, sem nenhum movimento; o cancelado é a venda que aconteceu e foi desfeita. Para desfazer o cancelamento, use Reativar produto da venda.
O que muda e o que não muda
PATCH da venda.Passageiros e datas
O cancelamento é sempre pela lista passengers: não há data padrão nem cancelamento de todos sem listar. Nenhuma data pode ser anterior à data da venda.
passengers é recusado (422). Para cancelar o produto inteiro, liste todos os passageiros ativos.passengers, só as pessoas da lista são canceladas, cada uma com o seu canceled_at, obrigatório no item. A pessoa é citada pelo person.id, o id da pessoa em passengers[].person na consulta da venda.canceled quando todos os passageiros estão cancelados; antes disso continua active, com os passageiros cancelados marcados em canceled_at.passengers (corpo {} ou só as opções): a data de cancelamento dele é a do dia, como no Monde.canceled_at na raiz não é aceito (422): a data vai em cada passageiro da lista.Opções
delete_customer_balance: o saldo pendente a receber do cliente neste produto é excluído e passa a ser saldo excluído, que reduz a receita da venda. Só o saldo que ainda não virou pagamento sai: se o cliente não vai pagar uma forma de pagamento já lançada, exclua-a pelo PATCH da venda antes. Exige saldo a receber no produto.delete_supplier_balance: os itens ainda em aberto para o fornecedor (sem lançamento ou, com a fatura automática, numa fatura não liquidada nem fechada), inclusive a Lei Kandir, são excluídos. O que já foi liquidado ou pago direto ao fornecedor fica. Só vale quando o pedido deixa todos os passageiros cancelados, e exige item em aberto. Não existe em produto de operação própria.supplier_fine: a multa cobrada pelo fornecedor, informada como valor positivo na moeda em que o fornecedor é pago. Vira um item de multa a acertar com o fornecedor e reduz a receita. Exige delete_supplier_balance. Na agência, o fornecedor é pago na moeda final da venda, e a multa volta na consulta em supplier_fine. Na operadora, o fornecedor é pago na moeda de origem do produto: a multa enviada volta em supplier_fine_origin_currency, e supplier_fine traz o valor convertido para a moeda final pelo câmbio do produto. Exemplo na operadora, produto em USD com câmbio 5: supplier_fine: 30 no cancelamento volta como supplier_fine_origin_currency: 30 e supplier_fine: 150.calculate_commission: o produto cancelado continua no cálculo da meta dos planos de comissão, como o campo calculate_commission da consulta do produto. Padrão false: o produto sai da meta. Só vale quando o pedido deixa todos os passageiros cancelados.delete_supplier_balance e supplier_fine são recusados.Venda fechada
409).Resposta
canceled_at, calculate_commission, deleted_balance, delete_supplier_balance, supplier_fine e supplier_fine_origin_currency mostram o que o cancelamento gravou; a multa informada na moeda em que o fornecedor é pago aparece em supplier_fine na agência e em supplier_fine_origin_currency na operadora. A credencial sem a permissão de consultar vendas recebe só o id da venda.Exige, na empresa da venda, a permissão de editar vendas e a permissão "Cancelar produto", como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. Na venda de outro vendedor, exige também "Editar vendas de outros vendedores". A credencial da conexão automática, que só edita as vendas que criou, só cancela produto dessas vendas, e só quando o parceiro recebeu "Cancelar produto" na aprovação. O cancelamento fica no histórico da venda, com o nome da credencial.
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador da venda (UUID), o |
| product_id required | string <uuid> Example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 Identificador do produto da venda (UUID), o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
Array of objects Os passageiros a cancelar, cada um com a sua data. Obrigatório no produto com passageiros: para cancelar o produto inteiro, liste todos os passageiros ativos. Não envie em produto sem passageiros. Cada pessoa vai uma vez só: repetida, responde 422. | |
| calculate_commission | boolean Default: false Mantém o produto cancelado no cálculo da meta dos planos de comissão (o mesmo |
| delete_customer_balance | boolean Default: false Exclui o saldo pendente a receber do cliente neste produto, que passa a ser saldo excluído. |
| delete_supplier_balance | boolean Default: false Exclui os itens ainda em aberto para o fornecedor (fatura e Lei Kandir). Só vale quando o pedido deixa todos os passageiros cancelados. |
| supplier_fine | number <double> >= 0 Default: 0 Multa cobrada pelo fornecedor, em valor positivo, na moeda em que o fornecedor é pago: a moeda final da venda na agência e a moeda de origem do produto na operadora. Na consulta, volta em |
Cancela os dois passageiros do produto, cada um com a sua data, e com isso o produto inteiro, e exclui o saldo que o cliente ainda deve no produto.
{- "passengers": [
- {
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "canceled_at": "2026-10-14"
}, - {
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}, - "canceled_at": "2026-10-15"
}
], - "delete_customer_balance": true
}Trecho da resposta ao cancelar um dos dois passageiros com delete_customer_balance: o produto continua active, e o passageiro cancelado traz o canceled_at. Os demais campos da venda são os da consulta por ID.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "sale_number": 1024,
- "status": "opened",
- "insurances": [
- {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45",
- "status": "active",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 120.5,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "passengers": [
- {
- "canceled_at": "2026-10-14",
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - {
- "canceled_at": null,
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}
}
]
}
]
}Desfaz o cancelamento do produto, inteiro ou só de parte dos passageiros, como o descancelamento do Monde. O produto volta à situação active e entra de novo no cálculo da meta dos planos de comissão.
Passageiros
passengers, com a pessoa de cada passageiro cancelado que volta. Para reativar o produto inteiro, liste todos os passageiros cancelados. Produto com passageiros sem a lista é recusado (422).{}).person.id como no cancelamento, precisa ser passageiro cancelado do produto.canceled_at nem as opções do cancelamento (422): a reativação desfaz o cancelamento como ele foi gravado.Financeiro
409). Nesse produto, parte dos passageiros ainda pode ser reativada, mantendo o saldo excluído; para trazer de volta os últimos, reabra a venda antes.409: repita a requisição em alguns segundos. A multa que não entrou na fatura em 10 minutos não trava mais a reativação.Exige as mesmas permissões do cancelamento: editar vendas e "Cancelar produto", na empresa da venda, como o descancelamento do Monde. A resposta é a venda inteira, ou só o id dela para quem não pode consultar vendas. A reativação fica no histórico da venda, com o nome da credencial.
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador da venda (UUID), o |
| product_id required | string <uuid> Example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 Identificador do produto da venda (UUID), o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
Array of objects Os passageiros cancelados a reativar. Obrigatório no produto com passageiros: para reativar o produto inteiro, liste todos os cancelados. Não envie em produto sem passageiros. Cada pessoa vai uma vez só: repetida, responde 422. |
Reativa só um passageiro cancelado, citado pelo id da pessoa. A multa e o saldo excluído ficam enquanto houver passageiro cancelado.
{- "passengers": [
- {
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}
}
]
}Trecho da resposta ao reativar o último passageiro cancelado: o produto volta a active, os passageiros ficam sem canceled_at, e a multa e o saldo excluído voltam a zero. Os demais campos da venda são os da consulta por ID.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "sale_number": 1024,
- "status": "opened",
- "insurances": [
- {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45",
- "status": "active",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "passengers": [
- {
- "canceled_at": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - {
- "canceled_at": null,
- "person": {
- "id": "c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e"
}
}
]
}
]
}Altera o vencimento e a descrição de um item do fornecedor da venda, como o Editar do item na aba Financeiro do Monde. Os itens e os id deles vêm em financial.vendor_items, na consulta da venda por ID. O campo omitido fica como está, e o campo desconhecido é ignorado.
O que se edita aqui
bill e payment nulos). Com a fatura automática do fornecedor, o item ainda a faturar também se edita, como no Monde.409: o vencimento e a descrição que valem são os do lançamento, que se altera em Alterar conta a pagar ou receber.409: o vencimento é o do pagamento, que se altera nos pagamentos da venda, em Alterar venda.generated_credit) responde 409: ele é tratado no crédito da pessoa.409. O item que não é do fornecedor desta venda, inclusive o item do cliente e o aguardando exclusão, responde 404.Resposta
financial.vendor_items. A credencial sem a permissão de consultar vendas recebe só o id da venda.Exige, na empresa da venda, a permissão de editar vendas e "Ver aba financeiro", como no Monde; sem "Ver aba financeiro", a resposta é 403 com a mensagem do Monde. Na venda de outro vendedor, exige também "Editar vendas de outros vendedores".
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador da venda (UUID), o |
| id required | string <uuid> Example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 Identificador do item do fornecedor (UUID), o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| due_date | string <date> Novo vencimento do item, no formato ISO 8601 (AAAA-MM-DD). O vencimento é obrigatório: |
| description | string or null <= 100 characters Nova descrição do item, com até 100 caracteres. |
Muda o vencimento e a descrição do item ainda a faturar.
{- "due_date": "2026-12-15",
- "description": "Faturar em dezembro"
}Trecho da resposta: o item alterado volta em financial.vendor_items, ao lado do item que já está num lançamento. Os demais campos da venda são os da consulta por ID.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "sale_number": 1024,
- "status": "closed",
- "financial": {
- "observations": null,
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [ ],
- "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "invoice",
- "description": "Faturar em dezembro",
- "due_date": "2026-12-15",
- "amount": -650.95,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Gera a fatura do pagamento avulso ou do sinal ao fornecedor ou representante, com os itens do fornecedor em aberto da venda, como o Gerar Pagamento Avulso ou Sinal da aba Financeiro e o Sinal Fornecedor do menu do produto, no Monde. Os itens e os id deles vêm em financial.vendor_items, na consulta da venda por ID. O campo desconhecido é ignorado.
Como a fatura é gerada
409; tente de novo depois.Recusas
409, como a fatura já fechada ou liquidada em que o item está.product_id responde 422, apontando o item.Resposta
Location. A credencial que não consulta a fatura recebe só o id dela.Exige, na empresa da venda, a permissão de editar vendas, e na venda de outro vendedor também "Editar vendas de outros vendedores". Exige também "Ver aba financeiro", como o Gerar Pagamento Avulso ou Sinal da aba Financeiro do Monde; só o deposit com product_id, que é o Sinal Fornecedor do produto, não exige. A fatura feita pela venda, sem a fatura automática, exige também "Gerar Fatura", das contas a pagar e receber.
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador da venda (UUID), o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| kind required | string Enum: "advance" "deposit" O que gerar, como no Monde:
|
| product_id | string <uuid> Produto da venda (UUID, o |
required | Array of objects non-empty Os itens do fornecedor que entram na fatura, ao menos um. Todos precisam ser desta venda, estar em aberto e ser do mesmo fornecedor ou representante e da mesma moeda, como a grade do Monde filtrada pelo fornecedor escolhido. |
Gera o pagamento avulso com todo o saldo do item.
{- "kind": "advance",
- "items": [
- {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "amount": 650.95
}
]
}Exemplo de detalhe de uma fatura de fornecedor, com os itens em items e credit_card_items vazio.
{- "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
- "number": "291",
- "transaction_kind": "debit",
- "kind": "vendor_invoice",
- "description": "Fatura Fornecedor Avulsa",
- "document": null,
- "invoice_number": null,
- "amount": 4,
- "final_amount": 4,
- "issue_date": "2026-07-13",
- "due_date": "2026-07-13",
- "settlement_date": null,
- "created_at": "2026-07-13T14:42:00",
- "canceled": false,
- "checked": false,
- "invoice_closed": false,
- "system_generated": false,
- "generates_credit": false,
- "periodicity": "without_periodicity",
- "recurrence_kind": "non_recurrent",
- "recurrence_group_id": null,
- "observations": null,
- "billet": null,
- "check": null,
- "card": null,
- "sale": null,
- "person": {
- "id": "d1e2f3a4-b5c6-4788-e9f0-a1b2c3d4e5f6"
}, - "company": {
- "id": "0a1b2c3d-4e5f-4677-8899-aabbccddeeff"
}, - "account": null,
- "payment_method": null,
- "operation": null,
- "invoice_rule": null,
- "created_by": {
- "id": "e5f6a7b8-c9d0-4122-f3a4-b5c6d7e8f9a0"
}, - "movements": [ ],
- "apportionments": {
- "per_company": [ ],
- "per_cost_center": [ ]
}, - "custom_fields": [ ],
- "attachments": [ ],
- "categories": [ ],
- "commissions": [ ],
- "items": [
- {
- "description": "Diárias de Hospedagem",
- "cost_center": null,
- "checked": false,
- "amount": -4,
- "sale": {
- "id": "8b9c0d1e-2f3a-4b5c-8d6e-7f8a9b0c1d2e"
}, - "sale_product": {
- "id": "f0a1b2c3-d4e5-4966-a7b8-c9d0e1f2a3b4"
}, - "cvc_statement": null
}
], - "credit_card_items": [ ]
}Inclui o Faturar na venda, como o Faturar da aba Financeiro da venda no Monde: o pagante paga o saldo do cliente pela fatura de cliente. O campo desconhecido é ignorado; a descrição, que o Faturar não tem, também.
Como é gravado
202.payments.agency.to_invoice da consulta da venda, numa linha por fatura de cliente e centro de custo. Até lá, ele não aparece na venda.payments não o mantém nem o remove. Ele sai pela remoção do Faturar.Recusas
409: o Faturar só é incluído na venda aberta.422, como o Monde, que só oferece o Faturar quando há saldo.422, apontando o produto, como a soma zero e o centro de custo que o pagante não tem.Resposta
id dela.Exige, na empresa da venda, a permissão de editar vendas, e na venda com recibo impresso também "Alterar vendas com recibo impresso".
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador da venda (UUID), o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| payer_id | string <uuid> (sale_to_invoice_payer_id) Pagante (UUID de pessoa, o |
| cost_center | string <= 50 characters Centro de custo do pagante, até 50 caracteres. Com pagante pessoa jurídica, tem de ser um dos centros de custo cadastrados nela, e é gravado com o nome do cadastro. Com pagante pessoa física é recusado, a menos que a agência use centro de custo em texto livre. Omitido, o Faturar fica sem centro de custo. |
required | Array of objects (sale_to_invoice_products) non-empty Os produtos da venda e o valor de cada um, ao menos um. Cada produto aparece uma vez, tem saldo do cliente e é da mesma moeda de venda que os outros: um pagamento tem uma moeda só. A soma dos valores, com os sinais, não pode ser zero. |
Fatura para o pagante da venda o saldo do cliente de um produto, sem centro de custo.
{- "products": [
- {
- "sale_product_id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45",
- "amount": 650.95
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e"
}, - "operation": {
- "id": "8936058a-2906-4239-9a7f-e22ccc2c195e"
}, - "seller": {
- "id": "7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "intermediary": {
- "id": "d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8"
}, - "requester": {
- "id": "b17c5e38-6a90-4d21-9f43-8e2b70c5a916"
}, - "approver": {
- "id": "95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4"
}, - "promoter": {
- "id": "6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30"
}, - "travel": {
- "id": "7c1d9f30-5a2b-4e68-9d47-2f8b6c0a1e35"
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião comercial"
}
], - "insurances": [
- {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 25.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 417.94,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 100,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 281.54,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 50,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 281.54,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "amount": 5630.73,
- "customer_amount": 6475.34,
- "total_amount": 6475.34,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 68.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:34:59"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "boarding_fee": 136.06,
- "other_fees": 0,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "agency_fee": 0,
- "amount": 1360.67,
- "customer_amount": 1804.75,
- "total_amount": 1804.75,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 7.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 240.5,
- "customer_amount": 264.55,
- "total_amount": 264.55,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4.28,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 121.95,
- "customer_amount": 134.14,
- "total_amount": 134.14,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 17.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 25,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "intermediary_commission_percentage": 2,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 50,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-20T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 20,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:34:59",
- "arrival_date": "2026-12-07T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "commission_percentage": 12,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": 2,
- "unit_price": 1500,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:34:59",
- "arrival_date": "2026-11-22T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "discount_amount": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Inclui a Devolução Faturar na venda, como o Devolução › Faturar da aba Financeiro da venda no Monde: o valor que a agência devolve ao cliente pela fatura de cliente. O corpo é o do Faturar, com a descrição (description) no lugar do centro de custo, que é ignorado. O campo desconhecido é ignorado.
Como é gravada
202.payments.agency.to_invoice da consulta da venda, na linha da fatura de cliente, somada com o sinal: o valor negativo é a Devolução. Ela sai pela remoção do Faturar, junto com a linha.Recusas
409.422.422).Resposta
id dela.Exige, na empresa da venda, a permissão de editar vendas, e na venda com recibo impresso também "Alterar vendas com recibo impresso".
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador da venda (UUID), o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| payer_id | string <uuid> (sale_to_invoice_payer_id) Pagante (UUID de pessoa, o |
| description | string <= 100 characters Descrição da Devolução Faturar, até 100 caracteres. |
required | Array of objects (sale_to_invoice_products) non-empty Os produtos da venda e o valor de cada um, ao menos um. Cada produto aparece uma vez, tem saldo do cliente e é da mesma moeda de venda que os outros: um pagamento tem uma moeda só. A soma dos valores, com os sinais, não pode ser zero. |
Devolve ao cliente, pela fatura de cliente, o saldo negativo de um produto.
{- "description": "Reembolso do seguro",
- "products": [
- {
- "sale_product_id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "amount": -150
}
]
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e"
}, - "operation": {
- "id": "8936058a-2906-4239-9a7f-e22ccc2c195e"
}, - "seller": {
- "id": "7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "intermediary": {
- "id": "d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8"
}, - "requester": {
- "id": "b17c5e38-6a90-4d21-9f43-8e2b70c5a916"
}, - "approver": {
- "id": "95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4"
}, - "promoter": {
- "id": "6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30"
}, - "travel": {
- "id": "7c1d9f30-5a2b-4e68-9d47-2f8b6c0a1e35"
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião comercial"
}
], - "insurances": [
- {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 25.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 417.94,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 100,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 281.54,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 50,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 281.54,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "amount": 5630.73,
- "customer_amount": 6475.34,
- "total_amount": 6475.34,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 68.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:34:59"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "boarding_fee": 136.06,
- "other_fees": 0,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "agency_fee": 0,
- "amount": 1360.67,
- "customer_amount": 1804.75,
- "total_amount": 1804.75,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 7.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 240.5,
- "customer_amount": 264.55,
- "total_amount": 264.55,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4.28,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 121.95,
- "customer_amount": 134.14,
- "total_amount": 134.14,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 17.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 25,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "intermediary_commission_percentage": 2,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 50,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-20T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 20,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:34:59",
- "arrival_date": "2026-12-07T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "commission_percentage": 12,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": 2,
- "unit_price": 1500,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:34:59",
- "arrival_date": "2026-11-22T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "discount_amount": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Remove uma linha do Faturar da venda, como o Excluir da grade de pagamentos da aba Financeiro no Monde. A linha é a de payments.agency.to_invoice da consulta da venda, apontada pela fatura de cliente (bill_id) e pelo centro de custo (cost_center).
O que é removido
Recusas
409.409, a menos que reopen_sale venha true: aí a venda é reaberta, e a credencial precisa também da permissão "Reabrir venda" (403 sem ela).409 sempre: reabra a fatura antes, por Reabrir fatura de cliente.409, a menos que remove_settlement venha true: aí a liquidação da fatura é desfeita.422, como a confirmação que não é true nem false.Resposta
id dela.Exige, na empresa da venda, a permissão de editar vendas, e na venda com recibo impresso também "Alterar vendas com recibo impresso".
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador da venda (UUID), o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| bill_id required | string <uuid> Fatura de cliente da linha (UUID, o |
| cost_center | string or null Centro de custo da linha, o |
| reopen_sale | boolean Default: false Confirma a reabertura da venda fechada, como o Monde pergunta antes de excluir. Com |
| remove_settlement | boolean Default: false Confirma desfazer a liquidação da fatura de cliente liquidada, como o Monde pergunta antes de excluir. Sem a confirmação, a fatura liquidada responde |
Remove a linha do Faturar da fatura de cliente que não tem centro de custo.
{- "bill_id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819",
- "cost_center": null
}{- "id": "9f8e7d6c-5b4a-3210-9876-5432109876ab",
- "sale_number": 987,
- "sale_date": "2026-11-15",
- "status": "closed",
- "observations": "Venda finalizada.",
- "printed_receipt": true,
- "created_at": "2026-11-15T10:30:00",
- "totals": {
- "products": 19188.57,
- "fees": 598.84,
- "discount": 225,
- "revenue": 1500,
- "balance": 0,
- "final_amount": 19870.43
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e"
}, - "operation": {
- "id": "8936058a-2906-4239-9a7f-e22ccc2c195e"
}, - "seller": {
- "id": "7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "intermediary": {
- "id": "d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8"
}, - "requester": {
- "id": "b17c5e38-6a90-4d21-9f43-8e2b70c5a916"
}, - "approver": {
- "id": "95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4"
}, - "promoter": {
- "id": "6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30"
}, - "travel": {
- "id": "7c1d9f30-5a2b-4e68-9d47-2f8b6c0a1e35"
}, - "custom_fields": [
- {
- "id": 12345,
- "value": "Reunião comercial"
}
], - "insurances": [
- {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
- "document": "14296922",
- "begin_date": "2026-11-20",
- "end_date": "2026-12-05",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Embarque confirmado.",
- "included_services": "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 50.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 25.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 625.95,
- "customer_amount": 650.95,
- "amount": 650.95
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "9921508090000",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 25,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 625.95,
- "customer_amount": 650.95,
- "total_amount": 650.95,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cruises": [
- {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182",
- "local_id": "b2c3d4e5-f6a7-8901-2345-678901bcdef0",
- "booking_number": "987568489",
- "departure_date": "2026-11-21",
- "arrival_date": "2026-12-05",
- "ship_name": "MXS Example Seaview",
- "cruise_destination": "Bahamas",
- "accommodation_kind": "Duplo Casal",
- "cabin_number": "1234",
- "cabin_kind": "Royal Suite",
- "cabin_category": "7A",
- "meal_plan": "All inclusive",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Cabine confirmada.",
- "included_services": "Pacote: All Inclusive\nCódigo: 1234",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 835.88,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 417.94,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 100,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 120,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 100,
- "products": 8358.77,
- "customer_amount": 8478.77,
- "amount": 8478.77
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "CRZ-90412",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 120,
- "tip": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 8358.77,
- "customer_amount": 8478.77,
- "total_amount": 8478.77,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "hotels": [
- {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293",
- "local_id": "c3d4e5f6-a7b8-9012-3456-789012cdef01",
- "booking_number": "1020506090",
- "check_in": "2026-12-08",
- "check_out": "2026-12-15",
- "destination": "international",
- "accommodation_kind": "Duplo Casal",
- "room_category": "Deluxe",
- "meal_plan": "All Inclusive",
- "nights": 8,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Reserva garantida.",
- "included_services": "Epic Journey Hotel: Avenida Rebouças, 397, São Paulo, SP, Brasil\nQuarto com vista para cidade.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 563.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 281.54,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 50,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 281.54,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "discount": 50,
- "products": 5630.73,
- "customer_amount": 6475.34,
- "amount": 6475.34
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "HTL-55821",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 281.54,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 563.07,
- "amount": 5630.73,
- "customer_amount": 6475.34,
- "total_amount": 6475.34,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "airline_tickets": [
- {
- "id": "4d5e6f70-8192-4a3b-cd4e-5f6071829304",
- "local_id": "d4e5f6a7-b8c9-0123-4567-890123def012",
- "locator": "WABCJJ",
- "destination": "international",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 136.07,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 68.04,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 20,
- "cc_rav_fee": 27.22,
- "cc_du_fee": 27.22,
- "totals": {
- "fees": 136.06,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 20,
- "products": 1360.67,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "customer_amount": 1804.75,
- "amount": 1804.75
}, - "supplier": {
- "id": "3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "segments": [
- {
- "airline_code": "AA",
- "flight_number": "1234",
- "class": "A",
- "origin": "NAS",
- "departure_date": "2026-11-20T15:34:59",
- "destination": "JFK",
- "arrival_date": "2026-11-20T15:34:59"
}
], - "passengers": [
- {
- "ticket_number": "99526874895",
- "emission_name": "Maria da Silva",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "boarding_fee": 136.06,
- "other_fees": 0,
- "rav_fee": 204.01,
- "rav_fee_discount": 0,
- "du_fee": 104.01,
- "du_fee_discount": 0,
- "agency_fee": 0,
- "amount": 1360.67,
- "customer_amount": 1804.75,
- "total_amount": 1804.75,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "train_tickets": [
- {
- "id": "5e6f7081-92a3-4b4c-de5f-607182930415",
- "local_id": "e5f6a7b8-c9d0-1234-5678-901234ef0123",
- "document": "RE9988777",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 15,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 7.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 240.5,
- "customer_amount": 264.55,
- "amount": 264.55
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "RE9988777",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 24.05,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 240.5,
- "customer_amount": 264.55,
- "total_amount": 264.55,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "ground_transportations": [
- {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526",
- "local_id": "f6a7b8c9-d0e1-2345-6789-012345f01234",
- "document": "GT123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-23T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Bilhete emitido.",
- "included_services": "Refeição inclusa\nWi-Fi gratuito.",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 8.55,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4.28,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 5,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 5,
- "products": 121.95,
- "customer_amount": 134.14,
- "amount": 134.14
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "0001234567",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 12.19,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 121.95,
- "customer_amount": 134.14,
- "total_amount": 134.14,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "car_rentals": [
- {
- "id": "708192a3-b4c5-4d6e-f071-829304152637",
- "local_id": "a7b8c9d0-e1f2-3456-7890-123456a01234",
- "document": "CR123456789",
- "pickup_date": "2026-11-20",
- "pickup_location": "Aeroporto de Congonhas",
- "dropoff_date": "2026-11-27",
- "dropoff_location": "Aeroporto de Congonhas",
- "destination": "national",
- "vehicle_category": "Econômico",
- "rental_days": 7,
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Retirada confirmada.",
- "included_services": "Quilometragem livre\nSeguro básico incluso\nTanque cheio na retirada",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 35,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 17.5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 10,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 10,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "LOC-77310",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "travel_packages": [
- {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748",
- "local_id": "b8c9d0e1-f2a3-4567-8901-234567a01234",
- "document": "TP123456789",
- "begin_date": "2026-11-25",
- "end_date": "2026-12-02",
- "destination": "international",
- "package_name": "Pacote Europa Clássica",
- "transport": "scheduled_flight",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem: Hotéis 4 estrelas\nRefeições: Café da manhã e jantar\nPasseios: City tour em 5 cidades\nSeguro viagem internacional",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 250,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 125,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 100,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 25,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 25,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "PCT2024050001",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "other_fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "others": [
- {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968",
- "product": {
- "id": "a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b"
}, - "document": "OUT123456",
- "destination": "Salvador",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 12,
- "commission_percentage": 2,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 4,
- "intermediary_commission_percentage": 2,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 50,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "OUT2024060012",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "excursions": [
- {
- "id": "d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081",
- "local_id": "c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e",
- "document": "EXC123456",
- "departure_date": "2026-11-20T15:34:59",
- "arrival_date": "2026-11-20T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Passeio confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 10,
- "commission_percentage": 10,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 5,
- "intermediary_commission_percentage": 5,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 20,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 350,
- "customer_amount": 350,
- "amount": 350
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}, - "passengers": [
- {
- "document": "EXC2024060034",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "amount": 350,
- "customer_amount": 350,
- "total_amount": 350,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "cvc_packages": [
- {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605",
- "product": {
- "id": "c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d"
}, - "package_name": "CVC Caribe 7 noites",
- "receipt_number": "89100000183488",
- "departure_date": "2026-11-30T15:34:59",
- "arrival_date": "2026-12-07T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "delete_supplier_balance": false,
- "supplier_fine": 0,
- "supplier_fine_origin_currency": 0,
- "observations": "Pacote confirmado.",
- "included_services": "Hospedagem all inclusive\nTraslados inclusos",
- "currency": "BRL",
- "exchange_rate": 1,
- "commission_amount": 490,
- "commission_percentage": 12,
- "over_amount": 0,
- "over_percentage": 0,
- "over": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "deductions": 0,
- "discount_amount": 0,
- "cc_rav_fee": 0,
- "quantity": 2,
- "unit_price": 1500,
- "unit_fee": 80,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 3160,
- "customer_amount": 3160,
- "amount": 3160
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "representative": {
- "id": "028ea1ef-3f8e-4c7f-93da-463794a5afda"
}
}
], - "operations": [
- {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716",
- "product": {
- "id": "b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c"
}, - "document": "OP-000123",
- "departure_date": "2026-11-22T15:34:59",
- "arrival_date": "2026-11-22T15:34:59",
- "status": "active",
- "issue_date": "2026-11-15",
- "canceled_at": null,
- "calculate_commission": true,
- "deleted_balance": 0,
- "observations": "City tour confirmado.",
- "included_services": "Guia local incluso\nTransporte incluso",
- "currency": "BRL",
- "exchange_rate": 1,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "intermediary_over": 0,
- "agency_service_fee": 0,
- "agency_card_rate": 0,
- "discount_amount": 0,
- "quantity": null,
- "unit_price": null,
- "unit_fee": null,
- "totals": {
- "fees": 0,
- "rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "discount": 0,
- "products": 2500,
- "customer_amount": 2500,
- "amount": 2500
}, - "supplier": {
- "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}, - "passengers": [
- {
- "document": "OP2024060056",
- "cost_center": "Corporativa EXT",
- "canceled_at": null,
- "fees": 0,
- "amount": 2500,
- "customer_amount": 2500,
- "total_amount": 2500,
- "person": {
- "id": "322ff2c2-43e0-4376-bea5-20f88b673b6d"
}
}
]
}
], - "payments": {
- "agency": {
- "bills": [
- {
- "id": "9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d",
- "local_id": "pagamento-1"
}, - {
- "id": "1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071",
- "local_id": "pagamento-2"
}, - {
- "id": "4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920",
- "local_id": "pagamento-3"
}
], - "refunds": [
- {
- "id": "3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718"
}
], - "credit": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "amount": 6475.34,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "origin_sale": {
- "id": "3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8"
}, - "products": [
- {
- "amount": 6475.34,
- "sale_product": {
- "id": "3c4d5e6f-7081-492a-bc3d-4e5f60718293"
}
}
]
}
], - "to_invoice": [
- {
- "bill": {
- "id": "4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819"
}, - "cost_center": "Diretoria",
- "amount": 2350,
- "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": -150,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "retained_by_intermediary": [
- {
- "id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01",
- "due_date": "2026-12-15",
- "amount": 195,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 625.95,
- "sale_product": {
- "id": "1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071"
}
}
]
}
], - "legacy": [
- {
- "id": "d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70",
- "due_date": "2026-10-16",
- "amount": 300,
- "check": null,
- "card": {
- "brand": "mastercard",
- "last_digits": "5678",
- "authorization": "ABC123"
}, - "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "payment_method": {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}
]
}
]
}, - "vendor": {
- "credit_card": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081",
- "local_id": "pagamento-4",
- "due_date": "2026-12-15",
- "card_last_digits": "1234",
- "authorization": "XYZ789",
- "installments": 2,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 8358.77,
- "sale_product": {
- "id": "2b3c4d5e-6f70-4819-ab2c-3d4e5f607182"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968"
}
}, - {
- "amount": 3160,
- "sale_product": {
- "id": "5c4b3a29-1e0d-4982-7c6b-5a4938271605"
}
}, - {
- "amount": 2500,
- "sale_product": {
- "id": "6d5c4b3a-2f1e-4093-8d7c-6b5a49382716"
}
}
]
}
], - "check": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192",
- "due_date": "2026-12-15",
- "bank_code": "341",
- "check_number": 654321,
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "credit": [
- {
- "id": "a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3",
- "local_id": "pagamento-6",
- "due_date": "2026-12-15",
- "document": "CRED-000123",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 134.14,
- "sale_product": {
- "id": "6f708192-a3b4-4c5d-ef60-718293041526"
}
}
]
}
], - "others": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4",
- "local_id": "pagamento-5",
- "due_date": "2026-12-15",
- "details": "Fatura",
- "payer": {
- "id": "2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4"
}, - "products": [
- {
- "amount": 2500,
- "sale_product": {
- "id": "8192a3b4-c5d6-4e7f-0182-930415263748"
}
}
]
}
]
}
}, - "commissions": [
- {
- "description": "Plano: Padrão, cálculo: 10%",
- "amount": 700,
- "retained_amount": 0,
- "balance": 700,
- "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}
}, - {
- "description": "Comissão Intermediário",
- "amount": 49.75,
- "retained_amount": 0,
- "balance": 49.75,
- "person": {
- "id": "1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6"
}
}, - {
- "description": null,
- "amount": -100,
- "retained_amount": 0,
- "balance": -100,
- "person": {
- "id": "2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7"
}
}
], - "financial": {
- "observations": "Teste de observações financeiras",
- "vendor_bills": [
- {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}
], - "standalone_bills": [
- {
- "id": "f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f"
}
], - "vendor_items": [
- {
- "id": "4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16",
- "kind": "invoice",
- "description": null,
- "due_date": "2026-11-10",
- "amount": -320,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": {
- "id": "c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39"
}, - "payment": null
}, - {
- "id": "8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84",
- "kind": "lei_kandir",
- "description": null,
- "due_date": "2026-11-20",
- "amount": -12.5,
- "currency": "BRL",
- "sale_product": {
- "id": "5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45"
}, - "person": {
- "id": "0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5"
}, - "bill": null,
- "payment": null
}
]
}
}Retorna os três campos adicionais do produto da venda (external_number, additional1 e additional2) com o título que a agência deu a cada um no Monde, como "Nº Pedido". Na venda, informe e leia o campo pela key: o título só serve para saber qual campo é qual, e mudar o título no Monde não muda a key. O campo sem título (active falso) não aparece no Monde, e a API ignora o valor enviado nele. Pede a permissão de consultar vendas.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "key": "external_number",
- "label": "Ferrovia",
- "active": true
}, - {
- "key": "additional1",
- "label": "Nº Pedido",
- "active": true
}, - {
- "key": "additional2",
- "label": null,
- "active": false
}
]
}Consulte e mantenha o catálogo de produtos de viagem (seguros, cruzeiros, hotéis, passagens aéreas, operações próprias e outros) usados nas vendas, com os fornecedores de cada produto e os representantes de cada fornecedor. Fornecedores e representantes são partes do produto: são lidos com a permissão de ler produtos, e cada um tem as próprias permissões de gravar e de excluir, como no Monde.
Retorna a lista de produtos disponíveis no sistema, com possibilidade de filtrar por tipo de produto.
| kind | Array of strings Items Enum: "insurance" "cruise" "hotel" "airline_ticket" "train_ticket" "ground_transportation" "excursion" "visa" "car_rental" "travel_package" "cvc_package" "operation" "others" Examples:
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 |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo produtos de diferentes tipos.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Seguro Viagem",
- "kind": "insurance",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": "Cobertura completa para viagens internacionais"
}, - {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Cruzeiro",
- "kind": "cruise",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": null
}, - {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92",
- "name": "Diárias de Hospedagem",
- "kind": "hotel",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": "Hotel 5 estrelas em Copacabana"
}, - {
- "id": "979cc2d4-4e37-4d36-b6de-eb1e9e1080f0",
- "name": "Passagem Aérea",
- "kind": "airline_ticket",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": null
}, - {
- "id": "20febcb5-85ef-427d-9a4e-da407062432d",
- "name": "Operação Própria",
- "kind": "operation",
- "passengers": true,
- "system": false,
- "active": true,
- "nbs_code": null,
- "included_services": "Turismo de aventura"
}, - {
- "id": "3b857f74-8c82-4391-bc95-2245fc4ba341",
- "name": "Outros",
- "kind": "others",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": null
}, - {
- "id": "bdaaf1b2-ee48-4b20-810a-10ccc27875b0",
- "name": "Aluguel de Carro",
- "kind": "car_rental",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": "Locação de veículo econômico"
}, - {
- "id": "ae36c79c-37cd-4185-af57-448a75683ba1",
- "name": "Pacote Turístico",
- "kind": "travel_package",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": "Pacote completo de viagem"
}, - {
- "id": "49dd6ca0-9eca-4718-906e-c32805d8d677",
- "name": "Produto CVC",
- "kind": "cvc_package",
- "passengers": false,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": "Produto exclusivo CVC"
}, - {
- "id": "4f1c9a27-58aa-4d3e-9f0b-1c7d6e2b8a94",
- "name": "Excursão",
- "kind": "excursion",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": "Passeio com guia acompanhante"
}, - {
- "id": "d9d27b79-649e-4ef9-b198-f32baaa9f9d2",
- "name": "Visto",
- "kind": "visa",
- "passengers": true,
- "system": true,
- "active": true,
- "nbs_code": null,
- "included_services": null
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra um produto no catálogo. Como na tela de Produtos do Monde, a criação só faz produtos dos tipos others (Outros) e operation (Operação Própria): os demais tipos são produtos do sistema. Operação própria é recurso de agência e é recusada numa base de operadora (consolidadora). O tipo e o passengers são escolhidos na criação e não mudam depois. Os fornecedores entram depois, em /products/{id}/supplies. Exige a permissão de criar e editar produtos numa empresa cuja licença permita gravar.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name required | string <= 50 characters Nome do produto |
| included_services | string or null Serviços inclusos no produto |
| active | boolean Default: true Indica se o produto está ativo |
| nbs_code | string or null Código NBS do produto (Nomenclatura Brasileira de Serviços) |
| kind | string Default: "others" Enum: "others" "operation" Tipo do produto. Na criação só são aceitos:
|
| passengers | boolean Default: true Indica se o produto tem passageiros. Padrão |
Exemplo de criação de um produto do tipo Outros, com passageiros e código NBS.
{- "name": "Passeio de Barco",
- "included_services": "Passeio de escuna com almoço",
- "kind": "others",
- "passengers": true,
- "active": true,
- "nbs_code": "1.2501.11.00"
}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": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Fornecimento padrão",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "percentage",
- "commission_percentage": 5,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
]
}Retorna os dados completos de um produto específico, incluindo seus fornecimentos com o fornecedor, os dados de comissão e os representantes.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Fornecimento padrão",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "percentage",
- "commission_percentage": 5,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
]
}Altera um produto já cadastrado, inclusive os do sistema. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. Os serviços inclusos (included_services) e o código NBS (nbs_code) enviados como nulo ficam em branco; name, kind, passengers e active não podem ser retirados, e enviados como nulo são recusados (422). O tipo e o passengers não mudam depois do cadastro: enviá-los com o valor que o produto já tem é aceito, e com outro valor é recusado. Produtos CVC são mantidos pela integração da CVC e não podem ser alterados (409). A resposta traz o produto alterado no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de produtos; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string <= 50 characters Nome do produto |
| included_services | string or null Serviços inclusos no produto |
| active | boolean Default: true Indica se o produto está ativo |
| nbs_code | string or null Código NBS do produto (Nomenclatura Brasileira de Serviços) |
| kind | string Default: "others" Enum: "others" "operation" Tipo do produto. Na criação só são aceitos:
|
| passengers | boolean Default: true Indica se o produto tem passageiros. Padrão |
Exemplo de alteração que só inativa o produto, mantendo os demais campos.
{- "active": false
}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": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Fornecimento padrão",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "percentage",
- "commission_percentage": 5,
- "commission_amount": 0,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
]
}Exclui o produto definitivamente. Produtos do sistema não podem ser excluídos, e o produto com vínculos (fornecedores, vendas, regras de faturamento ou de nota fiscal, planos de comissão, integrações) também não: para tirá-lo do catálogo, inative-o pelo PATCH (active: false) ou unifique-o com outro produto na tela de Produtos do Monde. Os dois casos respondem 409. Exige a permissão de excluir produtos.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Retorna os fornecedores (fornecimentos) do produto, cada um com as condições comerciais e os representantes. Exige a permissão de ler produtos.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de lista de fornecimentos, com os representantes de cada um.
{- "data": [
- {
- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
]
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Adiciona um fornecedor ao produto. A pessoa do fornecedor (supplier) é obrigatória e é referenciada pelo UUID. O mesmo fornecedor pode entrar mais de uma vez, desde que com descrições diferentes. A comissão é em percentual ou em valor: o campo do outro tipo fica zerado e, se enviado, tem de ser zero. Os campos omitidos ficam com o padrão do Monde: comissão em percentual, valores zerados e over sobre 100%. restitutes_kandir_law só se aplica aos produtos com retenção da Lei Kandir (passagem aérea, seguro viagem e transporte terrestre), e nos demais é recusado. Produtos de operação própria e produtos CVC não têm fornecedores (409). Exige a permissão "Adicionar Fornecedor" de produtos.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
required | object Fornecedor do fornecimento.
|
| description | string or null <= 50 characters Descrição do fornecimento (campo opcional). |
| restitutes_kandir_law | boolean Indica se o fornecimento restitui a Lei Kandir. |
| commission_type | string Enum: "percentage" "amount" Tipo da comissão — percentage (percentual) ou amount (valor). |
| commission_percentage | number <double> Percentual de comissão. |
| commission_amount | number <double> Valor da comissão. |
| over_percentage | number <double> Percentual de over. |
| over_value | number <double> Percentual aplicado sobre o over. |
| du_percentage | number <double> Percentual da taxa de cartão DU. |
| rav_percentage | number <double> Percentual da taxa de cartão RAV. |
Exemplo de fornecedor com comissão em percentual e over.
{- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "over_percentage": 2.5,
- "over_value": 100
}Exemplo de resposta de um fornecimento do produto.
{- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [ ]
}Retorna um fornecimento do produto, com as condições comerciais e os representantes. O ID de um fornecimento de outro produto responde 404.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um fornecimento do produto.
{- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [ ]
}Altera um fornecimento do produto. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. A descrição enviada como nula fica em branco; o fornecedor (supplier), o restitutes_kandir_law e os campos da comissão não podem ser retirados, e enviados como nulo são recusados (422). Ao trocar o commission_type, o campo da comissão do outro tipo é zerado. Os representantes são mantidos pelo próprio caminho deles. Exige a permissão "Editar Fornecedor" de produtos. A resposta traz o fornecimento alterado quando a credencial também tem a permissão "Visualizar" de produtos; sem ela, apenas o id. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
object Fornecedor do fornecimento.
| |
| description | string or null <= 50 characters Descrição do fornecimento (campo opcional). |
| restitutes_kandir_law | boolean Indica se o fornecimento restitui a Lei Kandir. |
| commission_type | string Enum: "percentage" "amount" Tipo da comissão — percentage (percentual) ou amount (valor). |
| commission_percentage | number <double> Percentual de comissão. |
| commission_amount | number <double> Valor da comissão. |
| over_percentage | number <double> Percentual de over. |
| over_value | number <double> Percentual aplicado sobre o over. |
| du_percentage | number <double> Percentual da taxa de cartão DU. |
| rav_percentage | number <double> Percentual da taxa de cartão RAV. |
Exemplo de alteração que troca a comissão para valor; o percentual de comissão fica zerado.
{- "commission_type": "amount",
- "commission_amount": 35
}Exemplo de resposta de um fornecimento do produto.
{- "id": "6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b",
- "description": "Tarifa net",
- "commission_type": "percentage",
- "commission_percentage": 10,
- "commission_amount": 0,
- "over_percentage": 2.5,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "restitutes_kandir_law": true,
- "supplier": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "representations": [ ]
}Remove o fornecimento do produto, junto com os representantes dele. Não é possível remover o fornecimento usado em vendas (unifique-o com outro fornecedor na tela de Produtos do Monde) nem o fornecedor que tem regra de faturamento para o produto: os dois casos respondem 409. Exige a permissão "Excluir Fornecedor" de produtos.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Retorna os representantes de um fornecimento do produto, cada um com as condições comerciais próprias. Exige a permissão de ler produtos.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de lista de representantes.
{- "data": [
- {
- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Adiciona um representante ao fornecimento do produto. A pessoa do representante (representative) é obrigatória, referenciada pelo UUID, e não pode se repetir no mesmo fornecimento. A comissão segue as mesmas regras do fornecimento: em percentual ou em valor, com o campo do outro tipo zerado, e os campos omitidos com o padrão do Monde. Exige a permissão "Adicionar Representante" de produtos.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
required | object Representante do fornecimento.
|
| commission_type | string Enum: "percentage" "amount" Tipo da comissão — percentage (percentual) ou amount (valor). |
| commission_percentage | number <double> Percentual de comissão. |
| commission_amount | number <double> Valor da comissão. |
| over_percentage | number <double> Percentual de over. |
| over_value | number <double> Percentual aplicado sobre o over. |
| du_percentage | number <double> Percentual da taxa de cartão DU. |
| rav_percentage | number <double> Percentual da taxa de cartão RAV. |
Exemplo de representante com comissão em valor.
{- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}, - "commission_type": "amount",
- "commission_amount": 50
}Exemplo de resposta de um representante do fornecimento.
{- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}Retorna um representante do fornecimento. O ID de um representante de outro fornecimento responde 404.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| id required | string <uuid> Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a Identificador único do representante do fornecimento (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um representante do fornecimento.
{- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}Altera um representante do fornecimento. Informe apenas os campos que devem mudar: o campo omitido permanece como está. O representante (representative) e os campos da comissão não podem ser retirados, e enviados como nulo são recusados (422). Exige a permissão "Editar Representante" de produtos. A resposta traz o representante alterado quando a credencial também tem a permissão "Visualizar" de produtos; sem ela, apenas o id. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| id required | string <uuid> Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a Identificador único do representante do fornecimento (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
object Representante do fornecimento.
| |
| commission_type | string Enum: "percentage" "amount" Tipo da comissão — percentage (percentual) ou amount (valor). |
| commission_percentage | number <double> Percentual de comissão. |
| commission_amount | number <double> Valor da comissão. |
| over_percentage | number <double> Percentual de over. |
| over_value | number <double> Percentual aplicado sobre o over. |
| du_percentage | number <double> Percentual da taxa de cartão DU. |
| rav_percentage | number <double> Percentual da taxa de cartão RAV. |
Exemplo de alteração só do percentual de over.
{- "over_percentage": 1.5
}Exemplo de resposta de um representante do fornecimento.
{- "id": "8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a",
- "commission_type": "amount",
- "commission_percentage": 0,
- "commission_amount": 50,
- "over_percentage": 0,
- "over_value": 100,
- "du_percentage": 0,
- "rav_percentage": 0,
- "representative": {
- "id": "c3b7e8eb-1199-5457-c170-923c3fe56c92"
}
}Remove o representante do fornecimento. O representante usado em vendas não pode ser removido (409). Exige a permissão "Excluir Representante" de produtos.
| product_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do produto (formato UUID). |
| supply_id required | string <uuid> Example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b Identificador único do fornecimento do produto (formato UUID). |
| id required | string <uuid> Example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a Identificador único do representante do fornecimento (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte e mantenha os tipos de cabine cadastrados no sistema para utilizar em produtos de cruzeiro.
Retorna a lista de tipos de cabine cadastrados no sistema.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo todas as cabines cadastradas.
{- "data": [
- {
- "name": "Externa"
}, - {
- "name": "Interna"
}, - {
- "name": "Suíte"
}, - {
- "name": "Varanda"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra uma cabine. O nome é a chave da cabine: é por ele que a cabine é consultada, alterada e excluída, e é ele que o produto de cruzeiro da venda informa em cabin_kind.
Exige a permissão "Editar" de cabines em alguma empresa que não seja somente leitura. A resposta traz a cabine cadastrada.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string [ 1 .. 30 ] characters Nome da cabine, até 30 caracteres e sem repetir outra cabine. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia a cabine. |
Exemplo de cadastro de cabine.
{- "name": "Varanda"
}Exemplo de resposta de uma cabine.
{- "name": "Varanda"
}Retorna a cabine pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F).
| name required | string <= 30 characters Example: Varanda Nome atual da cabine, com codificação de URL |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma cabine.
{- "name": "Varanda"
}Altera a cabine pelo nome atual, informado no caminho com codificação de URL. O campo omitido permanece como está. Um nome novo renomeia a cabine, e os produtos de venda que a usam passam a mostrar o nome novo, como no Monde.
O reenvio com a mesma Idempotency-Key depois de trocar o nome responde 404: o caminho antigo não existe mais.
Exige a permissão "Editar" de cabines em alguma empresa que não seja somente leitura. A resposta traz a cabine a quem também pode ler cabines; aos demais, só o nome. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).
| name required | string <= 30 characters Example: Varanda Nome atual da cabine, com codificação de URL |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string [ 1 .. 30 ] characters Nome da cabine, até 30 caracteres e sem repetir outra cabine. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia a cabine. |
Exemplo de alteração que renomeia a cabine.
{- "name": "Varanda Premium"
}Exemplo de resposta de uma cabine.
{- "name": "Varanda"
}Exclui a cabine pelo nome atual, informado no caminho com codificação de URL. A cabine usada em algum produto de venda não pode ser excluída: a resposta é 409, como no Monde.
Exige a permissão "Excluir" de cabines em alguma empresa que não seja somente leitura.
| name required | string <= 30 characters Example: Varanda Nome atual da cabine, com codificação de URL |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte e mantenha os pacotes turísticos usados nos produtos de pacote turístico das vendas.
Retorna a lista de pacotes cadastrados no sistema, em ordem de nome.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo todos os pacotes cadastrados.
{- "data": [
- {
- "name": "Bariloche 5 noites",
- "services_included": null
}, - {
- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra um pacote. O nome é a chave do pacote: é por ele que o pacote é consultado, alterado e excluído, e é ele que o produto de pacote turístico da venda informa em package_name.
Exige a permissão "Editar" de pacotes em alguma empresa que não seja somente leitura. A resposta traz o pacote cadastrado.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string [ 1 .. 50 ] characters Nome do pacote, até 50 caracteres e sem repetir outro pacote. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia o pacote. |
| services_included | string or null Serviços inclusos no pacote. Na alteração, nulo deixa o campo em branco. |
Exemplo de cadastro de pacote.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Exemplo de resposta de um pacote.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Retorna o pacote pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F).
| name required | string <= 50 characters Example: Disney 7 noites Nome atual do pacote, com codificação de URL |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um pacote.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Altera o pacote pelo nome atual, informado no caminho com codificação de URL. O campo omitido permanece como está. Os serviços inclusos enviados nulos ficam em branco. Um nome novo renomeia o pacote, e os produtos de venda que o usam passam a mostrar o nome novo, como no Monde.
O reenvio com a mesma Idempotency-Key depois de trocar o nome responde 404: o caminho antigo não existe mais.
Exige a permissão "Editar" de pacotes em alguma empresa que não seja somente leitura. A resposta traz o pacote a quem também pode ler pacotes; aos demais, só o nome. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).
| name required | string <= 50 characters Example: Disney 7 noites Nome atual do pacote, com codificação de URL |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string [ 1 .. 50 ] characters Nome do pacote, até 50 caracteres e sem repetir outro pacote. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia o pacote. |
| services_included | string or null Serviços inclusos no pacote. Na alteração, nulo deixa o campo em branco. |
Exemplo de alteração que renomeia o pacote.
{- "name": "Disney 8 noites"
}Exemplo de resposta de um pacote.
{- "name": "Disney 7 noites",
- "services_included": "Aéreo, hotel e ingressos para os parques"
}Exclui o pacote pelo nome atual, informado no caminho com codificação de URL. O pacote usado em algum produto de venda não pode ser excluído: a resposta é 409, como no Monde.
Exige a permissão "Excluir" de pacotes em alguma empresa que não seja somente leitura.
| name required | string <= 50 characters Example: Disney 7 noites Nome atual do pacote, com codificação de URL |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte e mantenha os centros de custo cadastrados no sistema para utilizar em lançamentos financeiros.
Retorna a lista de centros de custo cadastrados no sistema.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo todos os centros de custo cadastrados.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Administrativo"
}, - {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "description": "Comercial"
}, - {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "description": "Marketing"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra um centro de custo. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description required | string <= 50 characters Descrição do centro de custo, até 50 caracteres. Obrigatória na inclusão. |
Centro de custo Marketing.
{- "description": "Marketing"
}Exemplo de resposta de um centro de custo específico.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Administrativo"
}Retorna um centro de custo específico pelo seu identificador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do centro de custo |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um centro de custo específico.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Administrativo"
}Altera a descrição do centro de custo. O campo omitido permanece como está; description não pode ser retirado, e enviado como nulo é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do centro de custo |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description | string <= 50 characters Descrição do centro de custo, até 50 caracteres. Obrigatória na inclusão. |
Altera a descrição.
{- "description": "Marketing digital"
}Exemplo de resposta de um centro de custo específico.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Administrativo"
}Exclui o centro de custo. O centro de custo usado no rateio de algum lançamento financeiro responde 409. Não exige Idempotency-Key.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do centro de custo |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte e mantenha as moedas cadastradas no sistema e as cotações delas, para utilizar em produtos de venda e lançamentos financeiros.
Retorna a lista de moedas cadastradas no sistema.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo todas as moedas cadastradas.
{- "data": [
- {
- "code": "BRL",
- "description": "Real",
- "symbol": "R$",
- "active": true
}, - {
- "code": "USD",
- "description": "Dólar Americano",
- "symbol": "US$",
- "active": true
}, - {
- "code": "EUR",
- "description": "Euro",
- "symbol": "€",
- "active": false
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma moeda específica pelo seu código ISO 4217.
| code required | string Example: BRL Código da moeda no padrão ISO 4217 |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma moeda específica.
{- "code": "BRL",
- "description": "Real",
- "symbol": "R$",
- "active": true
}Ativa ou desativa a moeda pelo código. A lista de moedas é interna e fixa: código, descrição e símbolo não mudam, e enviar nesses campos um valor diferente do atual é recusado com 422. O campo omitido permanece como está.
Exige a permissão "Editar moedas e gravar câmbios" de moedas em alguma empresa que não seja somente leitura. A resposta traz a moeda a quem também pode ler moedas; aos demais, só o código.
| code required | string Example: USD Código da moeda no padrão ISO 4217 |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| code | string = 3 characters Código da moeda. É fixo: um valor diferente do atual é recusado (422) |
| description | string <= 100 characters Descrição da moeda. É fixa: um valor diferente do atual é recusado (422) |
| symbol | string or null <= 5 characters Símbolo da moeda. É fixo: um valor diferente do atual é recusado (422) |
| active | boolean Indica se a moeda está ativa |
Exemplo de alteração que desativa a moeda.
{- "active": false
}Exemplo de resposta de uma moeda específica.
{- "code": "BRL",
- "description": "Real",
- "symbol": "R$",
- "active": true
}Nenhuma moeda é excluída: a lista de moedas é interna e fixa, e a resposta é sempre 409. Para deixar de usar uma moeda, desative-a em Alterar moeda.
Exige a permissão "Excluir" de moedas em alguma empresa que não seja somente leitura.
| code required | string Example: USD Código da moeda no padrão ISO 4217 |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Retorna o histórico de cotações da moeda, da mais recente para a mais antiga. A cotação diz quantos reais vale uma unidade da moeda; a vigente é a mais recente. Exige a permissão "Visualizar" de moedas.
| code required | string Example: USD Código da moeda no padrão ISO 4217 |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com o histórico de cotações da moeda.
{- "data": [
- {
- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}, - {
- "id": "2b7e4c1a-0f3d-4e8b-a6c2-91d5e7f30b44",
- "currency": {
- "code": "USD"
}, - "value": 5.38,
- "quoted_at": "2026-10-13T09:15:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Grava a cotação nova da moeda, com a data e a hora do momento da gravação, como a ferramenta Atualizar Câmbios do Monde. O valor é quantos reais vale uma unidade da moeda, maior que zero, e é gravado com 4 casas decimais.
Só as moedas ativas, menos o real (BRL), recebem cotação. Quando o valor é igual ao da cotação vigente, nada é gravado e a resposta traz a vigente, com 200.
A gravação de cotações é exclusiva das operadoras: na agência a resposta é 403. Exige a permissão "Editar moedas e gravar câmbios" de moedas em alguma empresa que não seja somente leitura.
| code required | string Example: USD Código da moeda no padrão ISO 4217 |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| value required | number ( 0 .. 99999999999.9999 ] Quantos reais vale uma unidade da moeda, maior que zero. É gravado com 4 casas decimais |
Exemplo de gravação da cotação nova da moeda.
{- "value": 5.4321
}Exemplo de resposta de uma cotação.
{- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}Retorna uma cotação da moeda pelo ID.
| code required | string Example: USD Código da moeda no padrão ISO 4217 |
| id required | string <uuid> Example: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 ID da cotação |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma cotação.
{- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}Grava de uma vez a cotação nova de várias moedas, como a ferramenta Atualizar Câmbios do Monde. Cada item leva o código da moeda e o valor, quantos reais vale uma unidade dela; só as moedas ativas, menos o real (BRL), recebem cotação, e a mesma moeda não pode repetir na lista.
A gravação é de tudo ou nada: um item inválido recusa a requisição inteira com 422, e o erro traz a posição dele na lista, contada a partir de 0. A moeda cujo valor é igual ao da cotação vigente fica de fora, e a resposta traz só as cotações gravadas: 201 quando ao menos uma foi gravada, e 200 com a lista vazia quando todos os valores são iguais aos das cotações vigentes.
Exclusivo das operadoras: na agência a resposta é 403. Exige a permissão "Editar moedas e gravar câmbios" de moedas em alguma empresa que não seja somente leitura.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
required | Array of objects non-empty As cotações novas, uma por moeda |
Exemplo de atualização das cotações do dólar e do euro.
{- "exchange_rates": [
- {
- "currency_code": "USD",
- "value": 5.4321
}, - {
- "currency_code": "EUR",
- "value": 6.1234
}
]
}Exemplo de resposta em que só o dólar mudou de valor e foi gravado.
{- "exchange_rates": [
- {
- "id": "8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10",
- "currency": {
- "code": "USD"
}, - "value": 5.4321,
- "quoted_at": "2026-10-14T09:30:00"
}
]
}Consulte e mantenha as categorias financeiras cadastradas no sistema, agrupadas por tipo (receita ou despesa) e grupo.
Retorna a lista de categorias financeiras cadastradas no sistema.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo categorias de despesa e receita.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Aluguel",
- "kind": "expense",
- "pass_through": false
}, - {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "description": "Comissões a Repassar",
- "kind": "expense",
- "pass_through": true
}, - {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3",
- "description": "Venda de Pacotes",
- "kind": "revenue",
- "pass_through": false
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra uma categoria financeira num grupo. O tipo (expense ou revenue) é o do grupo informado em group_id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description required | string <= 50 characters Descrição da categoria, até 50 caracteres. Obrigatória na inclusão. |
| group_id required | string <uuid> ID do grupo da categoria (consulte em |
| pass_through | boolean Indica se a categoria é de repasse: valores que só transitam pela agência e ficam fora do resultado. Na inclusão, o padrão é |
Categoria de despesa no grupo Despesas Administrativas.
{- "description": "Aluguel",
- "group_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "pass_through": false
}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": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Receitas Operacionais"
}
}Retorna uma categoria financeira específica pelo seu identificador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da categoria |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Receitas Operacionais"
}
}Altera a descrição, o repasse ou o grupo da categoria. A categoria só troca para outro grupo do mesmo tipo: não é permitido alterar o tipo de uma categoria, como no Monde, e o grupo de outro tipo é recusado com 422. O campo omitido permanece como está; description, group_id e pass_through não podem ser retirados, e enviados como nulo são recusados (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da categoria |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description | string <= 50 characters Descrição da categoria, até 50 caracteres. Obrigatória na inclusão. |
| group_id | string <uuid> ID do grupo da categoria (consulte em |
| pass_through | boolean Indica se a categoria é de repasse: valores que só transitam pela agência e ficam fora do resultado. Na inclusão, o padrão é |
Altera só a descrição; os demais campos ficam como estão.
{- "description": "Aluguel da loja"
}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": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Receitas Operacionais"
}
}Exclui a categoria. A categoria usada em algum lançamento financeiro, ou escolhida como padrão numa configuração do Monde, responde 409. Como no Monde, o grupo que fica sem categorias é excluído junto. Não exige Idempotency-Key.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da categoria |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte e mantenha os grupos que organizam as categorias financeiras. Cada grupo é de despesa ou de receita, e as categorias dele herdam esse tipo. Usa as permissões de Categorias. O Monde apaga sozinho o grupo que fica sem categorias quando uma categoria é gravada por ele: cadastre o grupo junto da primeira categoria. Pela API, excluir a última categoria do grupo também apaga o grupo.
Retorna os grupos de categorias, os de despesa antes dos de receita, em ordem de nome.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Grupos de despesa e de receita.
{- "data": [
- {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Despesas Administrativas",
- "kind": "expense"
}, - {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "name": "Receitas de Vendas",
- "kind": "revenue"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra um grupo de categorias de despesa ou de receita. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name required | string <= 50 characters Nome do grupo, até 50 caracteres. Obrigatório na inclusão. |
| kind required | string Enum: "expense" "revenue" Tipo do grupo: |
Grupo de despesa.
{- "name": "Impostos",
- "kind": "expense"
}Exemplo de um grupo de categorias de despesa.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Retorna um grupo de categorias pelo seu identificador.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Identificador único do grupo |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de um grupo de categorias de despesa.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Altera o nome do grupo. O tipo não muda depois da inclusão: as categorias do grupo já foram lançadas com aquele sinal, e o tipo diferente é recusado com 422. O campo omitido permanece como está; name e kind não podem ser retirados, e enviados como nulo são recusados (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Identificador único do grupo |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string <= 50 characters Nome do grupo, até 50 caracteres. Obrigatório na inclusão. |
| kind | string Enum: "expense" "revenue" Aceito só com o tipo atual do grupo: outro tipo é recusado com 422. |
Altera só o nome.
{- "name": "Tributos"
}Exemplo de um grupo de categorias de despesa.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Exclui o grupo sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. O grupo vazio é excluído. Como no Monde, a exclusão do grupo com categorias exclui também as categorias dele e pede confirmação, e por isso aqui o grupo com categorias responde 409. Nesse caso, para excluir o grupo com as categorias, use Excluir grupo de categorias com confirmação. Exige a permissão Excluir de Categorias numa empresa ativa que não seja somente leitura. Não exige Idempotency-Key: repetir responde 404.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Identificador único do grupo |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Exclui o grupo com a confirmação que o Monde pede antes de excluir as categorias dele. É a mesma exclusão de Excluir grupo de categorias, com as mesmas regras, permissões e respostas. A diferença é que a confirmação vai no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho. Como no Monde, a exclusão do grupo com categorias exclui também as categorias dele, e por isso pede a confirmação em delete_categories: sem ela, responde 409. Se alguma categoria for usada em lançamento financeiro ou numa configuração do Monde, nada é excluído e a resposta é 409. O grupo vazio é excluído sem a confirmação. O valor que não é true nem false responde 422. Exige a permissão Excluir de Categorias numa empresa ativa que não seja somente leitura. Exige Idempotency-Key: sem ela, a resposta é 400. Como o grupo excluído deixa de existir, o reenvio depois da exclusão responde 404.
| id required | string <uuid> Example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 Identificador único do grupo |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| delete_categories | boolean Confirma que a exclusão do grupo exclui também as categorias dele. Sem ela, o grupo com categorias responde 409. Aceita só |
{- "delete_categories": true,
- "name": "Despesas Administrativas",
- "kind": "expense"
}{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Consulte as cidades que a agência pode usar, com estado, país e códigos oficiais (IBGE e SIAFI). São as cadastradas na agência e as da lista de cidades do Monde, que traz os municípios do IBGE e as cidades do exterior. A cidade da lista entra no cadastro da agência quando uma pessoa ou nota fiscal passa a usá-la, com o mesmo id.
Retorna as cidades que a agência pode usar, as cadastradas nela e as da lista de cidades do Monde. Não pede permissão: toda credencial consulta.
| name | string Example: name=sao paulo Filtra por nome, sem diferenciar maiúsculas nem acentos, como o campo Cidade do Monde: acha o início das palavras do nome (ex.: |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo cidades brasileiras e estrangeira.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Miami, FL",
- "ibge": null,
- "siafi": null
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "name": "Rio de Janeiro",
- "ibge": "3304557",
- "siafi": "6001"
}, - {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "São Paulo",
- "ibge": "3550308",
- "siafi": "7107"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma cidade específica pelo seu identificador. Não pede permissão: toda credencial consulta.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da cidade |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma cidade brasileira, com o estado e o país.
{- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "São Paulo",
- "ibge": "3550308",
- "siafi": "7107",
- "state": {
- "id": "f6e0bbfe-44cc-478a-c4a3-c56f6de89fc5",
- "acronym": "SP",
- "name": "São Paulo"
}, - "country": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "name": "Brasil",
- "code": "BR",
- "code_3": "BRA",
- "sisbacen": 1058
}
}Consulte, cadastre, altere e exclua as funções de pessoa do módulo de comissões, como no cadastro de Funções do Monde: o nome da função, as empresas ou vendedores sobre cujas vendas ela é comissionada e as pessoas vinculadas a ela, com o plano de comissão, a data de início e as metas de cada uma. As funções Vendedor e Intermediário são do sistema: não mudam de nome, não comissionam sobre empresas ou vendedores e não são excluídas, mas recebem pessoas. As metas são gravadas aqui, como no "Plano e Metas" da pessoa no Monde: a lista goals de cada pessoa em people, com a permissão "Editar" de funções; o recurso Metas só as consulta. O recurso é só da agência: na instalação de operadora, todas as chamadas respondem 403. Ler exige a permissão "Visualizar" de funções; gravar, a "Editar" numa empresa que não esteja somente leitura; excluir, a "Excluir".
Retorna a lista de funções cadastradas, por nome, com os campos próprios de cada uma.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com uma função da agência e as duas funções do sistema.
{- "data": [
- {
- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false
}, - {
- "id": "32c878b4-291d-4b4a-9854-47212d172761",
- "description": "Intermediário",
- "seller": false,
- "intermediary": true,
- "system": true
}, - {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e",
- "description": "Vendedor",
- "seller": true,
- "intermediary": false,
- "system": true
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra uma função. A função cadastrada aqui não é de vendedor nem de intermediário, e por isso precisa de ao menos uma empresa ou vendedor ativo em commissioned_over. Cada pessoa aparece uma vez na função, e a que é comissionada precisa da data de início. Cada pessoa pode vir já com as metas, em goals. Exige a permissão "Editar" de funções.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description required | string <= 30 characters Nome da função, até 30 caracteres. |
Array of objects (entity_reference) Empresas e vendedores ativos sobre cujas vendas a função é comissionada, pelo | |
Array of objects (person_role_person_write) Pessoas vinculadas à função. Na alteração, a lista enviada é a final. |
Exemplo de cadastro de uma função comissionada sobre uma empresa, já com uma pessoa vinculada.
{- "description": "Gerente",
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01"
}
]
}Exemplo de resposta de uma função comissionada sobre uma empresa, com uma pessoa vinculada.
{- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false,
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01",
- "not_commissioned": false,
- "goals": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
]
}
]
}Retorna uma função específica pelo seu identificador, com as empresas ou vendedores sobre cujas vendas ela é comissionada e as pessoas vinculadas, cada uma com as metas dela na função, por ano.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Identificador único da função |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma função comissionada sobre uma empresa, com uma pessoa vinculada.
{- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false,
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01",
- "not_commissioned": false,
- "goals": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
]
}
]
}Altera uma função já cadastrada. Informe apenas o que deve mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). O que a função não pode ficar sem é recusado (422): description, e em cada item de people a person e o not_commissioned. O commission_plan e a start_date do item enviados como nulos são retirados. A lista enviada como nula vale como a vazia. As listas enviadas são as finais: em commissioned_over, a empresa ou vendedor que ficou de fora deixa a função; em people, o item com id mantém e atualiza aquele vínculo (só os campos enviados nele), o item sem id vincula uma pessoa nova, e o vínculo que ficou de fora é desfeito, junto com as metas da pessoa na função. Em goals de um item, a lista enviada também é a final: a meta com id fica e muda só os campos enviados nela, a sem id entra e a que ficou de fora é excluída; goals omitido mantém as metas, e goals nulo exclui todas. Trocar entre si os anos de duas metas na mesma alteração é recusado (422): faça a troca em duas alterações, passando antes por um ano livre. Na função do sistema (Vendedor, Intermediário) só people muda. Exige a permissão "Editar" de funções. A resposta traz a função alterada no mesmo formato da consulta por ID quando a credencial também pode ler funções; sem isso, a alteração é gravada e a resposta traz apenas o id.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Identificador único da função |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description | string <= 30 characters Nome da função, até 30 caracteres. |
Array of objects (entity_reference) Empresas e vendedores ativos sobre cujas vendas a função é comissionada, pelo | |
Array of objects (person_role_person_write) Pessoas vinculadas à função. Na alteração, a lista enviada é a final. |
Exemplo de alteração em que um vínculo fica sem plano e passa a não comissionado, uma pessoa nova entra e os vínculos que não vieram na lista são desfeitos.
{- "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "commission_plan": null,
- "not_commissioned": true,
- "start_date": null
}, - {
- "person": {
- "id": "9a8b7c6d-5e4f-4321-8a9b-0c1d2e3f4a5b"
}, - "start_date": "2026-03-01"
}
]
}Exemplo de resposta de uma função comissionada sobre uma empresa, com uma pessoa vinculada.
{- "id": "7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
- "description": "Gerente",
- "seller": false,
- "intermediary": false,
- "system": false,
- "commissioned_over": [
- {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}
], - "people": [
- {
- "id": "0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b",
- "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "start_date": "2026-01-01",
- "not_commissioned": false,
- "goals": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
]
}
]
}Exclui a função definitivamente, com os vínculos de pessoas e as metas deles. A função do sistema e a função que já tem comissão calculada em alguma venda não são excluídas: a resposta é 409. Exige a permissão "Excluir" de funções.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Identificador único da função |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte, cadastre, altere e exclua os vendedores usados nas vendas. O vendedor é uma pessoa física já cadastrada, e o identificador dele é o da pessoa. O cadastro de vendedores é um só para o sistema inteiro, sem empresa: as permissões valem em qualquer empresa ativa em que forem concedidas, e gravar exige uma empresa que não seja somente leitura.
Retorna a lista de vendedores cadastrados no sistema (ativos e inativos).
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo vendedores ativos e inativos.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "active": true,
- "created_at": "2024-03-15T10:30:00"
}, - {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "active": false,
- "created_at": "2023-11-02T16:45:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Torna vendedor uma pessoa física já cadastrada, informada em person_id (o id da consulta de Pessoas). O vendedor passa a ter o mesmo identificador da pessoa. Como no Monde, só pessoa física vira vendedor, e cada pessoa só uma vez. O vendedor nasce ativo, a menos que active seja enviado como false. Para cadastrar a pessoa e o vendedor numa chamada só, junto da venda, use o seller de Inserir venda. Exige a permissão "Editar" de vendedores.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| external_id required | string <= 50 characters Identificador único utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID. |
| name required | string <= 100 characters Nome. |
| cpf | string = 11 characters CPF, sem pontos, traços ou espaços. |
| person_id required | string <uuid> Identificador da pessoa física que passa a ser vendedor |
| active | boolean Default: true Indica se o vendedor nasce ativo. Omitido, o vendedor nasce ativo |
Torna vendedor a pessoa física informada, já ativo.
{- "person_id": "f9d961b8-ea88-4346-8e52-afe94267417a"
}Exemplo de resposta de um vendedor específico.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "active": true,
- "created_at": "2024-03-15T10:30:00",
- "person": {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a"
}, - "created_by": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}
}Retorna um vendedor específico pelo seu identificador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do vendedor |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a"
}, - "created_by": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}
}Ativa ou desativa um vendedor. O vendedor inativo continua nas vendas em que já está, mas deixa de ser oferecido nas vendas novas do Monde. A pessoa do vendedor não muda: enviar em person_id outra pessoa é recusado com 422. O campo omitido permanece como está; person_id e active não podem ser retirados, e enviados como nulo são recusados (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Exige a permissão "Editar" de vendedores. A resposta traz o vendedor alterado quando a credencial também tem a permissão "Visualizar" de vendedores; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id do vendedor.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do vendedor |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| person_id | string <uuid> Identificador da pessoa do vendedor. Opcional; se enviado, precisa ser o da própria pessoa do vendedor, que não muda |
| active | boolean Indica se o vendedor fica ativo. O inativo deixa de ser oferecido nas vendas novas |
Desativa o vendedor, que deixa de ser oferecido nas vendas novas.
{- "active": false
}Exemplo de resposta de um vendedor específico.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "active": true,
- "created_at": "2024-03-15T10:30:00",
- "person": {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a"
}, - "created_by": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}
}Exclui o vendedor. A pessoa continua cadastrada; só deixa de ser vendedor. O vendedor que já está em alguma venda não pode ser excluído e responde 409: desative-o com active: false. Exige a permissão "Excluir" de vendedores.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do vendedor |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte e mantenha as formas de pagamento cadastradas no sistema para utilizar em lançamentos financeiros.
Retorna a lista de formas de pagamento cadastradas no sistema. Formas de uso interno do sistema não são retornadas.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo formas de pagamento do sistema e cadastradas pelo usuário.
{- "data": [
- {
- "id": "348e3bd9-f7ee-4a49-9be6-9a94b8b0a2f3",
- "name": "Cartão de Crédito",
- "system": true
}, - {
- "id": "253484f0-3597-4e91-96a1-2ea87f4b8ab0",
- "name": "Cheque",
- "system": true
}, - {
- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
- "name": "Dinheiro",
- "system": true
}, - {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "name": "Transferência Internacional",
- "system": false
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra uma forma de pagamento da agência. Ela nasce fora do sistema (system igual a false) e aparece na consulta. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name required | string <= 30 characters Nome da forma de pagamento, até 30 caracteres. Obrigatório na inclusão. |
Forma de pagamento da agência.
{- "name": "Vale-viagem"
}Exemplo de resposta de uma forma de pagamento específica.
{- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
- "name": "Dinheiro",
- "system": true
}Retorna uma forma de pagamento específica pelo seu identificador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da forma de pagamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma forma de pagamento específica.
{- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
- "name": "Dinheiro",
- "system": true
}Altera o nome da forma de pagamento. A forma do sistema (system igual a true) não se altera e responde 409, como no Monde; a de uso interno, que não aparece na consulta, responde 404. O campo omitido permanece como está; name não pode ser retirado, e enviado como nulo é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Quem não tem a permissão de leitura recebe só o id. Exige o cabeçalho Idempotency-Key. O cadastro é um só para o sistema inteiro, sem empresa: basta a permissão numa empresa ativa que não seja somente leitura. Campo que o endpoint não documenta é ignorado.
| id required | string <uuid> Example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 Identificador único da forma de pagamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string <= 30 characters Nome da forma de pagamento, até 30 caracteres. Obrigatório na inclusão. |
Altera o nome.
{- "name": "Voucher"
}Exemplo de resposta de uma forma de pagamento específica.
{- "id": "fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9",
- "name": "Dinheiro",
- "system": true
}Exclui a forma de pagamento da agência. A forma do sistema responde 409, assim como a usada em lançamentos, movimentações ou regras de taxa; a de uso interno responde 404. Não exige Idempotency-Key.
| id required | string <uuid> Example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 Identificador único da forma de pagamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte, cadastre, altere e exclua as contas e cartões: conta caixa, conta corrente e cartão de crédito, com os dados bancários e de cartão, as empresas em que cada conta está disponível, os grupos de usuários com acesso e a cobrança dos boletos da conta corrente.
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.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo uma conta corrente e um cartão de crédito.
{- "data": [
- {
- "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
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Cartão Corporativo",
- "kind": "card_account",
- "active": true,
- "currency": "BRL",
- "initial_balance": 0,
- "bank_operation": null,
- "agency": null,
- "agency_digit": null,
- "number": null,
- "digit": null,
- "pix_key": null,
- "bill_expiration": 10,
- "bill_closing": 1
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra uma conta caixa (cashier_account), conta corrente (checking_account) ou cartão de crédito (card_account), com as mesmas regras do cadastro do Monde. Cada tipo grava só os seus campos: o campo de outro tipo (como agency ou initial_balance num cartão, ou billing_accounts fora da conta corrente) é ignorado, como o campo que não existe, e não é gravado. A conta fica disponível nas empresas de companies, e a credencial precisa da permissão de inserir e editar contas e cartões em cada uma delas. No cartão de crédito, a fatura é gerada em invoice_company, que precisa estar entre as empresas da conta; com uma empresa só, é ela. A cobrança (billing_accounts) só existe na conta corrente.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description required | string <= 50 characters Descrição da conta |
| currency required | string Código da moeda (ISO 4217), uma das moedas cadastradas. Não pode ser trocado depois que a conta tem movimentação. |
| active | boolean Indica se a conta está ativa. A conta do recebimento padrão não pode ser desativada. |
| initial_balance | number <double> Saldo inicial, com até 2 casas decimais. Não existe no cartão de crédito, em que é ignorado. Alterá-lo reabre os caixas fechados da conta e exige a permissão Reabrir Caixa. |
object (entity_reference) Referência a um registro relacionado. | |
object Banco da conta corrente, pelo | |
| agency | string Agência da conta corrente: 4 dígitos, só números. |
| agency_digit | string <= 1 characters Dígito da agência bancária |
| bank_operation | string Operação da conta, só na Caixa Econômica Federal (banco 104), com 3 ou 4 dígitos. |
| number | string <= 10 characters Número da conta bancária |
| digit | string <= 1 characters Dígito da conta bancária |
| pix_key | string <= 100 characters Chave Pix da conta |
object Operadora do cartão de crédito (pessoa), obrigatória no cartão. | |
| bill_expiration | integer [ 1 .. 31 ] Dia de vencimento da fatura do cartão (1 a 31), obrigatório no cartão. |
| bill_closing | integer [ 1 .. 31 ] Dia de fechamento da fatura do cartão (1 a 31), obrigatório no cartão. |
object Empresa em que a fatura do cartão é gerada, uma das empresas de | |
required | Array of objects (entity_reference) non-empty Empresas em que a conta fica disponível, pelo |
Array of objects (entity_reference) Grupos de usuários com acesso à conta. Sem grupo, a conta não tem restrição. Grupo com acesso total não aceita vínculo. Na alteração, é a lista final. | |
Array of objects (billing_account_write) Cobranças dos boletos, só na conta corrente; nas demais contas, a lista é ignorada. Na alteração, é a lista final: a cobrança que já emitiu boletos não pode ficar de fora. | |
| kind required | string Enum: "cashier_account" "checking_account" "card_account" Tipo da conta: |
Cadastra uma conta corrente disponível numa empresa, liberada a um grupo de usuários e com a cobrança pelo Monde Bancos.
{- "kind": "checking_account",
- "description": "Banco do Brasil - Matriz",
- "currency": "BRL",
- "initial_balance": 1500,
- "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "bank": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "agency": "1412",
- "agency_digit": "5",
- "number": "04640",
- "digit": "2",
- "pix_key": "financeiro@agencia.com.br",
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "billing_accounts": [
- {
- "kind": "monde_bancos",
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "bank_fee": 2.5
}
]
}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": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil"
}, - "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "card_operator": null,
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "invoice_company": null,
- "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "next_bank_slip_number": 1520,
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "kind": "monde_bancos",
- "active": true,
- "registered": true,
- "allows_unregistered_issue": false,
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "ceb_code": null,
- "late_fine": 2,
- "late_interest": 1,
- "bank_fee": 2.5,
- "billet_rate": 0,
- "last_remittance": 0,
- "days_protest": null,
- "bank_issues_billet": false,
- "bank_generates_number": false,
- "billet_instructions": null,
- "local_of_payment": "Pagável em qualquer banco até o vencimento",
- "guarantor": null,
- "assignor_format": null,
- "our_number_format": null,
- "other_settings": null,
- "cobre_bem": null
}
]
}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.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da conta |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil"
}, - "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "card_operator": null,
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "invoice_company": null,
- "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "next_bank_slip_number": 1520,
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "kind": "monde_bancos",
- "active": true,
- "registered": true,
- "allows_unregistered_issue": false,
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "ceb_code": null,
- "late_fine": 2,
- "late_interest": 1,
- "bank_fee": 2.5,
- "billet_rate": 0,
- "last_remittance": 0,
- "days_protest": null,
- "bank_issues_billet": false,
- "bank_generates_number": false,
- "billet_instructions": null,
- "local_of_payment": "Pagável em qualquer banco até o vencimento",
- "guarantor": null,
- "assignor_format": null,
- "our_number_format": null,
- "other_settings": null,
- "cobre_bem": null
}
]
}Altera a conta ou cartão. O campo omitido fica como está, o enviado como null é retirado, e o tipo não muda. description, currency, active e initial_balance enviados como null respondem 422. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). O campo de outro tipo de conta é ignorado, como na inclusão: reenviar o que a consulta devolveu não é recusado. Cada lista enviada passa a ser a lista final da conta: em companies e user_groups, o item que ficou de fora é desvinculado; em billing_accounts, a cobrança com id é alterada (só nos campos enviados), a sem id é cadastrada e a que ficou de fora é excluída. Ligar ou desligar uma empresa exige a permissão de editar contas nela. A empresa com lançamento em aberto na conta, ou a que gera a fatura do cartão, não pode ser desligada. Alterar o saldo inicial reabre os caixas fechados da conta e, como no Monde, exige também a permissão Reabrir Caixa de Contas e Cartões numa das empresas da conta; sem ela, a resposta é 403 e nada é gravado. Reenviar o saldo gravado não pede a permissão. Trocar a empresa ou o dia de vencimento do cartão leva junto as faturas em aberto, e trocar a empresa exige a permissão de editar contas nas duas empresas. A resposta traz a conta só para quem também tem a permissão de leitura; aos demais, só o id.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da conta |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| description | string <= 50 characters Descrição da conta |
| currency | string Código da moeda (ISO 4217), uma das moedas cadastradas. Não pode ser trocado depois que a conta tem movimentação. |
| active | boolean Indica se a conta está ativa. A conta do recebimento padrão não pode ser desativada. |
| initial_balance | number <double> Saldo inicial, com até 2 casas decimais. Não existe no cartão de crédito, em que é ignorado. Alterá-lo reabre os caixas fechados da conta e exige a permissão Reabrir Caixa. |
object (entity_reference) Referência a um registro relacionado. | |
object Banco da conta corrente, pelo | |
| agency | string Agência da conta corrente: 4 dígitos, só números. |
| agency_digit | string <= 1 characters Dígito da agência bancária |
| bank_operation | string Operação da conta, só na Caixa Econômica Federal (banco 104), com 3 ou 4 dígitos. |
| number | string <= 10 characters Número da conta bancária |
| digit | string <= 1 characters Dígito da conta bancária |
| pix_key | string <= 100 characters Chave Pix da conta |
object Operadora do cartão de crédito (pessoa), obrigatória no cartão. | |
| bill_expiration | integer [ 1 .. 31 ] Dia de vencimento da fatura do cartão (1 a 31), obrigatório no cartão. |
| bill_closing | integer [ 1 .. 31 ] Dia de fechamento da fatura do cartão (1 a 31), obrigatório no cartão. |
object Empresa em que a fatura do cartão é gerada, uma das empresas de | |
Array of objects (entity_reference) non-empty Empresas em que a conta fica disponível, pelo | |
Array of objects (entity_reference) Grupos de usuários com acesso à conta. Sem grupo, a conta não tem restrição. Grupo com acesso total não aceita vínculo. Na alteração, é a lista final. | |
Array of objects (billing_account_write) Cobranças dos boletos, só na conta corrente; nas demais contas, a lista é ignorada. Na alteração, é a lista final: a cobrança que já emitiu boletos não pode ficar de fora. | |
| next_bank_slip_number | integer [ 1 .. 2147483647 ] Número do próximo boleto, só na alteração da conta corrente; nas demais contas, é ignorado, e o texto vazio é recusado (422) em qualquer conta. A numeração só anda para a frente: o número menor que o atual, ou que não seja maior que o último boleto emitido, responde 422. Reenviar o número atual não muda nada. |
Altera a descrição e a chave Pix e o convênio de uma cobrança existente. A lista de cobranças enviada é a final: cobrança que ficasse de fora seria excluída.
{- "description": "Banco do Brasil - Filial",
- "pix_key": "filial@agencia.com.br",
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "agreement_code": "7654321"
}
]
}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": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil"
}, - "owner": {
- "id": "7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b"
}, - "card_operator": null,
- "companies": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}
], - "invoice_company": null,
- "user_groups": [
- {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
}
], - "next_bank_slip_number": 1520,
- "billing_accounts": [
- {
- "id": "0f1e2d3c-4b5a-4968-8776-655443322110",
- "kind": "monde_bancos",
- "active": true,
- "registered": true,
- "allows_unregistered_issue": false,
- "portfolio": "17",
- "document_kind": "DM",
- "return_layout": "CNAB240",
- "remittance_layout": "CNAB240",
- "agreement_code": "1234567",
- "variation": "019",
- "accept": "N",
- "ceb_code": null,
- "late_fine": 2,
- "late_interest": 1,
- "bank_fee": 2.5,
- "billet_rate": 0,
- "last_remittance": 0,
- "days_protest": null,
- "bank_issues_billet": false,
- "bank_generates_number": false,
- "billet_instructions": null,
- "local_of_payment": "Pagável em qualquer banco até o vencimento",
- "guarantor": null,
- "assignor_format": null,
- "our_number_format": null,
- "other_settings": null,
- "cobre_bem": null
}
]
}Exclui a conta ou cartão de todas as empresas, então exige a permissão de excluir contas e cartões em cada empresa em que a conta está disponível. Como no Monde, não se exclui a conta com movimentações, com cobrança cadastrada, liberada a um grupo de usuários ou definida como conta do recebimento padrão (409).
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da conta |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte a tabela de bancos do Monde, a mesma usada para informar o banco de uma conta corrente. Pela API a tabela é só de consulta: o cadastro de bancos é feito no Monde.
Retorna a lista de bancos, ordenada pelo nome do banco, como na escolha do banco no cadastro de conta corrente.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo bancos da tabela de referência.
{- "data": [
- {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil S.A."
}, - {
- "id": "5d0f4a3e-8b1c-4a2f-9a51-2f1d3c6b7e80",
- "number": "104",
- "name": "Caixa Econômica Federal"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna um banco específico pelo seu identificador.
| id required | string <uuid> Example: c3b7e8eb-1199-4457-9170-923c3fe56c92 Identificador único do banco |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um banco específico.
{- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "number": "001",
- "name": "Banco do Brasil S.A."
}Consulte as regras de emissão de nota fiscal, com os campos da venda que compõem cada emissão. As regras não pertencem a nenhuma empresa: valem para a agência inteira, e só existem na base de agência.
Retorna a lista de regras da nota fiscal cadastradas no sistema. Produto, fornecedor e pagante nulos indicam que a regra vale para todos.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo uma regra geral e uma regra restrita a produto e fornecedor.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Regra padrão de pacotes",
- "representative_scope": "any",
- "created_at": "2024-03-15T10:30:00",
- "payer_rule": {
- "recipient": null,
- "revenues": [
- "du_fee",
- "rav_fee",
- "agency_service_fee"
], - "discounts": [
- "discount"
]
}, - "supplier_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}, - "representative_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Seguro viagem - fornecedor emite",
- "representative_scope": "none",
- "created_at": "2023-11-02T16:45:00",
- "payer_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}, - "supplier_rule": {
- "recipient": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "revenues": [
- "commission_amount",
- "over_amount"
], - "discounts": [ ]
}, - "representative_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma regra da nota fiscal específica pelo seu identificador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da regra da nota fiscal |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "created_by": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "payer_rule": {
- "recipient": null,
- "revenues": [
- "du_fee",
- "rav_fee",
- "agency_service_fee"
], - "discounts": [
- "discount"
]
}, - "supplier_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}, - "representative_rule": {
- "recipient": null,
- "revenues": [ ],
- "discounts": [ ]
}
}Consulte, crie, altere e exclua tarefas, com responsável, pessoa vinculada, categoria e vencimento, e comente no histórico delas. A tarefa que a credencial criou é sempre dela; a dos outros usuários pede a permissão Ver tarefas de outros usuários, como no Monde (veja as Perguntas frequentes).
Retorna a lista de tarefas das empresas em que a credencial tem permissão (tarefas sem empresa são visíveis em todas), da tarefa sem vencimento para a de vencimento mais distante. Os filtros são os da consulta de Tarefas do Monde e se combinam: responsável, quem cadastrou, pessoa, categoria, situação, vencidas, período (por vencimento, cadastro ou conclusão) e o vínculo com venda, viagem ou lançamento. Sem status, as tarefas excluídas não são retornadas. Filtro com valor inválido responde 400.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| assignee_id | string <uuid> Example: assignee_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Retorna só as tarefas deste responsável, pelo identificador da pessoa. |
| created_by_id | string <uuid> Example: created_by_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Retorna só as tarefas cadastradas por esta pessoa (o |
| person_id | string <uuid> Example: person_id=c3b7e8eb-1199-4457-9170-923c3fe56c92 Retorna só as tarefas vinculadas a esta pessoa. |
| category_id | string Example: category_id=11 Retorna só as tarefas desta categoria, pelo identificador obtido em Consultar categorias de tarefa. |
| status | Array of strings Items Enum: "pending" "completed" "deleted" Example: status=pending Situações a retornar, separadas por vírgula: |
| overdue | boolean Example: overdue=true
|
| date_field | string Enum: "due" "created_at" "completed_at" Example: date_field=due Data usada no filtro de período: |
| date_from | string <date> Example: date_from=2024-04-01 Início do período (inclusivo), no formato YYYY-MM-DD. |
| date_to | string <date> Example: date_to=2024-04-30 Fim do período (inclusivo, o dia inteiro), no formato YYYY-MM-DD. |
| sale_id | string <uuid> Example: sale_id=8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 Retorna só as tarefas vinculadas a esta venda. |
| travel_id | string <uuid> Example: travel_id=1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 Retorna só as tarefas vinculadas a esta viagem. |
| bill_id | string <uuid> Example: bill_id=5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 Retorna só as tarefas vinculadas a este lançamento (conta a pagar ou receber). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo tarefas pendente e concluída.
{- "data": [
- {
- "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"
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "number": 1043,
- "title": "Cobrar segunda parcela",
- "description": null,
- "due": "2024-04-05T14:00:00",
- "completed_at": "2024-04-05T11:12:00",
- "visualized": true,
- "deleted": false,
- "created_at": "2024-03-15T10:30:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cria uma tarefa com título e responsável; categoria e vencimento são opcionais, e a tarefa sem vencimento nunca fica atrasada. A empresa da tarefa é opcional, mas informá-la não é: envie company_identifier com o CNPJ da empresa, ou como nulo para a tarefa valer em todas as empresas; vazio é recusado. Omitir o campo é recusado, porque a empresa não é deduzida. Aceita, em history, os comentários com que a tarefa nasce. A tarefa pode nascer vinculada a uma venda (sale_id), uma viagem (travel_id) e um lançamento (bill_id), cada um opcional e sem relação obrigatória com a pessoa da tarefa (person_id). Quando vierem juntos, precisam combinar entre si: a venda tem de ser da viagem informada, e o lançamento, da venda informada. Só é aceito o registro que a credencial pode ler; os demais respondem 422 como não encontrados. O responsável é avisado por e-mail, e a tarefa nasce pendente.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier required | string or null = 14 characters ^[0-9]{14}$ CNPJ da empresa em que a tarefa será criada, só os dígitos. Nulo cria a tarefa sem empresa, valendo para todas as empresas; o campo é obrigatório e omiti-lo é recusado. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado |
| title required | string <= 100 characters Título da tarefa |
| description | string Descrição da tarefa |
| due | string <date-time> Data e hora de vencimento (nulo quando a tarefa não tem vencimento, e então nunca fica atrasada) |
| category_id | integer Identificador da categoria da tarefa, obtido em Consultar categorias de tarefa. |
| assignee_id required | string <uuid> Identificador da pessoa responsável pela tarefa, obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde e, na tarefa de uma empresa, ter acesso às tarefas dela, como no Monde. A conferência vale em toda alteração da tarefa, também quando o responsável não muda. |
| person_id | string <uuid> Identificador da pessoa vinculada à tarefa, obtido em Consultar pessoas. |
| sale_id | string <uuid> Identificador da venda a vincular, obtido em Consultar vendas. Com |
| travel_id | string <uuid> Identificador da viagem a vincular, obtido em Consultar viagens. |
| bill_id | string <uuid> Identificador do lançamento (conta a pagar ou receber) a vincular, obtido em Consultar contas a pagar e receber. Com |
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 |
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": [
- {
- "text": "Tarefa aberta pelo site."
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
]
}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": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "history": [
- {
- "created_at": "2024-03-20T14:05:00",
- "text": "Cliente confirmou os dados do embarque.",
- "historic": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}Retorna os dados de uma tarefa específica, incluindo o histórico, os campos personalizados e os anexos.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da tarefa (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "history": [
- {
- "created_at": "2024-03-20T14:05:00",
- "text": "Cliente confirmou os dados do embarque.",
- "historic": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}Altera uma tarefa já cadastrada. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado da tarefa — a descrição, o vencimento, a categoria, a pessoa e os vínculos. O title, o assignee_id e o completed não podem ser retirados: a tarefa precisa ter título e responsável, e enviá-los como nulo ou vazio é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Para concluir a tarefa envie completed como true, e para reabri-la, como false. O company_identifier omitido mantém a empresa da tarefa; com um CNPJ, leva a tarefa para aquela empresa e exige a permissão "Editar" de tarefas também nela; enviado como nulo, deixa a tarefa sem empresa, valendo para todas. Os campos personalizados não substituem: cada um enviado é gravado por cima do atual, o enviado com value nulo ou vazio é limpo (o obrigatório não se limpa: a resposta é 422), e os demais permanecem. Os vínculos com venda, viagem e lançamento (sale_id, travel_id, bill_id) seguem as regras da criação: omitido, o vínculo fica; enviado como nulo, sai da tarefa. A pessoa já preenchida da tarefa não é trocada nem retirada enquanto ela tiver vínculo: desfaça os vínculos antes, ou na mesma requisição. Preencher a pessoa da tarefa que está sem pessoa é permitido, mesmo com vínculo. Comentários são enviados em Comentar na tarefa. Exige a permissão "Editar" de tarefas. Tarefa excluída não pode ser alterada: a resposta é 409. Quem participa da tarefa é avisado por e-mail da alteração, como na alteração feita no Monde. A resposta traz a tarefa alterada no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de tarefas na empresa da tarefa; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da tarefa. Vale também para a tarefa que a própria credencial criou.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da tarefa (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier | string or null = 14 characters ^[0-9]{14}$ CNPJ da empresa para onde a tarefa vai, só os dígitos. Nulo tira a tarefa da empresa, deixando-a válida para todas; omitido, mantém a empresa atual. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado. A tarefa de outro usuário exige também, na empresa de destino, "Ver tarefas de outros usuários"; sem ela, a resposta é 403 com a mensagem do Monde |
| title | string <= 100 characters Título da tarefa |
| description | string or null Descrição da tarefa |
| due | string or null <date-time> Data e hora de vencimento. Nulo tira o vencimento, e a tarefa deixa de ficar atrasada; omitido, mantém o vencimento atual |
| category_id | integer or null Identificador da categoria da tarefa, obtido em Consultar categorias de tarefa. Nulo tira a categoria; omitido, mantém a categoria atual. |
| assignee_id | string <uuid> Identificador da pessoa responsável pela tarefa, obtido em Consultar pessoas. A pessoa precisa ser um usuário ativo do Monde e, na tarefa de uma empresa, ter acesso às tarefas dela, como no Monde. A conferência vale em toda alteração da tarefa, também quando o responsável não muda. |
| person_id | string or null <uuid> Identificador da pessoa vinculada à tarefa, obtido em Consultar pessoas. |
| sale_id | string or null <uuid> Identificador da venda a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual. |
| travel_id | string or null <uuid> Identificador da viagem a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual. |
| bill_id | string or null <uuid> Identificador do lançamento a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual. |
| completed | boolean
|
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 |
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": [
- {
- "id": 123,
- "value": "Urgente"
}
]
}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": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "history": [
- {
- "created_at": "2024-03-20T14:05:00",
- "text": "Cliente confirmou os dados do embarque.",
- "historic": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}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.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da tarefa (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Acrescenta um comentário ao histórico da tarefa e devolve a tarefa com o histórico atualizado — ou apenas o id da tarefa, quando a credencial não tem a permissão "Visualizar" de tarefas na empresa da tarefa, mesmo na tarefa que ela criou. Quem participa da tarefa é avisado do comentário por e-mail, como no comentário feito no Monde. Exige a permissão "Editar" de tarefas. Tarefa excluída não recebe comentário: a resposta é 409. O comentário pode levar arquivos: envie cada um antes em Enviar anexo, com resource_type task e o id da tarefa, e informe os ids devolvidos em attachment_ids. Cada anexo fica ligado ao comentário e aparece dentro dele no Monde. Com anexos, o texto é opcional. O histórico é só acréscimo: comentário registrado não se altera nem se exclui, e as linhas de alteração que o Monde gera não são enviadas por aqui.
| task_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da tarefa (formato UUID). |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| text | string Texto do comentário |
| attachment_ids | Array of strings <uuid> [ items <uuid > ] Identificadores dos anexos a ligar ao comentário, devolvidos por Enviar anexo. Cada um precisa ser anexo desta tarefa, não excluído e ainda sem comentário; os demais respondem 422 como não encontrados. |
Exemplo de comentário acrescentado ao histórico de uma tarefa existente.
{- "text": "Cliente confirmou os dados do embarque."
}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": {
- "id": 11
}, - "assignee": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "sale": {
- "id": "8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8"
}, - "travel": {
- "id": "1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9"
}, - "bill": null,
- "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "history": [
- {
- "created_at": "2024-03-20T14:05:00",
- "text": "Cliente confirmou os dados do embarque.",
- "historic": null,
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}, - {
- "created_at": "2024-03-15T10:30:00",
- "text": null,
- "historic": "Tarefa cadastrada",
- "person": null,
- "attachments": [ ]
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Alta"
}
], - "attachments": [
- {
- "id": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
- "description": "voucher.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
]
}Consulte, crie, altere e exclua as categorias de tarefas. Cada categoria pode ser uma coluna do quadro de tarefas (kanban), e a ordem das colunas também é gravada aqui. As categorias não pertencem a nenhuma empresa: valem para a agência inteira.
Retorna a lista de categorias de tarefas cadastradas no sistema, com a marcação do quadro de tarefas e a posição de cada coluna.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo categorias de tarefas, duas delas no quadro.
{- "data": [
- {
- "id": 12,
- "name": "Cobrança",
- "kanban": false,
- "kanban_position": null
}, - {
- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}, - {
- "id": 7,
- "name": "Reserva",
- "kanban": true,
- "kanban_position": 1
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cria uma categoria de tarefa. Como na tela de Categorias do Monde, a categoria nova entra no quadro de tarefas como a última coluna; envie kanban como false para deixá-la fora do quadro, ou kanban_position para pô-la em outra posição, deslocando as demais colunas. O nome é único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado. Exige a permissão "Editar" de categorias de tarefas.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name required | string <= 30 characters Nome da categoria de tarefa, com até 30 caracteres. É único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado. |
| kanban | boolean Default: true Indica se a categoria é uma coluna do quadro de tarefas (kanban). Omitido, a categoria entra no quadro. |
| kanban_position | integer >= 1 Posição da coluna no quadro de tarefas, a partir de 1, da esquerda para a direita; as demais colunas se deslocam. Vai de 1 até o número de colunas do quadro já contando esta categoria, e só é aceita para a categoria que fica no quadro. Omitida, a categoria nova entra como última coluna e a alterada mantém a posição. |
Cria a categoria e a põe na segunda coluna do quadro de tarefas.
{- "name": "Emissão",
- "kanban_position": 2
}Exemplo de resposta com uma categoria de tarefa específica.
{- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}Retorna os dados de uma categoria de tarefa específica.
| id required | integer Example: 42 Identificador único da categoria de tarefa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com uma categoria de tarefa específica.
{- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}Altera uma categoria de tarefa. Informe apenas os campos que devem mudar: o campo omitido permanece como está. O nome e o kanban não podem ser retirados: enviados como nulo são recusados (422), assim como o nome vazio e o kanban ou a kanban_position enviados como texto vazio. kanban_position só fica nula fora do quadro: enviada como nula na categoria que continua no quadro, é recusada (422). Renomear a categoria leva junto as tarefas dela. Com kanban_position, a coluna vai para aquela posição do quadro e as demais se deslocam; com kanban como false, a categoria sai do quadro, e as tarefas dela continuam na categoria. Exige a permissão "Editar" de categorias de tarefas. A resposta traz a categoria alterada no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de categorias de tarefas; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id.
| id required | integer Example: 42 Identificador único da categoria de tarefa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string <= 30 characters Nome da categoria de tarefa, com até 30 caracteres. É único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado. |
| kanban | boolean Indica se a categoria é uma coluna do quadro de tarefas (kanban). Ao voltar para o quadro sem |
| kanban_position | integer or null >= 1 Posição da coluna no quadro de tarefas, a partir de 1, da esquerda para a direita; as demais colunas se deslocam. Vai de 1 até o número de colunas do quadro já contando esta categoria, e só é aceita para a categoria que fica no quadro. Omitida, a categoria nova entra como última coluna e a alterada mantém a posição. |
Altera só o nome da categoria; as tarefas dela acompanham.
{- "name": "Emissão de bilhetes"
}Exemplo de resposta com uma categoria de tarefa específica.
{- "id": 42,
- "name": "Emissão",
- "kanban": true,
- "kanban_position": 2
}Exclui a categoria de tarefa definitivamente, e a coluna dela sai do quadro. Como no Monde, só a categoria sem tarefas pode ser excluída, contando também as tarefas concluídas e as excluídas: mova as tarefas para outra categoria antes. Exige a permissão "Excluir" de categorias de tarefas.
| id required | integer Example: 42 Identificador único da categoria de tarefa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte, cadastre, altere e exclua as viagens, com cliente, vendedor, situação e o período calculado a partir das vendas vinculadas, e vincule ou desvincule vendas. A viagem que a credencial cadastrou, ou com venda que ela criou, é sempre dela; a dos outros vendedores pede a permissão Consultar vendas de outros vendedores, como no Monde, também para alterar, excluir e vincular (veja as Perguntas frequentes).
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.
| 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 |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo viagens a iniciar e finalizada.
{- "data": [
- {
- "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"
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "number": "000041",
- "description": "Congresso - São Paulo",
- "situation": "finished",
- "start_date": "2024-02-05",
- "end_date": "2024-02-09",
- "observations": null,
- "created_at": "2024-01-10T09:00:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra uma viagem na empresa informada em company_identifier, com as mesmas regras do Monde: descrição (até 60 caracteres), cliente (customer_id, uma pessoa) e vendedor (seller_id, um vendedor ativo) são obrigatórios. O vendedor vem no corpo porque a credencial da API não é um usuário do Monde. O número da viagem é gerado na gravação. A viagem nasce sem vendas: vincule-as depois em POST /travels/{id}/sales/{sale_id}. Exige a permissão "Editar" de Viagens na empresa. A viagem cadastrada pela credencial é dela: ela altera, exclui e vincula vendas a essa viagem sem a permissão Consultar vendas de outros vendedores. A viagem cadastrada por outra credencial segue essa permissão, como a dos outros vendedores.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ da empresa da viagem, só os dígitos. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado |
| description required | string <= 60 characters Descrição da viagem, com até 60 caracteres |
| customer_id required | string <uuid> ID da pessoa cliente da viagem, a mesma de |
| seller_id required | string <uuid> ID do vendedor da viagem, o mesmo de |
| observations | string Observações da viagem |
Array of objects (custom_field) Campos personalizados a preencher na viagem, definidos pela agência. Os obrigatórios precisam vir na criação |
Viagem com descrição, cliente, vendedor e observações.
{- "company_identifier": "46598887000162",
- "description": "Lua de mel - Cancún",
- "customer_id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "seller_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "observations": "Cliente prefere assentos na janela."
}Viagem recém-cadastrada, ainda sem vendas vinculadas: sem datas e sem situação.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "number": "000043",
- "description": "Lua de mel - Cancún",
- "situation": null,
- "start_date": null,
- "end_date": null,
- "observations": "Cliente prefere assentos na janela.",
- "created_at": "2024-03-15T10:30:00",
- "customer": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "seller": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": null,
- "sales": [ ],
- "passengers": [ ],
- "attachments": [ ],
- "custom_fields": [ ]
}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.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da viagem a ser obtida |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "seller": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "sales": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "3f2a1b0c-9d8e-4f6a-8b7c-6d5e4f3a2b1c"
}
], - "passengers": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - {
- "id": "a7c9b1d3-4e5f-4a6b-8c9d-0e1f2a3b4c5d"
}
], - "attachments": [
- {
- "id": "1c2d3e4f-5a6b-4c7d-9e8f-0a1b2c3d4e5f",
- "description": "roteiro.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "custom_fields": [
- {
- "id": 7,
- "value": "Lua de mel"
}
]
}Altera uma viagem já cadastrada. Informe apenas os campos que devem mudar: o campo omitido permanece como está. A descrição, o cliente, o vendedor e a empresa, que a viagem não pode ficar sem, enviados como nulo ou como texto vazio respondem 422, como na tarefa. As observações são a exceção: enviadas como nulo, ficam em branco. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). A empresa não muda depois do cadastro, como no Monde: company_identifier só é aceito com o CNPJ da própria viagem. Exige a permissão "Editar" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores; sem ela, a viagem responde 404. A resposta traz a viagem alterada no mesmo formato da consulta por ID quando a credencial também a consulta; sem isso, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da viagem.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da viagem |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ da empresa da viagem, só os dígitos. A empresa não muda depois do cadastro: só é aceito o CNPJ da própria viagem |
| description | string <= 60 characters Descrição da viagem, com até 60 caracteres |
| customer_id | string <uuid> ID da pessoa cliente da viagem, a mesma de |
| seller_id | string <uuid> ID do vendedor da viagem, o mesmo de |
| observations | string or null Observações da viagem. Enviadas como nulo, ficam em branco; o texto vazio é gravado como está |
Array of objects (custom_field) Campos personalizados da viagem, definidos pela agência. Não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão. O campo obrigatório não pode ser enviado vazio. Envie cada campo por |
Só os campos enviados mudam.
{- "description": "Lua de mel - Cancún e Tulum",
- "observations": "Incluir o passeio a Tulum."
}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": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "seller": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "sales": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "3f2a1b0c-9d8e-4f6a-8b7c-6d5e4f3a2b1c"
}
], - "passengers": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - {
- "id": "a7c9b1d3-4e5f-4a6b-8c9d-0e1f2a3b4c5d"
}
], - "attachments": [
- {
- "id": "1c2d3e4f-5a6b-4c7d-9e8f-0a1b2c3d4e5f",
- "description": "roteiro.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "custom_fields": [
- {
- "id": 7,
- "value": "Lua de mel"
}
]
}Exclui a viagem definitivamente. As vendas vinculadas saem da viagem antes, e cada uma registra no log o desvínculo. A viagem com anexos, inclusive os já excluídos, não é excluída (409), como no Monde: exclua os anexos definitivamente no Monde antes. Quando a empresa da viagem está configurada para aceitar só vendas cadastradas dentro de uma viagem, a viagem com vendas vinculadas não pode ser excluída pela API (409): no Monde, só o administrador a exclui. Exige a permissão "Excluir" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores; sem ela, a viagem responde 404.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da viagem |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Vincula a venda à viagem, como o botão Vincular venda do Monde. Como no Monde, a credencial precisa abrir a venda: a que ela criou ou, a de outro vendedor, com as permissões Visualizar e Abrir vendas de outros vendedores/intermediários de Vendas. A venda que a credencial não abre, ou de outra empresa, responde 404, como inexistente. A venda excluída, ou sem nenhum produto ativo, responde 422. A venda que já está nesta viagem responde 409. A venda que está em outra viagem é transferida para esta, como no Monde, sem conferir o acesso da credencial à viagem de origem, e a saída fica registrada no log da viagem de origem. O vínculo fica registrado no log da viagem e no da venda. Exige a permissão "Editar" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores. A resposta traz a viagem com a lista de vendas atualizada, ou apenas o id dela para a credencial que não a consulta.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da viagem |
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da venda |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
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": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "seller": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "d4c8f9fc-22aa-4568-a281-a34d4bf67da3"
}, - "created_by": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "sales": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "3f2a1b0c-9d8e-4f6a-8b7c-6d5e4f3a2b1c"
}
], - "passengers": [
- {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - {
- "id": "a7c9b1d3-4e5f-4a6b-8c9d-0e1f2a3b4c5d"
}
], - "attachments": [
- {
- "id": "1c2d3e4f-5a6b-4c7d-9e8f-0a1b2c3d4e5f",
- "description": "roteiro.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "custom_fields": [
- {
- "id": 7,
- "value": "Lua de mel"
}
]
}Tira a venda da viagem, e o desvínculo fica registrado no log da viagem e no da venda. A venda que não está nesta viagem, ou que a credencial não abre (como no vínculo), responde 404. Quando a empresa da viagem está configurada para aceitar só vendas cadastradas dentro de uma viagem, a venda não pode ser desvinculada pela API (409): no Monde, só o administrador desvincula; vincule-a a outra viagem para transferi-la. Exige a permissão "Editar" de Viagens na empresa da viagem e, na viagem de outro vendedor, a permissão Consultar vendas de outros vendedores.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da viagem |
| sale_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da venda |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte, crie, altere, duplique e exclua os orçamentos cadastrados no sistema, com validade, situação e o link público de visualização.
Retorna a lista de orçamentos das empresas em que a credencial tem permissão.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo orçamentos ativo e desativado.
{- "data": [
- {
- "id": 42,
- "title": "Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "details": "Pacote com aéreo, hospedagem all inclusive e traslados.",
- "valid_until": "2024-05-31",
- "active": true,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00"
}, - {
- "id": 41,
- "title": "Buenos Aires",
- "subtitle": "Feriado prolongado",
- "details": "Aéreo + hotel 4 estrelas no centro.",
- "valid_until": "2024-02-28",
- "active": false,
- "internal_observations": null,
- "cover_kind": "none",
- "cover_color": null,
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-01-10T09:00:00",
- "updated_at": "2024-01-12T14:20:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cria um orçamento na empresa informada em company_identifier, com as regras da tela de Orçamentos do Monde Web. O dono do orçamento (user_id) é obrigatório, porque a credencial da API não é um usuário do Monde: é ele quem vê, altera e exclui o orçamento pelo Monde, além dos administradores. Título e validade (valid_until) são obrigatórios, e a validade não pode estar no passado. Sem o cabeçalho, o orçamento nasce com o cabeçalho color, na cor principal das Configurações de Orçamentos da empresa, com o título e o subtítulo. Sem details, o conteúdo nasce do modelo de conteúdo da empresa, o salvo pelo administrador na tela de Configurações de Orçamentos do Monde Web ou, se a empresa nunca salvou as configurações, o modelo padrão. O orçamento nasce ativo, a menos que active seja enviado como false, e já com o link público em public_url. Exige a permissão de criar/editar orçamentos na empresa.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ da empresa em que o orçamento será criado, só os dígitos. A empresa não pode estar somente leitura. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado. |
| user_id required | string <uuid> Identificador do usuário dono do orçamento, o mesmo |
| person_id | string <uuid> Identificador da pessoa (cliente) do orçamento, obtido em Consultar pessoas. Opcional. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe. |
| title required | string Título do orçamento |
| subtitle | string Subtítulo do orçamento. Opcional. |
| valid_until required | string <date> Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado. |
| details | string Conteúdo do orçamento, em HTML. O HTML é limpo antes de gravar, com as mesmas regras do conteúdo dos guias. Opcional: na criação, sem ele vale o modelo de conteúdo da empresa, o salvo pelo administrador na tela de Configurações de Orçamentos do Monde Web; enviado como texto vazio, o orçamento fica sem conteúdo. |
| active | boolean Default: true Indica se o orçamento está ativo |
| internal_observations | string Observações internas (não aparecem no link público) |
| cover_kind | string Enum: "color" "image" "none" Cabeçalho do link público: |
| cover_color | string Cor de fundo do cabeçalho, em hexadecimal ( |
| cover_show_title | boolean Exibe o título no cabeçalho. No cabeçalho |
| cover_show_subtitle | boolean Exibe o subtítulo no cabeçalho. No cabeçalho |
Exemplo de criação de um orçamento com pessoa e observações internas.
{- "company_identifier": "46598887000162",
- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "person_id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "title": "Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "valid_until": "2035-05-31",
- "details": "<p>Pacote com aéreo, hospedagem all inclusive e traslados.</p>",
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_color": "#1f4e79"
}Exemplo de resposta de um orçamento específico.
{- "id": 42,
- "title": "Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "details": "Pacote com aéreo, hospedagem all inclusive e traslados.",
- "valid_until": "2024-05-31",
- "active": true,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "person": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Retorna um orçamento específico pelo seu identificador.
| id required | integer Example: 42 Identificador único do orçamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um orçamento específico.
{- "id": 42,
- "title": "Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "details": "Pacote com aéreo, hospedagem all inclusive e traslados.",
- "valid_until": "2024-05-31",
- "active": true,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "person": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Altera um orçamento já cadastrado. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. A pessoa (person_id), o subtítulo (subtitle), o conteúdo (details) e as observações internas (internal_observations), opcionais, enviados como nulo ficam em branco. A cor do cabeçalho (cover_color) nula só é aceita fora do cabeçalho color. O que o orçamento não pode ficar sem — title, valid_until, active, user_id, company_identifier, cover_kind, cover_show_title e cover_show_subtitle — não pode ser retirado: enviado como nulo, é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Como na tela do Monde Web, o orçamento só é gravado com a validade de hoje em diante: o orçamento vencido precisa de uma valid_until nova em qualquer alteração. A imagem que sai do conteúdo (details) deixa de ser do orçamento e é apagada uma hora depois. Com company_identifier, o orçamento vai para aquela empresa, o que exige a permissão de criar/editar orçamentos também nela. O dono precisa ter acesso à empresa de destino: sem user_id, o orçamento só muda de empresa se o dono atual também tiver acesso a ela; se não tiver, a alteração é recusada (422) e é preciso informar em user_id um dono que tenha. Exige a permissão de criar/editar orçamentos na empresa do orçamento. A resposta traz o orçamento alterado no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os orçamentos" na empresa dele; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id.
| id required | integer Example: 42 Identificador único do orçamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ da empresa para onde o orçamento vai, só os dígitos. Omitido, mantém a empresa atual; nulo ou vazio é recusado. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado. |
| user_id | string <uuid> Identificador do usuário dono do orçamento, o mesmo |
| person_id | string or null <uuid> Identificador da pessoa (cliente) do orçamento, obtido em Consultar pessoas. Nulo tira a pessoa do orçamento, e o texto vazio é recusado (422); omitido, mantém a atual. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe. |
| title | string Título do orçamento |
| subtitle | string or null Subtítulo do orçamento. Opcional. |
| valid_until | string <date> Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado. |
| details | string or null Conteúdo do orçamento, em HTML. O HTML é limpo antes de gravar, com as mesmas regras do conteúdo dos guias. Opcional: na criação, sem ele vale o modelo de conteúdo da empresa, o salvo pelo administrador na tela de Configurações de Orçamentos do Monde Web; enviado como texto vazio, o orçamento fica sem conteúdo. |
| active | boolean Indica se o orçamento está ativo |
| internal_observations | string or null Observações internas (não aparecem no link público). Nulo deixa o campo em branco, e o texto vazio é gravado como está; omitido, mantém o que o orçamento tem. |
| cover_kind | string Enum: "color" "image" "none" Cabeçalho do link público: |
| cover_color | string or null Cor de fundo do cabeçalho, em hexadecimal ( |
| cover_show_title | boolean Exibe o título no cabeçalho. No cabeçalho |
| cover_show_subtitle | boolean Exibe o subtítulo no cabeçalho. No cabeçalho |
Exemplo de alteração que muda só o subtítulo e a validade, mantendo os demais campos.
{- "subtitle": "Lua de mel - 10 noites",
- "valid_until": "2035-06-15"
}Exemplo de resposta de um orçamento específico.
{- "id": 42,
- "title": "Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "details": "Pacote com aéreo, hospedagem all inclusive e traslados.",
- "valid_until": "2024-05-31",
- "active": true,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "person": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Exclui o orçamento definitivamente, junto com as imagens dele. O link público deixa de funcionar e o orçamento não pode ser recuperado. Exige a permissão de excluir orçamentos na empresa do orçamento.
| id required | integer Example: 42 Identificador único do orçamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Cria uma cópia do orçamento, como a ação Duplicar da tela de Orçamentos do Monde Web. A cópia nasce na mesma empresa, com o mesmo subtítulo, conteúdo, imagens, cabeçalho, situação e observações internas, o título com "(cópia)" na frente e um link público novo. A pessoa e a validade não são copiadas: a validade (valid_until) é obrigatória, e a pessoa (person_id) é opcional. O dono da cópia (user_id) também é obrigatório. Exige a permissão de criar/editar orçamentos na empresa do orçamento. A resposta traz a cópia no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os orçamentos" na empresa; sem ela, a cópia é criada do mesmo jeito e a resposta traz apenas o id dela.
| id required | integer Example: 42 Identificador único do orçamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| user_id required | string <uuid> Identificador do usuário dono da cópia, o mesmo |
| valid_until required | string <date> Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado. |
| person_id | string <uuid> Identificador da pessoa (cliente) da cópia, obtido em Consultar pessoas. Opcional: sem ele, a cópia fica sem pessoa. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe. |
Exemplo de duplicação com a nova validade e outra pessoa.
{- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "valid_until": "2035-07-31",
- "person_id": "7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f"
}Exemplo de resposta com a cópia criada.
{- "id": 43,
- "title": "(cópia) Cancún",
- "subtitle": "Lua de mel - 14 noites",
- "details": "<p>Pacote com aéreo, hospedagem all inclusive e traslados.</p>",
- "valid_until": "2035-07-31",
- "active": true,
- "internal_observations": "Cliente pediu retorno até sexta.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "cover_image_url": null,
- "created_at": "2024-04-02T11:00:00",
- "updated_at": "2024-04-02T11:00:00",
- "person": {
- "id": "7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Consulte, crie, altere, duplique e exclua os guias de viagem da agência: conteúdo em HTML com um link público de visualização, como o dos orçamentos, mas sem pessoa vinculada e sem validade. Guias são um recurso da licença Monde Pro e existem só nas empresas que a contrataram. Com a licença Monde Pro somente leitura, os guias da empresa são consultados, mas não criados, alterados, duplicados nem excluídos.
Retorna a lista de guias das empresas em que a credencial tem permissão, do alterado mais recentemente para o mais antigo.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo um guia ativo e um desativado.
{- "data": [
- {
- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00"
}, - {
- "id": 41,
- "title": "Buenos Aires",
- "subtitle": "Feriado prolongado",
- "details": "<p>Tango em San Telmo e jantar em Puerto Madero.</p>",
- "active": false,
- "internal_observations": null,
- "cover_kind": "color",
- "cover_color": "#5f6777",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-01-10T09:00:00",
- "updated_at": "2024-01-12T14:20:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cria um guia na empresa informada em company_identifier. O dono do guia (user_id) é obrigatório, porque a credencial da API não é um usuário do Monde: é ele quem altera e exclui o guia pelo Monde, além dos administradores. Só o título é obrigatório. Sem o cabeçalho, o guia nasce com o cabeçalho color, no tom #5f6777, com o título e o subtítulo. O guia nasce ativo, a menos que active seja enviado como false, e já com o link público em public_url. Exige a permissão de criar/editar guias na empresa.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ da empresa em que o guia será criado, só os dígitos. A empresa precisa ter a licença Monde Pro, e nem ela nem a licença Monde Pro podem estar somente leitura. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado. |
| user_id required | string <uuid> Identificador do usuário dono do guia, o mesmo |
| title required | string Título do guia |
| subtitle | string Subtítulo do guia. Opcional. |
| details | string Conteúdo do guia, em HTML. O HTML é limpo antes de gravar: passam parágrafos, títulos, listas, tabelas, links, negrito, itálico, citação e código, e o resto vira texto ou é descartado. O guia tem dois níveis de título, |
| active | boolean Default: true Indica se o guia está ativo. O link público só abre o guia ativo. Desativado, o guia sai das viagens que o mostram no app do passageiro e não volta a elas ao ser reativado. |
| cover_kind | string Enum: "color" "image" "none" "default" Cabeçalho do link público: |
| cover_color | string Cor de fundo do cabeçalho, em hexadecimal ( |
| cover_show_title | boolean Exibe o título no cabeçalho. No cabeçalho |
| cover_show_subtitle | boolean Exibe o subtítulo no cabeçalho. No cabeçalho |
| hide_cover_text | boolean Mantido para quem já usa a API: |
| internal_observations | string Observações internas (não aparecem no link público) |
Exemplo de criação de um guia com observações internas.
{- "company_identifier": "46598887000162",
- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "internal_observations": "Enviar junto com o voucher.",
- "cover_color": "#1f4e79"
}Exemplo de resposta de um guia específico.
{- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Retorna um guia específico pelo seu identificador.
| id required | integer Example: 42 Identificador único do guia |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um guia específico.
{- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Altera um guia já cadastrado. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. O subtítulo (subtitle), o conteúdo (details) e as observações internas (internal_observations), opcionais, enviados como nulo ficam em branco. A cor do cabeçalho (cover_color) nula, sem cover_kind, é recusada no guia com o cabeçalho color; com cover_kind color, ela vira o tom padrão #5f6777. O que o guia não pode ficar sem — title, active, user_id, company_identifier, cover_kind, hide_cover_text, cover_show_title e cover_show_subtitle — não pode ser retirado: enviado como nulo, é recusado (422). O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). A imagem que sai do conteúdo (details) deixa de ser do guia e é apagada uma hora depois. Com company_identifier, o guia vai para aquela empresa, o que exige a permissão de criar/editar guias também nela. O dono precisa ter acesso à empresa de destino: sem user_id, o guia só muda de empresa se o dono atual também tiver acesso a ela; se não tiver, a alteração é recusada (422) e é preciso informar em user_id um dono que tenha. Exige a permissão de criar/editar guias na empresa do guia. A resposta traz o guia alterado no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os guias" na empresa do guia; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id do guia.
| id required | integer Example: 42 Identificador único do guia |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ da empresa para onde o guia vai, só os dígitos. Omitido, mantém a empresa atual; nulo ou vazio é recusado. A empresa em que a credencial não tem permissão nenhuma é recusada como CNPJ não encontrado. |
| user_id | string <uuid> Identificador do usuário dono do guia, o mesmo |
| title | string Título do guia |
| subtitle | string or null Subtítulo do guia. Opcional. |
| details | string Conteúdo do guia, em HTML. O HTML é limpo antes de gravar: passam parágrafos, títulos, listas, tabelas, links, negrito, itálico, citação e código, e o resto vira texto ou é descartado. O guia tem dois níveis de título, |
| active | boolean Indica se o guia está ativo. O link público só abre o guia ativo. Desativado, o guia sai das viagens que o mostram no app do passageiro e não volta a elas ao ser reativado. |
| cover_kind | string Enum: "color" "image" "none" "default" Cabeçalho do link público: |
| cover_color | string or null Cor de fundo do cabeçalho, em hexadecimal ( |
| cover_show_title | boolean Exibe o título no cabeçalho. No cabeçalho |
| cover_show_subtitle | boolean Exibe o subtítulo no cabeçalho. No cabeçalho |
| hide_cover_text | boolean Mantido para quem já usa a API: |
| internal_observations | string or null Observações internas (não aparecem no link público). Nulo deixa o campo em branco, e o texto vazio é gravado como está; omitido, mantém o que o guia tem. |
Exemplo de alteração que muda só o título e o subtítulo, mantendo os demais campos.
{- "title": "Lisboa e Sintra",
- "subtitle": "Roteiro de 6 dias"
}Exemplo de resposta de um guia específico.
{- "id": 42,
- "title": "Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-03-15T10:30:00",
- "updated_at": "2024-03-16T08:15:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Exclui o guia definitivamente, junto com as imagens dele. O link público deixa de funcionar, o guia sai das viagens que o mostram no app do passageiro e não pode ser recuperado. Exige a permissão de excluir guias na empresa do guia.
| id required | integer Example: 42 Identificador único do guia |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Cria uma cópia do guia, como a ação Duplicar da tela de Guias do Monde Web. A cópia nasce na mesma empresa, com o mesmo subtítulo, conteúdo, imagens, cabeçalho, situação e observações internas, o título com "(cópia)" na frente e um link público novo. O dono da cópia (user_id) é obrigatório. Exige a permissão de criar/editar guias na empresa do guia. A resposta traz a cópia no mesmo formato da consulta por ID quando a credencial também tem a permissão "Ler todos os guias" na empresa; sem ela, a cópia é criada do mesmo jeito e a resposta traz apenas o id dela.
| id required | integer Example: 42 Identificador único do guia |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| user_id required | string <uuid> Identificador do usuário dono da cópia, o mesmo |
Exemplo de duplicação informando o dono da cópia.
{- "user_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Exemplo de resposta com a cópia criada.
{- "id": 43,
- "title": "(cópia) Lisboa",
- "subtitle": "Roteiro de 5 dias",
- "details": "<h3>Dia 1</h3><p>Chegada e passeio pela Baixa.</p>",
- "active": true,
- "internal_observations": "Enviar junto com o voucher.",
- "cover_kind": "color",
- "cover_color": "#1f4e79",
- "cover_show_title": true,
- "cover_show_subtitle": true,
- "hide_cover_text": false,
- "cover_image_url": null,
- "created_at": "2024-04-02T11:00:00",
- "updated_at": "2024-04-02T11:00:00",
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "user": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}Consulte as regras de faturamento, com a pessoa dona da regra, o período de fechamento e as condições de vencimento. As regras valem para a agência inteira, sem empresa.
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.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo regras de fornecedor e de cliente.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Faturamento semanal aéreo",
- "person_kind": "supplier",
- "destination": "national",
- "movement": "to_pay",
- "cost_center": null,
- "closing": {
- "period_kind": "weekly",
- "week_start": "monday",
- "custom_period": null,
- "custom_period_due_date": null,
- "date_to_use": "after_checkin"
}, - "due_date": {
- "days_to_skip": 5,
- "on_weekend": "stay"
}
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Cliente corporativo mensal",
- "person_kind": "customer",
- "destination": "every",
- "movement": "every_movement",
- "cost_center": "Comercial",
- "closing": {
- "period_kind": "monthly",
- "week_start": null,
- "custom_period": null,
- "custom_period_due_date": null,
- "date_to_use": "after_sale_date"
}, - "due_date": {
- "days_to_skip": 10,
- "on_weekend": "next"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma regra de faturamento específica pelo seu identificador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da regra de faturamento |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "period_kind": "weekly",
- "week_start": "monday",
- "custom_period": null,
- "custom_period_due_date": null,
- "date_to_use": "after_checkin"
}, - "due_date": {
- "days_to_skip": 5,
- "on_weekend": "stay"
}, - "person": null,
- "product": null,
- "supplier": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "requester": null
}Consulte as integrações com fornecedores, que importam as vendas feitas no sistema do fornecedor. Os segredos do fornecedor (senha, token, chaves de API e PIN) nunca são retornados: a consulta diz só se estão preenchidos.
Retorna a lista de integrações das empresas em que a credencial tem permissão (integrações sem empresa valem para todas). Os campos adicionais, com os dados de acesso ao fornecedor, ficam só na consulta por ID.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo integrações de fornecedor e de buscador.
{- "data": [
- {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Assist Card Matriz",
- "active": true,
- "vendor_id": "b2359357-cff7-4d43-b6d2-99adf2ff373b",
- "vendor_name": "Assist Card"
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "description": "Argo Buscador",
- "active": false,
- "vendor_id": "31d759f3-ee91-4a10-8432-0f76b40cd11e",
- "vendor_name": "Argo IT"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma integração específica pelo seu identificador, com os campos adicionais que o fornecedor declara. Só o endereço do serviço e a identificação da agência no fornecedor voltam com valor. Os demais campos, como usuário, senha, token, chaves de API e PIN, nunca são retornados: filled diz se estão preenchidos.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único da integração |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma integração específica, com o usuário e a senha omitidos.
{- "id": "f9d961b8-ea88-4346-8e52-afe94267417a",
- "description": "Assist Card Matriz",
- "active": true,
- "vendor_id": "b2359357-cff7-4d43-b6d2-99adf2ff373b",
- "vendor_name": "Assist Card",
- "person": {
- "id": "5c4b3a29-1807-4f6e-9d5c-4b3a29180706"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "additional_fields": [
- {
- "name": "agency_code",
- "type": "text",
- "value": "1000",
- "filled": true
}, - {
- "name": "user",
- "type": "text",
- "value": null,
- "filled": true
}, - {
- "name": "pass",
- "type": "password",
- "value": null,
- "filled": true
}
]
}Consulte as pessoas cadastradas no sistema, com dados de contato, documentos e informações adicionais.
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}).
| 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: |
| code | integer Example: code=1024 Filtra pelo código sequencial da pessoa (valor exato). |
string Example: email=contato@exemplo.com Filtra por e-mail, sem diferenciar maiúsculas ou acentos (busca por trecho). | |
| label_id | string <uuid> Example: label_id=2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50 Filtra as pessoas que têm o marcador informado (UUID, o |
| birthday_from | string <date> Example: birthday_from=2026-12-28 Início da janela de aniversário (YYYY-MM-DD). Traz as pessoas cujo dia e mês de nascimento caem entre |
| birthday_to | string <date> Example: birthday_to=2027-01-05 Fim da janela de aniversário (YYYY-MM-DD), inclusive. Veja |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta da consulta contendo pessoa física e pessoa jurídica.
{- "data": [
- {
- "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": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": "Apto 12",
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "first_sale_date": "2022-01-10",
- "last_sale_date": "2024-03-01",
- "last_departure_date": "2024-03-15",
- "last_return_date": "2024-03-22",
- "last_task_update_at": "2024-03-18T15:12:00"
}, - "tax_withholding": null,
- "airline": null
}, - {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6",
- "code": 87,
- "person_kind": "company",
- "name": "Operadora de Turismo Ltda",
- "legal_name": "Operadora de Turismo S.A.",
- "cpf_cnpj": "12345678000199",
- "gender": null,
- "birthdate": null,
- "rg_ie": "9012345678",
- "city_inscription": "1234567",
- "tax_identification_number": null,
- "passport_number": null,
- "passport_expiration_date": null,
- "foreigner": false,
- "foreign_identity_document": null,
- "email": "contato@operadora.com.br",
- "phone_number": "4133334444",
- "mobile_number": null,
- "business_phone": null,
- "cvc_code": null,
- "observations": null,
- "charge_billet_fee": true,
- "created_at": "2019-04-18T08:15:00",
- "address": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": null,
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": null,
- "last_contacts": {
- "first_sale_date": null,
- "last_sale_date": null,
- "last_departure_date": null,
- "last_return_date": null,
- "last_task_update_at": null
}, - "tax_withholding": {
- "iss": true,
- "ir": false,
- "pis_cofins_csll": false
}, - "airline": null
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Insere uma pessoa física ou jurídica. Cada requisição cria um cadastro novo: o external_id, quando informado, precisa estar livre, e o CPF/CNPJ não pode pertencer a nenhuma pessoa já cadastrada. A resposta traz a pessoa criada no mesmo formato da consulta por ID. Informar seller exige também a permissão "Alterar Vendedor", e promoter, a "Alterar Promotor", como no Monde; sem ela, a resposta é 403. Enviar credit_cards ou kandir_law exige também a permissão "Ver aba financeiro" de pessoas, e incluir cartões, a "Cadastrar Cartão de Crédito", como no Monde, em que os cartões e a Lei Kandir ficam na aba Financeiro da pessoa; sem ela, a resposta é 403 com a mensagem do Monde. Sem "Ver aba financeiro", a resposta não traz credit_cards nem kandir_law, e sem "Visualizar dados do Cartão de Crédito", não traz credit_cards: o campo não vem.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| 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. |
| name required | string <= 100 characters Nome ou nome fantasia, de acordo com o tipo da pessoa. |
| legal_name | string or null <= 100 characters Razão social. |
| 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). |
| cpf_cnpj | string [ 11 .. 14 ] characters CPF ou CNPJ, de acordo com o tipo da pessoa, sem pontos, barras, traços ou espaços. |
| 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. |
| passport_number | string or null <= 20 characters Número do passaporte, sem pontos, traços ou espaços. |
| passport_expiration_date | string or null <date> Data de expiração do passaporte no formato ISO 8601 (AAAA-MM-DD). |
| foreigner | boolean Default: false Indica se a pessoa ou empresa é estrangeira. Use |
| 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. |
| business_phone | string or null <= 20 characters Telefone comercial |
object or null (person_birthplace) Naturalidade: cidade em que a pessoa nasceu. Informe o código IBGE ou, na falta dele, o nome da cidade com estado e país. Sem o código IBGE, a cidade é procurada pelo nome, sem diferenciar acento nem maiúscula, entre as que a agência pode usar: no Brasil, no estado; no exterior, no país. A cidade não é cadastrada: o nome que não corresponde a nenhuma é recusado (422). | |
object or null (person_additional_data) Dados adicionais da pessoa física. Ausente (null) para pessoa jurídica. | |
| website | string or null <= 50 characters Website (pessoa jurídica) |
| tax_identification_number | string or null <= 20 characters Identificação fiscal (pessoa jurídica estrangeira) |
object or null (person_tax_withholding) Retenções de imposto da pessoa jurídica. Ausente (null) para pessoa física. | |
object or null (person_airline) Dados de companhia aérea da pessoa jurídica (fornecedores). Ausente (null) para pessoa física. | |
string or null <= 200 characters Endereço de e-mail. | |
| 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. |
| 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. |
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 | |
Array of objects (person_credit_card_write) Cartões de crédito da pessoa, física ou jurídica. O número e o código de segurança são gravados cifrados e nunca voltam na resposta, que traz só os quatro últimos dígitos. O cartão vale até o último dia do mês da validade, e o cartão vencido é recusado. Exige as permissões "Ver aba financeiro" e "Cadastrar Cartão de Crédito" de pessoas. | |
Array of objects (person_cost_center_write) Centros de custo do cliente corporativo: os departamentos dele aceitos no centro de custo do passageiro e do item da fatura quando ele é o pagante. Não são os centros de custo da agência, de | |
Array of objects (person_kandir_law_write) Retenções da Lei Kandir (Lei 9.430/1996, art. 64) da pessoa jurídica, uma por produto, no mesmo formato da consulta por ID. Só aceitam retenção os produtos ativos Passagem Aérea, Seguro Viagem e Transporte Terrestre. O percentual omitido é zero, e o negativo é recusado. O |
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": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5000",
- "neighborhood": "Planalto Paulista",
- "additional_info": "Casa 2",
- "city_ibge": "3550308"
}, - "birthplace": {
- "city_ibge": "3550308"
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP",
- "rg_issue_date": "2010-03-01",
- "birth_certificate": "093456 01 55 2010 1 00123 456 7890123-45",
- "mother_name": "Joana da Silva"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "expiration_month": 5,
- "expiration_year": 2032
}, - {
- "number": "5555555555554444",
- "name": "MARIA S SOUZA",
- "issuer": "MasterCard",
- "expiration_month": 8,
- "expiration_year": 2031
}
]
}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": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": "Apto 12",
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "first_sale_date": "2022-01-10",
- "last_sale_date": "2024-03-01",
- "last_departure_date": "2024-03-15",
- "last_return_date": "2024-03-22",
- "last_task_update_at": "2024-03-18T15:12:00"
}, - "tax_withholding": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "created_by": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}
}
], - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
], - "attachments": [
- {
- "id": "3e1c4d5f-6071-4283-a495-1c2d3e4f5061",
- "description": "RG digitalizado",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Retorna os dados completos de uma pessoa pelo seu identificador, incluindo os blocos agrupados (dados adicionais, últimos contatos, retenções e companhia aérea) e as entidades fracas (contatos, marcadores, campos personalizados, anexos, cartões de crédito (sempre mascarados), e retenção da Lei Kandir). Como a aba Financeiro do Monde, credit_cards e kandir_law só vêm com a permissão "Ver aba financeiro" de pessoas, e credit_cards, também com a "Visualizar dados do Cartão de Crédito". Sem a permissão, o campo não vem: é omitido, não vem nulo.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único (UUID) da pessoa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": "Apto 12",
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "first_sale_date": "2022-01-10",
- "last_sale_date": "2024-03-01",
- "last_departure_date": "2024-03-15",
- "last_return_date": "2024-03-22",
- "last_task_update_at": "2024-03-18T15:12:00"
}, - "tax_withholding": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "created_by": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}
}
], - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
], - "attachments": [
- {
- "id": "3e1c4d5f-6071-4283-a495-1c2d3e4f5061",
- "description": "RG digitalizado",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Altera uma pessoa já cadastrada. Informe apenas os campos que devem mudar: o campo omitido permanece como está, e o enviado como nulo é retirado. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422), inclusive nos códigos que localizam a cidade (city_ibge, city_name, state_code, country_code) e no code de airline, que é único entre as pessoas. O objeto enviado como nulo retira tudo o que ele grava (address, birthplace, additional_data, airline), e o campo nulo dentro dele, só aquele dado; a cidade sai quando city_ibge e city_name vêm nulos. seller e promoter nulos tiram o vendedor e o promotor. Não podem ser retirados, e enviados como nulos são recusados (422): name, person_kind, foreigner, charge_billet_fee, o external_id (pode ser trocado por outro, mas não retirado), as retenções de tax_withholding e, quando a pessoa é usuário do Monde, o email. O tipo da pessoa não muda: person_kind, quando informado, precisa ser o mesmo que a pessoa já é. O external_id passa a identificar a pessoa, desde que não esteja identificando outra; o CPF/CNPJ e o código de companhia aérea não podem pertencer a outra pessoa. Como no Monde, o CPF/CNPJ gravado é conferido em toda alteração: na pessoa com documento inválido, a alteração responde 422 no campo cpf_cnpj até que ele seja enviado corrigido, ou nulo para retirá-lo. Quando a pessoa é usuário do Monde, o email também não pode ser o de outro usuário. As listas labels, contacts, credit_cards, cost_centers e kandir_law funcionam por substituição: a lista enviada passa a ser a da pessoa, a lista vazia ou nula retira todos os itens e o campo omitido mantém os atuais. Os campos personalizados não substituem: cada um enviado é gravado por cima do atual, o enviado com valor nulo ou vazio é limpo (o obrigatório é recusado), e os demais permanecem. A resposta traz a pessoa alterada no mesmo formato da consulta por ID quando a credencial também tem a permissão "Visualizar" de pessoas; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id da pessoa. A pessoa que é uma empresa do sistema e o e-mail de uma pessoa que é usuário ativo do Monde só são alterados por um administrador, como no Monde: a alteração responde 403 com o motivo. Trocar ou retirar (nulo) seller exige também a permissão "Alterar Vendedor", e trocar ou retirar promoter, a "Alterar Promotor"; o reenviado igual ao atual, e o nulo na pessoa que não tem vendedor ou promotor, não pedem a permissão. Enviar credit_cards ou kandir_law com algum item, ou vazios ou nulos quando retiram o que a pessoa tem, exige também a permissão "Ver aba financeiro" de pessoas, e cada operação nos cartões, a permissão dela, como no Monde: incluir cartão (item sem id) exige "Cadastrar Cartão de Crédito"; alterar cartão (item com id e algum campo diferente do gravado, ou com number ou cvv, que contam sempre como mudança; o reenviado como a consulta o devolve não pede) exige "Visualizar dados do Cartão de Crédito" e "Editar Cartão de Crédito"; e a lista que deixa de fora um cartão que a pessoa tem, removendo-o, exige "Remover Cartão de Crédito". O cartão citado só pelo id fica como está e não pede permissão própria. Sem a permissão, a resposta é 403 com a mensagem do Monde, e nada é alterado. Na resposta, sem "Ver aba financeiro", credit_cards e kandir_law não vêm, e sem "Visualizar dados do Cartão de Crédito", credit_cards não vem: o campo é omitido, não vem nulo.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único (UUID) da pessoa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| 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. |
| name | string <= 100 characters Nome ou nome fantasia, de acordo com o tipo da pessoa. |
| legal_name | string or null <= 100 characters Razão social. |
| 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). |
| cpf_cnpj | string [ 11 .. 14 ] characters CPF ou CNPJ, de acordo com o tipo da pessoa, sem pontos, barras, traços ou espaços. |
| 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. |
| passport_number | string or null <= 20 characters Número do passaporte, sem pontos, traços ou espaços. |
| passport_expiration_date | string or null <date> Data de expiração do passaporte no formato ISO 8601 (AAAA-MM-DD). |
| foreigner | boolean Default: false Indica se a pessoa ou empresa é estrangeira. Use |
| 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. |
| business_phone | string or null <= 20 characters Telefone comercial |
object or null (person_birthplace) Naturalidade: cidade em que a pessoa nasceu. Informe o código IBGE ou, na falta dele, o nome da cidade com estado e país. Sem o código IBGE, a cidade é procurada pelo nome, sem diferenciar acento nem maiúscula, entre as que a agência pode usar: no Brasil, no estado; no exterior, no país. A cidade não é cadastrada: o nome que não corresponde a nenhuma é recusado (422). | |
object or null (person_additional_data) Dados adicionais da pessoa física. Ausente (null) para pessoa jurídica. | |
| website | string or null <= 50 characters Website (pessoa jurídica) |
| tax_identification_number | string or null <= 20 characters Identificação fiscal (pessoa jurídica estrangeira) |
object or null (person_tax_withholding) Retenções de imposto da pessoa jurídica. Ausente (null) para pessoa física. | |
object or null (person_airline) Dados de companhia aérea da pessoa jurídica (fornecedores). Ausente (null) para pessoa física. | |
string or null <= 200 characters Endereço de e-mail. | |
| 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. |
| 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. |
object or null Endereço. | |
| city_inscription | string or null <= 15 characters Inscrição municipal |
| observations | string or null Observações da pessoa |
| charge_billet_fee | boolean Default: false Indica se a taxa de boleto é cobrada da pessoa |
entity_reference (object) or null Vendedor responsável pela pessoa | |
entity_reference (object) or null Promotor da pessoa (planos operadora) | |
Array of objects or null (entity_reference) Marcadores da pessoa. A lista enviada substitui a atual: o marcador que não vier nela é retirado. Envie uma lista vazia ou nula para retirar todos os marcadores; omita o campo para manter os atuais. Cada marcador precisa já estar cadastrado. | |
Array of objects or null (person_contact) Pessoas ligadas a este cadastro como contato. A lista enviada substitui a atual: o contato que não vier nela é desfeito. A função de cada contato é a que vier na lista: omiti-la deixa o contato sem função. Envie uma lista vazia ou nula para desfazer todos os contatos; omita o campo para manter os atuais. Cada pessoa informada precisa já estar cadastrada e não pode se repetir na lista. Os vínculos em que esta pessoa é contato de outra não são afetados. | |
Array of objects (person_custom_field) Campos personalizados de pessoas, definidos pela agência. Diferente das outras listas, não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão, então a lista vazia ou nula não muda nada. O campo enviado com | |
Array of objects or null (person_credit_card_write) Cartões de crédito da pessoa. A lista enviada substitui a atual: como a leitura não devolve o número, o cartão que a pessoa já tem é citado pelo | |
Array of objects or null (person_cost_center_write) Centros de custo do cliente corporativo (não os da agência, de | |
Array of objects or null (person_kandir_law_write) Retenções da Lei Kandir da pessoa jurídica, uma por produto. A lista enviada substitui a atual: o produto identifica a retenção, então o produto que a pessoa já tem altera a retenção dele, e o grupo, a abrangência e o imposto omitidos ficam como estão (o percentual enviado nulo é recusado); o produto novo inclui uma retenção, com o percentual omitido zerado; a retenção que não vier na lista é excluída. Envie uma lista vazia ou nula para excluir todas; omita o campo para manter as atuais. Exige a permissão "Ver aba financeiro" de pessoas quando traz alguma retenção ou retira as que a pessoa tem. |
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": {
- "postal_code": "04078011",
- "street": "Avenida Divino Salvador",
- "street_number": "5200",
- "city_ibge": "3550308"
}, - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
]
}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": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": "Apto 12",
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "first_sale_date": "2022-01-10",
- "last_sale_date": "2024-03-01",
- "last_departure_date": "2024-03-15",
- "last_return_date": "2024-03-22",
- "last_task_update_at": "2024-03-18T15:12:00"
}, - "tax_withholding": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "created_by": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}
}
], - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
], - "attachments": [
- {
- "id": "3e1c4d5f-6071-4283-a495-1c2d3e4f5061",
- "description": "RG digitalizado",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}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.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único (UUID) da pessoa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Devolve a foto da pessoa física (ou o logotipo da pessoa jurídica) como imagem, com o Content-Type do formato gravado. Exige a permissão de consultar pessoas. Esta chamada não exige o cabeçalho Content-Type.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único (UUID) da pessoa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Grava a foto da pessoa física (ou o logotipo da pessoa jurídica), substituindo a que já existir. A imagem vai no campo file de um multipart/form-data e precisa ser JPEG de até 150 KB, os mesmos limites do Monde, que só exibe a imagem nesse formato. Exige a permissão de alterar pessoas, numa empresa que não seja somente leitura. A troca fica registrada no histórico da pessoa.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único (UUID) da pessoa. |
| 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. |
| file required | string <binary> A imagem, em JPEG, com até 150 KB. |
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": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": "Apto 12",
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "first_sale_date": "2022-01-10",
- "last_sale_date": "2024-03-01",
- "last_departure_date": "2024-03-15",
- "last_return_date": "2024-03-22",
- "last_task_update_at": "2024-03-18T15:12:00"
}, - "tax_withholding": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "created_by": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}
}
], - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
], - "attachments": [
- {
- "id": "3e1c4d5f-6071-4283-a495-1c2d3e4f5061",
- "description": "RG digitalizado",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Remove a foto da pessoa física (ou o logotipo da pessoa jurídica). Exige a permissão de alterar pessoas, numa empresa que não seja somente leitura. A remoção fica registrada no histórico da pessoa.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único (UUID) da pessoa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Converte a pessoa para o tipo informado em person_kind, como a ação Converter para Pessoa Jurídica / Converter para Pessoa Física da consulta de pessoas do Monde. Os dados que só o tipo de origem tem são apagados: na conversão para pessoa jurídica, CPF, RG, sexo, telefone comercial, passaporte e sua validade, órgão emissor e data de emissão do RG e naturalidade; na conversão para pessoa física, CNPJ, inscrição estadual, razão social e site. O usuário do sistema não pode virar pessoa jurídica, e a empresa do sistema não muda de tipo. Exige a permissão de alterar pessoas, numa empresa que não seja somente leitura. O tipo não muda em Alterar pessoa, só aqui.
| person_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único (UUID) da pessoa. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| person_kind required | string Enum: "individual" "company" Tipo de destino: |
{- "person_kind": "company"
}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": {
- "postal_code": "80010000",
- "street": "Rua das Flores",
- "street_number": "100",
- "neighborhood": "Centro",
- "additional_info": "Apto 12",
- "city": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}
}, - "additional_data": {
- "marital_status": "married",
- "rg_emitter": "SSP/PR",
- "rg_issue_date": "2008-03-15",
- "birth_certificate": null,
- "mother_name": "Ana Souza"
}, - "last_contacts": {
- "first_sale_date": "2022-01-10",
- "last_sale_date": "2024-03-01",
- "last_departure_date": "2024-03-15",
- "last_return_date": "2024-03-22",
- "last_task_update_at": "2024-03-18T15:12:00"
}, - "tax_withholding": null,
- "airline": null,
- "birthplace": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "seller": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "promoter": null,
- "created_by": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "contacts": [
- {
- "role": "Financeiro",
- "person": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}
}
], - "labels": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50"
}
], - "custom_fields": [
- {
- "id": 123,
- "value": "Indicação"
}
], - "attachments": [
- {
- "id": "3e1c4d5f-6071-4283-a495-1c2d3e4f5061",
- "description": "RG digitalizado",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "credit_cards": [
- {
- "id": "6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c",
- "name": "Cartão Corporativo",
- "last_digits": "1111",
- "expiration_date": "2030-05-01",
- "issuer": "Visa",
- "ticket_card": null
}
], - "cost_centers": null,
- "kandir_law": null,
- "invoice_rules": [
- {
- "id": "8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b"
}
], - "photo": {
- "content_type": "image/jpeg",
- "size": 48213
}
}Consulte, crie, altere e exclua os marcadores usados para classificar pessoas. O cadastro de marcadores é um só para o sistema inteiro, sem empresa: as permissões valem em qualquer empresa ativa em que forem concedidas, e gravar exige uma empresa que não seja somente leitura.
Retorna a lista de marcadores cadastrados no sistema.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo todos os marcadores cadastrados.
{- "data": [
- {
- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
- "name": "VIP"
}, - {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Corporativo"
}, - {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "name": "Lua de mel"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cria um marcador. O nome é obrigatório, tem até 38 caracteres e não pode repetir o de outro marcador. Exige a permissão "Editar" de marcadores.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name required | string <= 38 characters Nome do marcador, com até 38 caracteres e diferente do nome dos demais marcadores |
Cria o marcador VIP.
{- "name": "VIP"
}Exemplo de resposta de um marcador específico.
{- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
- "name": "VIP"
}Retorna um marcador específico pelo seu identificador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do marcador |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de um marcador específico.
{- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
- "name": "VIP"
}Renomeia um marcador. O nome omitido permanece como está; enviado como nulo ou como texto vazio, é recusado (422), porque o marcador não fica sem nome. O novo nome segue as mesmas regras da criação, e as pessoas que têm o marcador continuam com ele. Exige a permissão "Editar" de marcadores. A resposta traz o marcador alterado quando a credencial também tem a permissão "Visualizar" de marcadores; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id do marcador.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do marcador |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| name | string <= 38 characters Nome do marcador, com até 38 caracteres e diferente do nome dos demais marcadores |
Troca o nome do marcador.
{- "name": "Cliente VIP"
}Exemplo de resposta de um marcador específico.
{- "id": "2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50",
- "name": "VIP"
}Exclui o marcador definitivamente e o retira de todas as pessoas que o tinham, como na exclusão pelo Monde. A exclusão não pode ser desfeita. Exige a permissão "Excluir" de marcadores.
| id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a Identificador único do marcador |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Consulte as empresas do sistema que a credencial alcança: as empresas ativas em que ela tem a permissão "Ler todas as empresas". É daqui que sai o CNPJ que as gravações pedem em company_identifier.
Retorna as empresas ativas em que a credencial tem a permissão "Ler todas as empresas", em ordem alfabética do nome. A empresa somente leitura vem na lista, marcada em read_only: ela continua sendo consultada, mas recusa as gravações.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com as empresas que a credencial alcança, uma delas somente leitura.
{- "data": [
- {
- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10",
- "name": "Monde Viagens",
- "legal_name": "Monde Viagens e Turismo Ltda",
- "cnpj": "46598887000162",
- "read_only": false,
- "person": {
- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10"
}
}, - {
- "id": "4c7e2b19-0a3d-4f6e-8b51-2d9c6a7e1f30",
- "name": "Monde Viagens Filial",
- "legal_name": "Monde Viagens Filial Ltda",
- "cnpj": "11222333000181",
- "read_only": true,
- "person": {
- "id": "4c7e2b19-0a3d-4f6e-8b51-2d9c6a7e1f30"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma empresa específica pelo seu identificador. Exige a permissão "Ler todas as empresas" na própria empresa, que precisa estar ativa. A empresa fora desse alcance responde 403, também quando o id não existe.
| id required | string <uuid> Example: 8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10 Identificador único da empresa |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta de uma empresa específica.
{- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10",
- "name": "Monde Viagens",
- "legal_name": "Monde Viagens e Turismo Ltda",
- "cnpj": "46598887000162",
- "read_only": false,
- "person": {
- "id": "8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10"
}
}Consulte e insira as contas a pagar e a receber (lançamentos financeiros) das empresas em que a credencial tem permissão. O mesmo recurso cobre os dois casos: contas a receber (transaction_kind = credit) e contas a pagar (transaction_kind = debit). Traz identificação, valores, situação, categorias, rateios, movimentações de liquidação, itens, comissões, anexos e campos personalizados. O lançamento que a credencial criou é sempre dela; o dos outros usuários pede o acesso aos lançamentos de todos os usuários, ou o recorte dele, como no Monde (veja as Perguntas frequentes).
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}.
| 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: |
| 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.
|
| 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 e overdue; liquidadas e canceladas só voltam quando pedidas explicitamente.
|
| recurrence_group_id | string <uuid> Example: recurrence_group_id=5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f Filtra pelos lançamentos de uma série de parcelamento ou recorrência, pelo |
| 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.: |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta contendo uma conta a receber (fatura de cliente) e uma conta a pagar (fatura de cartão).
{- "data": [
- {
- "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": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null
}, - {
- "id": "9f8e7d6c-5b4a-4938-8271-6f5e4d3c2b1a",
- "number": "67890",
- "transaction_kind": "debit",
- "kind": "credit_card_invoice",
- "description": "Fatura Mastercard",
- "document": null,
- "invoice_number": null,
- "amount": 5577.39,
- "final_amount": 5577.39,
- "issue_date": "2026-04-18",
- "due_date": "2026-05-15",
- "settlement_date": "2026-05-15",
- "created_at": "2026-04-18T13:45:36",
- "canceled": false,
- "checked": false,
- "invoice_closed": false,
- "system_generated": false,
- "generates_credit": false,
- "periodicity": "monthly",
- "recurrence_kind": "installment",
- "recurrence_group_id": "5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f",
- "observations": null,
- "billet": null,
- "check": null,
- "card": {
- "brand": "MasterCard",
- "last_digits": "4117",
- "authorization": "600551159"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cria um lançamento financeiro em aberto ou já liquidado, com as mesmas regras do lançamento manual do Monde. transaction_kind define se é conta a receber (credit) ou a pagar (debit), e qualquer categoria é aceita.
Categorias e valor final. A soma com sinal das categories é o valor final (final_amount): a categoria do mesmo tipo do lançamento soma, a de tipo oposto abate (o tipo vem em kind, em Consultar categorias). Se o valor final ficar diferente de amount, a diferença é acréscimo ou desconto, sujeita ao bloqueio de acréscimo e desconto da empresa. O valor final não pode ser negativo, e a mesma categoria não pode se repetir com a mesma descrição.
Rateios. Só em agência. O rateio por centro de custo (apportionments.per_cost_center) pode ficar entre 0 e 100% do valor final; o rateio entre empresas (apportionments.per_company), quando informado, precisa somar exatamente 100% e só aceita empresas em que a credencial também pode inserir lançamentos. Na operadora, os rateios e a operação própria são recusados.
Liquidação. Para criar o lançamento já liquidado, envie settlement_date com as movements, uma por conta em que o dinheiro entrou ou saiu. Exige também a permissão "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme o lançamento, como no Monde; sem ela, a resposta é 403. Quando a soma das movimentações não fecha com o valor final, diga o que fazer com a diferença em balance_resolution, como na liquidação: com category, ela vai para uma categoria, como desconto (pago a menos) ou acréscimo (pago a mais), e o valor final passa a ser o que foi pago. A categoria vem em balance_category_id; sem ela, vale a categoria padrão da empresa para aquele caso (desconto concedido ou recebido, acréscimo cobrado ou pago), e sem padrão o pedido é recusado. A categoria precisa ser do tipo que leva o valor final ao que foi pago. Sem balance_resolution, as movimentações precisam somar exatamente o valor final; o pagamento com juros ou desconto também pode ser enviado ajustando as categorias. Com partial, o pagamento parcial, quando foi pago menos que o valor final: o lançamento é liquidado com o que foi pago e ganha o sufixo " 1/2" na descrição, e o saldo vira um novo lançamento em aberto, com o sufixo " 2/2" e as mesmas categorias na proporção do saldo. Como no Monde, os dois ficam com o mesmo número em partes: o lançamento 71 vira 71-1 e o saldo, 71-2. A parcela que já tem parte no número (72-2) mantém o dela, e o saldo fica com a próxima parte livre. Sem saldo, o pagamento parcial não gera nada; pago a mais, é recusado. O partial_payment: true continua aceito e equivale a balance_resolution: partial; enviados juntos, os dois precisam dizer o mesmo, e o partial_payment que contradiz o balance_resolution é recusado com 422. A data de liquidação não pode ser maior que a data da última movimentação, e a emissão não pode ser maior que a liquidação. Cada movimentação usa uma conta ativa vinculada à empresa, e a forma de pagamento segue o tipo da conta: conta caixa e conta de cheques aceitam dinheiro ou cheque, conta cartão de crédito aceita só cartão de crédito, e conta corrente aceita as demais. Cheque exige o número. Parcelar (installments) só em conta cartão de crédito. Em contas a receber vale o bloqueio da data de movimentação, e o caixa do dia fechado recusa a movimentação com o motivo, como O caixa do dia "10/10/2026" da conta "Caixa" está fechado.
Taxa de cartão. Na conta a receber recebida em cartão de crédito ou de débito numa conta corrente, envie a taxa da operadora em card_rate, como no Monde: amount é o que o cliente pagou, e a conta recebe amount menos a taxa. A soma das taxas vira a categoria de taxa de cartão configurada na empresa, que abate o valor final; se essa categoria já estiver em categories, a taxa entra nela, e o valor dela passa a ser a soma das taxas. Sem a categoria configurada, a taxa é recusada com 422, e também a taxa em outra forma de pagamento, em conta a pagar ou fora da conta corrente, e a taxa igual ou maior que amount. Exemplo: conta a receber de R$ 420,00 com R$ 20,00 de taxa: a movimentação tem amount 420 e card_rate 20, a conta recebe R$ 400,00 e o valor final fica R$ 400,00.
Estorno no cartão. A conta a receber também se liquida na conta cartão de crédito, só com a forma cartão de crédito: é o estorno, que entra na fatura do cartão e abate o total dela, como no Monde. Parcelado, cada parcela entra na fatura do mês dela.
Parcelamento e recorrência. Envie recurrence_kind com a periodicity. No parcelamento (installment), installments é o total de parcelas, de 2 a 200, e cada parcela repete o valor cheio do lançamento: R$ 1.500,00 em 3 vezes gera 3 lançamentos de R$ 1.500,00. As parcelas vencem uma a cada período a partir de due_date, ganham o sufixo " 1/3" na descrição e -1 no número; a descrição tem até 50 caracteres justamente para caber esse sufixo. A recorrência (recurrent) gera os lançamentos dos próximos 5 anos com o mesmo valor e descrição, e o Monde continua gerando os seguintes. A quinzena (biweekly) é de 15 dias. A série é gerada em segundo plano, como no Monde: a resposta traz o primeiro lançamento com o recurrence_group_id já preenchido, e os demais aparecem em seguida em Consultar contas a pagar e receber com o filtro recurrence_group_id. Até a série ser gerada, o lançamento consultado por ID aparece sem o recurrence_group_id, e o recurrence_status diz se ela ainda falta ou se a última tentativa falhou. Os sufixos da parcela entram na descrição e no número de todos os lançamentos quando a série é gerada, inclusive no primeiro. O pagamento parcial e o balance_resolution não se combinam com parcelamento nem recorrência: as parcelas copiam as categorias do primeiro lançamento, e a categoria da diferença é só da baixa dele.
Bloqueios da empresa. Valem como configurados na empresa: o bloqueio de vencimento e o da data de movimentação em contas a receber, e o de acréscimo e desconto. Só a credencial com a permissão "Ignorar bloqueios" na empresa do lançamento passa por eles, como no Monde.
Padrões. Sem issue_date, a emissão é a menor data entre hoje, o vencimento e a liquidação; informada, ela não pode ser maior que o vencimento. Sem account_id, o lançamento recebe a conta de previsão padrão da empresa; o lançamento da venda fica sem conta prevista, como no Monde. O lançamento é sempre em BRL. Campos fora do contrato são ignorados.
Erros. O erro de um campo de um item de lista (categories, movements, custom_fields e os rateios) traz a posição do item na lista enviada, contada a partir de 0: O campo 'movements[1] account_id' não corresponde a nenhuma conta ativa vinculada à empresa do lançamento fala da segunda movimentação. Cada item com erro tem a sua mensagem. A regra conferida sobre a lista inteira, como a soma das movimentações ou a categoria repetida, vem no nome da lista, sem posição. O erro de formato de um campo do item também traz a posição: check enviado como texto no lugar de objeto responde O campo 'movements[0] check' deve ser uma lista ou um objeto….
Lançamento da venda. Para lançar uma conta a pagar ou a receber na venda, como o botão da aba Financeiro da venda no Monde, envie o sale_id, pelo id de GET /sales. O lançamento nasce como avulso da venda (kind igual a sale_standalone), ligado a ela e na empresa dela, e aparece em financial.standalone_bills de Consultar venda por ID. Da venda vem só a empresa: pessoa, categorias, valores e os demais campos vêm do payload, como em qualquer lançamento. O company_identifier pode ser omitido; enviado, precisa ser o CNPJ da empresa da venda. A venda fechada aceita o lançamento, e a excluída responde 409. O lançamento da venda não tem operação própria, parcelamento nem recorrência: operation_id e recurrence_kind são recusados com 422. Ele pode nascer liquidado, como os demais. Exige, na empresa da venda, as permissões de inserir contas a pagar e receber descritas abaixo e a permissão "Ver aba financeiro" de vendas; a permissão de editar a venda não é exigida, porque a venda não muda. A venda precisa estar entre as que a credencial consulta: a de fora do alcance responde 422 em sale_id, como a que não existe. Como a aba Financeiro só aparece com a venda aberta, a venda de outro vendedor pede também "Abrir vendas de outros vendedores", e sem ela responde 403; pela conexão automática autorizada antes das permissões "de outros", só a venda criada pela própria conexão.
Exige a permissão "Editar" de contas a pagar e receber na empresa, que não pode estar somente leitura; pela conexão automática autorizada antes das permissões "de outros", vale também a de inserir e editar as próprias contas. O lançamento criado fica sendo da credencial. A resposta traz o lançamento criado, igual a Consultar conta a pagar ou receber por ID, mesmo para a credencial sem a permissão "Visualizar", e em generated_bills o saldo do pagamento parcial, que é criado na mesma chamada: se ele for recusado, nada é gravado. As parcelas e recorrências não vêm em generated_bills: elas são buscadas pelo recurrence_group_id. Acompanhar a série, pela consulta por ID ou pela listagem, exige a permissão de leitura de contas a pagar e receber.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ da empresa do lançamento. A credencial precisa poder inserir lançamentos nela. Obrigatório, exceto no lançamento da venda (com |
| sale_id | string <uuid> Venda em que a conta a pagar ou a receber é lançada, pelo id de |
| transaction_kind required | string Enum: "credit" "debit" Natureza do lançamento: |
| person_id required | string <uuid> Pessoa do lançamento (cliente ou fornecedor), pelo id de |
| description required | string <= 50 characters Descrição do lançamento, com até 50 caracteres. Dos 60 que o Monde guarda, 10 ficam reservados para o que o próprio sistema acrescenta, como o sufixo " 1/3" da parcela e o " 1/2" do pagamento parcial. |
| document | string <= 50 characters Documento de referência, como o número da nota, com até 50 caracteres. |
| amount required | number <double> decimal places <= 2 > 0 Valor do lançamento, maior que zero, com até 2 casas decimais. |
| currency | string = 3 characters Código da moeda do lançamento no padrão ISO 4217, entre as moedas ativas. Omitido, o lançamento é em real ( |
| issue_date | string <date> Data de emissão no formato ISO 8601 (AAAA-MM-DD). Quando omitida, é hoje, ou o vencimento ou a liquidação, quando forem anteriores. Não pode ser maior que o vencimento nem que a liquidação. |
| due_date required | string <date> Data de vencimento no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio de vencimento da empresa. |
| account_id | string <uuid> Conta prevista para a liquidação, pelo id de |
| operation_id | string <uuid> Operação própria, pelo id do produto de operação própria. Precisa estar ativa. Só em agência. |
| observations | string Observações do lançamento. |
| billing_account_id | string <uuid> Conta de cobrança do boleto, pelo id de |
| billet_demonstrative | string Demonstrativo do boleto, o texto que sai impresso nele. Só na conta a receber. |
required | Array of objects (bill_category_create) non-empty Categorias do lançamento, ao menos uma. A soma com sinal delas é o valor final. |
object Rateios do lançamento. Só em agência. | |
Array of objects (custom_field) Campos personalizados do financeiro, pelo id de | |
| settlement_date | string <date> Data de liquidação no formato ISO 8601 (AAAA-MM-DD), enviada junto com |
Array of objects (bill_movement_create) Movimentações da liquidação, enviadas junto com | |
| partial_payment | boolean Pagamento parcial, o mesmo que |
| balance_resolution | string Enum: "category" "partial" O que fazer com a diferença entre o que foi pago e o valor final, no lançamento criado já liquidado: |
| balance_category_id | string <uuid> Só com |
| recurrence_kind | string Enum: "installment" "recurrent" Gera a série a partir do lançamento, em segundo plano: |
| periodicity | string Enum: "weekly" "biweekly" "monthly" "bimonthly" "quarterly" "semiannual" "annual" Intervalo entre os lançamentos da série: |
| installments | integer [ 2 .. 200 ] Total de parcelas do parcelamento, de 2 a 200, contando a do próprio lançamento. Cada parcela repete o valor cheio. |
Conta a pagar com documento, conta prevista, duas categorias, rateio por centro de custo e entre empresas, e campo personalizado.
{- "company_identifier": "46598887000162",
- "transaction_kind": "debit",
- "person_id": "c3b7e8eb-1199-4457-9170-923c3fe56c92",
- "description": "Aluguel escritório - Outubro/2026",
- "document": "NF 1001",
- "amount": 1500,
- "issue_date": "2026-10-07",
- "due_date": "2026-10-15",
- "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
- "observations": "Contrato 2026/10",
- "categories": [
- {
- "category_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
- "amount": 1200,
- "description": "Aluguel"
}, - {
- "category_id": "e5f6a7b8-c9d0-4e1f-a2b3-c4d5e6f7a8b9",
- "amount": 300
}
], - "apportionments": {
- "per_cost_center": [
- {
- "cost_center_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
- "percentage": 60
}
], - "per_company": [
- {
- "company_identifier": "46598887000162",
- "percentage": 100
}
]
}, - "custom_fields": [
- {
- "id": 123,
- "value": "Matriz"
}
]
}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": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "person": {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}, - "company": {
- "id": "0a1b2c3d-4e5f-4677-8899-aabbccddeeff"
}, - "account": {
- "id": "c3d4e5f6-a7b8-4900-d1e2-f3a4b5c6d7e8"
}, - "payment_method": {
- "id": "a1a2a3a4-b5b6-4788-c9c0-d1d2d3d4d5d6"
}, - "operation": null,
- "invoice_rule": {
- "id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a"
}, - "created_by": {
- "id": "e5f6a7b8-c9d0-4122-f3a4-b5c6d7e8f9a0"
}, - "movements": [
- {
- "id": "3f2a6d7e-1b2c-4d5e-8f90-a1b2c3d4e5f6"
}
], - "apportionments": {
- "per_company": [
- {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "cost_center": {
- "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
}
}
]
}, - "custom_fields": [
- {
- "id": 123,
- "value": "Matriz"
}
], - "attachments": [
- {
- "id": "b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3",
- "description": "contrato.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "categories": [
- {
- "amount": 1500,
- "category": {
- "id": "b3c4d5e6-f7a8-4b9c-0d1e-2f3a4b5c6d7e"
}
}
], - "commissions": [ ],
- "items": [
- {
- "description": "Pacote turístico",
- "cost_center": "Alteração de pax",
- "checked": false,
- "amount": 1294.72,
- "sale": {
- "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b"
}, - "sale_product": {
- "id": "f0a1b2c3-d4e5-4966-a7b8-c9d0e1f2a3b4"
}, - "cvc_statement": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}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.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de detalhe de uma fatura de cliente, com categorias, movimentações, rateios, itens, anexos e campos personalizados.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "number": "12345",
- "transaction_kind": "credit",
- "kind": "customer_invoice",
- "description": "Fatura cliente - Janeiro/2026",
- "document": "NF 1001",
- "invoice_number": 42,
- "amount": 1500,
- "final_amount": 1500,
- "issue_date": "2026-01-10",
- "due_date": "2026-02-10",
- "settlement_date": null,
- "created_at": "2026-01-10T13:45:36",
- "canceled": false,
- "checked": false,
- "invoice_closed": false,
- "system_generated": false,
- "generates_credit": false,
- "periodicity": "without_periodicity",
- "recurrence_kind": "non_recurrent",
- "recurrence_group_id": null,
- "observations": null,
- "billet": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "person": {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}, - "company": {
- "id": "0a1b2c3d-4e5f-4677-8899-aabbccddeeff"
}, - "account": {
- "id": "c3d4e5f6-a7b8-4900-d1e2-f3a4b5c6d7e8"
}, - "payment_method": {
- "id": "a1a2a3a4-b5b6-4788-c9c0-d1d2d3d4d5d6"
}, - "operation": null,
- "invoice_rule": {
- "id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a"
}, - "created_by": {
- "id": "e5f6a7b8-c9d0-4122-f3a4-b5c6d7e8f9a0"
}, - "movements": [
- {
- "id": "3f2a6d7e-1b2c-4d5e-8f90-a1b2c3d4e5f6"
}
], - "apportionments": {
- "per_company": [
- {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "cost_center": {
- "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
}
}
]
}, - "custom_fields": [
- {
- "id": 123,
- "value": "Matriz"
}
], - "attachments": [
- {
- "id": "b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3",
- "description": "contrato.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "categories": [
- {
- "amount": 1500,
- "category": {
- "id": "b3c4d5e6-f7a8-4b9c-0d1e-2f3a4b5c6d7e"
}
}
], - "commissions": [ ],
- "items": [
- {
- "description": "Pacote turístico",
- "cost_center": "Alteração de pax",
- "checked": false,
- "amount": 1294.72,
- "sale": {
- "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b"
}, - "sale_product": {
- "id": "f0a1b2c3-d4e5-4966-a7b8-c9d0e1f2a3b4"
}, - "cvc_statement": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}Altera um lançamento financeiro, em aberto ou liquidado, com as mesmas regras do lançamento manual do Monde. Informe só os campos que devem mudar: o campo omitido permanece como está. document, observations e operation_id se esvaziam quando enviados como nulos; person_id, description, issue_date, due_date, account_id e amount são obrigatórios no lançamento, e enviá-los nulos ou vazios é recusado, assim como company_identifier nulo ou vazio. A lista enviada como nula vale como a vazia: categories nula é recusada como a lista vazia, e apportionments nulo esvazia os dois rateios (per_cost_center ou per_company nulo esvazia só aquele). Os campos personalizados não substituem: cada um enviado é gravado por cima do atual, o enviado com value nulo ou vazio é limpo, e os demais permanecem; os obrigatórios não precisam ser reenviados, mas não podem ser limpos. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).
O que se altera. Pessoa, descrição, documento, emissão, vencimento, conta prevista, operação própria, observações, campos personalizados, valor, categorias, rateios, empresa e, no lançamento liquidado, a data de liquidação e as movimentações. Esta operação não liquida nem estorna: para isso, use Liquidar conta a pagar ou receber e Desfazer a liquidação. A natureza (transaction_kind) não muda: enviada, é ignorada como qualquer campo fora do contrato.
Que lançamentos. Todo lançamento não excluído, em aberto ou liquidado, com as travas que o Monde aplica a cada tipo (kind). O excluído e a fatura inválida respondem 409.
sale_payment, ou com venda vinculada): pessoa, empresa e valor não mudam. No sale_standalone, só a empresa.customer_invoice, vendor_invoice, vendor_standalone): pessoa, empresa e valor original não mudam; o valor vem dos itens.credit_card_invoice): vencimento, empresa e valor não mudam, e ela não tem categorias. Os rateios dividem o valor final dela, a soma das compras do cartão.commission): como o lançamento avulso, mas sem operação própria.category_id. A operação própria só é aceita no lançamento avulso (normal) sem número de fatura, como no Monde.settlement_date muda a data de liquidação, que não pode ficar vazia nem passar da data da última movimentação. Mudar a data de liquidação para uma diferente da gravada exige também a permissão "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. A mesma data reenviada não pede a permissão. Cada item de movements com id aponta uma movimentação que o lançamento já tem, e muda só a conta, a forma de pagamento, a data, o valor, a taxa de cartão, o cheque ou o cartão enviados. O item sem id é uma movimentação nova, como o Adicionar do Monde, e vem com a conta, a forma de pagamento, a data e o valor. As movimentações não enviadas ficam como estão, e não é possível retirar movimentação. Os ids das movimentações vêm em movements de Consultar conta a pagar ou receber por ID. As movimentações precisam somar exatamente o valor final: mudar o valor pede a movimentação junto. Na movimentação com taxa de cartão (card_rate), o valor é o que o cliente pagou, e a conta recebe o valor menos a taxa: mudar só a taxa mantém o que o cliente pagou e muda o que entrou na conta, como no Monde, e a categoria de taxa de cartão acompanha, assim como a taxa cartão agência dos produtos da venda e a receita dela. A forma de pagamento da movimentação com taxa gerada pelo sistema não muda para outra que não seja cartão. A conta a receber pode passar para a conta cartão de crédito, com a forma cartão de crédito: é o estorno, que entra na fatura do cartão. A empresa do lançamento liquidado não muda. O caixa fechado e, em contas a receber, o bloqueio da data de movimentação valem como no Monde. Em lançamento em aberto, uma data em settlement_date ou uma movimentação em movements é recusada: esta operação não liquida.undo_bank_reconciliation como true. Com a confirmação, a alteração é gravada, e a conciliação dessa movimentação precisará ser refeita. A alteração que não mexe nas movimentações conciliadas, como a das categorias, dos rateios ou da descrição, mantém a conciliação e é gravada sem a confirmação.categories enviadas substituem as do lançamento, e a soma com sinal delas é o valor final, como na inserção: a diferença para amount é acréscimo ou desconto, sujeita ao bloqueio de acréscimo e desconto da empresa. A lista não pode ficar vazia. O amount enviado sem categories segue a regra do Monde: com uma categoria só, ela acompanha o novo valor; com mais de uma, o novo valor precisa ser igual à soma delas, senão é recusado e é preciso enviar as categorias junto.apportionments.per_cost_center pode ficar entre 0 e 100% do valor final, e apportionments.per_company, quando informado, precisa somar exatamente 100% e só aceita empresas em que a credencial também pode inserir lançamentos. A lista vazia retira o rateio.company_identifier leva o lançamento para outra empresa, e exige a permissão "Editar" de contas a pagar e receber também nela, que não pode estar somente leitura. O lançamento de outro usuário exige também, na empresa de destino, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); sem ele, a resposta é 403 com a mensagem do Monde. Sem account_id, a conta prevista continua a mesma se a nova empresa também a tem; senão, vale a conta de previsão padrão da nova empresa. Como no Monde, o lançamento com boleto registrado ou emitido não muda de empresa.recurrence_scope seja this_and_following: aí ela vale também para os lançamentos seguintes da série, como a opção "Atualizar este e próximos" do Monde. Os seguintes são alterados em segundo plano, logo depois da resposta. Nunca se levam a eles a liquidação, o número, o documento e os dados do boleto; o vencimento deles segue a periodicidade da série a partir do lançamento alterado, e na recorrência a emissão também. Cada seguinte só é alterado quando a credencial poderia alterá-lo diretamente, com as regras do fim desta descrição: a permissão "Editar" na empresa dele, que não pode estar somente leitura; no de outro usuário, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, a "Editar lançamento liquidado". O seguinte que não atende a isso fica como está, sem interromper os demais. O seguinte excluído também fica como está. Em lançamento fora de uma série, this_and_following é recusado.id. Vale também para o lançamento que a própria credencial criou.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| person_id | string <uuid> Pessoa do lançamento (cliente ou fornecedor), pelo id de |
| description | string <= 50 characters Descrição do lançamento, com até 50 caracteres. Não pode ser vazia. |
| document | string or null <= 50 characters Documento de referência, como o número da nota, com até 50 caracteres. Nulo limpa; o texto vazio é gravado. |
| issue_date | string <date> Data de emissão no formato ISO 8601 (AAAA-MM-DD). Não pode ser maior que o vencimento. |
| due_date | string <date> Data de vencimento no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio de vencimento da empresa. |
| account_id | string <uuid> Conta prevista para a liquidação, pelo id de |
| operation_id | string or null <uuid> Operação própria, pelo id do produto de operação própria. Precisa estar ativa. Só em agência e no lançamento avulso sem número de fatura. Nulo limpa. |
| observations | string or null Observações do lançamento. Nulo limpa; o texto vazio é gravado. |
| billing_account_id | string or null <uuid> Conta de cobrança do boleto, pelo id de |
| billet_demonstrative | string or null Demonstrativo do boleto, o texto que sai impresso nele. Só na conta a receber. Nulo ou texto vazio limpa: o Monde não grava demonstrativo vazio. |
| close_invoice | boolean Confirma o fechamento da fatura de cliente aberta junto com a conta de cobrança: |
| company_identifier | string = 14 characters ^[0-9]{14}$ CNPJ da empresa para onde o lançamento vai. A credencial precisa poder inserir lançamentos nela. Lançamento com boleto registrado ou emitido não muda de empresa. |
| amount | number <double> decimal places <= 2 > 0 Valor do lançamento, maior que zero, com até 2 casas decimais. Sem |
Array of objects (bill_category_create) non-empty Categorias do lançamento, ao menos uma. Substituem as atuais, e a soma com sinal delas é o valor final. | |
object or null Rateios do lançamento. Só em agência. Cada um enviado substitui o atual; o que não veio fica como está. | |
| recurrence_scope | string Enum: "only_this" "this_and_following" Só para lançamento de parcelamento ou recorrência: |
Array of objects (custom_field) Campos personalizados do financeiro, pelo id de | |
| settlement_date | string <date> Só em lançamento liquidado. Data de liquidação no formato ISO 8601 (AAAA-MM-DD). Não pode ficar vazia nem passar da data da última movimentação. |
Array of objects (bill_movement_update) Só em lançamento liquidado. Movimentações que o lançamento já tem, cada uma pelo id, com o que muda nela, e as novas, sem id, completas. As não enviadas ficam como estão; não é possível retirar movimentação. | |
| undo_bank_reconciliation | boolean Confirma a alteração que desfaz a conciliação bancária: |
Altera só os campos informados; os demais ficam como estão.
{- "description": "Aluguel escritório - Novembro/2026",
- "document": "NF 1002",
- "due_date": "2026-11-15",
- "observations": "Vencimento renegociado com o locador"
}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": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "person": {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}, - "company": {
- "id": "0a1b2c3d-4e5f-4677-8899-aabbccddeeff"
}, - "account": {
- "id": "c3d4e5f6-a7b8-4900-d1e2-f3a4b5c6d7e8"
}, - "payment_method": {
- "id": "a1a2a3a4-b5b6-4788-c9c0-d1d2d3d4d5d6"
}, - "operation": null,
- "invoice_rule": {
- "id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a"
}, - "created_by": {
- "id": "e5f6a7b8-c9d0-4122-f3a4-b5c6d7e8f9a0"
}, - "movements": [
- {
- "id": "3f2a6d7e-1b2c-4d5e-8f90-a1b2c3d4e5f6"
}
], - "apportionments": {
- "per_company": [
- {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "cost_center": {
- "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
}
}
]
}, - "custom_fields": [
- {
- "id": 123,
- "value": "Matriz"
}
], - "attachments": [
- {
- "id": "b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3",
- "description": "contrato.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "categories": [
- {
- "amount": 1500,
- "category": {
- "id": "b3c4d5e6-f7a8-4b9c-0d1e-2f3a4b5c6d7e"
}
}
], - "commissions": [ ],
- "items": [
- {
- "description": "Pacote turístico",
- "cost_center": "Alteração de pax",
- "checked": false,
- "amount": 1294.72,
- "sale": {
- "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b"
}, - "sale_product": {
- "id": "f0a1b2c3-d4e5-4966-a7b8-c9d0e1f2a3b4"
}, - "cvc_statement": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}Exclui o lançamento como o Monde exclui: ele não é apagado, fica marcado como excluído (canceled igual a true). Deixa de aparecer em Consultar contas a pagar e receber, a não ser que o parâmetro status peça as canceladas, e continua disponível na consulta por ID, com as categorias, os rateios e os anexos que tinha.
Que lançamentos. O lançamento avulso (normal) e a fatura de cliente e de fornecedor (customer_invoice, vendor_invoice, vendor_standalone). Na fatura, os itens saem dela: os de cliente voltam a ser faturados pelas regras de faturamento, os de fornecedor ficam a faturar (e voltam a ser faturados quando a agência fatura os fornecedores automaticamente), e os itens do extrato CVC lançados direto na fatura e os de venda cancelada são apagados. A fatura fica marcada como excluída, mesmo sem itens. Respondem 409, com o motivo:
sale_payment, sale_standalone ou com venda vinculada): ele sai pela exclusão da venda;credit_card_invoice), que sai sozinha quando fica sem lançamentos;commission);Sem confirmação. Esta é a exclusão sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. Por isso, o lançamento liquidado e o lançamento com movimentação conciliada respondem 409, e o recurrence_scope responde 422: no lançamento de uma série, o DELETE exclui só ele. Quando a recusa 409 pedir uma confirmação, ou para excluir também os seguintes da série, use Excluir conta a pagar ou receber com confirmação, que tem as mesmas regras e leva as confirmações no corpo.
A exclusão fica no log do lançamento, em nome da credencial.
Exige a permissão "Excluir" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura; a permissão "Editar" não basta. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", o lançamento liquidado responde 403, mesmo o que também seria recusado com 409, como o gerado por venda. A credencial exclui o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. Não exige Idempotency-Key: repetir a requisição depois de excluído responde 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Exclui o lançamento com as respostas às perguntas que o Monde faz antes de excluir: remover a liquidação, desfazer a conciliação bancária e excluir também os seguintes da série. É a mesma exclusão de Excluir conta a pagar ou receber, com as mesmas regras, permissões e respostas. A diferença é que as confirmações vão no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho.
O lançamento não é apagado: fica marcado como excluído (canceled igual a true), como no Monde. Os lançamentos aceitos e as recusas com 409 são os do DELETE.
Lançamento liquidado. Excluir remove a liquidação, e as movimentações saem das contas, como a pergunta "Essa conta já está liquidada. Deseja remover a liquidação e excluir?" do Monde. O pedido sem remove_settlement igual a true responde 409. Exige também a permissão "Editar lançamento liquidado" de contas a pagar e receber. O caixa fechado na data de alguma movimentação, e a movimentação de cartão de uma fatura de cartão já liquidada, impedem a exclusão: a resposta é 422 com o motivo.
Conciliação bancária. O lançamento com movimentação conciliada responde 409, com o aviso do Monde, até o pedido trazer undo_bank_reconciliation igual a true. Com a confirmação, a conciliação é desfeita e precisará ser refeita.
Parcelamento e recorrência. No lançamento de uma série, a exclusão vale só para ele, a menos que recurrence_scope seja this_and_following, como a opção "Excluir este e próximos" do Monde: os lançamentos seguintes da série que não têm movimentação são apagados, em segundo plano, logo depois da resposta, e a série deixa de se repetir. Cada seguinte só é apagado quando a credencial poderia excluí-lo diretamente: com a permissão "Excluir" de contas a pagar e receber na empresa dele, que não pode estar somente leitura; no de outro usuário, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, a "Editar lançamento liquidado". O seguinte que não atende a isso fica, fora da série. Os apagados não voltam. Em lançamento fora de uma série, this_and_following é recusado.
O corpo só leva essas confirmações, e o campo omitido vale como não confirmado. O valor fora do formato responde 422, antes das recusas com 409. A exclusão fica no log do lançamento, em nome da credencial.
Exige a permissão "Excluir" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura; a permissão "Editar" não basta. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", o lançamento liquidado responde 403. A credencial exclui o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde.
Exige Idempotency-Key: sem ela, a resposta é 400. O reenvio com a mesma chave devolve a resposta da primeira exclusão, 204 com o cabeçalho X-Idempotent-Replay: true, sem excluir de novo.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| recurrence_scope | string Enum: "only_this" "this_and_following" Só para lançamento de parcelamento ou recorrência: |
| remove_settlement | boolean Confirma a exclusão do lançamento liquidado, que remove a liquidação e as movimentações dele. Obrigatório como |
| undo_bank_reconciliation | boolean Confirma que a conciliação bancária do lançamento será desfeita. Obrigatório como |
{- "remove_settlement": true
}{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Liquida (dá baixa em) um lançamento em aberto, com as regras da liquidação do Monde. Envie a data de liquidação (settlement_date) e as movimentações (movements), uma por conta em que o dinheiro entrou ou saiu, com a conta, a forma de pagamento, a data e o valor, como na inserção já liquidada. Cada movimentação usa uma conta ativa vinculada à empresa do lançamento, e a forma de pagamento segue o tipo da conta: conta caixa e conta de cheques aceitam dinheiro ou cheque, conta cartão de crédito aceita só cartão de crédito, e conta corrente aceita as demais. Cheque exige o número. Parcelar (installments) só em conta cartão de crédito. A data de liquidação não pode ser maior que a data da última movimentação, e a emissão não pode ser maior que a liquidação.
Taxa de cartão e estorno. Na conta a receber recebida em cartão de crédito ou de débito numa conta corrente, card_rate é a taxa da operadora: a conta recebe amount menos a taxa, e a soma das taxas vira a categoria de taxa de cartão da empresa, que abate o valor final, como na inserção já liquidada. A conta a receber liquidada na conta cartão de crédito, com a forma cartão de crédito, é o estorno, que entra na fatura do cartão.
Valor pago diferente do valor final. Quando as movimentações não somam o valor final, diga o que fazer com a diferença em balance_resolution, como a pergunta do Monde ao liquidar:
category: a diferença vai para uma categoria, como desconto (pago a menos) ou acréscimo (pago a mais), e o valor final passa a ser o que foi pago. A categoria vem em balance_category_id; sem ela, vale a categoria padrão da empresa para aquele caso (desconto concedido ou recebido, acréscimo cobrado ou pago), e sem padrão o pedido é recusado. A categoria precisa ser do tipo que leva o valor final ao que foi pago: a de despesa numa conta a pagar paga a mais, por exemplo. Vale o bloqueio de acréscimo e desconto da empresa.partial: só quando foi pago menos que o valor final. O lançamento é liquidado com o que foi pago e ganha o sufixo " 1/2" na descrição, e o saldo vira um novo lançamento em aberto, com o sufixo " 2/2" e as mesmas categorias na proporção do saldo. O saldo vem em generated_bills.Sem balance_resolution, as movimentações precisam somar exatamente o valor final. Na fatura de cartão, a diferença vai sempre para a próxima fatura do mesmo cartão, sem escolha (balance_resolution não muda o destino dela): o que faltou pagar entra nela como dívida, e o que sobrou, como abatimento. Na fatura de cliente gerada pelo Monde e na fatura de fornecedor, exceto a da CVC, a API liquida só o valor total, e o pagamento menor ou maior que ele é recusado com 422. Nas demais faturas, a diferença se resolve só com category; o pagamento parcial é recusado com 422.
Que lançamentos. Todos os tipos, como no Monde: o lançamento avulso (normal), o pagamento da venda (sale_payment), o avulso da venda (sale_standalone), a comissão (commission), a fatura de cliente e de fornecedor (customer_invoice, vendor_invoice, vendor_standalone) e a fatura de cartão (credit_card_invoice). Respondem 409, com o motivo: o lançamento já liquidado (para mudar a baixa, use a alteração), o excluído e a fatura inválida. O lançamento em outra moeda se liquida como no Monde: o amount da movimentação é na moeda do lançamento e, na conta em outra moeda, entra convertido pelo câmbio (exchange_rate). A movimentação numa conta fora do real guarda o câmbio de referência da moeda da conta para o real (reference_exchange_rate). Como no Monde, os dois vêm sugeridos pela última cotação e podem ser corrigidos: omitidos, valem as cotações (sem cotação cadastrada para converter, 422); informados, valem os do banco.
Pagamento da venda. Cada pagamento feito à agência numa venda (dinheiro, cartão, boleto, cheque, depósito e outros, uma conta por parcela) é um lançamento sale_payment, e o id dele vem em payments.agency.bills de Consultar venda por ID e da resposta da inserção e da alteração da venda. Os pagamentos ao fornecedor e o crédito na agência não geram lançamento e não se liquidam. A baixa usa a forma e os dados de pagamento combinados na venda, como o "Liquidar usando dados da venda" do Monde: payment_method_id é opcional na movimentação e, ausente, vale a forma da venda; a movimentação que usa a forma da venda recebe o cartão ou o cheque informados nela, que card e check substituem quando enviados. A taxa de cartão calculada na venda passa para a primeira movimentação, quando ela é de cartão (senão, fica no lançamento), sem precisar enviar card_rate: como em toda movimentação com taxa, o amount é o que o cliente pagou, e a conta recebe o amount menos a taxa. A taxa de cartão da liquidação é rateada entre os produtos da venda, na taxa cartão agência deles, e sai da receita da venda, como no Monde. O saldo do pagamento parcial (balance_resolution igual a partial) nasce ligado à mesma venda, sem os sufixos " 1/2" e " 2/2" na descrição: ele aparece em payments.agency.bills da venda. No pagamento parcial, os itens do pagamento ficam no lançamento até o valor pago, e o item que passa dele é dividido: a parte paga fica, e o resto vai para o saldo, cada parte com a taxa cartão agência na proporção do seu valor. As categorias do saldo vêm das categorias padrão de fatura da empresa; sem elas, a liquidação é recusada com 422 e nada é gravado. Pessoa, empresa e valor do pagamento não mudam.
Regras do Monde. Em contas a receber valem o bloqueio da data de movimentação e o de acréscimo e desconto da empresa, que para a integração valem sempre. O caixa do dia fechado recusa a movimentação com o motivo, como O caixa do dia "14/10/2026" da conta "Caixa" está fechado. A liquidação e as movimentações ficam no log do lançamento, em nome da credencial.
As respostas seguem uma ordem: a permissão (403), o formato do pedido (422), a situação do lançamento (409) e as regras da liquidação e do Monde (422). Os erros de um item de movements trazem a posição dele, contada a partir de 0.
Exige a permissão "Editar" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura: liquidar é o mesmo direito de inserir o lançamento já liquidado. Exige também a permissão Liquidar conta a pagar ou Liquidar conta a receber, conforme a natureza do lançamento; sem ela, a resposta é 403 com a mensagem do Monde. A credencial liquida o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. A resposta traz o lançamento liquidado, igual a Consultar conta a pagar ou receber por ID, com o saldo do pagamento parcial em generated_bills, quando a credencial também tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento; sem ela, a liquidação é gravada do mesmo jeito e a resposta traz só o id. Vale também para o lançamento que a própria credencial criou.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| settlement_date required | string <date> Data de liquidação no formato ISO 8601 (AAAA-MM-DD). Não pode ser maior que a data da última movimentação, nem menor que a emissão. |
required | Array of objects (bill_movement_create) non-empty Movimentações da liquidação, ao menos uma: uma por conta em que o dinheiro entrou ou saiu. Sem |
| balance_resolution | string Enum: "category" "partial" O que fazer com a diferença entre o que foi pago e o valor final: |
| balance_category_id | string <uuid> Só com |
Conta de R$ 420,00 paga em dinheiro na conta caixa.
{- "settlement_date": "2026-10-14",
- "movements": [
- {
- "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
- "payment_method_id": "fc9f5c65-71b2-4bab-ba56-aee44fe6d998",
- "date": "2026-10-14",
- "amount": 420
}
]
}Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Desfaz a liquidação de um lançamento, como remover a liquidação no Monde: a data de liquidação fica em branco, as movimentações saem das contas e o lançamento volta a ficar em aberto. Saem junto a taxa de cartão e a taxa de banco geradas na liquidação, menos a taxa de cartão calculada na venda, que fica no pagamento da venda. A taxa cartão agência dos produtos da venda volta a zero, e a receita da venda deixa de descontá-la, como no Monde; numa nova liquidação, a taxa é rateada pelo valor de cada produto; o acréscimo e o desconto lançados nela ficam, e o valor final continua com eles. O lançamento com o saldo de um pagamento parcial também fica. O boleto em baixa pendente volta a registrado, e o crédito gerado pela liquidação é estornado. A remoção das movimentações fica no log do lançamento, em nome da credencial.
Que lançamentos. Os mesmos que a liquidação aceita. Respondem 409, com o motivo: o lançamento em aberto, o excluído e a fatura cujo saldo foi levado para outro lançamento (a liquidação dela não é desfeita enquanto o saldo estiver lá). Na fatura de cartão, o saldo levado à próxima fatura do mesmo cartão sai de lá junto; a recusa só vem quando essa próxima fatura já está liquidada.
Sem confirmação. Este é o desfazer sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. Por isso, o lançamento com movimentação conciliada responde 409, e o recurrence_scope responde 422: no lançamento de uma série, o DELETE desfaz só a liquidação dele. Quando a recusa 409 pedir a confirmação, ou para desfazer também a liquidação dos seguintes da série, use Desfazer a liquidação com confirmação, que tem as mesmas regras e leva as confirmações no corpo.
O caixa fechado na data de alguma movimentação, e a movimentação de cartão de uma fatura de cartão já liquidada, impedem desfazer: a resposta é 422 com o motivo.
Exige as permissões "Editar" e "Editar lançamento liquidado" de contas a pagar e receber, na empresa do lançamento, que não pode estar somente leitura. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", a resposta é 403 mesmo para o lançamento que já está em aberto. A credencial desfaz a liquidação do lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. Não exige Idempotency-Key: repetir a requisição depois de desfeita responde 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Desfaz a liquidação do lançamento com as respostas às perguntas do Monde: desfazer a conciliação bancária e desfazer também a liquidação dos seguintes da série. É o mesmo desfazer de Desfazer a liquidação de conta a pagar ou receber, com as mesmas regras, permissões e respostas. A diferença é que as confirmações vão no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho.
A data de liquidação fica em branco, as movimentações saem das contas e o lançamento volta a ficar em aberto, como no DELETE. Os lançamentos aceitos e as recusas com 409 também são os do DELETE.
Conciliação bancária. O lançamento com movimentação conciliada responde 409, com o aviso do Monde, até o pedido trazer undo_bank_reconciliation igual a true. Com a confirmação, a conciliação é desfeita e precisará ser refeita.
O caixa fechado na data de alguma movimentação, e a movimentação de cartão de uma fatura de cartão já liquidada, impedem desfazer: a resposta é 422 com o motivo. O corpo só leva as confirmações, e o campo omitido vale como não confirmado. O valor fora do formato responde 422, antes das recusas com 409.
Parcelamento e recorrência. No lançamento de uma série, desfaz só a liquidação dele, a menos que recurrence_scope seja this_and_following, como a opção "Atualizar este e próximos" do Monde: aí desfaz também a dos lançamentos seguintes da série que estão liquidados. Os seguintes em aberto, os excluídos e os anteriores ficam como estão. Cada seguinte passa pelas mesmas recusas do lançamento informado (o saldo levado a outro lançamento, a conciliação sem a confirmação de undo_bank_reconciliation) e exige que a credencial possa desfazer a liquidação dele diretamente. É tudo ou nada: se um deles não pode reabrir, nenhuma liquidação é desfeita, e a resposta é 409 com o seguinte que barrou e o motivo; o caixa fechado na data de uma movimentação de qualquer deles responde 422. Em lançamento fora de uma série, this_and_following é recusado com 422.
Exige as permissões "Editar" e "Editar lançamento liquidado" de contas a pagar e receber, na empresa do lançamento, que não pode estar somente leitura. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", a resposta é 403 mesmo para o lançamento que já está em aberto. A credencial desfaz a liquidação do lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde.
Exige Idempotency-Key: sem ela, a resposta é 400. O reenvio com a mesma chave devolve a resposta do primeiro pedido, 204 com o cabeçalho X-Idempotent-Replay: true, sem desfazer de novo.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| recurrence_scope | string Enum: "only_this" "this_and_following" Só para lançamento de parcelamento ou recorrência: |
| undo_bank_reconciliation | boolean Confirma que a conciliação bancária do lançamento será desfeita. Obrigatório como |
{- "recurrence_scope": "this_and_following",
- "undo_bank_reconciliation": true
}{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Liquida vários lançamentos em aberto numa chamada, como a liquidação dos lançamentos marcados na consulta do Monde. Envie os ids em bill_ids, até 100, sem repetir. Cada lançamento recebe a baixa do seu valor final inteiro, na mesma data (settlement_date), na mesma conta (account_id) e com a mesma forma de pagamento (payment_method_id) e os mesmos dados de cheque (check) ou de cartão (card). Para pagar só parte de um lançamento, ou dividir a baixa entre contas, use Liquidar conta a pagar ou receber.
Tudo ou nada. Se um dos lançamentos não pode ser liquidado, nenhum é, e a mensagem diz qual barrou, pelo número: Não é possível liquidar o lançamento Nº 71. O lançamento está excluído e não pode ser alterado..
Dados da venda. Com use_sale_data igual a true, cada pagamento da venda é liquidado com a forma e os dados de cheque ou cartão combinados na própria venda, como o "Liquidar usando dados da venda" do Monde. Vale só quando todos os lançamentos são pagamento da venda (sale_payment), e aí payment_method_id, check e card não são aceitos. O padrão é false.
Conta, forma e taxa de cartão. A conta precisa estar ativa e vinculada às empresas de todos os lançamentos, e a forma de pagamento segue o tipo da conta, como na liquidação de um lançamento: conta caixa e conta de cheques aceitam dinheiro ou cheque, conta cartão de crédito aceita só cartão de crédito, e conta corrente aceita as demais. Parcelar (installments) só em conta cartão de crédito. A taxa de cartão não é enviada: ela vem das categorias de cada lançamento, como no Monde, e card_rate é recusado.
Moeda. Os lançamentos precisam estar na mesma moeda. A conta em outra moeda só é aceita quando o Monde trabalha com mais de uma moeda (na operadora ou com multimoedas), como na liquidação em lote do Monde; nela, exchange_rate converte o valor de todos; omitido, vale a última cotação, e sem cotação cadastrada o pedido é recusado com 422.
Que lançamentos. Os mesmos que a liquidação de um lançamento aceita, com as mesmas recusas com 409: o lançamento já liquidado, o excluído e a fatura inválida. Valem as regras do Monde em cada um, como a emissão maior que a liquidação, os bloqueios da empresa e o caixa do dia fechado, que respondem 422 com o motivo. A liquidação e as movimentações ficam no log de cada lançamento, em nome da credencial.
As respostas seguem uma ordem: o lançamento que não existe (404, com os ids), a permissão (403), o formato do pedido (422), a situação de cada lançamento (409) e as regras da liquidação e do Monde (422).
Exige, em cada lançamento, as permissões da liquidação de um lançamento: "Editar" de contas a pagar e receber na empresa dele, que não pode estar somente leitura, e Liquidar conta a pagar ou Liquidar conta a receber, conforme a natureza dele. Basta faltar em um lançamento para a resposta ser 403 com a mensagem do Monde e nada ser liquidado. O alcance também é o mesmo: a credencial liquida os lançamentos que ela criou e, com o acesso aos lançamentos de outros usuários, os demais; o de fora desse acesso responde 404. A resposta traz em data os lançamentos liquidados, cada um igual a Consultar conta a pagar ou receber por ID, quando a credencial tem a permissão "Visualizar" de contas a pagar e receber na empresa dele; sem ela, a liquidação é gravada do mesmo jeito e vem só o id.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| bill_ids required | Array of strings <uuid> [ 1 .. 100 ] items unique [ items <uuid > ] Ids (UUID) dos lançamentos a liquidar, de 1 a 100, sem repetir. Todos precisam estar na mesma moeda. |
| settlement_date required | string <date> Data de liquidação no formato ISO 8601 (AAAA-MM-DD), a mesma para todos os lançamentos. É também a data das movimentações, e a emissão de cada lançamento não pode ser maior que ela. |
| account_id required | string <uuid> Conta em que o dinheiro entrou ou saiu, a mesma para todos os lançamentos: ativa e vinculada às empresas de todos eles. |
| use_sale_data | boolean Default: false Com |
| payment_method_id | string <uuid> Forma de pagamento, a mesma para todos os lançamentos, que segue o tipo da conta. Omitida, cada lançamento fica sem forma na movimentação. Não é aceita com |
| installments | integer [ 1 .. 99 ] Parcelas, de 1 a 99. Mais de uma só em conta cartão de crédito, em que cada parcela entra na fatura do mês dela. |
object Dados do cheque, só com a forma cheque, que exige o número. Não é aceito com | |
object Dados do cartão, só com as formas de cartão de crédito ou de débito. Não é aceito com | |
| exchange_rate | number <double> > 0 Câmbio da moeda dos lançamentos para a moeda da conta, o mesmo para todos, quando as duas são diferentes. Omitido, vale a última cotação; enviado com a conta na moeda dos lançamentos, é ignorado. |
Duas contas pagas em dinheiro na conta caixa, cada uma pelo valor final.
{- "bill_ids": [
- "212b54b8-27df-4859-80a9-79ad855bcd09",
- "6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f"
], - "settlement_date": "2026-10-14",
- "account_id": "8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01",
- "payment_method_id": "fc9f5c65-71b2-4bab-ba56-aee44fe6d998"
}Resposta para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa dos lançamentos: traz só o id de cada um.
{- "data": [
- {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - {
- "id": "6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f"
}
]
}Restaura um lançamento excluído, como o Restaurar do Monde: a exclusão é lógica, e o lançamento volta às consultas como estava antes de ser excluído, com as categorias, os rateios e os anexos. A liquidação que saiu junto na exclusão não volta: o lançamento restaurado fica em aberto, e para liquidá-lo de novo use Liquidar conta a pagar ou receber. O boleto que ficou aguardando a baixa no banco por causa da exclusão volta a registrado, exceto na conta de cobrança de fintech, em que a baixa já foi pedida ao banco. A restauração fica no log do lançamento, em nome da credencial.
Que lançamentos. Só o lançamento avulso (normal), como no Monde. Respondem 409, com o motivo: o lançamento que não está excluído, o gerado por uma venda (que é restaurado pela venda), a fatura de cliente e de fornecedor, a comissão e os demais tipos. Os lançamentos seguintes de uma série apagados pelo "excluir este e próximos" não existem mais e não voltam.
Exige as permissões "Restaurar" e "Editar" de contas a pagar e receber, na empresa do lançamento, que não pode estar somente leitura. A credencial restaura o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. Não exige Idempotency-Key nem corpo: repetir a requisição depois de restaurado responde 409. A resposta traz o lançamento restaurado, igual a Consultar conta a pagar ou receber por ID, quando a credencial tem a permissão "Visualizar" de contas a pagar e receber na empresa dele; sem essa permissão, traz apenas o id. Vale também para o lançamento que a própria credencial criou.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 Identificador único da conta a pagar ou receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de detalhe de uma fatura de cliente, com categorias, movimentações, rateios, itens, anexos e campos personalizados.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09",
- "number": "12345",
- "transaction_kind": "credit",
- "kind": "customer_invoice",
- "description": "Fatura cliente - Janeiro/2026",
- "document": "NF 1001",
- "invoice_number": 42,
- "amount": 1500,
- "final_amount": 1500,
- "issue_date": "2026-01-10",
- "due_date": "2026-02-10",
- "settlement_date": null,
- "created_at": "2026-01-10T13:45:36",
- "canceled": false,
- "checked": false,
- "invoice_closed": false,
- "system_generated": false,
- "generates_credit": false,
- "periodicity": "without_periodicity",
- "recurrence_kind": "non_recurrent",
- "recurrence_group_id": null,
- "observations": null,
- "billet": {
- "status": "registered",
- "number": 12345,
- "our_number": "000000012345",
- "amount": 1500,
- "demonstrative": "Pagável em qualquer banco até o vencimento.",
- "rejection_reason": null,
- "account": {
- "id": "d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9"
}
}, - "check": null,
- "card": null,
- "sale": null,
- "person": {
- "id": "a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6"
}, - "company": {
- "id": "0a1b2c3d-4e5f-4677-8899-aabbccddeeff"
}, - "account": {
- "id": "c3d4e5f6-a7b8-4900-d1e2-f3a4b5c6d7e8"
}, - "payment_method": {
- "id": "a1a2a3a4-b5b6-4788-c9c0-d1d2d3d4d5d6"
}, - "operation": null,
- "invoice_rule": {
- "id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a"
}, - "created_by": {
- "id": "e5f6a7b8-c9d0-4122-f3a4-b5c6d7e8f9a0"
}, - "movements": [
- {
- "id": "3f2a6d7e-1b2c-4d5e-8f90-a1b2c3d4e5f6"
}
], - "apportionments": {
- "per_company": [
- {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1"
}
}, - {
- "percentage": 50,
- "amount": 750,
- "company": {
- "id": "a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2"
}
}
], - "per_cost_center": [
- {
- "percentage": 100,
- "amount": 1500,
- "cost_center": {
- "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
}
}
]
}, - "custom_fields": [
- {
- "id": 123,
- "value": "Matriz"
}
], - "attachments": [
- {
- "id": "b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3",
- "description": "contrato.pdf",
- "extension": "pdf",
- "content_type": "application/pdf",
}
], - "categories": [
- {
- "amount": 1500,
- "category": {
- "id": "b3c4d5e6-f7a8-4b9c-0d1e-2f3a4b5c6d7e"
}
}
], - "commissions": [ ],
- "items": [
- {
- "description": "Pacote turístico",
- "cost_center": "Alteração de pax",
- "checked": false,
- "amount": 1294.72,
- "sale": {
- "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b"
}, - "sale_product": {
- "id": "f0a1b2c3-d4e5-4966-a7b8-c9d0e1f2a3b4"
}, - "cvc_statement": null
}, - {
- "description": null,
- "cost_center": null,
- "checked": false,
- "amount": 205.28,
- "sale": null,
- "sale_product": null,
- "cvc_statement": {
- "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}
}
], - "credit_card_items": [ ]
}Gera o boleto da conta a receber, como o Imprimir Boleto do Monde: o boleto que ainda não foi emitido é numerado e emitido, com a linha digitável e o código de barras, e o já emitido é devolvido de novo, com o mesmo número. O boleto registrado pelo PJBank é devolvido com o Pix copia e cola; enquanto ele está a caminho do banco, a resposta é 422, e é preciso esperar o registro. Para o PDF, use Baixar o PDF do boleto.
Conta de cobrança. O boleto sai pela conta de cobrança do lançamento, gravada em billing_account_id na inclusão ou na edição. Sem ela, vale a única conta de cobrança da empresa que emite sem registro; com mais de uma, a resposta é 422 com os ids delas, e a escolhida vai em billing_account_id, como o Monde pergunta. A escolhida fica gravada no lançamento.
Moeda estrangeira. O boleto sai em reais. No lançamento em outra moeda, envie o câmbio da emissão em exchange_rate: sem ele, a resposta é 422, como o Monde pergunta o câmbio.
Fatura de cliente aberta. O boleto cobra o que a fatura tem, e o Monde só o emite com a fatura fechada: ele pergunta se fecha a fatura. Pela API, a fatura de cliente aberta responde 409 até o pedido trazer close_invoice como true, que fecha a fatura e emite o boleto, com as regras e a permissão "Fechar Fatura" de Fechar fatura de cliente.
As recusas do Monde respondem 422 com a mensagem dele: a conta a pagar, a liquidada e a situação da cobrança que não permite emitir. O lançamento excluído responde 409.
Exige a permissão "Imprimir boleto" de vendas na empresa do lançamento e, no boleto que ainda não foi emitido, também "Gerar boletos" de contas a pagar e receber, com a empresa liberada para gravação, como no Monde. O alcance é o da consulta do lançamento.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da conta a receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| billing_account_id | string <uuid> Conta de cobrança do boleto, pelo id de |
| exchange_rate | number <double> Câmbio da emissão, maior que zero, no lançamento em moeda estrangeira: o boleto sai em reais. |
| close_invoice | boolean Confirma o fechamento da fatura de cliente aberta, para gerar o boleto dela. Sem ela, a fatura aberta responde 409. |
{ }{- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "number": 15838,
- "our_number": "109/00015838-6",
- "digitable_line": "34191.09008 01583.861412 04640.150005 7 16540000014935",
- "barcode": "34197165400000149351090015838614120464015000",
- "amount": 149.35,
- "due_date": "2026-11-20",
- "pix_code": null,
- "bank": {
- "code": "341-7",
- "name": "Itaú"
}
}Devolve o PDF do boleto já gerado, o mesmo que o Monde envia por e-mail: o recibo do pagador e a ficha de compensação, com o código de barras e, no PJBank, o QR do Pix. No lançamento em moeda estrangeira, o boleto sai com o câmbio da última geração.
O boleto que ainda não foi gerado responde 409: gere-o antes em Gerar boleto de conta a receber. A situação da cobrança que o Monde não imprime responde 422.
Exige a permissão "Imprimir boleto" de vendas na empresa do lançamento, com o alcance da consulta do lançamento.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da conta a receber. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Fecha a fatura de cliente, como o Fechar Fatura do Monde: a fatura fechada não aceita alteração nos itens, para poder ser enviada ao cliente. O primeiro fechamento numera a fatura e marca a data em que ela foi faturada; a fatura que nunca tinha sido faturada passa a ter a emissão no dia do fechamento. Fechar de novo depois de reabrir mantém o número.
Só a fatura de cliente é fechada. Respondem 409, com o motivo: o lançamento excluído, o que não é fatura de cliente e a fatura já fechada. Respondem 422, como no Monde: a emissão anterior à venda mais antiga dos itens e o item que ainda aguarda exclusão.
Exige a permissão "Fechar Fatura" de contas a pagar e receber na empresa da fatura, que não pode estar somente leitura. Não exige "Editar": como no Monde, basta a credencial alcançar a fatura, com o mesmo alcance da consulta. A resposta traz a fatura fechada, ou só o id dela para a credencial que não tem a permissão "Visualizar".
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Reabre a fatura de cliente fechada, como o Reabrir Fatura do Monde, para que os itens voltem a ser alterados. O número da fatura fica. Se a fatura já foi enviada ao cliente, considere fazer as alterações na próxima fatura.
Respondem 409, com o motivo: o lançamento excluído, o que não é fatura de cliente e a fatura que não está fechada. O item que ainda aguarda exclusão impede reabrir, com 422, como no Monde.
Exige a permissão "Reabrir Fatura" de contas a pagar e receber na empresa da fatura, que não pode estar somente leitura, com o mesmo alcance de Fechar fatura de cliente. Não exige Idempotency-Key nem corpo: repetir a requisição depois de reaberta responde 409.
| id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Altera as duas colunas que o Monde edita na grade dos itens da fatura. checked marca ou desmarca o item como conferido, e vale na fatura de fornecedor gerada pelo Monde e no avulso de fornecedor. cost_center troca o centro de custo do item, e vale na fatura de cliente gerada pelo Monde, fora da base de operadora, que não mostra a coluna. Com pagante pessoa jurídica, o centro de custo precisa ser um dos cadastrados nele (a comparação ignora maiúsculas e espaços nas pontas, e o item fica com o nome como está no cadastro), a não ser que a agência use o centro de custo em texto livre; null limpa o centro de custo. O item que fica igual a outro da fatura é somado a ele, como no Monde.
Item somado a outro. Dois itens da fatura são iguais quando têm o mesmo produto de venda, lado, tipo e centro de custo. O item que fica igual a outro é somado a ele e deixa de existir, e o id dele passa a responder 404. Isso acontece na troca do centro de custo, em que some o item alterado e fica o outro, e quando o item entra em outra fatura, em que some o item que entrou e fica o que já estava lá. O reembolso não é somado. Depois de cada ação sobre os itens, os id que valem são os de items da resposta; para reencontrar a linha, use sale_product, side, kind e cost_center. A repetição com a mesma Idempotency-Key devolve a resposta original, com os id daquele momento: para os de agora, consulte a fatura em Consultar conta a pagar ou receber por ID.
Que faturas. As ações sobre os itens valem na fatura de cliente, na fatura de fornecedor e no avulso de fornecedor, exceto na fatura de fornecedor da CVC. Respondem 409, com o motivo: o lançamento excluído, o que não é uma dessas faturas, a fatura liquidada, a fatura fechada e o campo que não vale naquela fatura. O Monde pergunta se desfaz a liquidação ou reabre a fatura e repete a operação; pela API, desfaça a liquidação em Desfazer a liquidação de conta a pagar ou receber ou reabra a fatura em Reabrir fatura de cliente antes de repetir.
Exige a permissão "Editar" de contas a pagar e receber na empresa da fatura, com o mesmo alcance da edição do lançamento. O item que não é da fatura responde 404. A resposta traz a fatura como ficou, igual a Consultar conta a pagar ou receber por ID, ou só o id dela para a credencial que não tem a permissão "Visualizar".
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| id required | string <uuid> Example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 ID do item da fatura, o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| checked | boolean Marca o item como conferido ( |
| cost_center | string or null <= 50 characters Centro de custo do item. |
{- "checked": true
}Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Corrige os valores de um item, como o Corrigir valores do Monde. Vale na fatura de cliente e na de fornecedor geradas pelo Monde, no item ligado a um produto de venda. value é o valor novo do item, com o sinal dele, e a diferença vai para a próxima fatura. Na fatura de fornecedor, a comissão, o over e as taxas de cartão (cc_du_fee e cc_rav_fee) mudam no produto da venda, e o item da fatura acompanha; a comissão e o over aceitam o percentual ou o valor, e o outro é calculado sobre a base do produto. Na fatura de cliente, só value. O campo omitido fica como está. O item corrigido continua com o mesmo id; a diferença é um item novo na próxima fatura, onde pode ser somada a um item igual.
Mudar value pede a fatura em aberto: a liquidada e a fechada respondem 409. A comissão, o over e as taxas mudam mesmo com a fatura fechada, e o acerto vai para outra fatura do fornecedor. A taxa de cartão maior que a taxa do produto responde 422, como no Monde.
Exige as permissões "Editar" e "Alterar taxa CC" de contas a pagar e receber, na empresa da fatura. Quando a correção muda de fato a comissão, o over ou as taxas do produto de uma venda fechada, exige também "Alterar dados do produto em vendas fechadas" de vendas; e, na venda com recibo impresso, "Alterar vendas com recibo impresso". Sem elas, a resposta é 403 com a mensagem do Monde.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| id required | string <uuid> Example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 ID do item da fatura, o |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| value | number <double> Valor novo do item, com o sinal dele. A diferença vai para a próxima fatura. |
| commission_percentage | number <double> Percentual de comissão do produto da venda. Só na fatura de fornecedor. |
| commission_amount | number <double> Valor da comissão do produto da venda. Só na fatura de fornecedor. |
| over_percentage | number <double> Percentual de over do produto da venda. Só na fatura de fornecedor. |
| over_amount | number <double> Valor do over do produto da venda. Só na fatura de fornecedor. |
| cc_du_fee | number <double> Taxa CC DU do produto da venda, que não pode passar da taxa DU. Só na fatura de fornecedor de passagem aérea. |
| cc_rav_fee | number <double> Taxa CC RAV do produto da venda, que não pode passar da taxa RAV. Só na fatura de fornecedor. |
{- "commission_amount": 20
}Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Traz para a fatura itens de outra fatura em aberto, como o Adicionar itens à fatura do Monde. Os itens que podem entrar são os que Itens que podem entrar na fatura lista: da mesma pessoa, empresa e moeda, de fatura que não está liquidada nem fechada. A fatura de cliente recebe itens de outra fatura de cliente; a fatura de fornecedor e o avulso de fornecedor, da fatura de fornecedor gerada pelo Monde e do avulso de fornecedor. O id que não pode entrar recusa a chamada inteira com 422, e nada é movido. A fatura de onde o item sai, se ficar sem itens, é excluída. O item que entra igual a um item da fatura é somado a ele: o id enviado deixa de existir, e a resposta traz o item que já estava, com a soma. Veja Item somado a outro em Alterar conferido ou centro de custo de item da fatura.
Valem as mesmas faturas e recusas de Alterar conferido ou centro de custo de item da fatura, e a mesma permissão "Editar". A resposta traz a fatura como ficou.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| item_ids required | Array of strings <uuid> non-empty [ items <uuid > ] IDs dos itens em que a ação age. |
{- "item_ids": [
- "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30"
]
}Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}Lista os itens das faturas e das contas a pagar e receber, um por linha, com a venda de origem e o lançamento em que cada um está: é a composição de cada pagamento. Com date_field=settlement_date e o período, vêm os itens de tudo o que foi liquidado no mês, sem abrir fatura por fatura.
O amount tem o sinal que o Monde grava, e os itens de um lançamento somam o valor dele, negativo na conta a pagar. Numa fatura de fornecedor, o que é pago ao fornecedor sai negativo e o que é recebido do cliente, positivo. A soma fecha com o valor do lançamento, não com o valor final da baixa.
Os itens do mesmo lançamento vêm juntos, da liquidação mais recente para a mais antiga, e os de lançamento em aberto vêm no fim. O item de lançamento excluído e o que ainda não está em lançamento ficam de fora.
Exige a permissão "Visualizar" de contas a pagar e receber e alcança os mesmos lançamentos de Consultar contas a pagar e receber.
| bill_id | string <uuid> Example: bill_id=212b54b8-27df-4859-80a9-79ad855bcd09 ID do lançamento: só os itens dele. É o |
| account_id | string <uuid> Example: account_id=6e0216e5-5536-4f4b-8c93-36371398b3cf ID da conta do lançamento: só os itens dos lançamentos dela. |
| person_id | string <uuid> Example: person_id=7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a ID da pessoa do item. |
| side | string Enum: "vendor" "customer" Example: side=vendor Lado do item: |
| date_field | string Enum: "settlement_date" "due_date" "issue_date" Example: date_field=settlement_date Data do período: |
| date_from | string <date> Example: date_from=2026-10-01 Início do período, inclusive (AAAA-MM-DD). |
| date_to | string <date> Example: date_to=2026-10-31 Fim do período, inclusive (AAAA-MM-DD). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "id": "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30",
- "description": "Pacote Cancún",
- "cost_center": null,
- "checked": true,
- "amount": -22000,
- "side": "vendor",
- "kind": "invoice",
- "document": "LOC111",
- "issue_date": "2026-10-01",
- "person": {
- "id": "7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a"
}, - "sale": {
- "id": "0b6f3d1a-6c2e-4a8f-9d71-2e5c8b4a7f10"
}, - "sale_product": {
- "id": "9a1c2e3f-4b5d-4e6f-8a7b-1c2d3e4f5a6b"
}, - "cvc_statement": null,
- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "settlement_date": "2026-10-15"
}, - {
- "id": "8e1d2c3b-4a5f-4e6d-9c8b-7a6f5e4d3c2b",
- "description": "Comissão recebida do cliente",
- "cost_center": null,
- "checked": true,
- "amount": 12000,
- "side": "customer",
- "kind": "invoice",
- "document": "LOC333",
- "issue_date": "2026-10-02",
- "person": {
- "id": "2bda359b-9554-43a5-a220-d145d70c01cb"
}, - "sale": {
- "id": "d05a6c2d-25d0-498d-881f-c906d327b3a0"
}, - "sale_product": {
- "id": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9"
}, - "cvc_statement": null,
- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "settlement_date": "2026-10-15"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Lista os itens que Adicionar itens à fatura aceita, com a fatura em que cada um está e o vencimento dela, do vencimento mais antigo ao mais novo. Só entram as faturas que a credencial alcança. q busca, como no Monde, pelo número da fatura e da venda, pelo documento do produto, pela descrição do item, pelo fornecedor, pelo valor e pelas datas da venda e do vencimento.
Exige a permissão "Editar" de contas a pagar e receber na empresa da fatura. O lançamento excluído e o que não é fatura com itens respondem 409.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| q | string Example: q=Hospedagem Texto a buscar nos itens. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "id": "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30",
- "description": "Diárias de Hospedagem",
- "cost_center": null,
- "checked": false,
- "amount": -400,
- "side": "vendor",
- "kind": "invoice",
- "document": "HTL-20931",
- "issue_date": "2026-07-20",
- "person": {
- "id": "7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a"
}, - "sale": {
- "id": "0b6f3d1a-6c2e-4a8f-9d71-2e5c8b4a7f10"
}, - "sale_product": {
- "id": "9a1c2e3f-4b5d-4e6f-8a7b-1c2d3e4f5a6b"
}, - "cvc_statement": null,
- "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "due_date": "2026-08-05"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Manda cada item para a fatura que a regra de faturamento dele aponta, como o Monde faz em duas ações com o mesmo motor. Na fatura de cliente lançada à mão é o Remover itens da fatura: o item sai dela e vai para a fatura gerada pelo Monde. Na fatura gerada pelo Monde é o Recalcular vencimento dos itens selecionados: o item muda de fatura se a regra mudou depois do faturamento. Nas demais faturas, responde 409. O id que não é desta fatura recusa a chamada inteira com 422.
Valem as mesmas recusas de Alterar conferido ou centro de custo de item da fatura. Exige a permissão "Editar" de contas a pagar e receber, também no Recalcular vencimento, que o Monde não cobra. A resposta traz a fatura como ficou e, em reprocessed_items, onde cada item enviado ficou: a fatura (bill) e o item nela (item). O item é o próprio item ou, quando a fatura de destino já tinha um item igual, o item a que ele foi somado; o item que a regra mantém na fatura aparece com a própria fatura. A fatura que fica sem itens é excluída, e a resposta traz só reprocessed_items.
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| item_ids required | Array of strings <uuid> non-empty [ items <uuid > ] IDs dos itens em que a ação age. |
{- "item_ids": [
- "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30"
]
}{- "reprocessed_items": [
- {
- "id": "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30",
- "bill": {
- "id": "9a1d6c3e-52b7-4e0f-8a3d-1f6b2c7e4d90"
}, - "item": {
- "id": "0b7e2f4a-6c1d-4a9e-b3f5-8d2c1e7a6f40"
}
}
]
}Leva os itens para uma fatura avulsa nova, lançada à mão, como o Faturar Avulso do Monde: avulso de fornecedor quando os itens são de fornecedor, e fatura de cliente quando são de cliente. O vencimento é o de due_date ou, sem ele, hoje, como no Monde. O item sem valor fica na fatura; sem nenhum item com valor, a resposta é 422. O id que não é desta fatura recusa a chamada inteira com 422. A fatura de onde os itens saem, se ficar sem itens, é excluída. Os itens continuam com o mesmo id na fatura nova.
Valem as mesmas faturas e recusas de Alterar conferido ou centro de custo de item da fatura, e a mesma permissão "Editar". A resposta é 201 com a fatura nova, ou só o id dela para a credencial que não tem a permissão "Visualizar".
| bill_id required | string <uuid> Example: 212b54b8-27df-4859-80a9-79ad855bcd09 ID da fatura. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| item_ids required | Array of strings <uuid> non-empty [ items <uuid > ] IDs dos itens em que a ação age. |
| due_date | string <date> Vencimento da fatura avulsa. Sem ele, vence hoje. |
{- "item_ids": [
- "5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30"
]
}Resposta da alteração para a credencial que não tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento, mesmo no lançamento que ela criou: traz apenas o id do lançamento.
{- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}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.
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}.
| 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.
|
| date_field | string Value: "movement_date" Example: date_field=movement_date Campo de data usado no filtro. Valor aceito: movement_date (data da movimentação). Obrigatório quando date_from ou date_to é informado. |
| date_from | string <date> Example: date_from=2026-10-01 Filtrar movimentações com data igual ou posterior a esta, no formato ISO 8601 (AAAA-MM-DD). |
| date_to | string <date> Example: date_to=2026-10-31 Filtrar movimentações com data igual ou anterior a esta, no formato ISO 8601 (AAAA-MM-DD). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com uma liquidação em cartão e uma transferência entre contas.
{- "data": [
- {
- "id": "6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42",
- "date": "2026-01-26",
- "amount": -9112.17,
- "transaction_kind": "debit",
- "description": null,
- "check": null,
- "card": {
- "brand": "MasterCard",
- "last_digits": "4117",
- "authorization": "600551159"
}
}, - {
- "id": "0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40",
- "date": "2026-01-26",
- "amount": 63063,
- "transaction_kind": "credit",
- "description": "Repasse diário",
- "check": null,
- "card": null
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}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.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Identificador da movimentação. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
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": {
- "brand": "MasterCard",
- "last_digits": "4117",
- "authorization": "600551159"
}, - "account": {
- "id": "f9d961b8-ea88-4346-8e52-afe94267417a"
}, - "payment_method": {
- "id": "c3b7e8eb-1199-4457-9170-923c3fe56c92"
}, - "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "credit_card_invoice": null,
- "counterpart_account": null
}Saldo, extrato e fechamento de caixa de uma conta corrente ou caixa, como na tela Extrato de Conta do Monde. Conta de outro tipo (cartão de crédito, cheques, investimento) responde 404. O saldo e o extrato são do recurso Saldo e Extrato, separado da leitura de Contas e Cartões, com a permissão Extrato de Conta, como no Monde. Fechar e reabrir o caixa pedem as permissões Fechar Caixa e Reabrir Caixa do recurso Contas e Cartões, uma para cada ação, como no Monde. Pela conexão automática, ler o saldo e o extrato e fechar e reabrir o caixa são exceção concedida pelo Monde na aprovação: o extrato traz todas as movimentações da conta e o fechamento vale para a conta inteira, inclusive para o que a agência lançou. Basta que uma das empresas da conta conceda a permissão. O fechamento é uma marca d'água: fechar um dia fecha todos até ele, e com o caixa fechado o Monde recusa incluir, alterar ou excluir movimentação naqueles dias.
Saldo da conta ao fim do dia informado: o saldo inicial da conta mais todas as movimentações até a data, inclusive. É o mesmo saldo com que o extrato fecha aquele dia.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID da conta corrente ou caixa, o mesmo de Contas e Cartões. |
| date | string <date> Example: date=2026-10-15 Data do saldo (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "date": "2026-10-15",
- "currency": "BRL",
- "balance": 1849.75,
- "cash_closed_until": "2026-10-10"
}Extrato da conta no período, linha a linha como no Monde: o saldo anterior, as movimentações de cada dia (lançamentos e transferências, na ordem em que foram gravadas) e o saldo ao fim de cada dia que teve movimentação, com a indicação de caixa fechado. Não pagina: o período tem no máximo 45 dias. Como traz nome e documento das pessoas, cada consulta fica registrada no Histórico como uma exportação do Extrato de Conta.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID da conta corrente ou caixa, o mesmo de Contas e Cartões. |
| date_from required | string <date> Example: date_from=2026-10-01 Primeiro dia do extrato (ISO 8601, |
| date_to required | string <date> Example: date_to=2026-10-15 Último dia do extrato (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "currency": "BRL",
- "date_from": "2026-10-01",
- "date_to": "2026-10-15",
- "cash_closed_until": "2026-10-10",
- "opening_balance": 2000,
- "closing_balance": 1849.75,
- "data": [
- {
- "type": "opening_balance",
- "date": "2026-09-30",
- "balance": 2000,
- "cash_closed": true
}, - {
- "type": "bill_movement",
- "date": "2026-10-02",
- "account_movement": {
- "id": "3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
}, - "bill": {
- "id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d"
}, - "sale": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "number": "1520",
- "description": "Pacote Lisboa",
- "document": null,
- "person": {
- "name": "Ana Souza",
- "document": "52998224725"
}, - "check": null,
- "card": {
- "brand": "Visa",
- "last_digits": "1234",
- "ticket_card": null
}, - "billet": null,
- "amount": 0
}, - {
- "type": "daily_balance",
- "date": "2026-10-02",
- "balance": 2000,
- "cash_closed": true
}, - {
- "type": "transfer",
- "date": "2026-10-15",
- "account_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "bill": null,
- "sale": null,
- "number": null,
- "description": "Transferência para: Banco. Sangria do caixa",
- "document": null,
- "person": null,
- "check": null,
- "card": null,
- "billet": null,
- "amount": -150.25
}, - {
- "type": "daily_balance",
- "date": "2026-10-15",
- "balance": 1849.75,
- "cash_closed": false
}
]
}Fecha o caixa da conta até o dia informado, com as regras do Monde: não fecha dia futuro nem dia já fechado (para isso, reabra antes). Quando expected_balance vem, o fechamento é recusado se o saldo do dia mudou desde a leitura, como a conferência da tela. Só conta corrente ou caixa ativa; a empresa somente leitura não fecha. O fechamento fica no log da conta com a credencial. Exige Idempotency-Key.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID da conta corrente ou caixa, o mesmo de Contas e Cartões. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| date required | string <date> Dia até o qual o caixa fica fechado (ISO 8601, |
| expected_balance | number <double> Saldo do dia conferido pelo integrador (o |
{- "date": "2026-10-15",
- "expected_balance": 1849.75
}{- "account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "cash_closed_until": "2026-10-15"
}Reabre o caixa a partir do dia informado: ele e os dias seguintes voltam a aceitar movimentação. Só recua o fechamento; reabrir um dia que já está aberto responde 422. A reabertura fica no log da conta com a credencial. Não exige Idempotency-Key.
| account_id required | string <uuid> Example: f9d961b8-ea88-4346-8e52-afe94267417a ID da conta corrente ou caixa, o mesmo de Contas e Cartões. |
| date required | string <date> Example: 2026-10-10 Dia a reabrir (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Consulte, crie, altere e exclua as transferências entre as contas da agência, como na tela de Transferência do Monde. Uma transferência são duas movimentações irmãs: a saída na conta de origem (forma de pagamento Débito em conta) e a entrada na conta de destino (Depósito bancário). As duas aparecem também em Movimentações e no extrato. Só transferem contas corrente ou caixa ativas, e as duas contas precisam estar em empresas em que a credencial tem a permissão: alcançar uma das contas não basta. O caixa fechado na data recusa a gravação, a alteração e a exclusão, como no Monde. Permissões do recurso Transferências entre Contas, as do Monde: Transferência entre Contas (consultar), Editar (inserir e alterar), Excluir e Visualizar Log, que mostra o histórico das transferências em Logs (origem conta_movimento). Pela conexão automática, consultar, editar, excluir e ver o log são exceção concedida pelo Monde na aprovação: a transferência não guarda quem a lançou, então quem a lê ou grava alcança também as que a agência lançou.
Lista as transferências cujas duas contas estão em empresas em que a credencial pode ler transferências, da mais recente para a mais antiga. Cada transferência aparece uma vez, pela movimentação de origem.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| account_id | string <uuid> Example: account_id=f9d961b8-ea88-4346-8e52-afe94267417a Filtra as transferências que saem ou entram nesta conta (UUID). |
| date_from | string <date> Example: date_from=2026-10-01 Data inicial da transferência (ISO 8601, |
| date_to | string <date> Example: date_to=2026-10-31 Data final da transferência (ISO 8601, |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cria a transferência com as regras da tela do Monde: contas corrente ou caixa ativas, diferentes entre si, valor maior que zero e descrição de até 100 caracteres. As duas contas precisam estar em empresas em que a credencial insere e edita transferências, fora das empresas somente leitura. A inclusão fica no log com a credencial. A resposta traz a transferência só para quem também pode lê-la; aos demais, só o id. Exige Idempotency-Key.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| date required | string <date> Data da transferência (ISO 8601, |
| origin_account_id required | string <uuid> Conta de onde o valor sai: o |
| destination_account_id required | string <uuid> Conta onde o valor entra: o |
| amount required | number <double> Valor a transferir, maior que zero e com até 2 casas decimais. |
| description | string or null <= 100 characters Descrição da transferência, com até 100 caracteres. |
{- "date": "2026-10-15",
- "origin_account_id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853",
- "destination_account_id": "6e0216e5-5536-4f4b-8c93-36371398b3cf",
- "amount": 150.25,
- "description": "Sangria do caixa"
}{- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}Devolve a transferência. Ela pode ser aberta pelo ID de qualquer das duas movimentações, e responde sempre pela de origem.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}Altera só os campos enviados; o omitido fica como está, e a description enviada nula é apagada. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). As contas continuam conferidas mesmo quando não vêm no corpo: a transferência cuja conta deixou de ser corrente ou caixa ativa só é gravada escolhendo outra. Quando uma das movimentações está na conciliação bancária, mudar a data, o valor ou a conta dela desfaz a conciliação, e essa alteração pede undo_bank_reconciliation como true, como o aviso do Monde: sem ela, a resposta é 409. Mudar só a descrição mantém a conciliação e grava sem a confirmação. A alteração fica no log com a credencial. A resposta traz a transferência só para quem também pode lê-la; aos demais, só o id. Exige Idempotency-Key.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| date | string <date> Data da transferência (ISO 8601, |
| origin_account_id | string <uuid> Conta de onde o valor sai: o |
| destination_account_id | string <uuid> Conta onde o valor entra: o |
| amount | number <double> Valor a transferir, maior que zero e com até 2 casas decimais. |
| description | string or null <= 100 characters Descrição da transferência, com até 100 caracteres. |
| undo_bank_reconciliation | boolean Confirma que a gravação pode desfazer a conciliação bancária de uma das movimentações. Sem ela, a exclusão da transferência conciliada e a alteração que muda a data, o valor ou a conta da movimentação conciliada respondem 409. |
{- "amount": 200
}{- "id": "857569b5-2721-4756-a27a-748168e00606",
- "date": "2026-10-15",
- "amount": 150.25,
- "description": "Sangria do caixa",
- "origin_account": {
- "id": "ddecf0c0-c13d-43e9-b14b-c394a8bbe853"
}, - "destination_account": {
- "id": "6e0216e5-5536-4f4b-8c93-36371398b3cf"
}, - "origin_movement": {
- "id": "857569b5-2721-4756-a27a-748168e00606"
}, - "destination_movement": {
- "id": "21268e50-5cdb-47f9-9ba8-6c0b1f521419"
}
}Exclui as duas movimentações da transferência, sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. Quando uma das movimentações está na conciliação bancária, a exclusão desfaz a conciliação, e por isso a resposta é 409. Nesse caso, para excluir mesmo assim, use Excluir transferência com confirmação. A exclusão não fica no log, como no Monde. Exige a permissão Excluir de Transferências entre Contas nas empresas das duas contas, que não podem estar somente leitura. Não exige Idempotency-Key: repetir responde 404.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Exclui as duas movimentações da transferência com a confirmação que o Monde pede quando uma delas está na conciliação bancária. É a mesma exclusão de Excluir transferência, com as mesmas regras, permissões e respostas. A diferença é que a confirmação vai no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho. Quando uma das movimentações está na conciliação bancária, a exclusão desfaz a conciliação: sem undo_bank_reconciliation como true, a resposta é 409; com a confirmação, a conciliação é desfeita e precisará ser refeita. O valor que não é booleano responde 422. A exclusão não fica no log, como no Monde. Exige a permissão Excluir de Transferências entre Contas nas empresas das duas contas, que não podem estar somente leitura. Exige Idempotency-Key: sem ela, a resposta é 400. Como a transferência excluída deixa de existir, o reenvio depois da exclusão responde 404.
| id required | string <uuid> Example: 857569b5-2721-4756-a27a-748168e00606 ID da transferência, que é o ID da movimentação de origem. O ID da movimentação de destino também é aceito e devolve a mesma transferência. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| undo_bank_reconciliation | boolean Confirma que a gravação pode desfazer a conciliação bancária de uma das movimentações. Sem ela, a exclusão da transferência conciliada e a alteração que muda a data, o valor ou a conta da movimentação conciliada respondem 409. |
{- "undo_bank_reconciliation": true
}{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Consulte, lance e exclua os reembolsos das vendas: lado do reembolso, valor, datas e as referências para a venda, o produto da venda, a pessoa, a empresa e a conta a pagar ou a receber.
Retorna os reembolsos das empresas em que a credencial tem permissão.
| refund_type | string Enum: "customer" "vendor" Example: refund_type=customer Filtra pelo lado do reembolso.
|
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com um reembolso de fornecedor e um reembolso de cliente.
{- "data": [
- {
- "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"
}, - {
- "id": "0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40",
- "refund_type": "customer",
- "amount": -1208.89,
- "description": "Reembolso devido ao cancelamento da viagem",
- "issue_date": "2022-04-09",
- "due_date": "2022-05-24"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna um reembolso pelo identificador. É o endpoint que resolve as referências a reembolsos devolvidas por outros recursos.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Identificador do reembolso. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
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": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "sale_product": {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92"
}, - "person": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "bill": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}
}Exclui o reembolso, como a exclusão do reembolso na venda do Monde. O reembolso ainda sem fatura sai sozinho; o que está numa fatura sai dela, e a fatura que fica vazia sai junto. O reembolso do produto e a receita da venda voltam ao que eram.
Responde 409 quando a fatura do reembolso está liquidada ou fechada (reabra-a no Monde antes) ou quando o reembolso está num lançamento que não é fatura. O reembolso ao cliente, que no Monde sai pela grade de pagamentos da venda, só é excluído na venda aberta: na venda fechada, responde 409 (reabra a venda no Monde antes).
O reembolso do fornecedor que já virou conta a pagar/receber o Monde não exclui pela venda: é o que está na conta gerada só para ele (bill no lançamento) ou, com a fatura automática de fornecedor desligada (e nos produtos importados da CVC), o que está em qualquer fatura. No Monde, ele sai excluindo a conta, depois de confirmar. Este DELETE é a exclusão sem confirmação: ele não tem corpo, e o corpo enviado é ignorado. Por isso, esse reembolso responde 409 e nada muda. Para confirmar a exclusão da conta, use Excluir reembolso com confirmação.
No Monde, excluir o reembolso é editar a venda, sem permissão própria: exige a permissão Editar de Vendas na empresa do reembolso, que não pode ser somente leitura, e, na venda que a credencial não criou, Editar vendas de outros vendedores. O reembolso do fornecedor, que no Monde sai pela aba Financeiro da venda, exige também Ver aba financeiro. Na venda com recibo impresso, o reembolso ao cliente e o do fornecedor exigem também Alterar vendas com recibo impresso.
Exige o Idempotency-Key, porque a exclusão muda o financeiro. Como o reembolso excluído deixa de existir, o reenvio com a mesma chave depois da exclusão responde 404, sem excluir nada de novo.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Identificador do reembolso. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Exclui o reembolso com a confirmação que o Monde pede antes de excluir a conta a pagar/receber em que ele está. É a mesma exclusão de Excluir reembolso, com as mesmas regras, permissões e respostas. A diferença é que a confirmação vai no corpo deste POST, e não no DELETE: o corpo do DELETE não tem significado no HTTP (RFC 9110), e proxies e clientes HTTP podem descartá-lo no caminho.
O reembolso ainda sem fatura sai sozinho; o que está numa fatura sai dela, e a fatura que fica vazia sai junto. O reembolso do produto e a receita da venda voltam ao que eram. As recusas com 409 do DELETE valem aqui também: a fatura liquidada ou fechada, o lançamento que não é fatura e o reembolso ao cliente na venda fechada.
O reembolso do fornecedor que já virou conta a pagar/receber o Monde não exclui pela venda: é o que está na conta gerada só para ele (bill no lançamento) ou, com a fatura automática de fornecedor desligada (e nos produtos importados da CVC), o que está em qualquer fatura. No Monde, ele sai excluindo a conta, depois de confirmar. Aqui, a confirmação vai em remove_from_bill: sem ela como true, a exclusão responde 409 e nada muda; com ela, a conta inteira é excluída, como no Monde: o reembolso sai, e os outros itens da conta não são apagados, voltam a ficar pendentes, sem fatura (com a fatura automática de fornecedor ligada, voltam para a fatura das regras de faturamento). Exemplo: a fatura de R$ 1.200,00 com este reembolso de R$ 200,00 e outro item de R$ 1.000,00 é excluída; o reembolso some, e o item de R$ 1.000,00 volta a ficar pendente. O que impede excluir a conta no Monde (como a fatura do sistema que ainda tem itens) responde 409, e nada muda.
No Monde, excluir o reembolso é editar a venda, sem permissão própria: exige a permissão Editar de Vendas na empresa do reembolso, que não pode ser somente leitura, e, na venda que a credencial não criou, Editar vendas de outros vendedores. O reembolso do fornecedor, que no Monde sai pela aba Financeiro da venda, exige também Ver aba financeiro. Na venda com recibo impresso, o reembolso ao cliente e o do fornecedor exigem também Alterar vendas com recibo impresso. Excluir com remove_from_bill a conta inteira é, no Monde, excluir o lançamento: exige também Editar e Excluir de Contas a Pagar e Receber sobre essa conta e, na conta de outro usuário, o acesso aos lançamentos dos outros usuários; sem elas, 403.
Exige o Idempotency-Key: sem ela, a resposta é 400. Como o reembolso excluído deixa de existir, o reenvio depois da exclusão responde 404, sem excluir nada de novo.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Identificador do reembolso. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| remove_from_bill | boolean Confirma a exclusão do reembolso do fornecedor que já virou conta a pagar/receber: a conta inteira é excluída, e os outros itens dela voltam a ficar pendentes, sem fatura. Obrigatório como |
{- "remove_from_bill": true
}{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Lança o reembolso de um produto da venda, como as ações Reembolso Cliente e Reembolso Fornecedor do produto no Monde. O reembolso entra no reembolso do produto e, por ele, na receita da venda.
customer: a agência devolve o valor ao cliente. O reembolso é lançado negativo, em nome de person_id (o pagante da venda, quando omitido), na moeda de venda do produto e com vencimento no dia.vendor: o fornecedor devolve o valor à agência (credit, o padrão) ou a agência paga o fornecedor (debit), em nome do representante do produto ou, sem ele, do fornecedor, na moeda de venda do produto (na operadora, na moeda de origem).billing, invoice (Faturar) manda o reembolso para a fatura pelas regras de faturamento, em segundo plano: a do cliente sempre; a do fornecedor só com a fatura automática de fornecedor ligada, e fora dos produtos da CVC. Até lá, bill volta nulo. bill (Gerar conta a pagar/receber) gera na hora uma fatura avulsa só com o reembolso, com vencimento no dia, que volta em bill. 409), e o produto não pode estar excluído. O reembolso ao cliente só existe na agência: na operadora, responde 403. São recusados com 422: o reembolso com o controle de crédito ligado, o reembolso do fornecedor de operação própria e o reembolso sem a categoria padrão de reembolso configurada na empresa. id.| id required | string <uuid> Example: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63 Identificador da venda do produto reembolsado. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| sale_product_id required | string <uuid> Identificador do produto da venda reembolsado, como aparece no produto dentro da venda. |
| refund_type required | string Enum: "customer" "vendor" Lado do reembolso.
|
| amount required | number <double> > 0 Valor do reembolso, positivo. O sinal sai de |
| transaction_kind | string Enum: "credit" "debit" Direção do dinheiro para a agência.
|
| billing required | string Enum: "invoice" "bill" Como o reembolso é cobrado.
|
| issue_date | string <date> Data de emissão do reembolso. Quando omitida, é a data do dia. |
| description | string <= 100 characters Descrição do reembolso, com até 100 caracteres. |
| person_id | string <uuid> Pessoa que recebe o reembolso ao cliente. Quando omitida, é o pagante da venda. Não vale no reembolso do fornecedor. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe. |
| cost_center | string <= 50 characters Centro de custo do reembolso ao cliente, só com |
Exemplo de reembolso ao cliente que vai para a fatura do cliente.
{- "sale_product_id": "e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148",
- "refund_type": "customer",
- "amount": 1208.89,
- "billing": "invoice",
- "issue_date": "2022-04-09",
- "description": "Reembolso devido ao cancelamento da viagem",
- "person_id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}Exemplo de reembolso de cliente ainda sem conta a pagar ou a receber.
{- "id": "0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40",
- "refund_type": "customer",
- "amount": -1208.89,
- "description": "Reembolso devido ao cancelamento da viagem",
- "issue_date": "2022-04-09",
- "due_date": "2022-05-24",
- "sale": {
- "id": "3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63"
}, - "sale_product": {
- "id": "e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148"
}, - "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "bill": null
}Os relatórios do Monde, com a mesma consulta da tela: a API e o relatório trazem as mesmas linhas, com os mesmos filtros. Cada relatório pede a permissão dele, como no Monde, e alcança só as empresas em que a credencial tem a permissão e que têm licença. As linhas vêm paginadas por cursor. Como os relatórios trazem dados de contato e documentos das pessoas, cada página consultada fica registrada no Histórico como uma exportação do relatório.
Os passageiros dos produtos vendidos, como o relatório Lista de Passageiros do Monde: uma linha por passageiro de cada produto, com os dados de contato, os documentos e o endereço dele, os trechos aéreos com o assento, os detalhes e os valores do produto e as pessoas da venda. É a mesma consulta do relatório, então a API e a tela trazem os mesmos passageiros. Pede a permissão Lista de Passageiros do recurso Lista de Passageiros, como no Monde. Sem a permissão Consultar passageiros de outros vendedores/intermediários, vêm só os passageiros das vendas que a própria integração criou. Pela conexão automática, essa permissão é exceção concedida pelo Monde na aprovação.
Os passageiros vêm em ordem de embarque e, no mesmo dia, pelo passageiro. Fica de fora o produto excluído e, sem include_canceled, o passageiro cancelado. A empresa sem a permissão na credencial ou sem licença não entra. Como no Monde, o aprovador e a operação própria só vêm na agência, e o promotor só na operadora: o campo que não é do tipo da agência não vem na resposta. Como traz contato e documentos dos passageiros, cada página consultada fica registrada no Histórico como uma exportação da Lista de Passageiros.
| date_field | string Enum: "departure_date" "arrival_date" "sale_date" "canceled_at" Example: date_field=departure_date Data que |
| date_from | string <date> Example: date_from=2026-11-01 Primeiro dia do período (ISO 8601, |
| date_to | string <date> Example: date_to=2026-11-30 Último dia do período (ISO 8601, |
| status | Array of strings Items Enum: "opened" "closed" "canceled" Example: status=opened,closed Situações da venda, separadas por vírgula: |
| include_canceled | boolean Com |
| person_id | string <uuid> Example: person_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só o passageiro desta pessoa. |
| payer_id | string <uuid> Example: payer_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas deste pagante. |
| seller_id | string <uuid> Example: seller_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas deste vendedor. Junto de |
| intermediary_id | string <uuid> Example: intermediary_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas deste intermediário. Junto de |
| requester_id | string <uuid> Example: requester_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas deste solicitante. |
| approver_id | string <uuid> Example: approver_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas deste aprovador. |
| promoter_id | string <uuid> Example: promoter_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas deste promotor. |
| product_id | string <uuid> Example: product_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só os produtos deste produto do cadastro, inclusive as vendas em que ele é a operação própria, como no Monde. |
| supplier_id | string <uuid> Example: supplier_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só os produtos deste fornecedor. |
| representative_id | string <uuid> Example: representative_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só os produtos deste representante. |
| city_id | string <uuid> Example: city_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só os passageiros que moram nesta cidade, a do cadastro da pessoa. |
| company_id | Array of strings <uuid> [ items <uuid > ] Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Só as vendas destas empresas, separadas por vírgula. |
| label_id | Array of strings <uuid> [ items <uuid > ] Example: label_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Só os passageiros com algum destes marcadores, separados por vírgula. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Um passageiro de passagem aérea com conexão numa venda fechada, dentro de uma viagem, com assento marcado só no primeiro trecho.
{- "data": [
- {
- "id": "2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35",
- "person": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "name": "Ana Souza",
- "emission_name": "SOUZA/ANA",
- "gender": "F",
- "birthdate": "1990-05-04",
- "birthplace": "Florianópolis",
- "cpf": "52998224725",
- "rg": "1234456",
- "rg_issuing_agency": "SSP",
- "rg_issue_date": "2008-03-02",
- "birth_certificate": null,
- "passport_number": "FX123456",
- "passport_expiration_date": "2031-02-03",
- "email": "ana@example.com",
- "phone_number": "4833221100",
- "mobile_number": "48999887766",
- "address": {
- "postal_code": "88010000",
- "street": "Rua Felipe Schmidt",
- "street_number": "100",
- "additional_info": "Apto 301",
- "neighborhood": "Centro",
- "city_name": "Florianópolis",
- "state_code": "SC"
}, - "ticket_number": "0472345678901",
- "cost_center": null,
- "canceled_at": null,
- "sale": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10",
- "number": 1024,
- "date": "2026-10-01",
- "status": "closed"
}, - "sale_product": {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92"
}, - "product": {
- "id": "a2c099e8-d6af-4de5-8d74-3005dd49d632",
- "name": "Passagem Aérea"
}, - "supplier": {
- "id": "3f1c9e20-5d7a-4b6c-9e2f-1a2b3c4d5e6f",
- "name": "Companhia Aérea",
- "city_name": "São Paulo"
}, - "representative": null,
- "departure_date": "2026-11-10T23:55:00",
- "arrival_date": "2026-11-11T17:05:00",
- "destination": "international",
- "document": "ABC123",
- "product_details": {
- "nights": null,
- "accommodation_kind": null,
- "room_category": null,
- "meal_plan": null,
- "cabin_kind": null,
- "cabin_number": null,
- "cabin_category": null,
- "ship_name": null,
- "cruise_destination": null,
- "vehicle_category": null,
- "pickup_location": null,
- "dropoff_location": null,
- "package_name": null,
- "transport": null
}, - "airline_segments": [
- {
- "airline_code": "TP",
- "flight_number": "88",
- "class": "Y",
- "origin": "GRU",
- "departure_date": "2026-11-10T23:55:00",
- "destination": "LIS",
- "arrival_date": "2026-11-11T13:40:00",
- "seat_number": "12A"
}, - {
- "airline_code": "TP",
- "flight_number": "1950",
- "class": "Y",
- "origin": "LIS",
- "departure_date": "2026-11-11T16:10:00",
- "destination": "OPO",
- "arrival_date": "2026-11-11T17:05:00",
- "seat_number": null
}
], - "amounts": {
- "currency": "BRL",
- "amount": 3200,
- "fees": 420.5,
- "other_fees": 0,
- "total_fees": 420.5,
- "du_fee": 0,
- "du_fee_discount": 0,
- "rav_fee": 150,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "customer_amount": 3200,
- "total_amount": 3770.5
}, - "external_number": null,
- "additional1": null,
- "additional2": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Agência Matriz"
}, - "seller": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64",
- "name": "Carlos Vendedor"
}, - "payer": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Ana Souza",
- "phone_number": "4833221100"
}, - "intermediary": null,
- "requester": null,
- "approver": null,
- "own_operation": null,
- "travel": {
- "id": "8b649124-14e2-4c43-b24f-2423e8db0423",
- "number": "000001",
- "description": "Lua de mel"
}, - "custom_fields": {
- "person": [ ],
- "sale": [
- {
- "id": 12,
- "value": "Indicação"
}
], - "travel": [ ]
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Os produtos vendidos, como o relatório Vendas por Produto do Monde: uma linha por produto, com as pessoas da venda, os detalhes e os valores do produto, os passageiros, as notas fiscais e os trechos aéreos. É a mesma consulta do relatório, então a API e a tela trazem os mesmos produtos. Pede a permissão Vendas por Produto do recurso Vendas por Produto, como no Monde. Sem a permissão Consultar vendas de outros vendedores/intermediários, vêm só os produtos das vendas que a própria integração criou. Pela conexão automática, essa permissão é exceção concedida pelo Monde na aprovação. Sem a permissão Visualizar comissão, over e receitas, o objeto commission não vem.
Os produtos vêm da venda mais recente para a mais antiga e, na mesma data, pelo número da venda. Fica de fora o produto excluído. A empresa sem a permissão na credencial ou sem licença não entra. Como no Monde, com mais de uma moeda (na operadora, ou na agência com multimoedas) não vêm os abatimentos, o Adicional 1, as notas fiscais nem o over sobre, e o promotor só vem nesse caso. O Número Externo e os Adicionais sem título nas Configurações também não vêm. Como traz contato e documento do pagante, cada página consultada fica registrada no Histórico como uma exportação de Vendas por Produto.
| date_field | string Enum: "sale_date" "departure_date" "arrival_date" "canceled_at" Example: date_field=sale_date Data que |
| date_from | string <date> Example: date_from=2026-10-01 Primeiro dia do período (ISO 8601, |
| date_to | string <date> Example: date_to=2026-10-31 Último dia do período (ISO 8601, |
| status | Array of strings Items Enum: "opened" "closed" "canceled" Example: status=opened,closed Situações da venda, separadas por vírgula: |
| product_status | Array of strings Items Enum: "active" "canceled" Example: product_status=active Situações do produto, separadas por vírgula: |
| seller_id | string <uuid> Example: seller_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas deste vendedor. |
| product_id | string <uuid> Example: product_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só os produtos vendidos deste produto do cadastro. |
| supplier_representative_id | string <uuid> Example: supplier_representative_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só os produtos em que esta pessoa é o fornecedor ou o representante, como o filtro Fornecedor/Representante do Monde. |
| own_operation_id | string <uuid> Example: own_operation_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Só as vendas desta operação própria. |
| company_id | Array of strings <uuid> [ items <uuid > ] Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Só as vendas destas empresas, separadas por vírgula. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Uma passagem aérea com um passageiro, uma nota fiscal e a comissão, numa agência sem multimoedas.
{- "data": [
- {
- "id": "2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35",
- "sale": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10",
- "number": 1024,
- "date": "2026-10-01",
- "status": "closed"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Viagens Floripa"
}, - "own_operation": null,
- "seller": {
- "id": "7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
- "name": "Carla Mendes"
}, - "payer": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Ana Souza",
- "person_kind": "individual",
- "cpf_cnpj": "52998224725",
- "email": "ana@example.com",
- "phone_number": "4833221100",
- "mobile_number": "48999887766"
}, - "requester": null,
- "intermediary": null,
- "approver": null,
- "travel": {
- "id": "4d5e6f70-8192-4a3b-9c4d-5e6f708192a3",
- "number": "000001",
- "description": "Lua de mel"
}, - "product": {
- "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
- "name": "Passagem Aérea"
}, - "supplier": {
- "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "name": "TAP Air Portugal",
- "city_name": "Lisboa",
- "state_code": null,
- "country_name": "Portugal"
}, - "representative": {
- "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
- "name": "Consolidadora Sul"
}, - "status": "active",
- "departure_date": "2026-11-10T23:55:00",
- "arrival_date": "2026-11-20T10:15:00",
- "canceled_at": null,
- "quantity": 1,
- "destination": "international",
- "document": "ABC123",
- "external_number": null,
- "additional1": null,
- "additional2": null,
- "product_details": {
- "nights": null,
- "accommodation_kind": null,
- "room_category": null,
- "meal_plan": null,
- "cabin_kind": null,
- "cabin_number": null,
- "cabin_category": null,
- "ship_name": null,
- "cruise_destination": null,
- "vehicle_category": null,
- "pickup_location": null,
- "dropoff_location": null,
- "package_name": null,
- "transport": null
}, - "passengers": [
- {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91",
- "name": "Ana Souza"
}
], - "nfs": [
- {
- "id": "6f7a8b9c-0d1e-4f2a-8b3c-4d5e6f7a8b9c",
- "nfse_number": "2026000123"
}
], - "airline_segments": [
- {
- "airline_code": "TP",
- "flight_number": "88",
- "class": "Y",
- "origin": "GRU",
- "departure_date": "2026-11-10T23:55:00",
- "destination": "LIS",
- "arrival_date": "2026-11-11T13:40:00"
}
], - "amounts": {
- "currency": "BRL",
- "unit_amount": 4500,
- "unit_fees": 380,
- "total_products": 4500,
- "fees": 380,
- "other_fees": 0,
- "total_fees": 380,
- "du_fee": 120,
- "cc_du_fee": 0,
- "cc_du_fee_percentage": 0,
- "du_fee_discount": 0,
- "rav_fee": 0,
- "cc_rav_fee": 0,
- "cc_rav_fee_percentage": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "agency_service_fee": 0,
- "discount": 0,
- "total_discount": 0,
- "deductions": 0,
- "billing": 5000,
- "total_amount": 5000,
- "customer_refund": 0,
- "supplier_refund": 0,
- "agency_card_rate": 0,
- "supplier_fine": 0,
- "deleted_balance": 0,
- "kandir_retention": 0
}, - "origin_amounts": {
- "currency": "BRL",
- "exchange_rate": 1,
- "total_products": 4500,
- "total_fees": 380,
- "agency_fee": 0,
- "du_fee": 120,
- "deductions": 0,
- "agency_service_fee": 0,
- "discount": 0,
- "du_fee_discount": 0,
- "rav_fee_discount": 0,
- "total_amount": 5000
}, - "commission": {
- "commission_amount": 450,
- "commission_percentage": 10,
- "over": 0,
- "over_amount": 0,
- "over_percentage": 0,
- "intermediary_commission_amount": 0,
- "intermediary_commission_percentage": 0,
- "intermediary_over_amount": 0,
- "intermediary_over_percentage": 0,
- "revenue": 570,
- "revenue_percentage": 11.4
}, - "custom_fields": {
- "person": [ ],
- "sale": [ ],
- "travel": [ ]
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Os valores das vendas somados por vendedor, como o relatório Vendas por Vendedor do Monde: uma linha por vendedor e empresa, com a quantidade de vendas e de produtos e todas as colunas de valores do relatório. É a mesma consulta do relatório, então a API e a tela somam os mesmos produtos. Quem vende em mais de uma empresa vem numa linha por empresa. Pede a permissão Vendas por Vendedor do recurso Vendas por Vendedor, como no Monde, e não existe na operadora. Sem a permissão Consultar vendas de outros vendedores/intermediários, a soma traz só as vendas que a própria integração criou. Pela conexão automática, essa permissão é exceção concedida pelo Monde na aprovação.
As linhas vêm em ordem alfabética do vendedor. Ficam de fora a venda cancelada e o produto excluído. A empresa sem a permissão na credencial ou sem licença não entra. O período da venda é obrigatório, em date_from e date_to: para somar vários anos, consulte um período de cada vez. Cada página consultada fica registrada no Histórico como uma exportação de Vendas por Vendedor.
| date_field | string Value: "sale_date" Example: date_field=sale_date Data que |
| date_from required | string <date> Example: date_from=2026-10-01 Primeiro dia do período da venda (ISO 8601, |
| date_to required | string <date> Example: date_to=2026-10-31 Último dia do período da venda (ISO 8601, |
| status | Array of strings Items Enum: "opened" "closed" Example: status=closed Situações da venda, separadas por vírgula: |
| product_status | Array of strings Items Enum: "active" "canceled" Example: product_status=active Situações do produto, separadas por vírgula: |
| seller_id | Array of strings <uuid> [ items <uuid > ] Example: seller_id=7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f Só estes vendedores, separados por vírgula. |
| company_id | Array of strings <uuid> [ items <uuid > ] Example: company_id=e5d9aaed-33bb-4679-b392-b45e5cd78eb4 Só as vendas destas empresas, separadas por vírgula. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Uma vendedora com doze vendas fechadas no mês, numa empresa.
{- "data": [
- {
- "seller": {
- "id": "7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
- "name": "Carla Mendes"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4",
- "name": "Viagens Floripa"
}, - "sales_count": 12,
- "products_count": 18,
- "amounts": {
- "total_amount": 65421.65,
- "billing": 60441.25,
- "total_products": 58210,
- "total_fees": 4980.4,
- "du_fee": 1450,
- "cc_du_fee": 0,
- "du_fee_discount": 0,
- "rav_fee": 960,
- "cc_rav_fee": 0,
- "rav_fee_discount": 0,
- "agency_fee": 0,
- "agency_service_fee": 0,
- "discount": 178.75,
- "deductions": 0
}, - "commission": {
- "commission_amount": 5390.5,
- "over_amount": 420,
- "intermediary_commission_amount": 0,
- "intermediary_over_amount": 0,
- "revenue": 7616.32
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}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.
Retorna os recibos das empresas em que a credencial tem permissão. Recibo excluído não é retornado.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
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": [
- {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92",
- "receipt_number": "89100000164635",
- "movement_date": "2019-12-29",
- "sale_date": "2019-12-29T18:00:00",
- "cancellation_date": null,
- "boarding_date": "2020-04-10",
- "return_date": "2020-04-15",
- "product_name": "Hotel Internacional",
- "package_name": "MADRI",
- "total_payments": 2068.04,
- "total_taxes": 0,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 0,
- "retained_commission": 0,
- "intermediary_commission": 0,
- "deposit": 0,
- "opfax": 1826.4,
- "opfax_balance": 200.9,
- "balance": 0,
- "imported": true,
- "edited": false,
- "checked": false,
- "deleted": false,
- "created_at": "2019-12-30T12:14:02"
}, - {
- "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"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}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.
| id required | string <uuid> Example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 Identificador do recibo do extrato CVC. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
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": {
- "code": 0,
- "name": "BAIXA DE RECIBO"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "contractor": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "seller": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "intermediary": null,
- "sale": {
- "id": "212b54b8-27df-4859-80a9-79ad855bcd09"
}, - "sale_product": {
- "id": "3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63"
}, - "nf": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "created_by": {
- "id": "1c4d8f2a-5b73-4e91-a6c8-3d90f2e5b174"
}
}Consulte os recibos do Master - Extrato da CVC, os de "Repasse Master Franqueado". O Master - Extrato existe só na empresa ligada como agência master franqueado, em Configurações › CVC: a empresa sem essa configuração fica fora da consulta, e a consulta por ID nela responde 403. O recibo sai no mesmo formato do Extrato CVC.
Retorna os recibos do Master - Extrato das empresas em que a credencial tem permissão e que estão ligadas como agência master franqueado, da movimentação mais recente para a mais antiga. Recibo excluído não é retornado.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com um recibo importado.
{- "data": [
- {
- "id": "8a5f1d27-3e9c-4b80-b6d2-1c7e4f9a3b56",
- "receipt_number": "0217000001198",
- "movement_date": "2026-09-08",
- "sale_date": "2026-08-28T15:12:00",
- "cancellation_date": null,
- "boarding_date": "2026-11-03",
- "return_date": "2026-11-10",
- "product_name": "Fácil Internacional",
- "package_name": "LISBOA",
- "total_payments": 6230.5,
- "total_taxes": 0,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 623.05,
- "retained_commission": 0,
- "intermediary_commission": 0,
- "deposit": 0,
- "opfax": 0,
- "opfax_balance": 0,
- "balance": 623.05,
- "imported": true,
- "edited": false,
- "checked": false,
- "deleted": false,
- "created_at": "2026-09-09T07:05:41"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna um recibo do Master - Extrato pelo identificador, incluindo o recibo já excluído, que vem com o campo deleted verdadeiro. O recibo de outro tipo de movimento responde 404: ele é consultado pelo Extrato CVC.
| id required | string <uuid> Example: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84 Identificador do recibo do Master - Extrato. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Recibo digitado, sem nota fiscal.
{- "id": "4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84",
- "receipt_number": "0217000001234",
- "movement_date": "2026-09-10",
- "sale_date": "2026-09-02T00:00:00",
- "cancellation_date": null,
- "boarding_date": null,
- "return_date": null,
- "product_name": null,
- "package_name": null,
- "total_payments": 4800,
- "total_taxes": 120,
- "total_discounts": 0,
- "total_abatement": 0,
- "calculated_commission": 480,
- "retained_commission": 0,
- "intermediary_commission": 96,
- "deposit": 0,
- "opfax": 0,
- "opfax_balance": 0,
- "balance": 384,
- "imported": false,
- "edited": true,
- "checked": false,
- "deleted": false,
- "created_at": "2026-09-10T14:32:05",
- "movement_kind": {
- "name": "Repasse Master Franqueado"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "contractor": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "seller": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "intermediary": null,
- "sale": null,
- "sale_product": null,
- "nf": null,
- "created_by": null
}Consulte as notas fiscais de serviço: numeração, situação, datas, valores, retenções e tributos, os dados do tomador gravados na nota (com a referência para a cidade dele), os dados da NFS-e e, na consulta por ID, os itens e as referências para pessoa, empresa, produto da venda e venda.
Também é possível inserir, editar e excluir a nota fiscal avulsa e executar as ações sobre ela: emitir a NFS-e, cancelar, informar a emissão feita na prefeitura, ajustar o valor, remover a numeração, criar a cópia para reemissão e baixar o XML. As permissões são as do Monde: gravar e as ações que só mudam a nota pedem Editar, excluir pede Excluir, emitir a NFS-e e cancelar pelo e-Notas pedem Emitir NFS-e, e criar a cópia para reemissão pede Criar cópia para reemissão. As notas fiscais não existem na instalação de operadora (consolidadora): nela, a gravação responde 403.
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.
| 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.
|
| 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 |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com uma nota cancelada e uma nota emitida.
{- "data": [
- {
- "id": "c71a5d38-0b64-4e29-9d17-6f2e8a4b3c05",
- "number": 982680,
- "series": "1",
- "issue_date": "2023-02-27",
- "status": "canceled",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": null,
- "document": "9572810403321",
- "manual_emission": true,
- "amount": 1840,
- "service_amount": 1840,
- "net_amount": 1748,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Nota cancelada a pedido do tomador.",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": "2023-03-02T09:14:52",
- "created_at": "2023-02-27T10:03:41",
- "recipient": {
- "kind": "supplier",
- "name": "Azul Linhas Aéreas Brasileiras S.A.",
- "cpf_cnpj": "09296295000160",
- "state_inscription": "2536987410",
- "city_inscription": "1023456",
- "postal_code": "06460040",
- "street": "Avenida Marcos Penteado de Ulhoa Rodrigues",
- "street_number": "939",
- "neighborhood": "Tamboré",
- "additional_info": null,
- "phone": "(11) 4831-1245",
- "email": "fiscal@voeazul.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "6d2b8e04-91a7-4c35-8f60-2a7d1c9e5b38"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": "13302",
- "batch": "8471",
- "protocol": "202302271003410001",
- "verification_code": "K2QW71PZ",
- "processed_at": "2023-02-27T10:05:12",
- "errors": null
}
}, - {
- "id": "5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83",
- "number": 982677,
- "series": "1",
- "issue_date": "2023-01-13",
- "status": "issued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": null,
- "document": null,
- "manual_emission": false,
- "amount": 113.48,
- "service_amount": 2613.82,
- "net_amount": 113.48,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": null,
- "cvc_original_data": null,
- "printed_at": "2023-02-09T17:26:29",
- "canceled_at": null,
- "created_at": "2023-02-09T17:16:14",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": null,
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 5.67,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": "13299",
- "batch": null,
- "protocol": null,
- "verification_code": "BFLXB50A",
- "processed_at": "2023-02-09T17:26:29",
- "errors": null
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Insere uma nota fiscal avulsa, não emitida, na empresa de company_identifier. O tomador é a pessoa do cadastro (person_id), com os dados e as retenções dela, ou os dados informados em recipient, com as retenções de taxes. Natureza da operação, CFOP, código NBS e alíquotas vêm das configurações de nota fiscal da empresa quando omitidos, e a data de emissão é a de hoje. O valor da nota é a soma dos itens, e os tributos são calculados na gravação. A numeração só vem na emissão.
Cada item pode trazer um local_id, que volta na resposta ao lado do identificador que o item recebeu.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ da empresa emitente, apenas dígitos. Obrigatório na inserção. A empresa da nota não muda: na edição, o CNPJ da própria empresa é ignorado, e o de outra responde 422 |
| issue_date | string <date> Data de emissão da nota fiscal |
| operation_nature | string <= 30 characters Natureza da operação declarada na nota fiscal |
| cfop | string <= 10 characters Código Fiscal de Operações e Prestações (CFOP) da nota fiscal |
| nbs_code | string Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal |
| observations | string <= 2000 characters Observações da nota fiscal |
| person_id | string or null <uuid> Identificador da pessoa do cadastro que é o tomador. Os dados do tomador e as retenções vêm do cadastro dela |
object (nf_recipient_write) Dados do tomador digitados na nota. Na inserção, vem no lugar de person_id. Na edição de uma nota ligada a uma pessoa do cadastro, o bloco só vale com person_id enviado como null, que é a escolha explícita do tomador digitado, como no Monde; sem isso, ele é ignorado. O campo omitido do bloco permanece como está. | |
object (nf_taxes_write) Retenções da nota. Só valem com o tomador em recipient: com person_id, as retenções são as do cadastro da pessoa, e as enviadas são ignoradas. | |
required | Array of objects (nf_item_write) Itens da nota fiscal |
Insere uma nota com os dados do tomador informados, retenção de ISS e dois itens.
{- "company_identifier": "62046591000140",
- "issue_date": "2026-10-16",
- "operation_nature": "Prestação de Serviço",
- "nbs_code": "109051200",
- "observations": "Referente à viagem de outubro",
- "recipient": {
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "city_id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false
}, - "items": [
- {
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500
}, - {
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350
}
]
}Nota não emitida, com o local_id de cada item enviado.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}, - {
- "id": "4d9b2e86-1a7c-4c35-9f04-8b6e3a1d5c72",
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}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.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de nota fiscal emitida, com um item e as referências para a venda que a originou.
{- "id": "5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83",
- "number": 982677,
- "series": "1",
- "issue_date": "2023-01-13",
- "status": "issued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": null,
- "document": null,
- "manual_emission": false,
- "amount": 113.48,
- "service_amount": 2613.82,
- "net_amount": 113.48,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": null,
- "cvc_original_data": null,
- "printed_at": "2023-02-09T17:26:29",
- "canceled_at": null,
- "created_at": "2023-02-09T17:16:14",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": null,
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 5.67,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": "13299",
- "batch": null,
- "protocol": null,
- "verification_code": "BFLXB50A",
- "processed_at": "2023-02-09T17:26:29",
- "errors": null
}, - "person": {
- "id": "d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64"
}, - "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92"
}, - "sale": {
- "id": "9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10"
}, - "created_by": {
- "id": "3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15"
}, - "canceled_by": null,
- "items": [
- {
- "id": "2b7f0c94-6e1a-4d38-a5c2-9f4e1b7d3a60",
- "description": "Prestação de serviço de intermediação de venda de Passagem Aérea",
- "amount": 113.48,
- "service_amount": 2613.82,
- "approximate_taxes_amount": 0
}
]
}Altera a nota fiscal não emitida; a nota em qualquer outra situação responde 409. O campo omitido permanece como está. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). A lista items, quando enviada, é a lista final: o item com id permanece e muda só o que veio nele, o item sem id é incluído, e o item da nota que não veio é retirado. A empresa da nota não muda.
Como na tela de edição, a gravação recalcula o valor e os tributos, e o tomador do cadastro é atualizado com os dados atuais da pessoa. Para trocar a data de emissão, envie só issue_date.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| issue_date | string <date> Data de emissão da nota fiscal |
| operation_nature | string <= 30 characters Natureza da operação declarada na nota fiscal |
| cfop | string <= 10 characters Código Fiscal de Operações e Prestações (CFOP) da nota fiscal |
| nbs_code | string Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal |
| observations | string <= 2000 characters Observações da nota fiscal |
| person_id | string or null <uuid> Identificador da pessoa do cadastro que é o tomador. Os dados do tomador e as retenções vêm do cadastro dela |
object (nf_recipient_write) Dados do tomador digitados na nota. Na inserção, vem no lugar de person_id. Na edição de uma nota ligada a uma pessoa do cadastro, o bloco só vale com person_id enviado como null, que é a escolha explícita do tomador digitado, como no Monde; sem isso, ele é ignorado. O campo omitido do bloco permanece como está. | |
object (nf_taxes_write) Retenções da nota. Só valem com o tomador em recipient: com person_id, as retenções são as do cadastro da pessoa, e as enviadas são ignoradas. | |
Array of objects (nf_item_write) Itens da nota fiscal |
Muda a data de emissão, altera o valor de um item, inclui outro e retira os que não vieram.
{- "issue_date": "2026-10-20",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "amount": 1600
}, - {
- "local_id": "linha-3",
- "description": "Intermediação de passeio",
- "amount": 120
}
]
}Nota não emitida, com o local_id de cada item enviado.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}, - {
- "id": "4d9b2e86-1a7c-4c35-9f04-8b6e3a1d5c72",
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}Exclui a nota fiscal não emitida. A nota emitida não se exclui (409): ela é cancelada pelo endpoint de cancelamento. A nota ligada a um lançamento financeiro também não se exclui (409).
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Envia a nota não emitida para a emissão da NFS-e pelo e-Notas. A emissão é assíncrona: a resposta 202 traz a nota aguardando emissão (awaiting_issue), e a prefeitura responde depois. Acompanhe pela consulta da nota por ID: ela passa por processing e termina emitida (issued), com o número em nfse.number, ou volta a não emitida (unissued), com o motivo em nfse.errors.
Antes de enviar, a nota limpa os erros anteriores, recebe a alíquota de ISS das configurações, atualiza o tomador do cadastro e recalcula os tributos. A empresa precisa estar configurada no e-Notas, e a nota precisa estar não emitida (409 nos dois casos). A nota com valor negativo não é enviada (422).
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
A nota enviada ao e-Notas, aguardando a resposta da prefeitura.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "awaiting_issue",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}Cancela a nota fiscal emitida; a nota em outra situação responde 409. Quando a empresa emite pelo e-Notas e cancela também na prefeitura, e a nota não foi emitida manualmente, a resposta é 202 e a nota fica aguardando o cancelamento (awaiting_cancellation) até a prefeitura confirmar. Nos demais casos a nota é cancelada só no Monde, na hora (200): cancele-a também na prefeitura.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
Para quem não pode ler notas fiscais na empresa, a escrita devolve só os identificadores.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1"
}
]
}Registra a NFS-e que a agência emitiu direto no site da prefeitura: a nota não emitida passa a emitida, com o número informado e marcada como emissão manual. Sem número, ela recebe o próximo da série do RPS. Só vale para a nota eletrônica não emitida (409).
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| nfse_number required | string <= 20 characters Número da NFS-e gerado pela prefeitura, com até 20 caracteres |
{- "nfse_number": "4521"
}Para quem não pode ler notas fiscais na empresa, a escrita devolve só os identificadores.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1"
}
]
}Aumenta ou reduz em percentual o valor de cada item da nota não emitida (409 nas demais), com arredondamento de duas casas. A nota passa a valer a soma dos itens, e os tributos são recalculados. Se o valor ficar negativo, a nota é gravada com o erro em nfse.errors.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| percentage required | number <double> Percentual do ajuste, diferente de zero: positivo aumenta o valor, negativo reduz (ex.: -10 reduz 10%) |
Reduz em 10% o valor de cada item da nota.
{- "percentage": -10
}Para quem não pode ler notas fiscais na empresa, a escrita devolve só os identificadores.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1"
}
]
}Remove o número e a série da nota não emitida (409 nas demais), para ela voltar a ser numerada na emissão. Repetir a remoção não muda nada, por isso este endpoint não pede Idempotency-Key.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Cria uma nota nova, não emitida, a partir da nota cancelada (409 nas demais), para reemiti-la. A cópia leva a data de emissão, o tomador e os itens da original, com as configurações de nota fiscal atuais da empresa; a pessoa do cadastro e as retenções não vêm junto, e os tributos são recalculados. A resposta traz a cópia.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
Nota não emitida, com o local_id de cada item enviado.
{- "id": "a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35",
- "number": null,
- "series": null,
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": "109051200",
- "document": null,
- "manual_emission": false,
- "amount": 1850,
- "service_amount": 0,
- "net_amount": 1850,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": "Referente à viagem de outubro",
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:12:44",
- "recipient": {
- "kind": "payer",
- "name": "Esferatur Passagens e Turismo Ltda",
- "cpf_cnpj": "76530260000130",
- "state_inscription": null,
- "city_inscription": "4471",
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Jardim Blumenau",
- "additional_info": "1º andar",
- "phone": "(47) 3221-0100",
- "email": "financeiro@esferatur.com.br",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92"
}
}, - "taxes": {
- "retain_iss": true,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 92.5,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": null,
- "company": {
- "id": "e5d9aaed-33bb-4679-b392-b45e5cd78eb4"
}, - "sale_product": null,
- "sale": null,
- "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "id": "f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13",
- "local_id": "linha-1",
- "description": "Intermediação de hospedagem",
- "amount": 1500,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}, - {
- "id": "4d9b2e86-1a7c-4c35-9f04-8b6e3a1d5c72",
- "local_id": "linha-2",
- "description": "Intermediação de traslado",
- "amount": 350,
- "service_amount": 0,
- "approximate_taxes_amount": 0
}
]
}Devolve o arquivo XML da NFS-e emitida, baixado do e-Notas ou, sem ele, o que ficou salvo na nota. A nota que não está emitida responde 409, e a emitida sem XML responde 404. Pede só a permissão de ler notas fiscais.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Redireciona (302) para o PDF da NFS-e emitida ou cancelada no e-Notas, o endereço que o Monde abre no navegador pela nota. A nota que não está emitida nem cancelada responde 409, e a que não tem o endereço do PDF responde 404. Pede só a permissão de ler notas fiscais.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da nota fiscal. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Gere as notas fiscais de serviço dos produtos vendidos a partir das regras de nota fiscal, como na tela Gerar Notas Fiscais do Monde. O fluxo tem dois passos: Consultar as notas a gerar devolve, para cada produto de venda fechada, as notas que já existem e as que a geração gravaria, com o tomador, o valor, os impostos, a regra e a fórmula; depois, Gerar notas fiscais grava as escolhidas, todas ou nenhuma. A empresa de referência (company_identifier) faz o papel da empresa em que o usuário entra no Monde: dela vêm a natureza da operação, o CFOP, as alíquotas, a data de emissão e o modelo do item de todas as notas, e cada nota fica na empresa da venda. As notas geradas ficam não emitidas, e aparecem em Consultar notas fiscais. O recurso não existe em instalações de operadora.
Retorna os produtos das vendas fechadas (produto não excluído) das empresas em que a credencial consulta as notas a gerar, do mais antigo para o mais novo pela data e pelo número da venda, com as notas que as regras de nota fiscal montam para cada um. Cada produto ganha até uma nota por tomador da regra (pagante, fornecedor e representante), no valor da fórmula menos o que as notas não canceladas do mesmo produto e tomador já cobriram. O produto cujas notas já cobrem a receita fica de fora. Sem período, a consulta traz as vendas do primeiro dia do mês até hoje. Como no Monde, entram as vendas que a própria credencial criou; as dos demais vendedores entram nas empresas em que ela tem também Consultar vendas de outros vendedores/intermediários em Vendas. Cada página varre no máximo 2.000 produtos: num período em que quase tudo já tem nota, a página pode vir com menos itens que size, ou vazia, com has_next_page verdadeiro; siga pelo next_cursor até has_next_page falso. Guarde o previewed_at da resposta: ele vai no pedido de geração. As páginas seguidas pelo next_cursor devolvem o previewed_at da primeira.
| company_identifier required | string Example: company_identifier=11222333000181 CNPJ da empresa de referência, de onde vêm a natureza da operação, o CFOP, as alíquotas, a data de emissão e o modelo do item das notas. Obrigatório. |
| date_field | string Enum: "sale_date" "product_start" Example: date_field=sale_date A data que o período filtra. Obrigatório quando
|
| date_from | string <date> Example: date_from=2026-10-01 Início do período, no formato ISO 8601 (YYYY-MM-DD). |
| date_to | string <date> Example: date_to=2026-10-31 Fim do período, no formato ISO 8601 (YYYY-MM-DD). |
| supplier_representative_id | string <uuid> Example: supplier_representative_id=0f3c1d52-7f0a-4a55-9a2e-1b6d1c2f3a4b Traz só os produtos em que esta pessoa é o fornecedor ou o representante. |
| include_without_revenue | boolean Default: false Inclui os produtos sem receita, com as notas de valor zero que as regras montam para eles. Padrão: |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "sale_product": {
- "id": "9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8"
}, - "sale": {
- "id": "1c6e2b7a-0d4f-4b1a-9e3c-5a7b8c9d0e1f"
}, - "company": {
- "id": "3a9d5c1e-2b4f-4c6a-8d0e-1f2a3b4c5d6e"
}, - "sale_number": 1532,
- "sale_date": "2026-10-05",
- "product": {
- "id": "4b2a6c8d-1e3f-4a5b-9c7d-2e4f6a8b0c1d"
}, - "payer": {
- "id": "6d8f0a2c-3e5b-4c7d-9e1f-4a6b8c0d2e3f"
}, - "supplier": {
- "id": "7e9a1b3c-4d6f-4e8a-0b2c-5d7e9f1a3b4c"
}, - "representative": null,
- "start_date": "2026-11-10",
- "end_date": "2026-11-20",
- "total_amount": 1500,
- "revenues": 120,
- "nfs_amount": 120,
- "balance": 0,
- "valid": true,
- "errors": [ ],
- "existing_nfs": [ ],
- "new_nfs": [
- {
- "recipient": {
- "kind": "payer",
- "name": "Maria Souza",
- "cpf_cnpj": "52998224725",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Centro",
- "additional_info": null,
- "phone": "(47) 3221-0100",
- "email": "maria@example.com",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "8f0b2c4d-5e7a-4f9b-1c3d-6e8f0a2b4c5d"
}
}, - "person": {
- "id": "6d8f0a2c-3e5b-4c7d-9e1f-4a6b8c0d2e3f"
}, - "issue_date": "2026-10-16",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": null,
- "amount": 120,
- "service_amount": 1500,
- "net_amount": 120,
- "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 6,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nf_rule": {
- "id": "2d4f6a8c-9e1b-4c3d-5e7f-8a0b2c4d6e8f"
}, - "nf_rule_description": "Regra do pagante",
- "formula": "Taxa de Serviço",
- "complementary": false,
- "generatable": true,
- "error": null
}
]
}
], - "previewed_at": "2026-10-16T10:15:30.123456-03:00",
- "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Gera as notas escolhidas na consulta das notas a gerar, identificadas pelo produto da venda (sale_product_id) e pelo tomador (recipient_kind). As notas são montadas de novo no momento da geração, com as mesmas regras, e gravadas todas ou nenhuma: se alguma nota pedida não puder ser gerada (já existe, tem erro ou a regra não a monta), nada é gravado e a resposta é 422. Se outra geração gravou nota para algum desses produtos depois do previewed_at informado, a resposta é 409 e a consulta tem de ser refeita. Produto que a consulta não mostraria (venda que a credencial não alcança, notas que já cobrem a receita ou, sem include_without_revenue, produto sem receita) também recusa o pedido inteiro com 422. A credencial precisa da permissão Gerar Notas Fiscais na empresa de referência e na empresa de cada venda. A resposta traz as notas geradas completas para quem também consulta notas fiscais na empresa delas; para os demais, só o id.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| company_identifier required | string = 14 characters ^[0-9]{14}$ CNPJ da empresa de referência, a mesma da consulta das notas a gerar |
| previewed_at required | string <date-time> O |
| include_without_revenue | boolean Default: false O mesmo valor usado na consulta: com |
required | Array of objects [ 1 .. 500 ] items As notas a gerar, no máximo 500 por pedido, sem repetir a mesma nota |
{- "company_identifier": "11222333000181",
- "previewed_at": "2026-10-16T10:15:30.123456-03:00",
- "include_without_revenue": false,
- "nfs": [
- {
- "sale_product_id": "9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8",
- "recipient_kind": "payer"
}
]
}{- "data": [
- {
- "id": "5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83",
- "number": null,
- "series": "1",
- "issue_date": "2026-10-16",
- "status": "unissued",
- "operation_nature": "Prestação de Serviço",
- "cfop": null,
- "nbs_code": null,
- "document": null,
- "manual_emission": false,
- "amount": 120,
- "service_amount": 1500,
- "net_amount": 120,
- "approximate_taxes_percentage": 0,
- "approximate_taxes_amount": 0,
- "observations": null,
- "cvc_original_data": null,
- "printed_at": null,
- "canceled_at": null,
- "created_at": "2026-10-16T10:16:02",
- "recipient": {
- "kind": "payer",
- "name": "Maria Souza",
- "cpf_cnpj": "52998224725",
- "state_inscription": null,
- "city_inscription": null,
- "postal_code": "89010300",
- "street": "Alameda Rio Branco",
- "street_number": "238",
- "neighborhood": "Centro",
- "additional_info": null,
- "phone": "(47) 3221-0100",
- "email": "maria@example.com",
- "foreign": false,
- "foreign_document": null,
- "city": {
- "id": "8f0b2c4d-5e7a-4f9b-1c3d-6e8f0a2b4c5d"
}
}, - "taxes": {
- "retain_iss": false,
- "retain_ir": false,
- "retain_pis_cofins_csll": false,
- "iss_percentage": 5,
- "iss_amount": 6,
- "pis_percentage": 0,
- "pis_amount": 0,
- "cofins_percentage": 0,
- "cofins_amount": 0,
- "ir_percentage": 0,
- "ir_amount": 0,
- "csll_percentage": 0,
- "csll_amount": 0
}, - "nfse": {
- "number": null,
- "batch": null,
- "protocol": null,
- "verification_code": null,
- "processed_at": null,
- "errors": null
}, - "person": {
- "id": "6d8f0a2c-3e5b-4c7d-9e1f-4a6b8c0d2e3f"
}, - "company": {
- "id": "3a9d5c1e-2b4f-4c6a-8d0e-1f2a3b4c5d6e"
}, - "sale_product": {
- "id": "9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8"
}, - "sale": {
- "id": "1c6e2b7a-0d4f-4b1a-9e3c-5a7b8c9d0e1f"
}, - "created_by": null,
- "canceled_by": null,
- "items": [
- {
- "description": "Passagem Aérea - venda 1532",
- "amount": 120,
- "service_amount": 1500,
- "approximate_taxes_amount": 0
}
]
}
]
}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.
Retorna o histórico de alterações do sistema, com filtros por autor, registro auditado, ação e origem. A consulta traz apenas os campos da própria linha; para o autor e o registro auditado, use a consulta por ID. O histórico é recortado por cadastro, como no Monde: o log de cada cadastro vem a quem tem "Visualizar Log" dele (vendas, pessoas, contas a pagar e receber, viagens, contas, transferências entre contas, notas fiscais, regras da nota fiscal e extrato CVC) ou, no cadastro sem essa permissão, a quem o lê. O log das cidades, que não têm mais permissão, só vem a quem lê todo o log. No log de venda, lançamento, nota fiscal e tarefa, a permissão vale na empresa do registro. No log das contas e das transferências entre contas, a permissão em qualquer empresa mostra o log de todas, como no Monde, que confere o "Visualizar Log" na empresa em que o usuário entrou, e não nas empresas das contas. O log da venda, do lançamento e da tarefa de outro usuário só vem a quem também alcança o registro, como na consulta dele: na venda, quem a abre ("Abrir vendas de outros vendedores/intermediários"); no lançamento, quem acessa os lançamentos de outros usuários (inteiro ou no recorte); na tarefa, quem vê as tarefas de outros usuários. No Monde o log fica na aba do registro, que só abre com essas permissões; por isso o log da venda, do lançamento e da tarefa já excluídos só vem a quem lê todo o log. As exportações ficam de fora. A linha que a credencial não vê responde 404 na consulta por ID.
| person_id | string <uuid> Example: person_id=b2a6d7da-ff94-40e3-b069-812b2fd45b91 Filtra pelo identificador do autor da alteração. |
| resource_id | string <uuid> Example: resource_id=9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118 Filtra pelo identificador do registro auditado. |
| kind | string Enum: "insertion" "edition" "deletion" "custom" "export" "email" Example: kind=edition Filtra pela ação registrada.
|
| 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 |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
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": [
- {
- "id": "5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83",
- "kind": "edition",
- "origin": "financeiro_categoria",
- "description": "Valor de \"10\" para \"20\"",
- "created_at": "2026-08-05T09:12:33"
}, - {
- "id": "c71a5d38-0b64-4e29-9d17-6f2e8a4b3c05",
- "kind": "export",
- "origin": "vendas por produto",
- "description": "Exportação de 128 registros",
- "created_at": "2026-08-05T08:41:07"
}, - {
- "id": "7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92",
- "kind": "insertion",
- "origin": "pessoa",
- "description": "Inserido via API pela credencial \"Integração Contabilidade\"\r\nNome: \"Maria Souza\"",
- "created_at": "2026-08-04T23:05:12"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma linha do histórico pelo identificador, com as referências para o autor da alteração e para o registro auditado.
| id required | string <uuid> Example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 Identificador da linha do histórico. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
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": {
- "id": "b2a6d7da-ff94-40e3-b069-812b2fd45b91"
}, - "resource": {
- "id": "9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118"
}
}Consulte as definições dos campos personalizados do sistema por recurso (vendas, viagens, pessoas, contas a pagar/receber e tarefas): o identificador, o nome, o tipo, se é obrigatório e as opções cadastradas. O valor de cada campo é informado na venda, na pessoa e no lançamento.
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.
| 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.
|
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Retorna as definições de campos personalizados de vendas, com um campo do tipo lista e um campo de texto.
{- "data": [
- {
- "id": 123,
- "resource": "sales",
- "name": "Centro de custo",
- "kind": "choices",
- "required": true,
- "active": true,
- "choices": [
- "Matriz",
- "Filial"
]
}, - {
- "id": 124,
- "resource": "sales",
- "name": "Observação interna",
- "kind": "text",
- "required": false,
- "active": true,
- "choices": [ ]
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}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.
| id required | integer Example: 123 Identificador do campo personalizado a consultar. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser 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": [
- "Matriz",
- "Filial"
]
}Consulte os planos de comissão, como no cadastro de Planos de Comissão do Monde. Um plano tem faixas de meta (o percentual da meta do mês que a pessoa precisa atingir para a faixa valer); cada faixa tem a entrada de todos os produtos e, se quiser, entradas de produtos específicos; e cada entrada tem os valores de comissão de cada função: um percentual sobre campos da venda ou um valor fixo, e opcionalmente outros valores para a venda que tem intermediário. No fechamento de comissões, vale a maior faixa que a pessoa atingiu, a entrada do produto vendido (sem ela, a de todos os produtos) e a regra da função da pessoa (sem ela na entrada do produto, a da entrada de todos os produtos). O plano é ligado às pessoas no cadastro de funções do Monde. O recurso é só da agência: na instalação de operadora, todas as chamadas respondem 403. Ler exige a permissão "Visualizar" de Planos de Comissão.
Retorna a lista de planos de comissão, por nome.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com dois planos.
{- "data": [
- {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d",
- "description": "Plano padrão"
}, - {
- "id": "8d7c6b5a-4f3e-4d2c-9b1a-0e9f8d7c6b5a",
- "description": "Plano gerentes"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna um plano de comissão com as faixas de meta, os produtos de cada faixa e os valores de cada função. As faixas vêm pelo percentual, a entrada de todos os produtos vem primeiro em cada faixa, e um campo do tipo que não está em uso (o valor fixo na comissão percentual, e vice-versa) vem zerado.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Identificador único do plano de comissão |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de plano com duas faixas: até atingir 100% da meta o vendedor recebe 3% (1,5% na venda com intermediário); a partir de 100%, 5%, e R$ 50,00 por unidade de um produto específico.
{- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d",
- "description": "Plano padrão",
- "goal_ranges": [
- {
- "id": "a0b1c2d3-e4f5-4a6b-8c7d-9e0f1a2b3c4d",
- "achieved_percentage": 0,
- "products": [
- {
- "id": "b1c2d3e4-f5a6-4b7c-9d8e-0f1a2b3c4d5e",
- "product": null,
- "rules": [
- {
- "id": "c2d3e4f5-a6b7-4c8d-8e9f-1a2b3c4d5e6f",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "commission_type": "percentage",
- "percentage": 3,
- "amount": 0,
- "calculated_on": [
- "commission_amount",
- "over_amount"
], - "differentiate_intermediary": true,
- "with_intermediary": {
- "commission_type": "percentage",
- "percentage": 1.5,
- "amount": 0,
- "calculated_on": [
- "commission_amount",
- "over_amount",
- "intermediary_commission_amount"
]
}
}
]
}
]
}, - {
- "id": "d3e4f5a6-b7c8-4d9e-9f0a-2b3c4d5e6f7a",
- "achieved_percentage": 100,
- "products": [
- {
- "id": "e4f5a6b7-c8d9-4e0f-8a1b-3c4d5e6f7a8b",
- "product": null,
- "rules": [
- {
- "id": "f5a6b7c8-d9e0-4f1a-9b2c-4d5e6f7a8b9c",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "commission_type": "percentage",
- "percentage": 5,
- "amount": 0,
- "calculated_on": [
- "commission_amount",
- "over_amount"
], - "differentiate_intermediary": false,
- "with_intermediary": {
- "commission_type": "percentage",
- "percentage": 0,
- "amount": 0,
- "calculated_on": [ ]
}
}
]
}, - {
- "id": "a6b7c8d9-e0f1-4a2b-8c3d-5e6f7a8b9c0d",
- "product": {
- "id": "9a8b7c6d-5e4f-4321-8a9b-0c1d2e3f4a5b"
}, - "rules": [
- {
- "id": "b7c8d9e0-f1a2-4b3c-9d4e-6f7a8b9c0d1e",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "commission_type": "amount",
- "percentage": 0,
- "amount": 50,
- "calculated_on": [ ],
- "differentiate_intermediary": false,
- "with_intermediary": {
- "commission_type": "percentage",
- "percentage": 0,
- "amount": 0,
- "calculated_on": [ ]
}
}
]
}
]
}
]
}Consulte as metas de vendas, como na tela Metas do Monde. A meta é de uma pessoa numa função, por ano, com o valor de cada mês; no fechamento de comissões, o que a pessoa vendeu no mês é comparado com a meta do mês para achar a faixa do plano de comissão. Este recurso é só de consulta: como no Monde, a meta é gravada pela função, no "Plano e Metas" da pessoa. Para cadastrar, alterar ou excluir uma meta, envie a lista goals da pessoa em people na alteração da função, com a permissão "Editar" de Funções. O recurso é só da agência: na instalação de operadora, todas as chamadas respondem 403. Ler exige a permissão "Visualizar" de Metas.
Retorna as metas, do ano mais recente para o mais antigo, com filtros opcionais por ano, função e pessoa.
| year | integer Example: year=2026 Ano da meta, com quatro dígitos |
| person_role_id | string <uuid> Example: person_role_id=f453b283-750d-4c5d-a493-a6bf8064090e Identificador da função |
| person_id | string <uuid> Example: person_id=3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7 Identificador da pessoa |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo de resposta com a meta de um vendedor.
{- "data": [
- {
- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Retorna uma meta específica pelo seu identificador.
| id required | string <uuid> Example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e Identificador único da meta |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
Exemplo da meta de um vendedor, com o plano de comissão dele.
{- "id": "1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a",
- "person_role": {
- "id": "f453b283-750d-4c5d-a493-a6bf8064090e"
}, - "person": {
- "id": "3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7"
}, - "commission_plan": {
- "id": "6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d"
}, - "year": 2026,
- "months": {
- "january": 50000,
- "february": 50000,
- "march": 60000,
- "april": 50000,
- "may": 50000,
- "june": 50000,
- "july": 80000,
- "august": 50000,
- "september": 50000,
- "october": 50000,
- "november": 50000,
- "december": 90000
}
}Conciliação bancária da conta corrente: envie o extrato OFX exportado do internet banking, consulte os extratos enviados com o resumo do que já foi conciliado e descarte o extrato enviado por engano. O vínculo das linhas e a conferência são feitos na tela de Conciliação Bancária do Monde Web. A permissão é a do Monde, Conciliação Bancária, numa das empresas da conta corrente. Pela conexão automática, a conciliação é exceção concedida pelo Monde na aprovação: ela alcança o extrato e as movimentações da conta inteira, de qualquer origem.
Retorna os extratos enviados para as contas correntes ativas das empresas em que a credencial tem a permissão Conciliação Bancária, do mais recente para o mais antigo. Filtre por conta com account_id.
| account_id | string <uuid> Só os extratos desta conta corrente (UUID). |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
- "account": {
- "id": "5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b"
}, - "file_name": "extrato-janeiro.ofx",
- "bank_code": "033",
- "branch": "1234",
- "account_number": "1234567890",
- "currency": "BRL",
- "period_start": "2025-01-01",
- "period_end": "2025-01-31",
- "ledger_balance": 15230.45,
- "ledger_balance_date": "2025-01-31",
- "lines": {
- "inserted": 42,
- "existing": 3,
- "corrected": 0,
- "uncorrected": 0
}, - "warnings": [ ],
- "created_at": "2025-02-03T10:15:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Envia o extrato OFX (.ofx ou .qfx, até 5 MB) de uma conta corrente ativa, em multipart/form-data, e já roda o casamento automático. A importação é a da tela: a linha é identificada pela conta e pelo FITID, então reenviar um período não duplica linhas, e a correção do banco (CORRECTFITID) é aplicada quando possível. Banco, agência e número da conta que não conferem com o cadastro só geram aviso em warnings; moeda diferente da conta e arquivo sem lançamentos são recusados com 422. A conta inexistente, ou que não é conta corrente ativa, também responde 422. Não pede company_identifier: o extrato é da conta corrente, que pode ser de mais de uma empresa, e basta a permissão Conciliação Bancária numa delas.
| 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. |
| account_id required | string <uuid> Conta corrente ativa a conciliar (UUID). |
| file required | string <binary> Arquivo OFX (.ofx ou .qfx) exportado do internet banking, até 5 MB. |
{- "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
- "account": {
- "id": "5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b"
}, - "file_name": "extrato-janeiro.ofx",
- "bank_code": "033",
- "branch": "1234",
- "account_number": "1234567890",
- "currency": "BRL",
- "period_start": "2025-01-01",
- "period_end": "2025-01-31",
- "ledger_balance": 15230.45,
- "ledger_balance_date": "2025-01-31",
- "lines": {
- "inserted": 42,
- "existing": 3,
- "corrected": 0,
- "uncorrected": 0
}, - "warnings": [ ],
- "created_at": "2025-02-03T10:15:00",
- "situations": {
- "ambiguous": 1,
- "bank_only": 4,
- "system_only": 2,
- "suggested": 10,
- "reconciled": 28
}, - "pending_count": 17,
- "reconciled_count": 28,
- "balance": {
- "date": "2025-01-31",
- "bank": 15230.45,
- "system": 15180.45,
- "difference": 50
}
}Retorna o extrato com o resumo da conciliação: quantas linhas há em cada situação e o confronto do saldo informado pelo banco com o saldo do sistema na mesma data.
| id required | string <uuid> Example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 Identificador (UUID) do extrato enviado. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "id": "6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10",
- "account": {
- "id": "5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b"
}, - "file_name": "extrato-janeiro.ofx",
- "bank_code": "033",
- "branch": "1234",
- "account_number": "1234567890",
- "currency": "BRL",
- "period_start": "2025-01-01",
- "period_end": "2025-01-31",
- "ledger_balance": 15230.45,
- "ledger_balance_date": "2025-01-31",
- "lines": {
- "inserted": 42,
- "existing": 3,
- "corrected": 0,
- "uncorrected": 0
}, - "warnings": [ ],
- "created_at": "2025-02-03T10:15:00",
- "situations": {
- "ambiguous": 1,
- "bank_only": 4,
- "system_only": 2,
- "suggested": 10,
- "reconciled": 28
}, - "pending_count": 17,
- "reconciled_count": 28,
- "balance": {
- "date": "2025-01-31",
- "bank": 15230.45,
- "system": 15180.45,
- "difference": 50
}
}Descarta o extrato: apaga as linhas que ele inseriu (a linha que já existia por um envio anterior fica) e desfaz a conferência dos lançamentos vinculados a elas. Com lançamento conferido em dia de caixa fechado, nada é apagado e a resposta é 422. Não exige Idempotency-Key.
| id required | string <uuid> Example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 Identificador (UUID) do extrato enviado. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Credenciais de acesso não são válidas."
]
}Receba um aviso quando registros mudam, em vez de consultar as listas de tempo em tempo. A assinatura (webhook) pertence à credencial que a cadastrou e é gerenciada por esta API.
Como funciona. Toda escrita nos registros da API — feita pelo Monde Desktop, pelo Monde Web ou pela própria API — grava o evento no banco, na mesma transação. A cada minuto os eventos são agrupados e entregues: um POST por evento e assinatura, com até 100 registros; passando disso, sai mais de um POST. O aviso é fino: leva o evento e os ids, e o estado atual sai da consulta do recurso. O mesmo registro salvo várias vezes no mesmo minuto entra uma vez só.
{
"id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d",
"event": "sales.changed",
"resource": "sales",
"occurred_at": "2026-10-16T14:32:10-03:00",
"data": [
{ "id": "b71a4c58-2f0e-4c1e-9a63-1c9a0f0b9e21", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" },
{ "id": "c92f0d13-6b1a-4f7e-8d2c-3e4f5a6b7c8d", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" }
]
}
Eventos. O catálogo está em Listar eventos de webhook: changed (registro criado ou alterado) e deleted de cada recurso, e os eventos de negócio (venda fechada e reaberta, produto cancelado, comissão fechada e paga, venda importada da fila de uma integração, nota fiscal emitida e cancelada, tarefa vencida, importação da integração concluída e importação dos extratos CVC concluída). Criação e alteração são um evento só: o aviso traz só o id, e a consulta diz como o registro está; se o seu sistema ainda não tem o registro, ele é novo. A alteração de um item que faz parte do registro (produto, passageiro, trecho, comissão, anexo e pagamento da venda; itens, categorias e rateio da conta; o grupo da categoria financeira) gera o changed do registro. Nos eventos de negócio, cada item traz também subresource_id, o item que provocou o evento (o produto cancelado, a comissão, a venda importada). company_id é nulo nos cadastros que não pertencem a uma empresa.
tasks.overdue é um evento de tempo: sai uma vez por vencimento, cerca de um minuto depois de o vencimento passar sem a tarefa ser concluída. A tarefa gravada já vencida, ou que venceu enquanto nenhum webhook assinava o evento, não o gera. Em cvc_statements.import_completed, o id do item é a execução da importação, consultável em Consultar logs por ID por quem tem a permissão Logs; os extratos que ela criou ou alterou mandam os avisos deles. integrations.import_completed avisa que a fila de vendas importadas da integração foi atualizada. cvc_statements.import_completed não sai da importação que falhou nem da que não achou arquivo novo. A moeda gera só o changed, quando é ativada ou desativada. Navios e cabines são identificados pelo nome: trocá-lo gera o deleted do id antigo e o changed do novo.
Ordem e repetição. A ordem entre avisos não é garantida: se a consulta de um id responder 404, o registro foi excluído. A credencial também recebe o aviso do que ela mesma gravou: quem grava de volta no Monde ao receber um aviso precisa ignorar a mudança que ele próprio fez, ou entra em ciclo.
Quem recebe. Só se assina evento de recurso que a credencial pode ler, e o aviso só sai do registro que a consulta por ID devolveria à credencial: a empresa precisa conceder a leitura do recurso e estar com a licença ativa. Credencial desativada para de receber.
Cabeçalhos e assinatura. Cada entrega traz X-Monde-Event, X-Monde-Delivery (o id da entrega, igual em todas as tentativas: use-o para descartar aviso repetido), X-Monde-Timestamp (segundos desde 1970) e X-Monde-Signature, no formato sha256=<hex>: o HMAC-SHA256 de "<timestamp>.<corpo>" com o segredo da assinatura. Confira a assinatura com o corpo exatamente como chegou e recuse horário muito antigo.
Repetição. Resposta 2xx confirma a entrega. Qualquer outra resposta, erro de conexão ou espera acima de 10 segundos é tentada de novo, com espera crescente (1, 2, 4, 8, 16, 32 e 64 minutos), num total de 8 tentativas. Redirecionamento não é seguido. A resposta 410 diz que o endereço não existe mais: a entrega desiste na hora, sem nova tentativa, e conta como esgotada. Depois de 10 entregas esgotadas seguidas a assinatura é desativada: active fica false e disabled_at e last_error dizem quando e por quê; enviar active como true religa. Enquanto o webhook está desativado não há aviso: as entregas que estavam pendentes ficam como falha no histórico, e religar não reenvia o que mudou nesse período. Depois de religar, consulte a listagem do recurso para pôr em dia o que foi alterado. O histórico de cada entrega fica 30 dias em Listar entregas do webhook.
Endereço. Só https, e nunca um endereço de rede interna, local ou reservada; a conferência é refeita antes de cada entrega.
Exige a permissão Webhooks da credencial: ler para consultar, criar e editar para cadastrar e alterar, excluir para remover.
Lista os webhooks da credencial autenticada, do mais recente para o mais antigo. O segredo nunca é devolvido.
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Cadastra um webhook na credencial autenticada. Envie o secret (32 a 255 caracteres; o vazio é recusado) ou omita-o para a API gerar um: o gerado vem uma única vez, nesta resposta, no campo secret. Cada evento precisa estar no catálogo e ser de um recurso que a credencial pode ler. Exige Idempotency-Key.
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| url | string <uri> Endereço https que recebe o POST. Endereço de rede interna, local ou reservada é recusado. |
| description | string or null <= 255 characters Descrição livre, até 255 caracteres. |
| events | Array of strings non-empty Lista de eventos do catálogo, de recursos que a credencial pode ler. Não pode ser vazia. |
| active | boolean Se o webhook recebe entregas. |
| secret | string [ 32 .. 255 ] characters Chave do HMAC-SHA256 da assinatura, de 32 a 255 caracteres. Só de gravação. |
{- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
]
}{- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00",
- "secret": "aZ3kP9qX7mL2nB8vC4tY6wR1sD5fG0hJ7kL9mN3pQ2rS8tU4"
}Devolve um webhook da credencial autenticada. O webhook de outra credencial responde 404.
| id required | string <uuid> ID do webhook. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00"
}Altera só os campos enviados: {"active": true} religa o webhook desativado sem reenviar o segredo. A lista events enviada substitui a anterior. O secret enviado troca o segredo e não é devolvido. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422). Exige Idempotency-Key.
| id required | string <uuid> ID do webhook. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, 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. |
| url | string <uri> Endereço https que recebe o POST. Endereço de rede interna, local ou reservada é recusado. |
| description | string or null <= 255 characters Descrição livre, até 255 caracteres. |
| events | Array of strings non-empty Lista de eventos do catálogo, de recursos que a credencial pode ler. Não pode ser vazia. |
| active | boolean Se o webhook recebe entregas. |
| secret | string [ 32 .. 255 ] characters Chave do HMAC-SHA256 da assinatura, de 32 a 255 caracteres. Só de gravação. |
{- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
]
}{- "id": "0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01",
- "description": "ERP do cliente",
- "events": [
- "sales.changed",
- "sales.closed"
], - "active": true,
- "consecutive_failures": 0,
- "disabled_at": null,
- "last_error": null,
- "created_at": "2026-10-16T10:00:00-03:00",
- "updated_at": "2026-10-16T10:00:00-03:00"
}Exclui o webhook e o histórico das entregas dele. As entregas ainda pendentes não são feitas.
| id required | string <uuid> ID do webhook. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "errors": [
- "Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Certifique-se de que todos os parâmetros, como o corpo da requisição, estão corretos antes de tentar novamente."
]
}Histórico das entregas dos últimos 30 dias, da mais recente para a mais antiga: o corpo enviado, o número de tentativas, o último código de resposta e o último erro.
| webhook_id required | string <uuid> ID do webhook. |
| cursor | string Example: cursor=eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 Cursor da próxima página, exatamente como veio em |
| size | integer [ 1 .. 50 ] Default: 20 Example: size=10 Número de registros por página. |
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d",
- "event": "sales.product_canceled",
- "status": "delivered",
- "attempts": 1,
- "response_status": 204,
- "last_error": null,
- "payload": {
- "id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d",
- "event": "sales.product_canceled",
- "resource": "sales",
- "occurred_at": "2026-10-16T14:32:10-03:00",
- "data": [
- {
- "id": "b71a4c58-2f0e-4c1e-9a63-1c9a0f0b9e21",
- "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab",
- "subresource_id": "9ba44a55-8c48-49d2-98ac-d397702ec961"
}
]
}, - "delivered_at": "2026-10-16T14:33:02-03:00",
- "created_at": "2026-10-16T14:33:01-03:00",
- "updated_at": "2026-10-16T14:33:02-03:00"
}
], - "pagination": {
- "size": 20,
- "has_next_page": false,
- "next_cursor": null
}
}Catálogo dos eventos que um webhook pode assinar, com a descrição e se a credencial autenticada pode assiná-los (subscribable, quando ela pode ler o recurso).
| Authorization required | string Example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. |
| Content-Type required | string Value: "application/json" Example: application/json Tipo de conteúdo da requisição. Deve ser application/json. |
{- "data": [
- {
- "name": "sales.closed",
- "resource": "sales",
- "action": "closed",
- "description": "Venda fechada",
- "subscribable": true
}
]
}As dúvidas que mais chegam sobre a API v3, com a resposta curta e o link para a seção que detalha o assunto.
A v2 continua funcionando, mas é legada e não recebe mais atualizações: toda integração deve usar a v3, que é a desta documentação. A v3 autentica com a credencial gerada pela agência; a v2 usa login e senha de um usuário do Monde e tem documentação própria.
Envie a credencial no cabeçalho Authorization com o esquema Bearer, como mostra a seção Autenticação. A credencial não expira, mas a agência pode revogá-la a qualquer momento.
No Monde, em Cadastros > Integrações, na integração API Monde. É ali que a agência escolhe as permissões da credencial, por empresa e por recurso, e de lá repassa a credencial a quem vai integrar.
Sim. Ao gerar a credencial, a agência concede só as permissões de leitura dos recursos que quiser liberar. As gravações respondem 403.
Sim. Uma credencial acessa todas as empresas da agência que receberam permissão nela. Toda empresa com licença ativa do Monde pode ser usada pela API, sem licença à parte. A empresa somente leitura só é consultada: as gravações nela respondem 403 com "A empresa está somente leitura: os registros dela podem ser consultados pela API, mas não gravados.".
Como no Monde, cada permissão vale para o que a própria credencial criou, e as permissões "de outros" estendem o alcance aos demais: em vendas, Consultar, Abrir e Editar vendas de outros vendedores; em contas a pagar e receber, Acessar lançamentos de todos os usuários e do sistema ou um dos recortes (faturas de clientes, de fornecedores, de cartão, lançamentos com operação própria e com venda); em tarefas, Ver tarefas de outros usuários. A viagem é da credencial quando ela a cadastrou ou criou uma venda dela, e as demais seguem Consultar vendas de outros vendedores. Listar e consultar pedem a permissão "Visualizar" do recurso também no que a própria credencial criou, como no Monde, em que sem ela não se abre o cadastro; a resposta da alteração sem essa permissão traz só os identificadores, e a da criação traz o registro criado inteiro. O registro de outro usuário fora do alcance responde 404; o que ela lê mas não pode alterar responde 403 com a mensagem do Monde. A credencial gerada antes dessas permissões continua alcançando todos os registros, como antes.
Falta a permissão daquele recurso na credencial, a empresa não tem licença ativa do Monde ou está somente leitura numa gravação, ou o recurso exige a licença Monde Pro, como os Guias. A mensagem da resposta diz qual é a causa. Quando é permissão, não é preciso gerar uma nova credencial: basta a agência marcar a permissão na credencial existente.
Pela Conexão automática. A agência autoriza o parceiro no próprio Monde, sem compartilhar uma credencial, e as permissões são as definidas na aprovação do parceiro.
Por enquanto, não: a API atende a base de produção da agência. Durante o desenvolvimento, comece pelas consultas, com uma credencial só de leitura, e use a idempotência nas gravações para não duplicar registros ao repetir uma requisição.
O limite é por janela curta de tempo, contado por IP, e não existe cota diária ou mensal. Os valores e o que fazer ao receber 429 estão em Limites de requisição.
Por cursor, com até 50 registros por página. Repita a consulta enviando o next_cursor da resposta anterior enquanto has_next_page for true. Veja Paginação.
Sim. A API lê e grava a mesma base que a agência usa no Monde, sem cópia nem atraso de sincronização.
Sim, na credencial criada pela própria agência: cadastre um endereço https em Webhooks e receba um POST assinado quando registros mudam. A permissão Webhooks não é oferecida na Conexão automática: ali a integração consulta a API periodicamente. Em vendas, o filtro updated_since traz só o que mudou desde a última consulta, inclusive quando a mudança foi numa parte da venda, como um produto, passageiro ou pagamento.
Pelo Changelog, que registra cada mudança com a data, e marca em destaque as que alteram o contrato. A API está em fase beta, então campos e endpoints ainda podem mudar. A etiqueta de cada endpoint diz se ele já pode ser usado: veja Disponibilidade dos endpoints.
Sim. Qualquer ferramenta que faça requisições HTTP com o cabeçalho de autenticação consegue consumir a API. Para o agente de IA que gera código, a documentação também está disponível em texto em https://web.monde.com.br/llms.txt.
Em Consultar vendas, escolha a data em date_field (data da venda, de embarque ou de retorno) e informe o intervalo em date_from e date_to.
Use updated_since em Consultar vendas, com data ou data e hora. Ele também traz a venda lançada com data retroativa, porque considera quando a venda foi alterada, e não a data dela, e traz a venda quando muda uma das partes que aparecem em Consultar venda por ID, como produtos, passageiros, pagamentos e contas vinculadas. A lista completa está na descrição do filtro. Guarde o instante em que a consulta começou, antes da primeira página, e na consulta seguinte parta dele com uma folga de alguns minutos para trás. Regrave cada venda pelo id, e envie status=opened,closed,canceled para receber também as exclusões. Hoje esse filtro existe só em vendas.
Use people_id com o ID da pessoa, que pode ser buscado em Consultar pessoas. O filtro traz a venda em que a pessoa aparece em qualquer papel: pagante, passageiro, vendedor, fornecedor. Para separar por vendedor ou por empresa, use o seller e a company que vêm em Consultar venda por ID.
A consulta de vendas traz os dados principais e os totais de cada venda. Produtos, pagamentos, comissões, anexos e campos personalizados vêm em Consultar venda por ID.
Por padrão, a consulta traz só as vendas abertas e fechadas. Para as excluídas, envie status=canceled.
Fornecedores, representantes, pagantes e passageiros são cadastros de pessoa. Consulte-os em Consultar pessoa por ID e guarde o resultado para não repetir a mesma consulta a cada venda.
Não com esses nomes. A venda traz o valor de cada produto, as taxas, as comissões e o over, a receita e os totais, e cada integração monta os indicadores dela a partir desses valores.
Não. A API entrega os registros, e o relatório é montado do lado de quem integra, a partir das vendas consultadas.
Em Contas a Pagar e Receber, Movimentações, Reembolsos e Notas Fiscais. A venda também traz, no detalhe, as contas que gerou.
Sim, em Inserir venda, uma venda por requisição. Os produtos aceitos e os campos obrigatórios estão na descrição da operação.
Não. Cada requisição grava uma venda. Para volume, envie uma após a outra, respeitando os limites de requisição.
Envie o cabeçalho Idempotency-Key, obrigatório em Inserir venda. Enquanto a chave vale, repeti-la devolve a resposta da primeira requisição, sem gravar de novo. A chave expira depois de pelo menos um dia. Veja Idempotência.
Na venda, cada pessoa é procurada pelo external_id que a sua integração enviou antes e, sem esse vínculo, pelo CPF ou CNPJ. Só quando nenhum dos dois encontra a pessoa é que ela é cadastrada. Envie sempre o CPF ou o CNPJ para reaproveitar o cadastro que já existe no Monde.
Pessoas, tarefas, anexos e contas a pagar e receber. A etiqueta de cada operação diz se ela já está disponível, e o Changelog registra cada nova operação.
Sim. Em Viagens, a integração cadastra, altera e exclui viagens e vincula ou desvincula as vendas delas, com as permissões Editar e Excluir de Viagens. A viagem cadastrada pela credencial é dela: alterar, excluir e vincular vendas a ela não pedem Consultar vendas de outros vendedores, que a viagem dos outros vendedores e das outras credenciais pede.
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.
details dos guias e dos orçamentos passa a aceitar as colunas com dois ou três <div data-block="column">. Antes, só com dois.details dos guias e dos orçamentos passa a aceitar data-carousel="thumbnails" no parágrafo das imagens do carrossel, que mostra miniaturas embaixo, no lugar das bolinhas. Outro valor, ou o atributo em outra tag, é descartado. ) entre elas.cover_kind (color, image ou none), cover_color, cover_show_title, cover_show_subtitle e cover_image_url.cover_kind, cover_color, cover_show_title e cover_show_subtitle. A imagem da capa só se escolhe pelo Monde Web. Sem a capa, o orçamento novo nasce com a capa color, na cor principal das Configurações de Orçamentos da empresa.subtitle e details deixam de ser obrigatórios: na criação podem ser omitidos, e na alteração o nulo os deixa em branco.seller que é um vendedor inativo no Monde passa a ser recusado com 422, como no Monde, em vez de responder 500. A credencial sem a permissão de editar Vendedores continua recebendo 403, como para o vendedor ainda não cadastrado. Na alteração, o vendedor que a venda já tem continua aceito, mesmo inativo.color, image ou none, como a dos orçamentos, e os guias devolvem também cover_show_title, cover_show_subtitle e cover_image_url. Os guias que tinham a capa default passaram para color, no tom #5f6777.cover_show_title e cover_show_subtitle. O hide_cover_text continua aceito e vale pelos dois, e a capa default continua aceita e vale como color no tom #5f6777. Sem a capa, o guia novo nasce com a capa color nesse tom.details deixa de ser obrigatório: na criação pode ser omitido, e na alteração o nulo o deixa em branco.details dos orçamentos passa a aceitar os três blocos dos guias: caixa de destaque, seção com imagem de fundo e duas colunas, como <div data-block>. Antes eles viravam texto comum.details dos guias, a caixa de destaque passa a ser só de texto: a imagem vai para um parágrafo logo depois dela, e a tabela, a citação, o código e a linha divisória vão para depois dela. A seção com imagem de fundo fica só com a primeira imagem, e as outras são descartadas.kind de Consultar logs e de Consultar logs por ID passa a trazer email para o e-mail enviado pelo registro, como o boleto ou a fatura de uma conta a pagar ou receber. A description traz os destinatários e os arquivos anexados. O filtro kind de Consultar logs passa a aceitar email.kind em texto livre, fora do conjunto documentado (Enviado por e-mail). Quem lia esse valor passa a receber email.reprocessed_items: para cada item enviado, a fatura em que ele ficou (bill) e o item nela (item), que é outro quando a fatura de destino já tinha um item igual e os dois foram somados. Quando todos os itens saem e a fatura é excluída, a resposta deixa de ser 204 sem corpo e passa a ser 200 só com reprocessed_items.id do item que é somado a outro igual, em Alterar conferido ou centro de custo de item da fatura: ele deixa de existir, e os id que valem são os de items da resposta. Nada muda no comportamento dessas ações.Idempotency-Key passa a repetir a resposta original, com X-Idempotent-Replay: true, em vez de 404. Vale para Remover itens da fatura ou recalcular o vencimento e para Faturar avulso os itens da fatura. Uma chave nova na fatura excluída continua respondendo 404.overpayment_return no Outros da agência (payments[].agency.others), em Inserir venda e na inclusão de pagamento por Alterar venda: com true, o pagamento é a Devolução › Gerar Conta a Pagar do Monde, que devolve ao cliente o que ele pagou a mais. Só é aceita com algum produto de saldo do cliente negativo antes dela. O amount de cada produto vai com o sinal do saldo do cliente nele (negativo no de saldo negativo, positivo nos outros), e o sinal que não bate é recusado com 422. Grava um lançamento em aberto, de débito quando a soma é negativa, com as categorias de pagamento e de recebimento do cliente. Não aceita description nem details. Vale também na operadora. Pede a mesma permissão de editar vendas.recurrence_scope, remove_settlement, undo_bank_reconciliation), Desfazer a liquidação com confirmação (recurrence_scope, undo_bank_reconciliation), Excluir reembolso com confirmação (remove_from_bill), Excluir transferência com confirmação (undo_bank_reconciliation) e Excluir grupo de categorias com confirmação (delete_categories).204 sem corpo no sucesso, 409 sem a confirmação, 422 com a confirmação fora do formato. Todos exigem Idempotency-Key.409, e a mensagem aponta o POST a usar. O recurrence_scope enviado no DELETE responde 422, apontando o POST: ignorado, ele faria a exclusão ou a reabertura de um lançamento só parecer a da série. Sem confirmação, o DELETE continua igual.payer_id, ou o da venda), o centro de custo e o valor de cada produto, com o sinal do saldo do cliente dele. Responde 202: os itens a faturar ficam gravados, e a fatura automática os leva à fatura de cliente logo depois.reopen_sale e a permissão "Reabrir venda"; a fatura liquidada só com remove_settlement; a fatura fechada, reaberta antes.payments[].agency.to_invoice sai da criação e da alteração da venda e passa a ser ignorado, como campo desconhecido. Na alteração, a lista payments não mantém nem remove o Faturar e a Devolução Faturar: eles só mudam pelos endpoints acima.payments.agency.to_invoice da consulta da venda é só leitura e muda de forma. Cada item é uma linha do Faturar que já entrou numa fatura de cliente, por fatura e centro de custo: bill, cost_center, amount (com o sinal; negativo é Devolução Faturar) e products (sale_product e amount). Saem id, due_date, description, payer, bills e o id dos produtos: o pagante e o vencimento são os da fatura. O Faturar que ainda não entrou em fatura não aparece. A Devolução Faturar, antes só referenciada pela fatura em payments.agency.bills, passa a aparecer na linha.visas[]) em Inserir venda, Alterar venda e Consultar venda por ID. É um produto do sistema, como a Excursão: não é preciso informar o produto, e ele passa a valer na primeira venda. Campos próprios: visa_type (tipo do visto, obrigatório, até 50 caracteres, como "Turismo") e destination_country (país do visto, obrigatório, código ISO 3166-1 alpha-2, como "US"; código fora do cadastro de países é recusado com 422).passengers[].fees, e a taxa de serviço da agência em agency_service_fee do produto.kind de Consultar vendas e de Produtos passa a aceitar visa, e o kind dos produtos passa a trazer visa.side: customer ou vendor), o tipo (kind), o documento do produto da venda (document), a emissão (issue_date) e a pessoa (person). Com eles, o pagamento de uma fatura de fornecedor se abre em cada venda: o que foi pago ao fornecedor e o que foi recebido do cliente.date_field=movement_date e date_from/date_to.bill_id), conta, pessoa, lado (side) e período (date_field = settlement_date, due_date ou issue_date). Com ele, a composição dos pagamentos do mês sai numa consulta, sem uma chamada por fatura. Pede a permissão "Visualizar" de contas a pagar e receber, já concedida a quem lê os lançamentos.apportionments na fatura de cartão (credit_card_invoice), como a aba Rateios do Monde. O rateio divide o valor final da fatura, que é a soma das compras do cartão. As categorias continuam recusadas.date_from e date_to) e filtra também por situação da venda e do produto, vendedor e empresa.sales_by_sellers.read_all) e "Consultar vendas de outros vendedores/intermediários" (sales_by_sellers.read_from_other_sellers), desmarcadas nas credenciais que já existem./64, e não por endereço: todos os endereços da mesma rede /64 somam no mesmo limite. Em IPv4 nada muda.balance_resolution: category passa pelo bloqueio de acréscimo e desconto da empresa, como no Monde. Acima do limite, o pedido é recusado com 422.sales_by_products.read_all), "Consultar vendas de outros vendedores/intermediários" (sales_by_products.read_from_other_sellers) e "Visualizar comissão, over e receitas" (sales_by_products.view_commission_columns), desmarcadas nas credenciais que já existem.search. O parâmetro é ignorado e a lista vem sem ele; para restringir a lista, use os demais filtros de cada um.undo_bank_reconciliation passa a ser exigido só quando a alteração muda o valor, a data ou a conta de uma movimentação conciliada, como o aviso do Monde. A alteração que não mexe nas movimentações conciliadas (categorias, rateios, descrição e demais dados) é gravada sem a confirmação e mantém a conciliação. Quem já envia a confirmação continua gravando como antes.external_id deixou de ser aceito nos produtos da venda e nos products[] dos pagamentos. O produto identifica-se só por local_id (obrigatório, até 50 caracteres e único na venda), e o pagamento aponta o produto por sale_product_local_id ou sale_product_id. O produto sem local_id e o item de pagamento sem referência ao produto são recusados com 422.credit_card_invoice) em todas as agências, com as travas do Monde. Ela deixa de responder 409 por não ter a edição liberada.details dos guias aceita três blocos: caixa de destaque, seção com imagem de fundo e duas colunas, como <div data-block>. O formato está na descrição do campo. Nos orçamentos, nada muda.cover_kind (default, image ou color), cover_color, hide_cover_text e cover_image_url.cover_kind, cover_color e hide_cover_text. A imagem da capa só se escolhe pelo Monde Web.subtitle deixa de ser obrigatório. Na alteração, enviado como nulo, tira o subtítulo. Nada muda para quem já envia o subtítulo.external_number, additional1 e additional2, com até 20 caracteres cada. Cada agência dá a esses campos o título que quiser (por exemplo, "Nº Pedido").passenger_lists.read_all) e "Consultar passageiros de outros vendedores/intermediários" (passenger_lists.read_from_other_sellers), desmarcadas nas credenciais que já existem.calculated_oncalculated_on pode trazer customer_refund, vendor_refund, agency_card_rate, supplier_fine e deleted_balance, quando o plano é calculado sobre esses valores.use_sale_data, cada pagamento da venda leva a forma e os dados de cheque ou cartão da própria venda.422). Antes, isso valia só com multimoedas.409: desative a moeda que você não usa.404:/settings (as abas, e-mail, e-Notas e o certificado, Bloqueios, Segurança, CVC, licenças, configurações de orçamento e de roteiro e o cadastro da empresa em /settings/company, que o Alterar pessoa já cobre) e o /payment_method_details./integrations, o /integration_vendors, os vínculos de produto e de pessoa, o /integration_credentials e o /supplier_authorizations. A consulta das integrações continua./commissions, /commission_closings e /commission_payments, e a inclusão, a alteração e a exclusão de planos de comissão. A consulta dos planos continua./cvc_statements e /cvc_master_statements, tudo menos a lista e o detalhe; e os fechamentos de extrato, o /cvc_imports e o /cvc_deposit_checks.currency), entre as ativas, quando o Monde trabalha com mais de uma: na operadora ou com multimoedas. Omitida, continua em real. As movimentações da liquidação feita na criação passam a aceitar exchange_rate e reference_exchange_rate, como a liquidação.currency).movements sem id passa a incluir uma movimentação nova no lançamento liquidado, como o Adicionar do Monde, com as parcelas (installments) na conta cartão de crédito. Antes, toda movimentação precisava do id.billing_account_id) e o demonstrativo do boleto (billet_demonstrative), como a aba Boleto do Monde. Na fatura de cliente aberta, a conta de cobrança responde 409 até o pedido trazer close_invoice como true, que fecha a fatura junto.close_invoice como true, que a fecha antes, como o Monde), e Baixar o PDF do boleto.sales.print_billet) e "Gerar boletos" (bills.generate_billet), desmarcadas nas credenciais que já existem.bills.close_invoice) e "Reabrir Fatura" (bills.reopen_invoice), desmarcadas nas credenciais que já existem.items em Consultar conta a pagar ou receber por ID passa a trazer o id, que as ações abaixo recebem.bills.change_card_fee), para Corrigir valores, e "Alterar dados do produto em vendas fechadas" (sales.edit_product_closed_sale), quando a correção muda o produto de uma venda fechada.sale_standalone) e a comissão (commission) passam a ser liquidados e reabertos como o lançamento avulso, como no Monde. Antes, respondiam 409. As permissões são as mesmas do avulso.hotels, cruises e car_rentals passa a trazer o document, a identificação do passageiro no produto, como o número do quarto ou da cabine.document (até 30 caracteres). Antes ele era descartado. Atenção: na alteração, o passageiro enviado sem document fica sem ele, como nos demais produtos; reenvie o valor lido para mantê-lo.POST) e alteração (PATCH), o texto vazio ("") passa a seguir uma regra só: no campo de texto, é gravado como foi enviado; no campo de texto obrigatório, é recusado (422); em campo de outro tipo (objeto, lista, número, booleano, data, opção ou referência por id), é recusado (422). Para retirar um valor na alteração, envie null. A regra está na introdução desta documentação."" variava por endpoint. Na inclusão, valia como campo não enviado. Na alteração, conforme o campo, limpava o valor como o null, era ignorado (inclusive objetos e listas, como seller e payer da venda, que respondiam 200 sem mudar nada) ou deixava o valor como estava. A integração que envia "" esperando que nada aconteça passa a gravar o texto vazio ou a receber 422.cpf_cnpj quando o CPF/CNPJ gravado na pessoa não é válido, qualquer que seja o campo alterado, como no Monde, que confere o documento a cada gravação. Para destravar, envie o cpf_cnpj corrigido, ou nulo para retirá-lo. Antes, a alteração estourava erro interno (500).advance) ou do sinal (deposit) com os itens do fornecedor em aberto de financial.vendor_items, cada um com o valor a gerar, como o Gerar Pagamento Avulso ou Sinal e o Sinal Fornecedor do Monde. O valor menor que o do item divide o item, e a sobra fica em aberto. Responde 201 com a fatura gerada. Pede a permissão de editar vendas, "Ver aba financeiro" (menos no deposit com product_id, o Sinal Fornecedor do produto) e "Gerar Fatura" quando a fatura automática do fornecedor está desligada ou a venda é da CVC.bills.generate_supplier_invoice) na credencial.financial.vendor_items: os itens do fornecedor da venda, como na aba Financeiro do Monde, cada um com id, kind, description, due_date, amount, currency, o produto (sale_product), o fornecedor ou representante (person), o lançamento em que está (bill) e o pagamento direto ao fornecedor que o quita (payment). Vem com "Ver aba financeiro", como o resto de financial.sale_id: lança a conta a pagar ou a receber na venda, como o botão da aba Financeiro da venda no Monde. O lançamento nasce como avulso da venda (kind igual a sale_standalone), na empresa dela, e aparece em financial.standalone_bills de Consultar venda por ID. Com sale_id, o company_identifier pode ser omitido e, enviado, precisa ser o CNPJ da empresa da venda. Exige também a permissão "Ver aba financeiro" de vendas, na empresa da venda. A venda fechada aceita o lançamento, e a excluída responde 409. operation_id e recurrence_kind são recusados com 422 no lançamento da venda, e sem account_id ele fica sem conta prevista, como no Monde.kind traz: sale_standalone, vendor_standalone e customer_invoice. A API não mudou.attachment_ids: os anexos já enviados à tarefa em Enviar anexo ficam ligados ao comentário e aparecem dentro dele no Monde. Com anexos, o texto é opcional. O anexo de outra tarefa, excluído ou já ligado a outro comentário responde 422. Pede a mesma permissão de comentar.history passa a trazer os anexos dele em attachments. Atenção: o text do comentário com anexo feito no Monde passa a vir sem a marcação (att:<id>) que o Monde guarda no lugar do arquivo.next_bank_slip_number: o número do próximo boleto que a conta corrente emitir. Vem nulo nas demais contas.recalculate_open_invoices. Com true, depois de gravar a alteração, os vencimentos das faturas em aberto que caem nas regras da pessoa são recalculados em segundo plano, como no botão Recalcular vencimentos do Monde. Omitido ou false, nada muda: só a regra é gravada. Valor que não é booleano responde 422.delete_categories: true. Sem a confirmação, a resposta continua 409. Se alguma categoria for usada em lançamento financeiro ou numa configuração do Monde, nada é excluído (409). Valor que não seja true ou false responde 422.passengers de um produto passa a alterar o mesmo passageiro, como no Monde, em vez de apagar e recriar a lista. O passageiro é identificado pela pessoa: a que já é passageiro ativo tem o mesmo passageiro alterado, a nova entra e o ativo que não vier sai.person.id, como a consulta da venda devolve, além dos dados da pessoa com o external_id. A pessoa apontada pelo id não é alterada, e o id exige a permissão de ler pessoas; sem ela, ou com uma pessoa jurídica, a resposta é 422.id e a forma com que ele foi incluído passa a ser alterado, como no Monde, em vez de ser recusado. Mudam o pagante, o vencimento, a descrição e os dados da forma (cartão, cheque, details, observations e o cost_center do Faturar), e só o que foi enviado; o id do pagamento continua o mesmo.products, a conta e a liquidação na alteração são recusados com 422, e outra forma também. Para mudá-los, retire o pagamento da lista e inclua um novo, como antes.cvc_original_data, só de leitura: os dados originais da nota importada do arquivo da CVC, que o Monde mostra na aba CVC da nota fiscal. Vem nulo quando a nota não veio desse arquivo. Vem também em toda resposta que traz a nota, como as gravações em /nfs e a geração de notas, e pede a mesma permissão de ler notas fiscais.agency, cash (Dinheiro), check (Cheque) e others (Outros); em vendor, check (Cheque direto ao fornecedor). Cada pagamento em cheque é um cheque, com check_number obrigatório, bank_code e o CPF/CNPJ em document.details nas observações. O Cheque direto ao fornecedor não gera lançamento.resource_type travel (viagem) e task (tarefa). Como no Monde, anexar pede Adicionar anexos e a permissão de editar a viagem ou a tarefa, na empresa dela.id continuam os mesmos, os sem id entram e os que ficaram fora da lista saem. O plano em uso por alguém numa função não é excluído (409).goals de cada pessoa em people de Funções, com a permissão Editar de Funções. A consulta de funções passa a trazer as metas de cada pessoa.403.changed e deleted de navios, cabines, categorias de tarefa e categorias financeiras; currencies.changed (a moeda só avisa a alteração); a tarefa vencida (tasks.overdue); e a importação concluída (integrations.import_completed e cvc_statements.import_completed).vendor_id da integração e o user_id e o integration_id da credencial, que não mudam depois do cadastro, também são ignorados./settings/payment_blocks, para consultar e alterar os Bloqueios de Contas a Pagar e Receber (acréscimo e desconto, dias de movimentação e de vencimento), com a permissão Configurar bloqueios, a mesma do Monde, que a permissão da aba Contas a Pagar e Receber não abre. Toda alteração fica no log da empresa, campo a campo./settings/security, que diz se o Monde pede o código por e-mail ao entrar num computador novo (Configurações - Segurança); e /settings/cvc, com os recursos da CVC e o FTP dos extratos, sem a senha (só ftp_password_configured), cuja alteração é sempre recusada (409), porque no Monde só quem tem acesso total altera a aba CVC (Configurações - CVC).updated_since considera as partes da vendaupdated_since passa a trazer a venda também quando muda uma parte dela, e não só o cabeçalho: produtos, passageiros, trechos e assentos, comissões, anexos, pagamentos e a inclusão, o cancelamento ou a exclusão das contas vinculadas. Vale para a alteração feita pelo Monde, pela API e por qualquer outro meio. A liquidação de uma conta só traz a venda quando muda a taxa cartão agência dos produtos ou quando é parcial e gera a conta do saldo. Atenção: a sincronização passa a receber vendas que antes ficavam de fora.status=opened,closed,canceled junto.person_id) ou os dados informados em recipient; o valor é a soma dos itens, e os tributos são calculados na gravação. Só a nota não emitida é editada ou excluída (409 nas demais). Na edição, a lista items enviada é a final: o item com id permanece, o sem id entra e o que não veio sai. Cada item novo pode trazer um local_id, devolvido na resposta ao lado do id gerado.id de cada item, usado para manter o item na edição.recipient só vale com person_id enviado como null, a escolha explícita do tomador digitado, como no Monde; sem isso, ele é ignorado, e reenviar o corpo lido não desliga a pessoa.created_by nem em canceled_by: quem gravou é a credencial, registrada no log.nf_generations.access), a mesma do Monde, que consulta e gera. Como no Monde, ela alcança as vendas que a própria credencial criou; as dos demais vendedores pedem também Consultar vendas de outros vendedores/intermediários em Vendas.product, payer, supplier e representative por { "id": ... }, representative_scope, e as notas de cada destinatário em payer_rule, supplier_rule e representative_rule, com recipient, revenues e discounts. A alteração só muda o que foi enviado, e a lista enviada é a lista final. A mesma aplicação só tem uma regra e o mesmo valor só entra na nota de um destinatário (422). A base de operadora, que não tem o cadastro de regras, responde 403 à gravação.created_by nulo); o log da regra diz qual credencial a gravou.revenues e discounts, recusam com 422 a lista enviada como texto ou objeto e o item que é lista ou objeto, como os demais campos.representative_scope passa a vir como a tela do Monde abre a regra: a regra gravada sem a marca de representante e sem representante, que não alcança venda nenhuma, vem none (antes vinha any), e a que tem o representante escolhido vem specific mesmo sem a marca (antes podia vir none).person_kind e person_id), e a gravação segue as mesmas regras da tela do Monde. Como no Monde, criar, alterar e tirar a regra de uma pessoa que tem outras exigem a permissão Editar de Regras de Faturamento; excluir a última regra da pessoa, que leva junto o cadastro de regras dela, exige Excluir. Na Conexão automática, gravar e excluir regras de faturamento é exceção concedida pelo Monde na aprovação, porque elas valem para a agência inteira.expense ou revenue) não muda depois da inclusão, e o grupo com categorias não se exclui (409). Usa as permissões de Categorias.Idempotency-Key, e o campo que o endpoint não documenta é ignorado, como no resto da API.POST /cvc_statements), Alterar recibo (PATCH, o campo omitido permanece), Excluir recibo (exclusão lógica) e Restaurar recibo. As ações do recibo viraram sub-recursos: vincular e desvincular a venda pelo número do recibo, processar a baixa de OPFAX e fechar a venda. As permissões são as do Monde: lançar o recibo, vincular a venda, processar a OPFAX e fechar a venda pedem só a consulta do Extrato (as duas últimas, também a de fechar vendas); alterar pede as novas Editar registros ou Editar registros importados, e excluir, restaurar e desvincular a venda pedem Excluir, Restaurar e Desvincular Venda do Recibo, a empresa com os recursos para lojas CVC ligados e não existe em base de operadora.movement_kind) passou a trazer também o código da CVC (code), que é o que o lançamento informa em movement_kind_code.company_identifier) e num período por vez: Consultar o resumo do fechamento, Consultar os movimentos do fechamento, cada um com valid, Marcar movimento como conferido e Fechar o extrato, que gera as faturas do fornecedor e devolve o id delas. Reabrir é excluir a fatura gerada em Excluir conta a pagar ou receber./cvc_master_statement_closings.expected_total, o valor total conferido, e é recusado com 422 se o valor faturado for diferente. A empresa precisa estar com os recursos para lojas CVC ligados (ou com a agência master franqueado, no Master); sem eles, a resposta é 403 dizendo o que ligar.GET /cvc_deposit_checks e GET /cvc_deposit_checks/{id}, com o depósito de cada movimento do extrato ao lado do faturado, retido e recebido do cliente e do saldo. Filtros period_start, period_end e only_closed_sales (padrão true, como no Monde). Exige a nova permissão Conferência Depósito CVC.202, e a situação diz quando terminou. Exige a nova permissão Importação de Extratos, como no Monde, em que a mesma permissão abre a tela e importa: ela vale para consultar, importar e ligar ou desligar a importação automática.POST assinado (HMAC-SHA256) quando registros mudam: um aviso por evento, com até 100 ids e a empresa de cada um. Endpoints para listar, criar, consultar, alterar (PATCH) e excluir webhooks, o histórico das entregas (GET /webhooks/{webhook_id}/deliveries) e o catálogo de eventos (GET /webhook_events): changed (criado ou alterado) e deleted de cada recurso e os eventos de negócio da venda e da nota fiscal. Entrega com repetição e espera crescente, e desativação depois de falhas seguidas.additional_fields, e a consulta por ID passou a trazê-los, com valor só no endereço do serviço e na identificação da agência; usuário, senha, token, chaves de API e PIN nunca são retornados (filled diz se estão preenchidos). A consulta passou a trazer também o vendor_id./integrations/{integration_id}/product_links e /integrations/{integration_id}/person_links, com consulta, inclusão, alteração e exclusão. Como o vínculo vale para todas as integrações do fornecedor, gravar e excluir exigem a permissão de inserir e editar integrações em cada uma delas.password_filled diz se está preenchida). Ler exige a nova permissão Ver Aba Usuário em Pessoas, como a aba Usuário do cadastro de pessoa no Monde; incluir, alterar e excluir exigem também Editar em Pessoas.active igual a false. Não há criação pela API.delivery, a entrega do acesso ao parceiro na conexão iniciada pela agência: aguardando, entregue ou com o prazo esgotado, como a tela de Integrações mostra.POST /oauth/connections com o client_id e o client_secret. A resposta traz as conexões em data e o nó pagination da API. Cada conexão é entregue uma única vez e espera a consulta por 72 horas; depois disso, a integração é excluída na conta da agência. O parceiro só aparece para a agência depois de marcar Conexão iniciada pela agência na área do parceiro. Veja o passo 7 da Conexão automática./settings/{tab} para Geral, Vendas, Recebimento, Contas a Pagar e Receber, Comissão, Metas, Fatura Cliente, Fatura Fornecedor, Notas Fiscais e Exportação Cartão Passagem. A alteração grava só os campos enviados, com as regras da tela, e fica no log da empresa. Cada aba pede a permissão do Monde para ela (como Configurações - Geral), que libera consultar e alterar a aba./settings/email, para consultar e alterar o servidor e o remetente dos e-mails da empresa, com a permissão Configurações - E-mail (Geral) do Monde. A senha do servidor só se grava./settings/company, para consultar e alterar o cadastro da empresa (nome, razão social, inscrições, contatos e endereço; o CNPJ não muda), e /settings/licenses, para consultar as licenças das empresas. Exigem a nova permissão Cadastro da Empresa e Licenças./settings/enotas, para consultar e alterar a emissão de NFS-e pelo e-Notas da empresa (regime, alíquotas, série e RPS, ambiente de teste e o acesso à prefeitura), e /settings/enotas/certificate, para enviar o certificado digital em multipart. Usuário, senha, token e certificado só se gravam: a consulta diz apenas se estão configurados e o vencimento do certificado. Exige a permissão da aba Notas Fiscais, a configuração de NF do Monde.name de Consultar cidades passa a achar a cidade também pelos outros nomes dela na lista de cidades do Monde: ?name=New York e ?name=Nova York acham Nova Iorque, ?name=Asunción acha Assunção. Acha também pelo início das palavras, pelo estado e pelo país, como o campo Cidade do Monde. O trecho em qualquer posição do nome continua achando.name, a lista deixa de vir em ordem alfabética: a cidade cujo nome é o informado vem primeiro, depois a que tem esse nome entre os outros nomes, a que começa por ele, a que o contém e, por fim, as demais; em cada grupo, a maior primeiro. Sem o filtro, a ordem continua pelo nome. O cursor de uma busca só vale para o mesmo name.O campo 'insurances passengers person name' é obrigatório não dizia de qual seguro nem de qual passageiro; agora vem O campo 'insurances[0] passengers[2] person name' é obrigatório. Vale para os produtos da venda, passengers, segments, seats, payments e os products deles, commissions, contacts, history e custom_fields. Dois itens com o mesmo erro passam a ter uma mensagem cada. Atenção: quem compara o texto da mensagem precisa considerar a posição.O campo 'movements[0] check' deve ser uma lista ou um objeto…. O item que não é objeto passa a ser apontado pela posição: O campo 'labels[1]' deve ser um objeto….'credit_cards[1]': Não é possível cadastrar um cartão vencido., no lugar de O campo 'credit_cards[1]' Não é possível…. Vale para credit_cards, cost_centers e kandir_law da pessoa.O campo 'commissions' só pode ser enviado em venda fechada…, e não mais uma mensagem por comissão. A comissão de intermediário sem intermediário na venda responde O campo 'commissions[0]' é de intermediário, e a venda não tem intermediário informado."contacts": [null] ou [""]) passa a responder 422. Antes ele era ignorado, e os itens seguintes mudavam de posição. A lista inteira enviada como null continua valendo como antes.birthplace) não é mais cadastrada. Sem o city_ibge, o city_name é procurado entre as cidades da agência e as da lista de cidades do Monde (Consultar cidades), sem diferenciar acento nem maiúscula: no Brasil, no estado do state_code; no exterior, no país do country_code.state_code é procurada primeiro como "Nome, UF", a forma em que a API cadastrava essas cidades antes, e depois só pelo nome no país.422 em city_name, e nada é gravado. Antes, a cidade era cadastrada com o nome enviado.agency.credit_card) passa a lançar a taxa do cartão, como no Monde. Sem taxa no payload, vale a "Taxa cartão de crédito" das configurações de Vendas. Para enviar outra, use card_rate_percentage (%) ou card_rate (valor), um dos dois. A taxa é rateada no agency_card_rate dos produtos pagos e abate o valor final do lançamento na categoria de taxa de cartão da empresa. Sem essa categoria configurada, a taxa maior que zero responde 422. Atenção: quem já envia esse pagamento passa a ter a taxa padrão da empresa lançada quando ela estiver configurada; para manter o lançamento sem taxa, envie card_rate_percentage igual a 0.agency_card_rate dos produtos é refeito com os pagamentos que ficam.passengers, com a pessoa (person.id) e a data de cancelamento de cada passageiro; o produto fica cancelado quando a lista cancela os que faltavam. O produto sem passageiros é cancelado sem a lista, na data do dia. O produto cancelado continua somando no valor da venda. Exige, na empresa da venda, a permissão de editar vendas e a permissão "Cancelar produto", nova na credencial, como no Monde; a credencial existente começa sem ela.passengers com a pessoa de cada passageiro que volta. Reativando todos os passageiros cancelados, devolve ao financeiro o que o cancelamento tinha excluído; reativando só parte, a multa e o saldo excluído ficam. Com a fatura automática do fornecedor, responde 409 enquanto a multa do cancelamento ainda está sendo lançada na fatura: repita em alguns segundos. Exige as mesmas permissões do cancelamento.kind, pelo tipo de produto: a venda entra quando tem algum produto não excluído de um dos tipos informados.airline_tickets) passa a aceitar observations na criação e na alteração, e passa a recusar com 422 o destino cruise: como no Monde, ela é national ou international. A passagem que a API gravou antes com cruise continua vindo assim na consulta e só é alterada com o destino trocado para national ou international: o cruise é recusado também quando o destino é omitido.promoter) como o Monde: é o promotor do cadastro do intermediário, copiado quando a venda é criada e a cada troca de intermediário. O promotor não é enviado no payload.reservation_due_date (data de vencimento da reserva) nos produtos da venda, exclusivo da operadora: gravado em Inserir venda e Alterar venda e devolvido na consulta. Na agência, é recusado com 422 e vem nulo na consulta.operation e operation_id) passa a ser recusada com 422, como no Monde, em que ela é exclusiva da agência.approver) enviado com valor em Inserir venda e Alterar venda passa a ser recusado com 422, como no Monde, em que a venda da operadora não tem aprovador. Enviado como null na alteração, ele é retirado da venda.agency.credit (Crédito na Agência), agency.to_invoice (Faturar, com vencimento, centro de custo e descrição, que entra na fatura de cliente pela fatura automática) e agency.retained_by_intermediary (Retido pelo Intermediário, só na agência e em venda com intermediário). O Crédito na Agência e o Retido pelo Intermediário respondem 422 na operadora. Sem payer, o Faturar fica no pagante da venda, também na operadora, como no Monde.vendor.credit) passam a conferir o saldo do pagante, somando os pagamentos com crédito da requisição, e a consumi-lo ao gravar a venda; sem saldo suficiente, a resposta é 422 com o saldo disponível. Retirados da venda na alteração, o crédito usado volta ao pagante. Como no Monde, o Crédito no Fornecedor usa, para o valor todo do pagamento, o saldo de um fornecedor e representante só: os do primeiro produto do pagamento, por ordem alfabética do representante e, depois, do fornecedor, mesmo quando o pagamento paga também produtos de outro fornecedor.payments, devolvendo o crédito usado. Antes, ele só saía pelo Monde.payments.agency.to_invoice, com id próprio, e as faturas em bills. A fatura de cliente do Faturar deixa de aparecer em payments.agency.bills, e o id dela deixa de manter o pagamento na alteração: use o id do Faturar. O Faturar que ainda não entrou em fatura passa a aparecer.products[]) ganha o id do item gravado para ele. A alteração mantém a linha pelo id dela ou pelo de qualquer um desses itens: quando um pagamento igual incluído depois entra na mesma linha e troca o id dela, o id guardado antes continua valendo.payments.agency.retained_by_intermediary) ganha id, e os dois passam a ser mantidos ou retirados pela lista payments da alteração: a alteração que envia payments sem o id deles os retira, o que antes não acontecia. O Faturar em fatura de cliente fechada ou liquidada não sai.id, como no Monde. Como no Monde, que só tira essa parte quando o usuário exclui aquela linha, a alteração não a retira por ficar de fora de payments enquanto a lista mantém outra linha do mesmo Faturar (mesmo pagante, centro de custo e descrição); ela sai quando nenhuma linha do Faturar fica na lista. Para manter o Faturar inteiro depois da divisão, envie o id de cada linha dele (ou de cada item em products).payer sem tirá-los de payments responde 422. Antes, o pagante mudava e os itens ficavam no nome do pagante anterior.observations) passam a ser aceitas na criação e na alteração, também na venda fechada, como no Monde. A alteração vai para o histórico da venda.customer) ou com o fornecedor (vendor), com as regras das ações Reembolso Cliente e Reembolso Fornecedor do Monde: o reembolso vai para a fatura pelas regras de faturamento (invoice) ou gera na hora uma fatura avulsa só com ele (bill), e entra no reembolso do produto e na receita da venda. O reembolso ao cliente só existe na agência: na operadora, responde 403. Como no Monde, lançar o reembolso é editar a venda: exige a permissão Editar de Vendas (na venda que a credencial não criou, também Editar vendas de outros vendedores; na venda com recibo impresso, também Alterar vendas com recibo impresso, no reembolso ao cliente e no do fornecedor) e o Idempotency-Key.409, e o reembolso ao cliente na venda fechada também. O reembolso do fornecedor que já virou conta a pagar/receber (a conta gerada só para ele ou, com a fatura automática de fornecedor desligada, qualquer fatura) só é excluído com remove_from_bill como true, como a confirmação do Monde ao excluir a conta: sem ela, responde 409; com ela, a conta inteira é excluída, como no Monde: o reembolso sai, e os outros itens da conta voltam a ficar pendentes, sem fatura. Exige as mesmas permissões do lançamento (inclusive Alterar vendas com recibo impresso na venda com recibo impresso), mais Ver aba financeiro no reembolso do fornecedor, e o Idempotency-Key. Excluir a conta inteira com remove_from_bill exige também Editar e Excluir de Contas a Pagar e Receber sobre ela (e, na conta de outro usuário, o acesso aos lançamentos dos outros usuários), como excluir o lançamento no Monde; sem elas, 403.custom_fields.POST /bank_reconciliations, em multipart/form-data), consultar e descartar os extratos enviados, refazer o casamento automático, consultar as linhas da conciliação com a situação de cada uma, consultar os candidatos de uma linha, vincular a linha (PATCH, com a lista final de movimentações e as contas a pagar ou receber em aberto a liquidar na data da linha), recusar a sugestão e conferir ou desfazer a conferência de cada movimentação.amount da movimentação é na moeda do lançamento; na conta em outra moeda, ele entra convertido pela última cotação, e sem cotação cadastrada a movimentação responde 422. Antes, o lançamento fora do real respondia 422. Pelo vínculo da conciliação bancária, a conta em aberto na moeda da conta corrente também se liquida.exchange_rate, que converte a moeda do lançamento na da conta (só na conta em outra moeda; com ele, a falta de cotação cadastrada deixa de responder 422), e reference_exchange_rate, o câmbio de referência da conta fora do real. No vínculo da conciliação, cada conta em aberto de open_bills aceita reference_exchange_rate na conta corrente fora do real. Os dois são opcionais, maiores que zero e gravados com 6 casas decimais; omitidos, valem as últimas cotações, e enviados onde não se aplicam são ignorados.conta_movimento) passa a pedir Visualizar Log de Transferências entre Contas, como no Monde, e não mais ler as Movimentações. Pela conexão automática, consultar, editar, excluir e ver o log das transferências é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: a transferência não guarda quem a lançou, então quem as lê ou grava alcança também as que a agência lançou.company_identifier): cor, redes sociais, condições gerais, modelo de conteúdo e logotipo. Alterar configurações de orçamento responde sempre 409, sem gravar nada: como no Monde, só o administrador altera as configurações, pela tela do Monde Web.updated_at, e a consulta por ID, também o dono do orçamento em user.person_id) ao criar, alterar ou duplicar um orçamento exige a permissão Ler todas as pessoas. Sem ela, a pessoa é recusada (422) com a mesma mensagem da pessoa que não existe.customer_id) ao criá-la ou alterá-la e a pessoa do reembolso ao cliente (person_id) também exige Ler todas as pessoas, com a mesma recusa.company_identifier): o rodapé da página pública dos guias. Alterar configurações de guia responde sempre 409, sem gravar nada: como no Monde, só o administrador altera as configurações, pela tela do Monde Web.company_identifier) sem informar o dono (user_id) passa a responder 422 quando o dono atual não tem acesso à empresa de destino, pedindo um dono que tenha. Antes, o guia mudava de empresa e ficava com um dono que não o alcança. Quando o dono atual tem acesso às duas empresas, nada muda.companies), os grupos de usuários com acesso (user_groups) e a cobrança da conta corrente (billing_accounts, Monde Bancos e CobreBem). Exigem as novas permissões Editar e Excluir de Contas e Cartões, como no Monde.agency ou initial_balance num cartão, ou billing_accounts fora da conta corrente) é ignorado, como o campo que não existe: não é gravado e não responde 422.initial_balance) reabre os caixas fechados da conta e exige também a nova permissão Reabrir Caixa de Contas e Cartões, como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. Reenviar o saldo gravado não pede a permissão.registered é gravado como a tela permite; no Monde Bancos, ele sai da carteira escolhida, e o valor enviado é ignorado.invoice_company, user_groups e billing_accounts.balance_resolution igual a partial, no lançamento com itens (como o pagamento da venda), o item dividido entre a conta paga e a do saldo passa a repartir a taxa cartão agência na proporção do valor de cada parte. Antes, a parte que ia para o saldo levava a taxa inteira do item, e a taxa cartão agência do produto ficava contada duas vezes até o saldo ser liquidado.sale_payment), cujo id vem em payments.agency.bills da venda. A baixa usa a forma e os dados de pagamento da venda: payment_method_id fica opcional na movimentação, e a taxa de cartão calculada na venda passa para a movimentação sem precisar enviar card_rate. Como em toda movimentação com taxa, amount é o que o cliente pagou, e a conta recebe amount menos a taxa. Ao desfazer, a taxa de cartão fica no lançamento.package_name), com os serviços inclusos./ships/MSC%20Preziosa). Renomear leva o nome novo para os produtos de venda que usam o registro, e o registro usado em produto de venda não é excluído (409).409): desative-a.201 quando gravam e 200 quando o valor é igual ao da cotação vigente e nada é gravado (no lote, com a lista vazia). Na agência, as duas respondem 403.null passa a ser retirado do registro, em vez de valer como omitido. O que o registro não pode ficar sem enviado como null responde 422. A lista enviada como null vale como a vazia, e o item de custom_fields com value nulo ou vazio limpa aquele campo (o obrigatório responde 422). A criação não muda. Alterar venda já seguia essa regra.address, birthplace, additional_data, airline, seller, promoter e as listas se esvaziam. name, person_kind, external_id, foreigner, charge_billet_fee, as retenções, o e-mail de usuário do Monde, os dados obrigatórios do cartão e os percentuais da Lei Kandir respondem 422.title, assignee_id e completed respondem 422.internal_observations fica em branco; title, subtitle, details, active, user_id e company_identifier respondem 422.apportionments nulo esvazia os rateios, e per_cost_center ou per_company nulo esvazia só aquele; company_identifier nulo responde 422.people nulo desfaz todos os vínculos; person e not_commissioned nulos num item de people respondem 422.422. As exceções são kanban_position, aceito nulo quando a categoria sai do quadro, e choices, em que o nulo vale como lista vazia.POST /products, tipos others e operation), alterar (PATCH /products/{id}) e excluir (DELETE /products/{id}). Produto CVC não se altera, e produto do sistema ou com vínculos não se exclui: os dois casos respondem 409. Exigem as novas permissões Editar e Excluir de produtos./products/{product_id}/supplies e representantes de cada fornecedor em /products/{product_id}/supplies/{supply_id}/representations, com consulta em lista, consulta por ID, criação, alteração (PATCH) e exclusão. A consulta usa a permissão de ler produtos; a gravação e a exclusão têm permissões próprias, como no Monde: Adicionar Fornecedor, Editar Fornecedor, Excluir Fornecedor, Adicionar Representante, Editar Representante e Excluir Representante.null é retirado. O campo que não pode ficar vazio (como name, active, supplier e os da comissão) enviado como null responde 422.id de cada fornecimento e de cada representante.status: opened, como o Monde: a venda reabre antes de o resto do pedido ser aplicado, e a alteração vale por inteiro ou nada muda. Reabrir só muda a situação da venda; as comissões e o financeiro ficam como estão. Exige a permissão "Reabrir venda", nova na credencial e conferida na empresa da venda, como no Monde; "Fechar venda" não reabre. A venda excluída continua respondendo 409.credit_cards ou kandir_law com algum item, ou retirando os da pessoa, passou a exigir a permissão "Ver aba financeiro" de pessoas, como no Monde, em que os cartões e a Lei Kandir ficam na aba Financeiro da pessoa. Cada operação nos cartões pede também a permissão dela: incluir cartão (item sem id), "Cadastrar Cartão de Crédito"; alterar cartão (item com id e algum campo a mudar), "Visualizar dados do Cartão de Crédito" e "Editar Cartão de Crédito"; deixar de fora da lista um cartão que a pessoa tem, "Remover Cartão de Crédito". Sem a permissão, a resposta é 403 com a mensagem do Monde, e nada é gravado.credit_cards e kandir_law só vêm com "Ver aba financeiro", e credit_cards, também com "Visualizar dados do Cartão de Crédito". Sem a permissão, o campo não vem: é omitido, não vem nulo.seller ou promoter nulos, na pessoa que tem) passou a exigir "Alterar Vendedor" ou "Alterar Promotor", como trocar já exigia.settlement_date do lançamento liquidado para uma data diferente da gravada passou a exigir também "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, como no Monde. Reenviar a mesma data não pede a permissão.commissions com alguma comissão passou a exigir "Ver aba comissões" e "Adicionar comissões". Em Alterar venda, enviar commissions, mesmo vazia ou nula, passou a exigir também "Ver aba comissões", além de "Adicionar comissões" e "Excluir comissões".cidade) passou a vir a quem tem "Visualizar Log" de cidades, em vez de a quem lê as cidades.id e, na venda, também o id e o local_id dos produtos e pagamentos enviados; o mesmo vale para a liquidação e a restauração do lançamento e para o comentário na tarefa. Uma alteração sem nenhum campo não serve de consulta. A criação continua devolvendo o registro criado inteiro, com os campos protegidos ocultos conforme as permissões de campo. O download de anexo segue a consulta do registro dono dele, com a mesma regra.balance_resolution diz o que fazer com a diferença: category a lança numa categoria de desconto ou acréscimo (a de balance_category_id ou a padrão da empresa), e partial liquida o que foi pago e cria um lançamento em aberto com o saldo, que vem em generated_bills. Liquida o lançamento avulso, as faturas de cliente e de fornecedor e a fatura de cartão com a edição liberada; o pagamento e o avulso da venda e a comissão respondem 409. Exige Idempotency-Key, a permissão "Editar" de contas a pagar e receber e a "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, as mesmas da inserção já liquidada.undo_bank_reconciliation como true. Exige também a permissão Editar lançamento liquidado. Não exige Idempotency-Key.commissions, cuja lista sempre substitui as comissões manuais. As comissões passaram a exigir "Adicionar comissões" e "Excluir comissões", no lugar de "Fechar venda". Excluir venda com recibo impresso passou a exigir também "Alterar vendas com recibo impresso". A credencial que já existia continua fazendo o que fazia: "Editar" vale também pelas permissões novas da alteração, "Fechar venda" pelas das comissões, e "Excluir" pela do recibo impresso.payments e financial, com "Ver aba financeiro"; e commissions, com "Ver aba comissões". Sem a permissão, o campo não vem. Na resposta da inserção e da alteração, sem "Ver aba financeiro", payments traz só o id e o local_id dos pagamentos enviados.seller) passou a exigir a permissão "Alterar Vendedor", e o promotor (promoter), a "Alterar Promotor", como no Monde; sem ela, a resposta é 403. A credencial que já existia continua com o que fazia: "Editar" vale também por essas permissões.assignee_id. A conferência vale em toda alteração, não só quando o responsável ou a empresa mudam. A tarefa sem empresa não confere.card_rate, a taxa de cartão, com as regras do Monde: só na conta a receber, em conta corrente e com a forma cartão de crédito ou de débito. amount é o que o cliente pagou, a conta recebe amount menos a taxa, e a soma das taxas vira a categoria de taxa de cartão configurada na empresa, que abate o valor final; sem essa categoria, a taxa responde 422. Na alteração, mudar só a taxa mantém o que o cliente pagou.Consultar movimentação por ID passa a trazer card_rate, a taxa de cartão da movimentação.
Nova Restaurar conta a pagar ou receber excluída (POST /bills/{id}/restoration), com as regras do Restaurar do Monde: só o lançamento avulso volta, em aberto, e a liquidação que saiu na exclusão não volta. O lançamento da venda, a fatura e a comissão respondem 409. Exige as permissões Restaurar e Editar de contas a pagar e receber na empresa do lançamento. O lançamento de outro usuário pede também Acessar dados de outros usuários, como nas demais ações.
Desfazer a liquidação ganha recurrence_scope, como a alteração e a exclusão: no lançamento de uma série, this_and_following desfaz também a liquidação dos seguintes que estão liquidados, com as mesmas recusas e a mesma permissão de cada um. Se um deles não pode reabrir, nenhuma liquidação é desfeita, e a resposta 409 diz qual barrou. O padrão continua sendo desfazer só o lançamento informado.
company_identifier nas gravações) e se a empresa está somente leitura. Exige a nova permissão "Ler todas as empresas", concedida em cada empresa que deve aparecer.409): desative-o com active: false. Exigem as novas permissões de vendedores "Editar" e "Excluir".id, quando uma pessoa ou nota fiscal passa a usá-la.city_ibge e o nome da cidade do endereço e da naturalidade passam a achar também a cidade da lista. Quando o nome se repete, vem a cidade maior. Antes, a cidade do exterior que a agência não tinha era criada de novo, sem relação com a da lista. A cidade do exterior enviada com state_code continua sendo procurada como "Nome, UF" e, sem par, criada com esse nome.choices) só no tipo lista, e recurso e tipo fixos depois de criados. Não há exclusão: o campo que não se usa mais é desativado com active: false. Exige a nova permissão Criar e editar de campos personalizados.kanban, que diz se a categoria é uma coluna do quadro de tarefas, e kanban_position, a posição da coluna no quadro (nula fora dele).kanban_position a leva para outra posição, deslocando as demais. A categoria com tarefas, inclusive concluídas ou excluídas, não é excluída: a resposta é 409. Exigem as novas permissões Editar e Excluir de categorias de tarefas.commissioned_over ficam no log da função, em nome da credencial.credit_cards (cartões de crédito), cost_centers (centros de custo do cliente corporativo) e kandir_law (retenções da Lei Kandir), no mesmo formato da consulta por ID. Na alteração, a lista enviada substitui a atual, como contacts e labels: o cartão que a pessoa já tem é citado pelo id, o centro de custo pelo nome e a retenção pelo produto. O número e o código de segurança do cartão são gravados cifrados e nunca voltam na resposta, que traz só os quatro últimos dígitos. Centros de custo e retenções só valem para pessoa jurídica, e a retenção só para Passagem Aérea, Seguro Viagem e Transporte Terrestre, com o total de cada grupo calculado pela soma de IR, CSLL, PIS e COFINS. Cada inclusão, alteração e exclusão entra no histórico da pessoa.id de cada cartão em credit_cards e a lista cost_centers.birthday_from e birthday_to (YYYY-MM-DD, juntos, até 366 dias) trazem quem faz aniversário na janela, sem olhar o ano e atravessando a virada do ano. Ganha também o filtro label_id, para as pessoas de um marcador.POST /people/{person_id}/conversion), com as regras da conversão do Monde: apaga os dados que só o tipo de origem tem e recusa o usuário do sistema e a empresa do sistema. Exige a permissão de alterar pessoas.photo (tipo e tamanho da foto, ou nulo) e invoice_rules (as regras de faturamento próprias da pessoa).email de outro usuário passa a responder 422 em email, e nada é gravado. Antes a resposta era 500. Vale também para a pessoa já cadastrada, citada em Inserir venda ou em Alterar venda, que é usuário sem e-mail e receberia o de outro usuário. A pessoa que não é usuário continua aceitando qualquer e-mail, inclusive o de um usuário, e Inserir pessoa não muda: a pessoa criada ainda não é usuário.assignee_id (responsável), created_by_id (quem cadastrou), person_id, category_id (ou uncategorized, para as tarefas sem categoria), status (pending, completed e deleted, separados por vírgula), overdue (vencidas), o período por date_field (due, created_at ou completed_at) com date_from e date_to, e o vínculo com venda, viagem e lançamento (sale_id, travel_id, bill_id). Sem status, a lista continua sem as tarefas excluídas. Filtro com valor inválido responde 400.sale_id, travel_id e bill_id em Criar tarefa e Alterar tarefa, e sale, travel e bill em Consultar tarefa por ID. Os vínculos não têm relação obrigatória com a pessoa da tarefa; quando vierem juntos, precisam combinar entre si: a venda tem de ser da viagem informada, e o lançamento, da venda informada. Na alteração, o vínculo enviado como nulo é desfeito, e a pessoa já preenchida da tarefa não é trocada enquanto ela tiver vínculo; preencher a pessoa da tarefa que está sem pessoa é permitido.recurrence_scope igual a this_and_following, cada lançamento seguinte da série só recebe a alteração quando a credencial poderia alterá-lo diretamente: com a permissão "Editar" na empresa dele, que não pode estar somente leitura; no de outro usuário, também o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, também a "Editar lançamento liquidado". O seguinte que não atende a isso fica como está, e a resposta continua 200.this_and_following, o lançamento seguinte excluído (canceled igual a true) fica como está e não recebe mais a alteração da série.recurrence_scope igual a this_and_following, cada lançamento seguinte da série só é apagado quando a credencial poderia excluí-lo diretamente: com a permissão "Excluir" na empresa dele, que não pode estar somente leitura; no de outro usuário, também o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, também a "Editar lançamento liquidado". O seguinte que não atende a isso continua lá, fora da série, e a resposta continua 204.setec. O código SETEC não era usado pelo Monde em nenhuma emissão de nota e foi removido do cadastro de cidades.balance_resolution e balance_category_id no lançamento criado já liquidado, como a liquidação: com category, a diferença entre o pago e o valor final vai para a categoria informada ou, sem ela, para a categoria padrão da empresa; com partial, o saldo vira um lançamento em aberto. O partial_payment: true continua aceito e equivale a balance_resolution: partial; o partial_payment que contradiz o balance_resolution é recusado com 422. O balance_resolution não se combina com parcelamento nem recorrência.balance_resolution diz o que fazer com a diferença: category a lança numa categoria de desconto ou acréscimo (a de balance_category_id ou a padrão da empresa), e partial liquida o que foi pago e cria um lançamento em aberto com o saldo, que vem em generated_bills. Liquida o lançamento avulso, as faturas de cliente e de fornecedor e a fatura de cartão com a edição liberada; o pagamento e o avulso da venda e a comissão respondem 409. Exige Idempotency-Key e a permissão de inserir e editar contas a pagar e receber, a mesma da inserção já liquidada.undo_bank_reconciliation como true. Exige também a permissão Editar liquidadas. Não exige Idempotency-Key.canceled igual a true e continua na consulta por ID. Exclui o lançamento avulso e a fatura de cliente e de fornecedor, cujos itens voltam a ser faturados; o gerado por venda, a fatura de cartão, o lançamento de comissão e a fatura gerada pelo Monde com itens respondem 409 com o motivo. O lançamento liquidado só é excluído com remove_settlement como true, que remove a liquidação, e o conciliado com undo_bank_reconciliation como true. Num parcelamento ou recorrência, recurrence_scope com this_and_following apaga também os lançamentos seguintes sem movimentação, como a opção "Excluir este e próximos" do Monde. Não exige Idempotency-Key.payments[].*.products[] passou a apontar o produto por sale_product_local_id (um produto enviado na mesma requisição) ou por sale_product_id (um produto que a venda já tem, só na alteração), no lugar de local_id, external_id e id. O valor destinado ao produto passou a se chamar amount, no lugar de payment_amount, como na consulta da venda. Por enquanto, local_id, external_id e payment_amount seguem aceitos, para não quebrar quem já os envia: migre para os nomes novos. Como o sale_product_local_id aponta só o valor, dois produtos da venda não podem mais usar o mesmo valor como chave, nem um em local_id e o outro em external_id.payments passou a ter uma única forma de pagamento: agency ou vendor, com uma só forma dentro. Para pagar com duas formas, envie dois pagamentos. Assim cada pagamento enviado volta com um id só.local_id passou a ser obrigatório em cada pagamento novo de payments e único entre os pagamentos novos da requisição; o pagamento sem ele é recusado com 422. É ele que volta na resposta, dentro do pagamento, ao lado do id gerado, que você usa para manter o pagamento na próxima alteração. O pagamento mantido pelo id não precisa dele.403 com "A empresa não tem licença ativa do Monde. Contate o nosso time de suporte para mais informações.".403.403 com "Este recurso exige a licença Monde Pro. Contate o nosso time de suporte para mais informações."; com a licença Monde Pro somente leitura, os guias são consultados, mas não gravados. O public_url fica nulo quando a empresa está somente leitura, não tem a licença Monde Pro ou tem a licença Monde Pro somente leitura.403 com mensagem própria, "A empresa está somente leitura: os registros dela podem ser consultados pela API, mas não gravados.", no lugar de "Sua licença não dá acesso a esta ação.". Vale para toda gravação: vendas, tarefas e o histórico delas, pessoas, contas a pagar e receber, anexos e guias, inclusive pela Conexão automática, e para a troca de empresa da tarefa ou do guia para uma empresa somente leitura. "Sua licença não dá acesso a esta ação." fica só para a licença Monde Pro somente leitura, nos guias. A consulta segue liberada.account_id) passa a aceitar qualquer conta ativa vinculada à empresa, inclusive conta cartão de crédito na conta a receber, como no Monde. A conta cartão continua fora das movimentações da conta a receber.operation_id) inativa.amount), categorias, rateios por centro de custo e entre empresas e a empresa do lançamento (company_identifier). As categorias e cada rateio enviados substituem os atuais; o valor enviado sem as categorias segue a regra do Monde: com uma categoria só, ela acompanha o novo valor; com mais de uma, ele precisa ser igual à soma delas. Levar o lançamento para outra empresa exige a permissão de inserir e editar também nela, e o lançamento com boleto registrado ou emitido não muda de empresa. Num parcelamento ou recorrência, recurrence_scope com this_and_following leva a alteração também aos lançamentos seguintes da série, em segundo plano, como a opção "Atualizar este e próximos" do Monde.settlement_date) e as movimentações que ele já tem (movements, cada uma pelo id), sem acrescentar nem retirar movimentação, sem liquidar e sem estornar. As movimentações precisam somar o valor final, e a empresa do lançamento liquidado não muda. Exige, além de Inserir e editar, a nova permissão Editar liquidadas em Contas a Pagar e Receber, oferecida na credencial da API. O lançamento com movimentação conciliada responde 409, com o aviso do Monde, até o pedido trazer undo_bank_reconciliation como true; com a confirmação, a conciliação da movimentação alterada é desfeita.bill em resource_type: informe o resource_id da conta a pagar ou receber de destino e o anexo entra no lançamento, aparecendo na consulta da conta por ID e no download. Exige, em Contas a Pagar e Receber, a permissão Adicionar anexos, que passou a ser oferecida na credencial da API, concedida na empresa do lançamento, que não pode ser somente leitura. O restante do envio não muda: um arquivo por requisição, as mesmas extensões, o mesmo limite de 12 MB e o mesmo Idempotency-Key.exchange_rate dos produtos e do payment_amount dos pagamentos de Criar venda passou a explicar como o câmbio é aplicado: cada valor é convertido e arredondado em 2 casas separadamente, e o total do produto é a soma desses valores. O cálculo não mudou; quem soma na moeda de origem e converte uma vez só pode chegar a centavos de diferença e ter o fechamento recusado por saldo pendente.recurrence_kind: installment, com periodicity e o total de installments), a recorrência (recurrence_kind: recurrent, pelos próximos 5 anos) e o pagamento parcial (partial_payment: true), em que o saldo vira um novo lançamento em aberto. A série é gerada em segundo plano, como no Monde: a resposta traz o recurrence_group_id, e os lançamentos da série se consultam pelo novo filtro recurrence_group_id de Consultar contas a pagar e receber. O saldo do pagamento parcial vem na hora, em generated_bills.recurrence_status: pending enquanto a série do parcelamento ou da recorrência não foi gerada, generated quando já foi, e retrying quando a última tentativa falhou e o Monde vai tentar de novo.operationId estável (por exemplo listSales, createSale e getPerson), que geradores de SDK e ferramentas de agentes de IA usam como nome da função.x-badges): o aviso que se repetia no começo de toda descrição saiu.https://web.monde.com.br/api/v3/openapi.yaml, com Content-Type: application/yaml. O endereço /api/v3/documentation/file continua valendo.details_format: todo orçamento tem os detalhes (details) em HTML, com as imagens em <img data-quote-image>.ValidationError: e com a data formatada (O caixa do dia "10/10/2026" da conta "Caixa" está fechado. no lugar de ValidationError: O caixa do dia "#Date(2026-10-10)#"…).company_identifier, a criação é recusada com 422 e a mensagem informa a empresa, como no Monde, que não deixa cadastrar venda fora de uma viagem nessa empresa. Antes a venda era criada solta. A API ainda não cria venda dentro de uma viagem; quem integra com essa empresa precisa desligar a configuração ou usar outra empresa.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.POST /bills), em aberto, com as regras do lançamento manual do Monde: a soma com sinal das categorias forma o valor final, o rateio por centro de custo fica entre 0 e 100%, o rateio entre empresas fecha 100%, e os bloqueios de vencimento e de acréscimo e desconto da empresa valem sempre. Exige a nova permissão de inserir e editar contas a pagar e receber e a chave de idempotência.settlement_date e as movements: a soma das movimentações fecha com o valor final, a forma de pagamento segue o tipo da conta, e o bloqueio da data de movimentação e o caixa fechado valem como no Monde. A liquidação parcial ainda não é aceita. Sem issue_date, a emissão passa a ser hoje ou o vencimento ou a liquidação, quando forem anteriores, em vez de recusar o vencimento já passado. O erro de um item de lista do lançamento traz a posição do item, a partir de 0, como em 'movements[1] account_id'."labels": { "0": { "id": "<id>" } } no lugar de "labels": [{ "id": "<id>" }]) passa a responder 422, com o nome do campo, e nada é gravado. Antes ela podia responder 500.commissions passou a vir no objeto person, com os mesmos campos do intermediário, no lugar do external_id. Como nos passageiros, a pessoa é procurada pelo external_id e, sem vínculo, pelo CPF/CNPJ; não achando, é cadastrada. Antes o external_id precisava já estar vinculado a uma pessoa, e a comissão não cadastrava ninguém. Como no Monde, o kind não restringe quem recebe: a comissão de vendedor pode ir para qualquer pessoa. Sem description, seller e intermediary gravam "Comissão Vendedor" e "Comissão Intermediário". A comissão que ainda mandar só o external_id é recusada com 422.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.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.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.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.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.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.PATCH /sales/{id}). Altera a venda aberta: o campo omitido permanece como está, e cada lista enviada substitui a atual (os produtos de cada tipo, os passageiros e trechos de cada produto enviado, payments e commissions). O campo enviado como null é retirado da venda (intermediary, approver, requester, operation_id e operation; a operation_id só sai junto do produto de operação própria que a sustenta), e o campo personalizado enviado em branco é limpo, menos o obrigatório. No produto alterado, o que o payload não traz, inclusive passageiros e trechos, permanece, e a lista de passageiros ou de trechos enviada vazia é recusada. No transporte terrestre e no bilhete de trem, cujos trechos ficam no texto dos serviços inclusos, os segments reenviados exigem o included_services junto, que grava como veio. A lista enviada como null equivale à lista vazia, com as mesmas travas; nos campos personalizados, que não são substituídos, ela não altera nada. Vale também para as listas de dentro de um item: os seats de um trecho enviado podem ir omitidos, vazios ou como null, e o pagamento novo com products vazio ou null é recusado. O produto que a venda já tem é apontado pelo id da consulta por ID; o produto sem id é incluído, e o que não vier na lista do seu tipo é excluído. Em payments, o pagamento enviado só com o id fica como está, o sem id é incluído e o que não vier é removido; no pagamento novo, o produto pago é apontado por sale_product_local_id, para um produto da mesma requisição, ou por sale_product_id, para um produto que a venda mantém. Os totais são recalculados, e o saldo do pagante e o valor a faturar ao fornecedor são ajustados pela diferença. O que já foi conciliado no financeiro não sai: a remoção de pagamento liquidado ou em fatura de cliente fechada responde 422, assim como valor do fornecedor em fatura fechada, liquidada ou avulsa e comissão paga. A venda excluída não pode ser alterada (409). Na venda fechada, como no Monde, só mudam o vendedor, o solicitante, o aprovador, os campos personalizados e as comissões, e o status só aceita closed (o resto responde 409). As comissões vêm no mesmo formato da criação, com quem recebe no objeto person. A venda pode ir para outra empresa em que a credencial também possa alterar venda, com as travas do Monde. Cada campo alterado vai para o log da venda. Exige a permissão "Criar e editar" na empresa da venda, ou "Criar e editar as próprias vendas" para a venda que a própria credencial criou.local_id com que ele veio ao lado do id gerado. A credencial sem permissão de leitura recebe só esses identificadores, no mesmo formato da venda, em vez de só o id da venda. Na consulta da venda, o pagamento ao fornecedor e os pagamentos à agência em credit e legacy passaram a trazer o id.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).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.airline_tickets[].segments[].seats. Cada assento aponta o passageiro pelo ticket_number, que precisa ser o bilhete de exatamente um dos passageiros do produto: o bilhete que não é de nenhum passageiro, ou que é de mais de um, responde 422 e nada é gravado. O mesmo passageiro não pode ter dois assentos no mesmo trecho. O seat_number aceita até 3 caracteres e é gravado em maiúsculas. Antes o campo era só documentado e ficava fora do que a API processava.segments[].seats), no mesmo formato da criação. O assento informado no Monde para um passageiro ainda sem bilhete vem com o ticket_number nulo. O passageiro continua sem o seat.X-Idempotent-Replay: true) para sempre.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.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).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.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.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.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.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.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 ").
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.attachments, com os anexos da tarefa, inclusive os enviados nos comentários. Cada anexo tem id, description, extension, content_type e download_url, no mesmo formato da venda. Criar tarefa, Alterar tarefa e Comentar na tarefa também trazem o campo quando devolvem a tarefa completa.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.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".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.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.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._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.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.redirect_uri quando a agência aprova ou recusa (com o state), e os erros de cada etapa.POST /oauth/revoke, passou a estar documentada: ela exclui a conexão com a agência na hora.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.
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.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.
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.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.
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.POST /sales. Anexos só entram na venda que o próprio parceiro criou.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.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.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.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.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.Idempotency-Key: reenviar o mesmo anexo com a mesma chave volta a ser processado, em vez de responder 409 indefinidamente.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.
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.
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.
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.
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.
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.
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.
?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.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.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.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.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.
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.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".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.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.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.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.cpf_cnpj. Antes, o conflito de documento estourava erro interno (500).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.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.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.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.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.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.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.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).
excursions.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.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.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.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.id; em Consultar conta a pagar ou receber por ID, credit_card_items[].id deu lugar à referência movement._summary, e o nome sem sufixo passou a ser o da consulta por ID.registered_at virou created_at em vendas, contas a pagar e receber, notas fiscais, regras da nota fiscal, tarefas, viagens, vendedores, pessoas, extrato CVC e logs — o nome mais comum para esse conceito no restante das APIs REST.registered_by virou created_by, pelo mesmo motivo, em vendas, contas a pagar e receber, notas fiscais, regras da nota fiscal, tarefas, viagens, vendedores, pessoas e extrato CVC.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.
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.gender e birthdate, nas duas leituras.birthplace, seller, promoter, registered_by, contacts, labels, custom_fields, attachments e credit_cards.id: são dados que só existem dentro da pessoa.masked_number virou last_digits e passou a trazer só os quatro últimos dígitos, sem a máscara.billet, check e card, que antes só existiam na consulta por ID. São dados do próprio lançamento.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.id. O item não tem consulta própria, e o identificador não resolvia nada.state e country saíram de Consultar cidades e ficaram em Consultar cidade por ID.group saiu de Consultar categorias e ficou em Consultar categoria por ID.bank saiu de Consultar contas e cartões e ficou em Consultar conta ou cartão por ID.kind passou a declarar os valores possíveis: insertion, edition, deletion, custom e export. Não há outros.person passou a indicar Consultar pessoa por ID, o endpoint que resolve a referência.travel, resolvida em Consultar viagem por ID. O vínculo existia só no sentido inverso.active, e Tarefas, deleted.payer_rule, supplier_rule e representative_rule, o recipient passou a vir antes de revenues e discounts.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.
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.
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.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.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.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.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.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.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.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.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.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.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.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.kind, sale_separate e vendor_separate viraram sale_standalone e vendor_standalone. O filtro kind aceita os novos valores.custom_fields, cada campo passou a trazer o id da definição e deixou de trazer o name, como na venda.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.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.supplies: cada um traz o fornecedor, os dados de comissão e os representantes.commission_value virou commission_amount, e commission_type passou a aceitar amount em vez de value.history (comentários e alterações) e os campos personalizados.category deixou de ser texto e virou referência, resolvida em Consultar categoria de tarefa por ID.client virou customer, e seller passou a apontar para o endpoint de vendedores.seller passou a apontar para Consultar vendedor por ID.status, que é derivável de active e valid_until, ambos ainda na resposta.attachment_id virou id.person.name, e o país, code (ISO 3166-1 alfa-2) e code_3 (alfa-3).labels da pessoa e category da tarefa.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.
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.
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.
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.
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.operation (objeto com id e name); antes o identificador vinha em operation_id.commissions: o rateio por pessoa e função (vendedor, intermediário e outros), com valor da comissão, valor retido e saldo.financial: observações financeiras, os repasses aos fornecedores e os lançamentos de contas a pagar e a receber vinculados à venda. Além da credencial gerada pela agência, um parceiro aprovado pelo Monde pode acessar a API v3 em nome de uma agência de viagens, via OAuth 2.0 (Authorization Code + PKCE), sem que a agência compartilhe a senha de uma credencial. O que o parceiro pode fazer é definido pelo Monde na aprovação, e a agência vê e aprova essa lista ao autorizar.
redirect_uri com um code.code por um token e usa o token para chamar a API em nome daquela agência.id_token nem dados do usuário.https://web.monde.com.br. https://web.monde.com.br/partners/signup e confirme o e-mail. O Monde analisa o cadastro, define as permissões e aprova.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.client_secret só no seu backend. Ele nunca vai para o navegador nem para o app do usuário.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. 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.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
scope: o que o parceiro pode fazer são as permissões definidas na aprovaçã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.redirect_uri com o code e o mesmo state que você enviou: SUA_REDIRECT_URI?code=agencia%7CujES3JCJylJRoM3j_kGeavaD2hFqz2oqw1Lazq_u0rs&state=STATEQuando 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
state com o da sessão. Se for diferente ou faltar, descarte a resposta.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.redirect_uri quando quem entrou não é administrador da agência. Nesse caso o usuário vê a explicação numa página do Monde. O consentimento oferece todas as empresas ativas da agência, e nenhuma é recusada por licença.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: <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>
<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>
<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>
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.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_TOKENPara confirmar que a conexão funciona sem criar dado, chame
GET /api/v3/sales com o token: curl https://web.monde.com.br/api/v3/sales -H "Authorization: Bearer SEU_ACCESS_TOKEN" -H "Content-Type: application/json"
200 com a lista das vendas que o parceiro alcança (as que ele criou e, quando o Monde concedeu na aprovação o acesso a outras origens, também as demais; sem essa exceção, a lista vem vazia numa conexão nova): o token é válido e a integração está pronta.403 com {"errors":["Você não tem permissão para executar essa ação."]}: o token é válido, mas o parceiro não tem a permissão "Visualizar" de vendas na empresa.401 com {"errors":["Credenciais de acesso não são válidas."]}: o token é inválido ou a conexão foi excluída. Recomece pela autorização.POST /sales.401.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.redirect_uri: o seu backend consulta as conexões novas e recebe cada uma já com o token, sem ninguém copiar chave. https://web.monde.com.br/partners/integration), só depois que a consulta abaixo estiver implementada. A conexão automática precisa estar habilitada (passo 1).client_id e o client_secret em HTTP Basic: curl -X POST https://web.monde.com.br/oauth/connections -u "SEU_CLIENT_ID:SEU_CLIENT_SECRET"O
client_id e o client_secret também podem ir no corpo, como na troca do token, mas nunca na URL: na query string eles são ignorados e a resposta é 401. Resposta 200: { "data": [ { "id": "5b0f3c2e-8a51-4f6e-9a3d-2f4f1f0c9e11", "access_token": "YWdlbmNpYXw2ZjFj...", "token_type": "Bearer", "company": { "name": "Agência Exemplo", "cnpj": "12345678000190" }, "authorized_at": "2026-10-19T14:32:05.000-03:00" } ], "pagination": { "size": 50, "has_next_page": false, "next_cursor": null } } access_token no backend antes de qualquer outro passo: ele não volta numa próxima consulta. Se ele se perder, a agência exclui a integração e conecta de novo. Use o id para não processar a mesma conexão duas vezes do seu lado.access_token é igual ao do passo 4: não expira, não tem refresh_token, é usado na API v3 do mesmo jeito (passo 5) e revogado do mesmo jeito (passo 6).company é a empresa da agência que foi conectada. Use o CNPJ para ligar a conexão ao cliente certo na sua plataforma.data. O nó pagination tem o formato da paginação da API, mas a fila não usa cursor: com has_next_page igual a true, consulte de novo em seguida, sem parâmetro, e o next_cursor vem sempre nulo. Sem conexão nova, a lista vem vazia. Com duas consultas ao mesmo tempo, uma delas pode vir com a lista vazia e has_next_page igual a true: consulte de novo.Cache-Control: no-store: não a guarde em cache nem em log, porque ela leva os tokens.401 com {"error":"invalid_client","error_description":"..."}: client_id ou client_secret errado, ou a conexão automática não está habilitada. Nada é entregue.