--- paths: "/sales": get: operationId: listSales summary: Consultar vendas x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_field required: false schema: type: string enum: - sale_date - departure_date - return_date description: '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.' example: sale_date - in: query name: date_from required: false schema: type: string format: date description: Filtrar vendas cujo campo escolhido em date_field seja igual ou posterior a esta data, no formato ISO 8601 (AAAA-MM-DD). example: '2024-01-01' - in: query name: date_to required: false schema: type: string format: date description: Filtrar vendas cujo campo escolhido em date_field seja igual ou anterior a esta data, no formato ISO 8601 (AAAA-MM-DD). example: '2024-12-31' - in: query name: status required: false schema: type: array items: type: string enum: - opened - closed - canceled style: form explode: false description: '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.' example: - opened - closed examples: single_status: summary: Filtrar por uma situação value: - canceled multiple_statuses: summary: Filtrar por múltiplas situações value: - opened - closed - canceled - in: query name: people_id required: false schema: type: array items: type: string format: uuid style: form explode: false description: '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.' example: - b2a6d7da-ff94-40e3-b069-812b2fd45b91 examples: single_person: summary: Filtrar por uma pessoa value: - b2a6d7da-ff94-40e3-b069-812b2fd45b91 multiple_people: summary: Filtrar por várias pessoas value: - b2a6d7da-ff94-40e3-b069-812b2fd45b91 - 3f1c9e20-5d7a-4b6c-9e2f-1a2b3c4d5e6f - in: query name: number required: false schema: type: integer description: 'Filtrar vendas pelo número exibido no aplicativo (ex.: 1024). Um número por requisição.' example: 1024 - in: query name: updated_since required: false schema: type: string format: date-time description: '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](#tag/Vendas/paths/~1sales~1{id}/get): produtos, passageiros, trechos e assentos, comissões, anexos, pagamentos e as contas vinculadas (inclusão, cancelamento e exclusão). A liquidação de uma conta só traz a venda quando muda a taxa cartão agência dos produtos (baixa ou estorno com taxa de cartão) ou quando é parcial e gera a conta do saldo. A mudança num cadastro que a venda só referencia (pessoa, produto do catálogo, fornecedor, função do comissionado) não traz a venda: esses dados se consultam nos endpoints de cada cadastro. A listagem traz o resumo da venda, e o detalhe vem de Consultar venda por ID. Para acompanhar também as vendas excluídas, envie `status=opened,closed,canceled` junto. Para não perder uma venda gravada por uma operação que terminou depois do corte, guarde o instante em que a consulta começou, antes da primeira página, e na consulta seguinte parta dele com uma folga de alguns minutos para trás, que cubra também a diferença entre o seu relógio e o horário de Brasília. Regrave cada venda pelo id: a mesma venda pode vir de novo, sem duplicar.' example: '2026-08-01T14:30:00' - in: query name: kind required: false schema: type: array items: type: string enum: - insurance - cruise - hotel - airline_ticket - train_ticket - ground_transportation - excursion - visa - car_rental - travel_package - cvc_package - operation - others style: form explode: false description: Filtrar vendas pelo tipo de produto, com os mesmos tipos de kind dos produtos. A venda entra quando tem algum produto não excluído do tipo informado. Para vários tipos, separe-os por vírgula — a venda entra quando tem produto de qualquer um deles. example: - airline_ticket - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/sales" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createSale summary: Inserir venda x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Retorno de uma requisição que já foi processada anteriormente com sucesso. A resposta é idêntica à original, mas com status 200 ao invés de 201, e inclui o cabeçalho X-Idempotent-Replay: true.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/sale_written" examples: all_products_sale: summary: Venda com todos os produtos "$ref": "#/components/examples/all_products_sale_single" '201': description: Venda criada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/sale_written" examples: all_products_sale: summary: Venda com todos os produtos "$ref": "#/components/examples/all_products_sale_single" visa_only_sale: summary: Venda de visto "$ref": "#/components/examples/visa_only_sale_single" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale" examples: all_products_sale: summary: Venda com todos os produtos "$ref": "#/components/examples/all_products_sale" sale_with_custom_fields: summary: Venda com campos personalizados "$ref": "#/components/examples/sale_with_custom_fields" required_fields_sale: summary: Venda com campos obrigatórios "$ref": "#/components/examples/required_fields_sale" multiple_products_of_same_kind_sale: summary: Venda com múltiplos produtos do mesmo tipo "$ref": "#/components/examples/multiple_products_of_same_kind_sale" insurance_only_sale: summary: Venda de seguro viagem "$ref": "#/components/examples/insurance_only_sale" cruise_only_sale: summary: Venda de cruzeiro "$ref": "#/components/examples/cruise_only_sale" hotel_only_sale: summary: Venda de diárias de hospedagem "$ref": "#/components/examples/hotel_only_sale" airline_ticket_only_sale: x-ignore-on-postman: true summary: Venda de passagem aérea "$ref": "#/components/examples/airline_ticket_only_sale" train_ticket_only_sale: x-ignore-on-postman: true summary: Venda de bilhete de trem "$ref": "#/components/examples/train_ticket_only_sale" ground_transportation_only_sale: x-ignore-on-postman: true summary: Venda de transporte terrestre "$ref": "#/components/examples/ground_transportation_only_sale" car_rental_only_sale: x-ignore-on-postman: true summary: Venda de locação de veículo "$ref": "#/components/examples/car_rental_only_sale" travel_package_only_sale: x-ignore-on-postman: true summary: Venda de pacote turístico "$ref": "#/components/examples/travel_package_only_sale" excursion_only_sale: x-ignore-on-postman: true summary: Venda de excursão "$ref": "#/components/examples/excursion_only_sale" visa_only_sale: x-ignore-on-postman: true summary: Venda de visto "$ref": "#/components/examples/visa_only_sale" company_payer_sale: summary: Venda com payer pessoa jurídica "$ref": "#/components/examples/company_payer_sale" foreigner_payer_sale: summary: Venda com payer estrangeiro "$ref": "#/components/examples/foreigner_payer_sale" datetime_products_sale: summary: Venda com datas e horários nos produtos "$ref": "#/components/examples/datetime_products_sale" foreign_sale: summary: Venda com currency e supplier estrangeiro "$ref": "#/components/examples/foreign_sale" foreign_passenger_sale: summary: Venda com passageiro estrangeiro "$ref": "#/components/examples/foreign_passenger_sale" multiple_passengers_sale: summary: Venda com múltiplos passageiros "$ref": "#/components/examples/multiple_passengers_sale" multiple_passengers_one_amount_sale: summary: Venda com múltiplos passageiros mas apenas um com amount "$ref": "#/components/examples/multiple_passengers_one_amount_sale" partial_payment_sale: summary: Venda com pagamento parcial "$ref": "#/components/examples/partial_payment_sale" operation_only_sale: summary: Venda de operação própria com passageiros "$ref": "#/components/examples/operation_only_sale" operation_no_passengers_sale: summary: Venda de operação própria sem passageiros "$ref": "#/components/examples/operation_no_passengers_sale" others_only_sale: summary: Venda de produto Outros com passageiros "$ref": "#/components/examples/others_only_sale" others_no_passengers_sale: summary: Venda de produto Outros sem passageiros, em moeda estrangeira "$ref": "#/components/examples/others_no_passengers_sale" own_operation_sale: summary: Venda de operação própria com todos os produtos "$ref": "#/components/examples/own_operation_sale" closed_sale_with_commissions: summary: Venda fechada com comissões "$ref": "#/components/examples/closed_sale_with_commissions" "/sales/{id}": get: operationId: getSale summary: Consultar venda por ID x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da venda (formato UUID). example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': "$ref": "#/components/responses/sale" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deleteSale summary: Excluir venda x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |-

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.

security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da venda (formato UUID). example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: Venda excluída com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A venda não pode ser excluída. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Não é possível excluir vendas fechadas. - A venda já está excluída. example: errors: - Não é possível excluir vendas fechadas. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateSale summary: Alterar venda x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da venda (formato UUID). example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: Venda alterada com sucesso. Traz a venda no formato da consulta por ID, ou apenas o id quando a credencial não pode ler a venda. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_written" - "$ref": "#/components/schemas/sale_written_reference" examples: all_products_sale: summary: Venda com todos os produtos "$ref": "#/components/examples/all_products_sale_single" updated_sale_reference: summary: Venda alterada, sem permissão de leitura "$ref": "#/components/examples/updated_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_update" examples: update_sale_header: summary: Alterar o aprovador e um campo personalizado "$ref": "#/components/examples/update_sale_header" update_sale_products: summary: Alterar um produto e substituir os pagamentos "$ref": "#/components/examples/update_sale_products" update_sale_payments: summary: Manter um pagamento e incluir outro "$ref": "#/components/examples/update_sale_payments" reopen_sale: summary: Reabrir a venda fechada e alterar a data "$ref": "#/components/examples/reopen_sale" "/sales/{sale_id}/products/{product_id}/cancellation": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador da venda (UUID), o `id` devolvido na consulta e na criação da venda. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: product_id required: true schema: type: string format: uuid description: Identificador do produto da venda (UUID), o `id` do produto em `insurances`, `hotels`, `airline_tickets` e nos demais nós de produto da venda. example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 post: operationId: cancelSaleProduct summary: Cancelar produto da venda x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- > **O produto só fica cancelado quando todos os passageiros dele estão cancelados.** Cancelar só parte dos passageiros deixa o produto `active`, com esses passageiros marcados em `canceled_at`. O produto sem passageiros é cancelado direto. As opções `calculate_commission`, `delete_supplier_balance` e `supplier_fine` só valem quando o pedido deixa todos os passageiros cancelados, isto é, quando a lista cancela os que ainda faltavam. `delete_customer_balance` vale também no cancelamento de parte dos passageiros. Cancela um produto da venda, ou parte dos passageiros dele, quando o cliente desiste do que foi vendido. Cancelar não é excluir: o produto excluído (que sai da lista de produtos no `PATCH /sales/{id}`) é o lançado por engano, sem nenhum movimento; o cancelado é a venda que aconteceu e foi desfeita. Para desfazer o cancelamento, use [Reativar produto da venda](#tag/Vendas/paths/~1sales~1{sale_id}~1products~1{product_id}~1reactivation/post). **O que muda e o que não muda** - O produto cancelado **continua somando no valor total da venda**, de propósito, como histórico. Os valores dele não mudam e ele não pode mais ser alterado pelo `PATCH` da venda. - O financeiro só muda pelas opções enviadas: sem nenhuma delas, o saldo do cliente e o que falta faturar ao fornecedor ficam como estão. - A venda com produto cancelado não pode ser excluída. Para excluí-la, reative o produto antes. **Passageiros e datas** O cancelamento é sempre pela lista `passengers`: não há data padrão nem cancelamento de todos sem listar. Nenhuma data pode ser anterior à data da venda. - Produto com passageiros sem `passengers` é recusado (`422`). Para cancelar o produto inteiro, liste todos os passageiros ativos. - Com `passengers`, só as pessoas da lista são canceladas, cada uma com o seu `canceled_at`, obrigatório no item. A pessoa é citada pelo `person.id`, o `id` da pessoa em `passengers[].person` na consulta da venda. - O produto só fica `canceled` quando todos os passageiros estão cancelados; antes disso continua `active`, com os passageiros cancelados marcados em `canceled_at`. - Produto sem passageiros é cancelado sem `passengers` (corpo `{}` ou só as opções): a data de cancelamento dele é a do dia, como no Monde. - `canceled_at` na raiz não é aceito (`422`): a data vai em cada passageiro da lista. - A data de cancelamento do produto é a data em que o cancelamento foi registrado no Monde, como no Monde Desktop. - Cancelar passageiro não ajusta sozinho a fatura do fornecedor: o acerto da parte do passageiro é feito na fatura. **Opções** - `delete_customer_balance`: o saldo pendente a receber do cliente neste produto é excluído e passa a ser **saldo excluído**, que reduz a receita da venda. Só o saldo que ainda não virou pagamento sai: se o cliente não vai pagar uma forma de pagamento já lançada, exclua-a pelo `PATCH` da venda antes. Exige saldo a receber no produto. - `delete_supplier_balance`: os itens ainda em aberto para o fornecedor (sem lançamento ou, com a fatura automática, numa fatura não liquidada nem fechada), inclusive a Lei Kandir, são excluídos. O que já foi liquidado ou pago direto ao fornecedor fica. Só vale quando o pedido deixa todos os passageiros cancelados, e exige item em aberto. Não existe em produto de operação própria. - `supplier_fine`: a multa cobrada pelo fornecedor, informada como valor positivo **na moeda em que o fornecedor é pago**. Vira um item de multa a acertar com o fornecedor e reduz a receita. Exige `delete_supplier_balance`. Na agência, o fornecedor é pago na moeda final da venda, e a multa volta na consulta em `supplier_fine`. Na operadora, o fornecedor é pago na moeda de origem do produto: a multa enviada volta em `supplier_fine_origin_currency`, e `supplier_fine` traz o valor convertido para a moeda final pelo câmbio do produto. Exemplo na operadora, produto em USD com câmbio 5: `supplier_fine: 30` no cancelamento volta como `supplier_fine_origin_currency: 30` e `supplier_fine: 150`. - `calculate_commission`: o produto cancelado continua no cálculo da meta dos planos de comissão, como o campo `calculate_commission` da consulta do produto. Padrão `false`: o produto sai da meta. Só vale quando o pedido deixa todos os passageiros cancelados. - Na agência com o controle de crédito, o saldo do fornecedor não é excluído no cancelamento e não há multa: o acerto é feito na fatura do fornecedor, e `delete_supplier_balance` e `supplier_fine` são recusados. **Venda fechada** - O produto inteiro pode ser cancelado com a venda fechada. Cancelar só parte dos passageiros exige a venda aberta (`409`). **Resposta** - A venda inteira, como na consulta por ID, para a integração ver a situação do produto e o saldo. No produto, `canceled_at`, `calculate_commission`, `deleted_balance`, `delete_supplier_balance`, `supplier_fine` e `supplier_fine_origin_currency` mostram o que o cancelamento gravou; a multa informada na moeda em que o fornecedor é pago aparece em `supplier_fine` na agência e em `supplier_fine_origin_currency` na operadora. A credencial sem a permissão de consultar vendas recebe só o `id` da venda. Exige, na empresa da venda, a permissão de editar vendas e a permissão "Cancelar produto", como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. Na venda de outro vendedor, exige também "Editar vendas de outros vendedores". A credencial da conexão automática, que só edita as vendas que criou, só cancela produto dessas vendas, e só quando o parceiro recebeu "Cancelar produto" na aprovação. O cancelamento fica no histórico da venda, com o nome da credencial. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_product_cancellation" examples: whole_product: summary: Cancelar o produto inteiro "$ref": "#/components/examples/sale_product_cancellation_whole_product" some_passengers: summary: Cancelar um passageiro "$ref": "#/components/examples/sale_product_cancellation_some_passengers" rest_with_fine: summary: Cancelar o resto com multa "$ref": "#/components/examples/sale_product_cancellation_rest_with_fine" responses: '200': description: Pedido gravado. Devolve a venda inteira, como na consulta por ID, ou só o `id` dela para quem não pode consultar vendas. O `status` do produto diz se ele ficou cancelado (`canceled`, todos os passageiros cancelados) ou continua ativo (`active`), e o `canceled_at` de cada passageiro diz quem foi cancelado. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: partial_response: summary: 'Resposta: passageiro cancelado, produto ativo' "$ref": "#/components/examples/sale_product_cancellation_partial_response" whole_response: summary: 'Resposta: todos cancelados, produto cancelado' "$ref": "#/components/examples/sale_product_cancellation_whole_response" sale_reference: summary: Resposta a quem não consulta vendas "$ref": "#/components/examples/sale_product_cancellation_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'O estado da venda ou do produto não deixa cancelar: venda excluída, produto já cancelado, ou cancelamento de parte dos passageiros com a venda fechada.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O produto já está cancelado. Para mudar o cancelamento, reative o produto e cancele-o de novo. '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'O corpo não confere com o produto: pessoa que não é passageiro ativo do produto, data que falta, que sobra ou que é anterior à da venda, opção que exige o produto inteiro ou um saldo que não existe, ou campo em formato errado.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - A pessoa de 'passengers[0] person' não é passageiro ativo deste produto. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/products/{product_id}/reactivation": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador da venda (UUID), o `id` devolvido na consulta e na criação da venda. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: product_id required: true schema: type: string format: uuid description: Identificador do produto da venda (UUID), o `id` do produto em `insurances`, `hotels`, `airline_tickets` e nos demais nós de produto da venda. example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 post: operationId: reactivateSaleProduct summary: Reativar produto da venda x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- Desfaz o cancelamento do produto, inteiro ou só de parte dos passageiros, como o descancelamento do Monde. O produto volta à situação `active` e entra de novo no cálculo da meta dos planos de comissão. **Passageiros** - A reativação é sempre pela lista `passengers`, com a pessoa de cada passageiro cancelado que volta. Para reativar o produto inteiro, liste todos os passageiros cancelados. Produto com passageiros sem a lista é recusado (`422`). - Produto sem passageiros é reativado sem a lista (corpo `{}`). - Cada pessoa da lista, citada pelo `person.id` como no cancelamento, precisa ser passageiro cancelado do produto. - O corpo não aceita `canceled_at` nem as opções do cancelamento (`422`): a reativação desfaz o cancelamento como ele foi gravado. **Financeiro** - Se o cancelamento excluiu o saldo do fornecedor, o que falta faturar ao fornecedor é lançado de novo. - Quando voltam todos os passageiros cancelados, o resto do cancelamento sai: o saldo do cliente excluído volta a ser saldo a receber do pagante, e a multa do fornecedor sai (se ela já foi faturada, um item de estorno a anula). - Reativando só parte dos passageiros, a multa e o saldo excluído ficam como estão. - Reembolsos e créditos já lançados pela venda não são desfeitos. - Com a venda fechada, a reativação é aceita, de parte dos passageiros ou do produto inteiro, como no Monde, sem reabrir a venda. A exceção é o produto cujo cancelamento excluiu saldo do cliente: a reativação que traz de volta todos os passageiros ainda cancelados, ou o produto inteiro, devolve esse saldo, e a venda fechada não tem saldo (`409`). Nesse produto, parte dos passageiros ainda pode ser reativada, mantendo o saldo excluído; para trazer de volta os últimos, reabra a venda antes. - Com a fatura automática do fornecedor, a multa do cancelamento é lançada na fatura alguns segundos depois. Enquanto isso, a reativação responde `409`: repita a requisição em alguns segundos. A multa que não entrou na fatura em 10 minutos não trava mais a reativação. Exige as mesmas permissões do cancelamento: editar vendas e "Cancelar produto", na empresa da venda, como o descancelamento do Monde. A resposta é a venda inteira, ou só o `id` dela para quem não pode consultar vendas. A reativação fica no histórico da venda, com o nome da credencial. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_product_reactivation" examples: reactivate_one_passenger: summary: Reativar um passageiro "$ref": "#/components/examples/sale_product_reactivation_one_passenger" reactivate_rest: summary: Reativar o resto "$ref": "#/components/examples/sale_product_reactivation_rest" responses: '200': description: Produto reativado. Devolve a venda inteira, como na consulta por ID, ou só o `id` dela para quem não pode consultar vendas. O `status` do produto volta a `active`, e os passageiros reativados ficam sem `canceled_at`. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: reactivation_response: summary: 'Resposta: produto reativado' "$ref": "#/components/examples/sale_product_reactivation_response" sale_reference: summary: Resposta a quem não consulta vendas "$ref": "#/components/examples/sale_product_cancellation_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'O estado da venda ou do produto não deixa reativar: venda excluída, produto sem cancelamento, saldo excluído com a venda fechada, ou a multa do cancelamento ainda sendo lançada na fatura automática do fornecedor (repita em alguns segundos).' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O produto não está cancelado, nem tem passageiro cancelado. '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'O corpo não confere com o produto: pessoa que não é passageiro cancelado do produto, lista que falta no produto com passageiros, vazia ou repetida, campo do cancelamento enviado na reativação, ou campo em formato errado.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - A pessoa de 'passengers[0] person' não é passageiro cancelado deste produto. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/vendor_items/{id}": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador da venda (UUID), o `id` devolvido na consulta e na criação da venda. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: id required: true schema: type: string format: uuid description: Identificador do item do fornecedor (UUID), o `id` do item em `financial.vendor_items` na consulta da venda. example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 patch: operationId: updateSaleVendorItem summary: Alterar item do fornecedor da venda x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- 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](#tag/Vendas/paths/~1sales~1{id}/get). O campo omitido fica como está, e o campo desconhecido é ignorado. **O que se edita aqui** - Só o item que ainda não está num lançamento nem foi pago direto ao fornecedor (`bill` e `payment` nulos). Com a fatura automática do fornecedor, o item ainda a faturar também se edita, como no Monde. - O item que já está num lançamento responde `409`: o vencimento e a descrição que valem são os do lançamento, que se altera em [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch). - O item pago direto ao fornecedor responde `409`: o vencimento é o do pagamento, que se altera nos pagamentos da venda, em [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch). - O crédito gerado para o fornecedor (`generated_credit`) responde `409`: ele é tratado no crédito da pessoa. - A venda excluída responde `409`. O item que não é do fornecedor desta venda, inclusive o item do cliente e o aguardando exclusão, responde `404`. - Como no Monde, a venda fechada ou com recibo impresso não impede a alteração, e a alteração não entra no histórico da venda. **Resposta** - A venda inteira, como na consulta por ID, com o item alterado em `financial.vendor_items`. A credencial sem a permissão de consultar vendas recebe só o `id` da venda. Exige, na empresa da venda, a permissão de editar vendas e "Ver aba financeiro", como no Monde; sem "Ver aba financeiro", a resposta é 403 com a mensagem do Monde. Na venda de outro vendedor, exige também "Editar vendas de outros vendedores". security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_vendor_item_update" examples: due_date_and_description: summary: Vencimento e descrição "$ref": "#/components/examples/sale_vendor_item_due_date_and_description" description_only: summary: Só a descrição "$ref": "#/components/examples/sale_vendor_item_description_only" responses: '200': description: Item alterado. Devolve a venda inteira, como na consulta por ID, ou só o `id` dela para quem não pode consultar vendas. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Resposta: a venda com o item alterado' "$ref": "#/components/examples/sale_vendor_item_sale_response" sale_reference: summary: Resposta para quem não consulta vendas "$ref": "#/components/examples/sale_vendor_item_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'O item não se edita aqui: a venda está excluída, ou o item já está num lançamento, foi pago direto ao fornecedor ou é crédito gerado.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - 'O item já está num lançamento (o ''bill'' dele): o vencimento e a descrição que valem são os do lançamento, que se edita nele.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'O corpo não confere: vencimento nulo, vazio ou fora do formato ISO 8601, ou descrição com mais de 100 caracteres ou que não é texto.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Informe o vencimento. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/vendor_invoices": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador da venda (UUID), o `id` devolvido na consulta e na criação da venda. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: createSaleVendorInvoice summary: Gerar pagamento avulso ou sinal ao fornecedor da venda x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- 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](#tag/Vendas/paths/~1sales~1{id}/get). O campo desconhecido é ignorado. **Como a fatura é gerada** - Com a fatura automática do fornecedor ligada, e fora da venda CVC, é a fatura avulsa automática: o item sai da fatura automática em que está e vai para a nova fatura. O item que a fatura automática ainda não processou responde `409`; tente de novo depois. - Sem a fatura automática, ou na venda CVC, é a fatura do fornecedor feita pela venda. O vencimento dela é o menor vencimento dos itens gerados, e o item sem vencimento conta como hoje. - Uma fatura tem uma pessoa e uma moeda só: todos os itens precisam ser do mesmo fornecedor ou representante e da mesma moeda. **Recusas** - A venda excluída responde `409`, como a fatura já fechada ou liquidada em que o item está. - O item de outra venda, de outro fornecedor ou moeda, que não está em aberto, repetido ou de outro produto que o de `product_id` responde `422`, apontando o item. - Como no Monde, a venda fechada ou com recibo impresso não impede a geração, e a venda não ganha registro no histórico: a fatura gerada tem o histórico dela. **Resposta** - A fatura gerada, como em [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get), com o endereço dela no cabeçalho `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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_vendor_invoice_create" examples: advance: summary: Pagamento avulso "$ref": "#/components/examples/sale_vendor_invoice_advance" deposit: summary: Sinal ao fornecedor do produto "$ref": "#/components/examples/sale_vendor_invoice_deposit" responses: '201': description: Fatura gerada. Devolve a fatura, como na consulta por ID, ou só o `id` dela para quem não a consulta. headers: Location: schema: type: string description: Endereço da fatura gerada na API (`/api/v3/bills/{id}`). content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: bill_response: summary: 'Resposta: a fatura gerada' "$ref": "#/components/examples/vendor_invoice_bill_single" bill_reference: summary: Resposta para quem não consulta a fatura "$ref": "#/components/examples/sale_vendor_invoice_bill_reference" '200': description: 'Reenvio com a mesma `Idempotency-Key`: devolve a resposta da primeira geração, sem gerar de novo.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: bill_response: summary: 'Resposta: a fatura gerada' "$ref": "#/components/examples/vendor_invoice_bill_single" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A venda está excluída, o item ainda não foi processado pela fatura automática, ou a fatura em que ele está já foi fechada ou liquidada. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - A venda está excluída e não gera pagamento avulso nem sinal ao fornecedor. '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'O corpo não confere: `kind` ausente ou fora da lista, `items` vazio, valor ausente ou não maior que zero, `transaction_kind` fora da lista, item de outra venda, de outro fornecedor ou moeda, que não está em aberto, repetido ou de outro produto, ou produto de operação própria ou excluído.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - 'O campo ''items[0] id'' não está em aberto: já está num lançamento ou foi pago direto ao fornecedor' '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/to_invoice": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador da venda (UUID), o `id` devolvido na consulta e na criação da venda. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: createSaleToInvoice summary: Faturar x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- Inclui o Faturar na venda, como o **Faturar** da aba Financeiro da venda no Monde: o pagante paga o saldo do cliente pela fatura de cliente. O campo desconhecido é ignorado; a descrição, que o Faturar não tem, também. **Como é gravado** - Grava um item a faturar do cliente por produto, sem lançamento próprio. A fatura automática leva os itens à fatura de cliente do pagante, em segundo plano, logo depois. Por isso a resposta é `202`. - O valor de cada produto vai com o sinal do saldo do cliente dele, como a tela do Monde mostra: negativo no produto de saldo negativo, positivo nos outros. - Quando o item entra na fatura, o Faturar aparece em `payments.agency.to_invoice` da [consulta da venda](#tag/Vendas/paths/~1sales~1{id}/get), numa linha por fatura de cliente e centro de custo. Até lá, ele não aparece na venda. - O Faturar não muda pela alteração da venda: a lista `payments` não o mantém nem o remove. Ele sai pela [remoção do Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice~1removal/post). **Recusas** - A venda fechada ou excluída responde `409`: o Faturar só é incluído na venda aberta. - Sem saldo do cliente a faturar em nenhum produto, a resposta é `422`, como o Monde, que só oferece o Faturar quando há saldo. - O produto que não é da venda, repetido, sem saldo do cliente, com o sinal trocado ou de outra moeda de venda responde `422`, apontando o produto, como a soma zero e o centro de custo que o pagante não tem. **Resposta** - A venda inteira, como na [consulta da venda por ID](#tag/Vendas/paths/~1sales~1{id}/get). A credencial que não consulta vendas recebe só o `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". security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_to_invoice_create" examples: to_invoice: summary: Faturar o saldo de um produto "$ref": "#/components/examples/sale_to_invoice" to_invoice_with_cost_center: summary: Faturar para outro pagante, com centro de custo "$ref": "#/components/examples/sale_to_invoice_with_cost_center" responses: '202': description: Faturar incluído. Os itens a faturar estão gravados, e a fatura automática os leva à fatura de cliente logo depois. Devolve a venda, como na consulta por ID, ou só o `id` dela para quem não consulta vendas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Resposta: a venda' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Resposta a quem não consulta vendas "$ref": "#/components/examples/sale_to_invoice_sale_reference" '200': description: 'Reenvio com a mesma `Idempotency-Key`: devolve a resposta da primeira inclusão, sem incluir de novo.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Resposta: a venda' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Resposta a quem não consulta vendas "$ref": "#/components/examples/sale_to_invoice_sale_reference" '409': description: A venda está fechada ou excluída. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Só é possível adicionar pagamentos em vendas abertas. Reabra a venda antes. '422': description: 'O corpo não confere: nenhum produto com saldo do cliente a faturar, `products` vazio, valor ausente ou zero, produto que não é da venda, repetido, sem saldo do cliente, com o sinal trocado ou de outra moeda de venda, soma zero, pagante que não existe, ou centro de custo longo demais, que o pagante não tem ou com pagante pessoa física.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: unavailable: value: errors: - Nenhum produto da venda tem saldo do cliente a faturar. sign: value: errors: - 'O campo ''products[0] sale_product_id'' tem saldo do cliente positivo: o valor dele vai positivo' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/to_invoice_returns": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador da venda (UUID), o `id` devolvido na consulta e na criação da venda. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: createSaleToInvoiceReturn summary: Devolução Faturar x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- 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](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice/post), com a descrição (`description`) no lugar do centro de custo, que é ignorado. O campo desconhecido é ignorado. **Como é gravada** - Como o Faturar: um item a faturar do cliente por produto, sem lançamento próprio, que a fatura automática leva à fatura de cliente logo depois. Por isso a resposta é `202`. - O valor de cada produto vai com o sinal do saldo do cliente dele: negativo no produto de saldo negativo, positivo nos outros. - Quando o item entra na fatura, a Devolução aparece em `payments.agency.to_invoice` da [consulta da venda](#tag/Vendas/paths/~1sales~1{id}/get), na linha da fatura de cliente, somada com o sinal: o valor negativo é a Devolução. Ela sai pela [remoção do Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice~1removal/post), junto com a linha. **Recusas** - A venda fechada ou excluída responde `409`. - Só é aceita quando algum produto da venda tem saldo do cliente negativo, como o Monde, que só oferece a Devolução nesse caso: sem ele, a resposta é `422`. - As regras dos produtos e da soma são as do Faturar (`422`). **Resposta** - A venda inteira, como na [consulta da venda por ID](#tag/Vendas/paths/~1sales~1{id}/get). A credencial que não consulta vendas recebe só o `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". security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_to_invoice_return_create" examples: to_invoice_return: summary: Devolução Faturar "$ref": "#/components/examples/sale_to_invoice_return" responses: '202': description: Devolução Faturar incluída. Os itens a faturar estão gravados, e a fatura automática os leva à fatura de cliente logo depois. Devolve a venda, como na consulta por ID, ou só o `id` dela para quem não consulta vendas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Resposta: a venda' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Resposta a quem não consulta vendas "$ref": "#/components/examples/sale_to_invoice_sale_reference" '200': description: 'Reenvio com a mesma `Idempotency-Key`: devolve a resposta da primeira inclusão, sem incluir de novo.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Resposta: a venda' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Resposta a quem não consulta vendas "$ref": "#/components/examples/sale_to_invoice_sale_reference" '409': description: A venda está fechada ou excluída. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Só é possível adicionar pagamentos em vendas abertas. Reabra a venda antes. '422': description: 'O corpo não confere: nenhum produto com saldo do cliente negativo, `products` vazio, valor ausente ou zero, produto que não é da venda, repetido, sem saldo do cliente, com o sinal trocado ou de outra moeda de venda, soma zero, pagante que não existe, ou descrição longa demais.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: unavailable: value: errors: - A Devolução só é aceita quando algum produto da venda tem saldo do cliente negativo. sign: value: errors: - 'O campo ''products[0] sale_product_id'' tem saldo do cliente positivo: o valor dele vai positivo' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/to_invoice/removal": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador da venda (UUID), o `id` devolvido na consulta e na criação da venda. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: removeSaleToInvoice summary: Remover linha do Faturar x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: |- 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](#tag/Vendas/paths/~1sales~1{id}/get), apontada pela fatura de cliente (`bill_id`) e pelo centro de custo (`cost_center`). **O que é removido** - A linha inteira: todos os itens do Faturar e da Devolução Faturar da venda naquela fatura de cliente e centro de custo. Os itens saem da fatura, e o saldo do cliente dos produtos volta. **Recusas** - A venda excluída responde `409`. - A venda fechada responde `409`, a menos que `reopen_sale` venha `true`: aí a venda é reaberta, e a credencial precisa também da permissão "Reabrir venda" (`403` sem ela). - A fatura de cliente fechada responde `409` sempre: reabra a fatura antes, por [Reabrir fatura de cliente](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1invoice_closure/delete). - A fatura de cliente liquidada responde `409`, a menos que `remove_settlement` venha `true`: aí a liquidação da fatura é desfeita. - A linha que a venda não tem, com aquela fatura e aquele centro de custo, responde `422`, como a confirmação que não é `true` nem `false`. **Resposta** - A venda inteira, como na [consulta da venda por ID](#tag/Vendas/paths/~1sales~1{id}/get). A credencial que não consulta vendas recebe só o `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". security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_to_invoice_removal" examples: removal: summary: Remover a linha sem centro de custo "$ref": "#/components/examples/sale_to_invoice_removal" removal_confirmed: summary: Remover reabrindo a venda e desfazendo a liquidação "$ref": "#/components/examples/sale_to_invoice_removal_confirmed" responses: '200': description: Linha do Faturar removida. Devolve a venda, como na consulta por ID, ou só o `id` dela para quem não consulta vendas. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é um replay de uma requisição anterior processada com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Resposta: a venda' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Resposta a quem não consulta vendas "$ref": "#/components/examples/sale_to_invoice_sale_reference" '409': description: A venda está excluída, a venda está fechada sem `reopen_sale`, a fatura de cliente está fechada, ou a fatura está liquidada sem `remove_settlement`. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - A fatura está liquidada. Para remover o Faturar, envie 'remove_settlement' como true, que desfaz a liquidação da fatura. '422': description: 'O corpo não confere: `bill_id` ausente, linha que a venda não tem com aquela fatura e aquele centro de custo, centro de custo que não é texto, ou confirmação que não é `true` nem `false`.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O campo 'bill_id' não corresponde a nenhuma linha do Faturar da venda com esta fatura e este centro de custo '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/attachments": post: operationId: uploadAttachment summary: Enviar anexo x-badges: - name: Beta tags: - Anexos description: |- security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_multipart" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: multipart/form-data: schema: "$ref": "#/components/schemas/attachment" examples: upload_attachments: summary: Exemplo de envio de anexo. "$ref": "#/components/examples/upload_attachments" responses: '200': description: 'Resposta de uma requisição que já foi processada com sucesso anteriormente. A resposta é idêntica à original, mas com status 200 ao invés de 201, e inclui o cabeçalho X-Idempotent-Replay: true.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que esta resposta é uma repetição de uma requisição processada com sucesso anteriormente. content: application/json: schema: "$ref": "#/components/schemas/attachments_response" examples: upload_attachments: summary: Exemplo de resposta do envio de anexo. "$ref": "#/components/examples/upload_attachments_response" '201': description: Anexo enviado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/attachments_response" examples: upload_attachments: summary: Exemplo de resposta do envio de anexo. "$ref": "#/components/examples/upload_attachments_response" '400': description: Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Verifique se os campos do form-data estão presentes e válidos. content: application/json: schema: type: object properties: errors: type: array items: type: string example: 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 campos, como resource_type, resource_id e file, estão corretos antes de tentar novamente. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': description: O cabeçalho Content-Type da requisição especificou um tipo de mídia que não é suportado pela API. Certifique-se de que a requisição esteja utilizando multipart/form-data. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O cabeçalho Content-Type da requisição especificou um tipo de mídia que não é suportado pela API. Certifique-se de que a requisição esteja utilizando multipart/form-data. '422': description: 'Ocorreu um erro de validação. Verifique as mensagens de erro retornadas para mais detalhes. O erro de um item de lista traz a posição do item na lista enviada, contada a partir de 0, em cada nível: O campo ''insurances[0] passengers[2] person name'' é obrigatório fala do terceiro passageiro do primeiro seguro. A regra conferida sobre a lista inteira, como o contato repetido, vem no nome da lista, sem posição. O item nulo ou em branco dentro de uma lista ([null], [""]) é recusado.' content: application/json: schema: type: object properties: errors: type: array items: type: string description: 'Lista de mensagens de erro. Exemplo: `[Formato inválido para anexo, Arquivo ''voucher.exe'' com extensão ''.exe'' não é permitida. Extensões permitidas: ''.pdf, .doc, .docx, .odt, .xls, .xlsx, .ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic, .heif, .txt, .csv'', Arquivo ''voucher.pdf'' (5.2 MB) excede o tamanho máximo permitido de 12 MB]`' examples: - - Formato inválido para anexo - 'Arquivo ''voucher.exe'' com extensão ''.exe'' não é permitida. Extensões permitidas: ''.pdf, .doc, .docx, .odt, .xls, .xlsx, .ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic, .heif, .txt, .csv''' - Arquivo 'voucher.pdf' (5.2 MB) excede o tamanho máximo permitido de 12 MB example: errors: - Formato inválido para anexo - 'Arquivo ''voucher.exe'' com extensão ''.exe'' não é permitida. Extensões permitidas: ''.pdf, .doc, .docx, .odt, .xls, .xlsx, .ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic, .heif, .txt, .csv''' - Arquivo 'voucher.pdf' (5.2 MB) excede o tamanho máximo permitido de 12 MB '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/attachments/{id}": patch: operationId: renameAttachment summary: Renomear anexo x-badges: - name: Beta tags: - Anexos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador do anexo. example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 requestBody: required: true content: application/json: schema: type: object required: - description properties: description: type: string description: Nome novo do anexo. Não pode ficar em branco. example: Comprovante de pagamento examples: rename_attachment: summary: Renomear o anexo value: description: Comprovante de pagamento responses: '200': description: O anexo renomeado. content: application/json: schema: "$ref": "#/components/schemas/attachments_response" examples: upload_attachments: summary: Exemplo de resposta do envio de anexo. "$ref": "#/components/examples/upload_attachments_response" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deleteAttachment summary: Excluir anexo x-badges: - name: Beta tags: - Anexos description: |- 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: O anexo do registro fora do alcance da credencial responde 404. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador do anexo. example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 responses: '204': description: Anexo excluído. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/attachments/{id}/download": get: operationId: downloadAttachment summary: Baixar anexo x-badges: - name: Beta tags: - Anexos description: |- 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: Baixar o anexo segue a consulta do registro dono dele: baixar pede a permissão "Visualizar" do recurso, também no que a própria credencial criou, e o anexo do registro de outro usuário pede também o alcance com que ela consulta o registro.

O endereço vem pronto no campo download_url dos anexos, na consulta por ID de cada um desses registros. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador do anexo. example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3 responses: '302': description: Redirecionamento para o link temporário do arquivo. headers: Location: schema: type: string format: uri description: Link temporário do arquivo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/products": get: operationId: listProducts summary: Consultar produtos x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: Retorna a lista de produtos disponíveis no sistema, com possibilidade de filtrar por tipo de produto. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: kind required: false schema: type: array items: type: string enum: - insurance - cruise - hotel - airline_ticket - train_ticket - ground_transportation - excursion - visa - car_rental - travel_package - cvc_package - operation - others style: form explode: false description: " Filtra produtos por tipo. Para múltiplos tipos, separe os valores por vírgula (ex: insurance,cruise,hotel). " example: - insurance - cruise examples: single_kind: summary: Filtro por um único tipo value: - insurance multiple_kinds: summary: Filtro por múltiplos tipos value: - insurance - cruise - hotel - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/products" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createProduct summary: Criar produto x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da criação original, sem criar outro produto.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/product" examples: product_detail: summary: Produto com fornecimentos "$ref": "#/components/examples/product_detail" '201': description: Produto criado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/product" examples: product_detail: summary: Produto com fornecimentos "$ref": "#/components/examples/product_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/product_create" examples: create_product: summary: Criar um produto "$ref": "#/components/examples/create_product" "/products/{id}": get: operationId: getProduct summary: Consultar produto por ID x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: Retorna os dados completos de um produto específico, incluindo seus fornecimentos com o fornecedor, os dados de comissão e os representantes. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/product" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateProduct summary: Alterar produto x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Produto alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/product" - "$ref": "#/components/schemas/entity_reference" examples: product_detail: summary: Produto com fornecimentos "$ref": "#/components/examples/product_detail" written_product_reference: summary: Registro alterado, sem a permissão de leitura "$ref": "#/components/examples/written_product_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/product_update" examples: update_product: summary: Inativar o produto "$ref": "#/components/examples/update_product" delete: operationId: deleteProduct summary: Excluir produto x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Produto excluído com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/products/{product_id}/supplies": get: operationId: listProductSupplies summary: Consultar fornecedores do produto x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: Retorna os fornecedores (fornecimentos) do produto, cada um com as condições comerciais e os representantes. Exige a permissão de ler produtos. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/supplies" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createProductSupply summary: Adicionar fornecedor ao produto x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta original, sem adicionar outro fornecedor.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/supply" examples: supply: summary: Fornecimento "$ref": "#/components/examples/supply" '201': description: Fornecedor adicionado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/supply" examples: supply: summary: Fornecimento "$ref": "#/components/examples/supply" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/supply_create" examples: create_supply: summary: Adicionar um fornecedor "$ref": "#/components/examples/create_supply" "/products/{product_id}/supplies/{id}": get: operationId: getProductSupply summary: Consultar fornecedor do produto por ID x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: Retorna um fornecimento do produto, com as condições comerciais e os representantes. O ID de um fornecimento de outro produto responde 404. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '200': "$ref": "#/components/responses/supply" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateProductSupply summary: Alterar fornecedor do produto x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '200': description: Fornecedor alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/supply" - "$ref": "#/components/schemas/entity_reference" examples: supply: summary: Fornecimento "$ref": "#/components/examples/supply" written_product_reference: summary: Registro alterado, sem a permissão de leitura "$ref": "#/components/examples/written_product_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/supply_update" examples: update_supply: summary: Passar a comissão para valor "$ref": "#/components/examples/update_supply" delete: operationId: deleteProductSupply summary: Remover fornecedor do produto x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '204': description: Fornecedor removido com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/products/{product_id}/supplies/{supply_id}/representations": get: operationId: listSupplyRepresentations summary: Consultar representantes do fornecedor x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: Retorna os representantes de um fornecimento do produto, cada um com as condições comerciais próprias. Exige a permissão de ler produtos. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/representations" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createSupplyRepresentation summary: Adicionar representante ao fornecedor x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta original, sem adicionar outro representante.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/representation" examples: representation: summary: Representante "$ref": "#/components/examples/representation" '201': description: Representante adicionado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/representation" examples: representation: summary: Representante "$ref": "#/components/examples/representation" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/representation_create" examples: create_representation: summary: Adicionar um representante "$ref": "#/components/examples/create_representation" "/products/{product_id}/supplies/{supply_id}/representations/{id}": get: operationId: getSupplyRepresentation summary: Consultar representante do fornecedor por ID x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: Retorna um representante do fornecimento. O ID de um representante de outro fornecimento responde 404. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - in: path name: id required: true schema: type: string format: uuid description: Identificador único do representante do fornecimento (formato UUID). example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a responses: '200': "$ref": "#/components/responses/representation" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateSupplyRepresentation summary: Alterar representante do fornecedor x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - in: path name: id required: true schema: type: string format: uuid description: Identificador único do representante do fornecimento (formato UUID). example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a responses: '200': description: Representante alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/representation" - "$ref": "#/components/schemas/entity_reference" examples: representation: summary: Representante "$ref": "#/components/examples/representation" written_product_reference: summary: Registro alterado, sem a permissão de leitura "$ref": "#/components/examples/written_product_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/representation_update" examples: update_representation: summary: Alterar o over "$ref": "#/components/examples/update_representation" delete: operationId: deleteSupplyRepresentation summary: Remover representante do fornecedor x-badges: - name: Beta color: "#f5803e" tags: - Produtos description: Remove o representante do fornecimento. O representante usado em vendas não pode ser removido (409). Exige a permissão "Excluir Representante" de produtos. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Identificador único do produto (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Identificador único do fornecimento do produto (formato UUID). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - in: path name: id required: true schema: type: string format: uuid description: Identificador único do representante do fornecimento (formato UUID). example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a responses: '204': description: Representante removido com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cabins": get: operationId: listCabins summary: Consultar cabines x-badges: - name: Beta color: "#f5803e" tags: - Cabines description: Retorna a lista de tipos de cabine cadastrados no sistema. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/cabins" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCabin summary: Cadastrar cabine x-badges: - name: Beta color: "#f5803e" tags: - Cabines description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já concluída com a mesma Idempotency-Key: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/cabin" examples: cabin: summary: Cabine "$ref": "#/components/examples/cabin" '201': description: Cabine cadastrada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/cabin" examples: cabin: summary: Cabine "$ref": "#/components/examples/cabin" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cabin_write" examples: create_cabin: summary: Cadastrar cabine "$ref": "#/components/examples/create_cabin" "/cabins/{name}": get: operationId: getCabin summary: Consultar cabine por nome x-badges: - name: Beta color: "#f5803e" tags: - Cabines description: Retorna a cabine pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: name required: true schema: type: string maxLength: 30 description: Nome atual da cabine, com codificação de URL example: Varanda responses: '200': "$ref": "#/components/responses/cabin" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCabin summary: Alterar cabine x-badges: - name: Beta color: "#f5803e" tags: - Cabines description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: name required: true schema: type: string maxLength: 30 description: Nome atual da cabine, com codificação de URL example: Varanda responses: '200': description: Cabine alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/cabin" examples: cabin: summary: Cabine "$ref": "#/components/examples/cabin" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cabin_write" examples: update_cabin: summary: Renomear cabine "$ref": "#/components/examples/update_cabin" delete: operationId: deleteCabin summary: Excluir cabine x-badges: - name: Beta color: "#f5803e" tags: - Cabines description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: name required: true schema: type: string maxLength: 30 description: Nome atual da cabine, com codificação de URL example: Varanda responses: '204': description: Cabine excluída com sucesso. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/ships": get: operationId: listShips summary: Consultar navios x-badges: - name: Beta color: "#f5803e" tags: - Navios description: Retorna a lista de navios cadastrados no sistema. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/ships" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createShip summary: Cadastrar navio x-badges: - name: Beta color: "#f5803e" tags: - Navios description: 'Cadastra um navio. O nome é a chave do navio: é por ele que o navio é consultado, alterado e excluído, e é ele que o produto de cruzeiro da venda informa em ship_name.

Exige a permissão "Editar" de navios em alguma empresa que não seja somente leitura. A resposta traz o navio cadastrado.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já concluída com a mesma Idempotency-Key: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/ship" examples: ship: summary: Navio "$ref": "#/components/examples/ship" '201': description: Navio cadastrado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/ship" examples: ship: summary: Navio "$ref": "#/components/examples/ship" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ship_write" examples: create_ship: summary: Cadastrar navio "$ref": "#/components/examples/create_ship" "/ships/{name}": get: operationId: getShip summary: Consultar navio por nome x-badges: - name: Beta color: "#f5803e" tags: - Navios description: Retorna o navio pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: name required: true schema: type: string maxLength: 30 description: Nome atual do navio, com codificação de URL example: MSC Preziosa responses: '200': "$ref": "#/components/responses/ship" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateShip summary: Alterar navio x-badges: - name: Beta color: "#f5803e" tags: - Navios description: 'Altera o navio pelo nome atual, informado no caminho com codificação de URL. O campo omitido permanece como está. Um nome novo renomeia o navio, e os produtos de venda que o usam passam a mostrar o nome novo, como no Monde.

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

Exige a permissão "Editar" de navios em alguma empresa que não seja somente leitura. A resposta traz o navio a quem também pode ler navios; aos demais, só o nome. O texto vazio é gravado como está; no campo obrigatório, e em campo que não é texto, é recusado (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: name required: true schema: type: string maxLength: 30 description: Nome atual do navio, com codificação de URL example: MSC Preziosa responses: '200': description: Navio alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/ship" examples: ship: summary: Navio "$ref": "#/components/examples/ship" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ship_write" examples: update_ship: summary: Renomear navio "$ref": "#/components/examples/update_ship" delete: operationId: deleteShip summary: Excluir navio x-badges: - name: Beta color: "#f5803e" tags: - Navios description: 'Exclui o navio pelo nome atual, informado no caminho com codificação de URL. O navio usado em algum produto de venda não pode ser excluído: a resposta é 409, como no Monde.

Exige a permissão "Excluir" de navios em alguma empresa que não seja somente leitura.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: name required: true schema: type: string maxLength: 30 description: Nome atual do navio, com codificação de URL example: MSC Preziosa responses: '204': description: Navio excluído com sucesso. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/packages": get: operationId: listPackages summary: Consultar pacotes x-badges: - name: Beta color: "#f5803e" tags: - Pacotes description: Retorna a lista de pacotes cadastrados no sistema, em ordem de nome. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/packages" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createPackage summary: Cadastrar pacote x-badges: - name: Beta color: "#f5803e" tags: - Pacotes description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já concluída com a mesma Idempotency-Key: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/package" examples: package: summary: Pacote "$ref": "#/components/examples/package" '201': description: Pacote cadastrado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/package" examples: package: summary: Pacote "$ref": "#/components/examples/package" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/package_write" examples: create_package: summary: Cadastrar pacote "$ref": "#/components/examples/create_package" "/packages/{name}": get: operationId: getPackage summary: Consultar pacote por nome x-badges: - name: Beta color: "#f5803e" tags: - Pacotes description: Retorna o pacote pelo nome, informado no caminho com codificação de URL (espaço como %20, barra como %2F). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: name required: true schema: type: string maxLength: 50 description: Nome atual do pacote, com codificação de URL example: Disney 7 noites responses: '200': "$ref": "#/components/responses/package" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updatePackage summary: Alterar pacote x-badges: - name: Beta color: "#f5803e" tags: - Pacotes description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: name required: true schema: type: string maxLength: 50 description: Nome atual do pacote, com codificação de URL example: Disney 7 noites responses: '200': description: Pacote alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/package" examples: package: summary: Pacote "$ref": "#/components/examples/package" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/package_write" examples: update_package: summary: Renomear pacote "$ref": "#/components/examples/update_package" delete: operationId: deletePackage summary: Excluir pacote x-badges: - name: Beta color: "#f5803e" tags: - Pacotes description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: name required: true schema: type: string maxLength: 50 description: Nome atual do pacote, com codificação de URL example: Disney 7 noites responses: '204': description: Pacote excluído com sucesso. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cost_centers": get: operationId: listCostCenters summary: Consultar centros de custo x-badges: - name: Beta color: "#f5803e" tags: - Centros de Custo description: Retorna a lista de centros de custo cadastrados no sistema. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/cost_centers" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCostCenter summary: Inserir centro de custo x-badges: - name: Beta color: "#f5803e" tags: - Centros de Custo description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já processada com a mesma chave de idempotência: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: "$ref": "#/components/schemas/cost_center" examples: cost_center: summary: Centro de custo administrativo "$ref": "#/components/examples/cost_center" '201': description: Centro de custo cadastrado. content: application/json: schema: "$ref": "#/components/schemas/cost_center" examples: cost_center: summary: Centro de custo administrativo "$ref": "#/components/examples/cost_center" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cost_center_create" examples: create_cost_center: summary: Novo centro de custo "$ref": "#/components/examples/create_cost_center" "/cost_centers/{id}": get: operationId: getCostCenter summary: Consultar centro de custo por ID x-badges: - name: Beta color: "#f5803e" tags: - Centros de Custo description: Retorna um centro de custo específico pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do centro de custo example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/cost_center" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCostCenter summary: Alterar centro de custo x-badges: - name: Beta color: "#f5803e" tags: - Centros de Custo description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do centro de custo example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Centro de custo alterado. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/cost_center" - "$ref": "#/components/schemas/entity_reference" examples: cost_center: summary: Centro de custo administrativo "$ref": "#/components/examples/cost_center" written_cost_center_reference: summary: Só o id "$ref": "#/components/examples/written_cost_center_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cost_center_update" examples: update_cost_center: summary: Renomear centro de custo "$ref": "#/components/examples/update_cost_center" delete: operationId: deleteCostCenter summary: Excluir centro de custo x-badges: - name: Beta color: "#f5803e" tags: - Centros de Custo description: Exclui o centro de custo. O centro de custo usado no rateio de algum lançamento financeiro responde 409. Não exige `Idempotency-Key`. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do centro de custo example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Centro de custo excluído. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies": get: operationId: listCurrencies summary: Consultar moedas x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: Retorna a lista de moedas cadastradas no sistema. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/currencies" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies/{code}": get: operationId: getCurrency summary: Consultar moeda por código x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: Retorna uma moeda específica pelo seu código ISO 4217. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Código da moeda no padrão ISO 4217 example: BRL responses: '200': "$ref": "#/components/responses/currency" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCurrency summary: Alterar moeda x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: code required: true schema: type: string description: Código da moeda no padrão ISO 4217 example: USD responses: '200': description: Moeda alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/currency" examples: currency: summary: Real "$ref": "#/components/examples/currency" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/currency_update" examples: deactivate_currency: summary: Desativar moeda "$ref": "#/components/examples/deactivate_currency" delete: operationId: deleteCurrency summary: Excluir moeda x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: '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](#tag/Moedas/paths/~1currencies~1{code}/patch).

Exige a permissão "Excluir" de moedas em alguma empresa que não seja somente leitura.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Código da moeda no padrão ISO 4217 example: USD responses: '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies/{code}/exchange_rates": get: operationId: listCurrencyExchangeRates summary: Consultar cotações da moeda x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Código da moeda no padrão ISO 4217 example: USD - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/exchange_rates" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCurrencyExchangeRate summary: Gravar cotação da moeda x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: code required: true schema: type: string description: Código da moeda no padrão ISO 4217 example: USD responses: '200': description: 'Valor igual ao da cotação vigente: nada foi gravado, e a resposta traz a vigente. Também é a resposta da repetição de uma requisição já concluída com a mesma Idempotency-Key.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate" examples: exchange_rate: summary: Cotação "$ref": "#/components/examples/exchange_rate" '201': description: Cotação gravada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate" examples: exchange_rate: summary: Cotação "$ref": "#/components/examples/exchange_rate" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_create" examples: create_exchange_rate: summary: Gravar cotação "$ref": "#/components/examples/create_exchange_rate" "/currencies/{code}/exchange_rates/{id}": get: operationId: getCurrencyExchangeRate summary: Consultar cotação por ID x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: Retorna uma cotação da moeda pelo ID. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Código da moeda no padrão ISO 4217 example: USD - in: path name: id required: true schema: type: string format: uuid description: ID da cotação example: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 responses: '200': "$ref": "#/components/responses/exchange_rate" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies/exchange_rates": post: operationId: updateExchangeRates summary: Atualizar câmbios x-badges: - name: Beta color: "#f5803e" tags: - Moedas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Todos os valores iguais aos das cotações vigentes: nada foi gravado, e a resposta traz a lista vazia. Também é a resposta da repetição de uma requisição já concluída com a mesma Idempotency-Key, que devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor "true", quando a resposta é a repetição de uma requisição anterior com a mesma Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_update_response" examples: exchange_rate_update_response: summary: Cotações gravadas "$ref": "#/components/examples/exchange_rate_update_response" '201': description: Cotações gravadas com sucesso. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_update_response" examples: exchange_rate_update_response: summary: Cotações gravadas "$ref": "#/components/examples/exchange_rate_update_response" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_update" examples: update_exchange_rates: summary: Atualizar câmbios "$ref": "#/components/examples/update_exchange_rates" "/categories": get: operationId: listCategories summary: Consultar categorias x-badges: - name: Beta color: "#f5803e" tags: - Categorias description: Retorna a lista de categorias financeiras cadastradas no sistema. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/categories" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCategory summary: Inserir categoria x-badges: - name: Beta color: "#f5803e" tags: - Categorias description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já processada com a mesma chave de idempotência: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: "$ref": "#/components/schemas/category" examples: category: summary: Categoria "$ref": "#/components/examples/category" '201': description: Categoria cadastrada. content: application/json: schema: "$ref": "#/components/schemas/category" examples: category: summary: Categoria "$ref": "#/components/examples/category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_create" examples: create_category: summary: Nova categoria "$ref": "#/components/examples/create_category" "/categories/{id}": get: operationId: getCategory summary: Consultar categoria por ID x-badges: - name: Beta color: "#f5803e" tags: - Categorias description: Retorna uma categoria financeira específica pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da categoria example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCategory summary: Alterar categoria x-badges: - name: Beta color: "#f5803e" tags: - Categorias description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da categoria example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Categoria alterada. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/category" - "$ref": "#/components/schemas/entity_reference" examples: category: summary: Categoria "$ref": "#/components/examples/category" written_category_reference: summary: Só o id "$ref": "#/components/examples/written_category_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_update" examples: update_category: summary: Renomear categoria "$ref": "#/components/examples/update_category" delete: operationId: deleteCategory summary: Excluir categoria x-badges: - name: Beta color: "#f5803e" tags: - Categorias description: 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`. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da categoria example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Categoria excluída. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cities": get: operationId: listCities summary: Consultar cidades x-badges: - name: Beta color: "#f5803e" tags: - Cidades description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: name required: false schema: type: string description: 'Filtra por nome, sem diferenciar maiúsculas nem acentos, como o campo Cidade do Monde: acha o início das palavras do nome (ex.: `Miguel` acha São Miguel do Oeste), os outros nomes da cidade na lista do Monde (ex.: `New York` e `Nova York` acham Nova Iorque), o estado e o país (ex.: `Paraná` traz também as cidades do Paraná). Com o filtro, a cidade cujo nome é o informado vem primeiro, depois a que tem esse nome entre os outros nomes, a que começa por ele, a que o contém e, por fim, as achadas pelo estado, pelo país ou por parte de outro nome; em cada grupo, a maior primeiro.' example: sao paulo - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/cities" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cities/{id}": get: operationId: getCity summary: Consultar cidade por ID x-badges: - name: Beta color: "#f5803e" tags: - Cidades description: 'Retorna uma cidade específica pelo seu identificador. Não pede permissão: toda credencial consulta.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da cidade example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/city" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/person_roles": get: operationId: listPersonRoles summary: Consultar funções x-badges: - name: Beta color: "#f5803e" tags: - Funções description: Retorna a lista de funções cadastradas, por nome, com os campos próprios de cada uma. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/person_roles" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createPersonRole summary: Cadastrar função x-badges: - name: Beta color: "#f5803e" tags: - Funções description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/person_role_write" examples: create_person_role: summary: Cadastrar uma função "$ref": "#/components/examples/create_person_role" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta do cadastro original, sem cadastrar outra função.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma gravação anterior. content: application/json: schema: "$ref": "#/components/schemas/person_role" examples: person_role: summary: Função "$ref": "#/components/examples/person_role" '201': description: Função cadastrada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/person_role" examples: person_role: summary: Função "$ref": "#/components/examples/person_role" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/person_roles/{id}": get: operationId: getPersonRole summary: Consultar função por ID x-badges: - name: Beta color: "#f5803e" tags: - Funções description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da função example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '200': "$ref": "#/components/responses/person_role" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updatePersonRole summary: Alterar função x-badges: - name: Beta color: "#f5803e" tags: - Funções description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da função example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/person_role_update" examples: update_person_role: summary: Alterar as pessoas da função "$ref": "#/components/examples/update_person_role" link_person_to_system_role: summary: Vincular uma pessoa à função Vendedor "$ref": "#/components/examples/link_person_to_system_role" update_person_goals: summary: Alterar as metas de uma pessoa "$ref": "#/components/examples/update_person_goals" responses: '200': description: Função alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma gravação anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/person_role" - "$ref": "#/components/schemas/entity_reference" examples: person_role: summary: Função "$ref": "#/components/examples/person_role" written_person_role_reference: summary: Função alterada, sem a permissão de leitura "$ref": "#/components/examples/written_person_role_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deletePersonRole summary: Excluir função x-badges: - name: Beta color: "#f5803e" tags: - Funções description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da função example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '204': description: Função excluída com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sellers": get: operationId: listSellers summary: Consultar vendedores x-badges: - name: Beta color: "#f5803e" tags: - Vendedores description: Retorna a lista de vendedores cadastrados no sistema (ativos e inativos). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/sellers" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createSeller summary: Cadastrar vendedor x-badges: - name: Beta color: "#f5803e" tags: - Vendedores description: Torna vendedor uma pessoa física já cadastrada, informada em `person_id` (o `id` da consulta de [Pessoas](#tag/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](#tag/Vendas/paths/~1sales/post). Exige a permissão "Editar" de vendedores. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta do cadastro original, sem cadastrar de novo.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de um cadastro anterior. content: application/json: schema: "$ref": "#/components/schemas/seller" examples: seller: summary: Vendedor ativo "$ref": "#/components/examples/seller" '201': description: Vendedor cadastrado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/seller" examples: seller: summary: Vendedor ativo "$ref": "#/components/examples/seller" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/seller_create" examples: create_seller: summary: Cadastrar vendedor "$ref": "#/components/examples/create_seller" "/sellers/{id}": get: operationId: getSeller summary: Consultar vendedor por ID x-badges: - name: Beta color: "#f5803e" tags: - Vendedores description: Retorna um vendedor específico pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do vendedor example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/seller" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateSeller summary: Alterar vendedor x-badges: - name: Beta color: "#f5803e" tags: - Vendedores description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do vendedor example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Vendedor alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/seller" - "$ref": "#/components/schemas/entity_reference" examples: seller: summary: Vendedor ativo "$ref": "#/components/examples/seller" written_seller_reference: summary: Alteração sem permissão de leitura "$ref": "#/components/examples/written_seller_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/seller_update" examples: deactivate_seller: summary: Desativar vendedor "$ref": "#/components/examples/deactivate_seller" delete: operationId: deleteSeller summary: Excluir vendedor x-badges: - name: Beta color: "#f5803e" tags: - Vendedores description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do vendedor example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Vendedor excluído com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/payment_methods": get: operationId: listPaymentMethods summary: Consultar formas de pagamento x-badges: - name: Beta color: "#f5803e" tags: - Formas de Pagamento description: Retorna a lista de formas de pagamento cadastradas no sistema. Formas de uso interno do sistema não são retornadas. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/payment_methods" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createPaymentMethod summary: Inserir forma de pagamento x-badges: - name: Beta color: "#f5803e" tags: - Formas de Pagamento description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já processada com a mesma chave de idempotência: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: "$ref": "#/components/schemas/payment_method" examples: payment_method: summary: Dinheiro "$ref": "#/components/examples/payment_method" '201': description: Forma de pagamento cadastrada. content: application/json: schema: "$ref": "#/components/schemas/payment_method" examples: payment_method: summary: Dinheiro "$ref": "#/components/examples/payment_method" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/payment_method_create" examples: create_payment_method: summary: Nova forma de pagamento "$ref": "#/components/examples/create_payment_method" "/payment_methods/{id}": get: operationId: getPaymentMethod summary: Consultar forma de pagamento por ID x-badges: - name: Beta color: "#f5803e" tags: - Formas de Pagamento description: Retorna uma forma de pagamento específica pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da forma de pagamento example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/payment_method" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updatePaymentMethod summary: Alterar forma de pagamento x-badges: - name: Beta color: "#f5803e" tags: - Formas de Pagamento description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da forma de pagamento example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 responses: '200': description: Forma de pagamento alterada. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/payment_method" - "$ref": "#/components/schemas/entity_reference" examples: payment_method: summary: Dinheiro "$ref": "#/components/examples/payment_method" written_payment_method_reference: summary: Só o id "$ref": "#/components/examples/written_payment_method_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/payment_method_update" examples: update_payment_method: summary: Renomear forma de pagamento "$ref": "#/components/examples/update_payment_method" delete: operationId: deletePaymentMethod summary: Excluir forma de pagamento x-badges: - name: Beta color: "#f5803e" tags: - Formas de Pagamento description: 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`. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da forma de pagamento example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 responses: '204': description: Forma de pagamento excluída. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts": get: operationId: listAccounts summary: Consultar contas e cartões x-badges: - name: Beta color: "#f5803e" tags: - Contas e Cartões description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/accounts" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createAccount summary: Inserir conta ou cartão x-badges: - name: Beta color: "#f5803e" tags: - Contas e Cartões description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já processada com a mesma chave de idempotência: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor `true`, quando a resposta é a repetição da original. content: application/json: schema: "$ref": "#/components/schemas/account" examples: account: summary: Cartão de crédito "$ref": "#/components/examples/account" '201': description: Conta ou cartão cadastrado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/account" examples: account: summary: Cartão de crédito "$ref": "#/components/examples/account" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/account_create" examples: create_account: summary: Conta corrente com cobrança "$ref": "#/components/examples/create_account" create_card_account: summary: Cartão de crédito "$ref": "#/components/examples/create_card_account" "/accounts/{id}": get: operationId: getAccount summary: Consultar conta ou cartão por ID x-badges: - name: Beta color: "#f5803e" tags: - Contas e Cartões description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/account" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateAccount summary: Alterar conta ou cartão x-badges: - name: Beta color: "#f5803e" tags: - Contas e Cartões description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Conta ou cartão alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente, com o valor `true`, quando a resposta é a repetição da original. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/account" - "$ref": "#/components/schemas/entity_reference" examples: account: summary: Cartão de crédito "$ref": "#/components/examples/account" written_account_reference: summary: Alteração sem permissão de leitura "$ref": "#/components/examples/written_account_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/account_update" examples: update_account: summary: Alterar descrição e convênio "$ref": "#/components/examples/update_account" delete: operationId: deleteAccount summary: Excluir conta ou cartão x-badges: - name: Beta color: "#f5803e" tags: - Contas e Cartões description: 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). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Conta ou cartão excluído com sucesso. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/banks": get: operationId: listBanks summary: Consultar bancos x-badges: - name: Beta color: "#f5803e" tags: - Bancos description: Retorna a lista de bancos, ordenada pelo nome do banco, como na escolha do banco no cadastro de conta corrente. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/banks" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/banks/{id}": get: operationId: getBank summary: Consultar banco por ID x-badges: - name: Beta color: "#f5803e" tags: - Bancos description: Retorna um banco específico pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do banco example: c3b7e8eb-1199-4457-9170-923c3fe56c92 responses: '200': "$ref": "#/components/responses/bank" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nf_rules": get: operationId: listNfRules summary: Consultar regras da nota fiscal x-badges: - name: Beta color: "#f5803e" tags: - Regras da Nota Fiscal description: Retorna a lista de regras da nota fiscal cadastradas no sistema. Produto, fornecedor e pagante nulos indicam que a regra vale para todos. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/nf_rules" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nf_rules/{id}": get: operationId: getNfRule summary: Consultar regra da nota fiscal por ID x-badges: - name: Beta color: "#f5803e" tags: - Regras da Nota Fiscal description: Retorna uma regra da nota fiscal específica pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da regra da nota fiscal example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/nf_rule" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/tasks": get: operationId: listTasks summary: Consultar tarefas x-badges: - name: Beta color: "#f5803e" tags: - Tarefas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" - in: query name: assignee_id required: false schema: type: string format: uuid description: Retorna só as tarefas deste responsável, pelo identificador da pessoa. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: created_by_id required: false schema: type: string format: uuid description: Retorna só as tarefas cadastradas por esta pessoa (o `created_by` da tarefa). example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: person_id required: false schema: type: string format: uuid description: Retorna só as tarefas vinculadas a esta pessoa. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 - in: query name: category_id required: false schema: type: string description: Retorna só as tarefas desta categoria, pelo identificador obtido em [Consultar categorias de tarefa](#tag/Categorias-de-Tarefas/paths/~1task_categories/get). `uncategorized` retorna as tarefas sem categoria. example: '11' - in: query name: status required: false schema: type: array items: type: string enum: - pending - completed - deleted style: form explode: false description: 'Situações a retornar, separadas por vírgula: `pending` (não concluída), `completed` (concluída) e `deleted` (excluída). As situações informadas se somam, e a tarefa excluída só vem quando `deleted` está entre elas. Sem o parâmetro, retorna as não concluídas e as concluídas.' example: - pending - in: query name: overdue required: false schema: type: boolean description: "`true` retorna só as tarefas vencidas: não concluídas e com o vencimento já passado. `false` retorna as que não estão vencidas. A tarefa sem vencimento nunca fica vencida." example: true - in: query name: date_field required: false schema: type: string enum: - due - created_at - completed_at description: 'Data usada no filtro de período: `due` (vencimento), `created_at` (cadastro) ou `completed_at` (conclusão). Obrigatório quando `date_from` ou `date_to` é informado.' example: due - in: query name: date_from required: false schema: type: string format: date description: Início do período (inclusivo), no formato YYYY-MM-DD. example: '2024-04-01' - in: query name: date_to required: false schema: type: string format: date description: Fim do período (inclusivo, o dia inteiro), no formato YYYY-MM-DD. example: '2024-04-30' - in: query name: sale_id required: false schema: type: string format: uuid description: Retorna só as tarefas vinculadas a esta venda. example: 8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 - in: query name: travel_id required: false schema: type: string format: uuid description: Retorna só as tarefas vinculadas a esta viagem. example: 1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 - in: query name: bill_id required: false schema: type: string format: uuid description: Retorna só as tarefas vinculadas a este lançamento (conta a pagar ou receber). example: 5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 responses: '200': "$ref": "#/components/responses/tasks" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTask summary: Criar tarefa x-badges: - name: Beta color: "#f5803e" tags: - Tarefas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da criação original, sem criar outra tarefa.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/task" examples: task_detail: summary: Tarefa com histórico e campos personalizados "$ref": "#/components/examples/task_detail" '201': description: Tarefa criada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/task" examples: task_detail: summary: Tarefa com histórico e campos personalizados "$ref": "#/components/examples/task_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_create" examples: create_task: summary: Tarefa com todos os campos "$ref": "#/components/examples/create_task" create_required_fields_task: summary: Tarefa só com os campos obrigatórios "$ref": "#/components/examples/create_required_fields_task" "/tasks/{id}": get: operationId: getTask summary: Consultar tarefa por ID x-badges: - name: Beta color: "#f5803e" tags: - Tarefas description: Retorna os dados de uma tarefa específica, incluindo o histórico, os campos personalizados e os anexos. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da tarefa (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/task" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTask summary: Alterar tarefa x-badges: - name: Beta color: "#f5803e" tags: - Tarefas description: '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](#tag/Tarefas/paths/~1tasks~1{task_id}~1history/post). 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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da tarefa (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Tarefa alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/task" - "$ref": "#/components/schemas/entity_reference" examples: task_detail: summary: Tarefa com histórico e campos personalizados "$ref": "#/components/examples/task_detail" written_task_reference: summary: Tarefa gravada, sem permissão de leitura "$ref": "#/components/examples/written_task_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Requisição em conflito: uma requisição com a mesma chave de idempotência já está sendo processada, ou a tarefa está excluída e não pode ser alterada.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. - A tarefa está excluída e não pode ser alterada. example: errors: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_update" examples: update_task: summary: Alteração de tarefa "$ref": "#/components/examples/update_task" complete_task: summary: Conclusão de tarefa "$ref": "#/components/examples/complete_task" delete: operationId: deleteTask summary: Excluir tarefa x-badges: - name: Beta color: "#f5803e" tags: - Tarefas description: 'Exclui a tarefa. A tarefa excluída deixa de aparecer em [Consultar tarefas](#tag/Tarefas/paths/~1tasks/get), 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](#tag/Tarefas/paths/~1tasks~1{id}/patch). 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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da tarefa (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Tarefa excluída com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'A tarefa não pode ser excluída: está concluída ou já foi excluída. Nada foi alterado.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - A tarefa está concluída e não pode ser excluída. Reabra a tarefa antes de excluí-la. - A tarefa já está excluída. example: errors: - A tarefa está concluída e não pode ser excluída. Reabra a tarefa antes de excluí-la. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/tasks/{task_id}/history": post: operationId: addTaskComment summary: Comentar na tarefa x-badges: - name: Beta color: "#f5803e" tags: - Tarefas description: '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](#tag/Anexos/paths/~1attachments/post), com `resource_type` `task` e o id da tarefa, e informe os `id`s 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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: task_id required: true schema: type: string format: uuid description: Identificador único da tarefa (formato UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta do registro original, sem registrar outro comentário.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de um registro anterior. content: application/json: schema: "$ref": "#/components/schemas/task" examples: task_detail: summary: Tarefa com histórico e campos personalizados "$ref": "#/components/examples/task_detail" '201': description: Comentário registrado com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/task" - "$ref": "#/components/schemas/entity_reference" examples: task_detail: summary: Tarefa com histórico e campos personalizados "$ref": "#/components/examples/task_detail" written_task_reference: summary: Tarefa gravada, sem permissão de leitura "$ref": "#/components/examples/written_task_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Requisição em conflito: uma requisição com a mesma chave de idempotência já está sendo processada, ou a tarefa está excluída e não recebe comentário.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. - A tarefa está excluída e não pode ser alterada. example: errors: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_comment_create" examples: create_task_historic: summary: Comentário na tarefa "$ref": "#/components/examples/create_task_historic" create_task_historic_with_attachments: summary: Comentário com anexos "$ref": "#/components/examples/create_task_historic_with_attachments" "/task_categories": get: operationId: listTaskCategories summary: Consultar categorias de tarefas x-badges: - name: Beta color: "#f5803e" tags: - Categorias de Tarefas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/task_categories" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTaskCategory summary: Criar categoria de tarefa x-badges: - name: Beta color: "#f5803e" tags: - Categorias de Tarefas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da criação original, sem criar outra categoria.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/task_category" examples: task_category: summary: Categoria de tarefa "$ref": "#/components/examples/task_category" '201': description: Categoria de tarefa criada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/task_category" examples: task_category: summary: Categoria de tarefa "$ref": "#/components/examples/task_category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_category_create" examples: create_task_category: summary: Criar como segunda coluna do quadro "$ref": "#/components/examples/create_task_category" "/task_categories/{id}": get: operationId: getTaskCategory summary: Consultar categoria de tarefa por ID x-badges: - name: Beta color: "#f5803e" tags: - Categorias de Tarefas description: Retorna os dados de uma categoria de tarefa específica. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identificador único da categoria de tarefa. example: 42 responses: '200': "$ref": "#/components/responses/task_category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTaskCategory summary: Alterar categoria de tarefa x-badges: - name: Beta color: "#f5803e" tags: - Categorias de Tarefas description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Identificador único da categoria de tarefa. example: 42 responses: '200': description: Categoria de tarefa alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/task_category" - "$ref": "#/components/schemas/numeric_entity_reference" examples: task_category: summary: Categoria de tarefa "$ref": "#/components/examples/task_category" written_task_category_reference: summary: Categoria alterada, sem permissão de leitura "$ref": "#/components/examples/written_task_category_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_category_update" examples: rename_task_category: summary: Renomear "$ref": "#/components/examples/rename_task_category" move_task_category: summary: Mover para a primeira coluna "$ref": "#/components/examples/move_task_category" hide_task_category: summary: Tirar do quadro "$ref": "#/components/examples/hide_task_category" delete: operationId: deleteTaskCategory summary: Excluir categoria de tarefa x-badges: - name: Beta color: "#f5803e" tags: - Categorias de Tarefas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identificador único da categoria de tarefa. example: 42 responses: '204': description: Categoria de tarefa excluída com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A categoria tem tarefas e não foi excluída. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - A categoria não pode ser excluída porque tem tarefas, inclusive concluídas ou excluídas. Mova as tarefas para outra categoria antes de excluí-la. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/travels": get: operationId: listTravels summary: Consultar viagens x-badges: - name: Beta color: "#f5803e" tags: - Viagens description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_field required: false schema: type: string enum: - start_date - end_date description: '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.' example: start_date - in: query name: date_from required: false schema: type: string format: date description: Filtrar viagens cujo campo escolhido em date_field seja igual ou posterior a esta data, no formato ISO 8601 (AAAA-MM-DD). example: '2024-01-01' - in: query name: date_to required: false schema: type: string format: date description: Filtrar viagens cujo campo escolhido em date_field seja igual ou anterior a esta data, no formato ISO 8601 (AAAA-MM-DD). example: '2024-12-31' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/travels" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTravel summary: Criar viagem x-badges: - name: Beta color: "#f5803e" tags: - Viagens description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da criação original, sem criar outra viagem.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/travel" examples: travel: summary: Viagem criada "$ref": "#/components/examples/created_travel" '201': description: Viagem criada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/travel" examples: travel: summary: Viagem criada "$ref": "#/components/examples/created_travel" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/travel_create" examples: create_travel: summary: Cadastrar viagem "$ref": "#/components/examples/create_travel" "/travels/{id}": get: operationId: getTravel summary: Consultar viagem por ID x-badges: - name: Beta color: "#f5803e" tags: - Viagens description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da viagem a ser obtida example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/travel" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTravel summary: Alterar viagem x-badges: - name: Beta color: "#f5803e" tags: - Viagens description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da viagem example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Viagem alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma gravação anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/travel" - "$ref": "#/components/schemas/entity_reference" examples: travel: summary: Detalhe da viagem "$ref": "#/components/examples/travel" written_travel_reference: summary: Viagem gravada, sem permissão de leitura "$ref": "#/components/examples/written_travel_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/travel_update" examples: update_travel: summary: Alterar a descrição e as observações "$ref": "#/components/examples/update_travel" delete: operationId: deleteTravel summary: Excluir viagem x-badges: - name: Beta color: "#f5803e" tags: - Viagens description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da viagem example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Viagem excluída com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/travels/{id}/sales/{sale_id}": post: operationId: linkTravelSale summary: Vincular venda à viagem x-badges: - name: Beta color: "#f5803e" tags: - Viagens description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da viagem example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador único da venda example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: Venda vinculada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma gravação anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/travel" - "$ref": "#/components/schemas/entity_reference" examples: travel: summary: Detalhe da viagem "$ref": "#/components/examples/travel" written_travel_reference: summary: Viagem gravada, sem permissão de leitura "$ref": "#/components/examples/written_travel_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: unlinkTravelSale summary: Desvincular venda da viagem x-badges: - name: Beta color: "#f5803e" tags: - Viagens description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da viagem example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: sale_id required: true schema: type: string format: uuid description: Identificador único da venda example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: Venda desvinculada com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/quotes": get: operationId: listQuotes summary: Consultar orçamentos x-badges: - name: Beta color: "#f5803e" tags: - Orçamentos description: Retorna a lista de orçamentos das empresas em que a credencial tem permissão. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/quotes" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createQuote summary: Criar orçamento x-badges: - name: Beta color: "#f5803e" tags: - Orçamentos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da criação original, sem criar outro orçamento.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/quote" examples: quote: summary: Orçamento de lua de mel "$ref": "#/components/examples/quote" '201': description: Orçamento criado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/quote" examples: quote: summary: Orçamento de lua de mel "$ref": "#/components/examples/quote" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/quote_create" examples: create_quote: summary: Criar um orçamento "$ref": "#/components/examples/create_quote" "/quotes/{id}": get: operationId: getQuote summary: Consultar orçamento por ID x-badges: - name: Beta color: "#f5803e" tags: - Orçamentos description: Retorna um orçamento específico pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identificador único do orçamento example: 42 responses: '200': "$ref": "#/components/responses/quote" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateQuote summary: Alterar orçamento x-badges: - name: Beta color: "#f5803e" tags: - Orçamentos description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Identificador único do orçamento example: 42 responses: '200': description: Orçamento alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/quote" - "$ref": "#/components/schemas/entity_reference" examples: quote: summary: Orçamento de lua de mel "$ref": "#/components/examples/quote" written_quote_reference: summary: Orçamento gravado, sem a permissão de leitura "$ref": "#/components/examples/written_quote_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/quote_update" examples: update_quote: summary: Alterar subtítulo e validade "$ref": "#/components/examples/update_quote" unlink_quote_person: summary: Tirar a pessoa do orçamento "$ref": "#/components/examples/unlink_quote_person" delete: operationId: deleteQuote summary: Excluir orçamento x-badges: - name: Beta color: "#f5803e" tags: - Orçamentos description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identificador único do orçamento example: 42 responses: '204': description: Orçamento excluído com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/quotes/{id}/duplication": post: operationId: duplicateQuote summary: Duplicar orçamento x-badges: - name: Beta color: "#f5803e" tags: - Orçamentos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Identificador único do orçamento example: 42 responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da duplicação original, sem criar outra cópia.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma duplicação anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/quote" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_quote: summary: Cópia do orçamento "$ref": "#/components/examples/duplicated_quote" '201': description: Orçamento duplicado com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/quote" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_quote: summary: Cópia do orçamento "$ref": "#/components/examples/duplicated_quote" written_quote_reference: summary: Orçamento gravado, sem a permissão de leitura "$ref": "#/components/examples/written_quote_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/quote_duplication" examples: duplicate_quote: summary: Duplicar um orçamento "$ref": "#/components/examples/duplicate_quote" "/guides": get: operationId: listGuides summary: Consultar guias x-badges: - name: Beta color: "#f5803e" tags: - Guias description: Retorna a lista de guias das empresas em que a credencial tem permissão, do alterado mais recentemente para o mais antigo. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/guides" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createGuide summary: Criar guia x-badges: - name: Beta color: "#f5803e" tags: - Guias description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da criação original, sem criar outro guia.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/guide" examples: guide: summary: Guia de Lisboa "$ref": "#/components/examples/guide" '201': description: Guia criado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/guide" examples: guide: summary: Guia de Lisboa "$ref": "#/components/examples/guide" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/guide_create" examples: create_guide: summary: Criar um guia "$ref": "#/components/examples/create_guide" "/guides/{id}": get: operationId: getGuide summary: Consultar guia por ID x-badges: - name: Beta color: "#f5803e" tags: - Guias description: Retorna um guia específico pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identificador único do guia example: 42 responses: '200': "$ref": "#/components/responses/guide" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateGuide summary: Alterar guia x-badges: - name: Beta color: "#f5803e" tags: - Guias description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Identificador único do guia example: 42 responses: '200': description: Guia alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/guide" - "$ref": "#/components/schemas/entity_reference" examples: guide: summary: Guia de Lisboa "$ref": "#/components/examples/guide" written_guide_reference: summary: Guia alterado, sem a permissão de leitura "$ref": "#/components/examples/written_guide_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/guide_update" examples: update_guide: summary: Alterar título e subtítulo "$ref": "#/components/examples/update_guide" deactivate_guide: summary: Desativar o guia "$ref": "#/components/examples/deactivate_guide" delete: operationId: deleteGuide summary: Excluir guia x-badges: - name: Beta color: "#f5803e" tags: - Guias description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identificador único do guia example: 42 responses: '204': description: Guia excluído com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/guides/{id}/duplication": post: operationId: duplicateGuide summary: Duplicar guia x-badges: - name: Beta color: "#f5803e" tags: - Guias description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Identificador único do guia example: 42 responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da duplicação original, sem criar outra cópia.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma duplicação anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/guide" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_guide: summary: Cópia do guia "$ref": "#/components/examples/duplicated_guide" '201': description: Guia duplicado com sucesso. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/guide" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_guide: summary: Cópia do guia "$ref": "#/components/examples/duplicated_guide" written_guide_reference: summary: Guia alterado, sem a permissão de leitura "$ref": "#/components/examples/written_guide_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/guide_duplication" examples: duplicate_guide: summary: Duplicar um guia "$ref": "#/components/examples/duplicate_guide" "/invoice_rules": get: operationId: listInvoiceRules summary: Consultar regras de faturamento x-badges: - name: Beta color: "#f5803e" tags: - Regras de Faturamento description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/invoice_rules" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/invoice_rules/{id}": get: operationId: getInvoiceRule summary: Consultar regra de faturamento por ID x-badges: - name: Beta color: "#f5803e" tags: - Regras de Faturamento description: Retorna uma regra de faturamento específica pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da regra de faturamento example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/invoice_rule" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/integrations": get: operationId: listIntegrations summary: Consultar integrações x-badges: - name: Beta color: "#f5803e" tags: - Integrações description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/integrations" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/integrations/{id}": get: operationId: getIntegration summary: Consultar integração por ID x-badges: - name: Beta color: "#f5803e" tags: - Integrações description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da integração example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/integration" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/people": get: operationId: listPeople summary: Consultar pessoas x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: '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}).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: name required: false schema: type: string description: Filtra por nome, sem diferenciar maiúsculas, acentos ou posição (busca por trecho). example: Maria da Silva - in: query name: cpf_cnpj required: false schema: type: string description: Filtra por CPF ou CNPJ (casa contra qualquer um dos dois). Informe só os dígitos, sem pontos, barras, traços ou espaços. example: '38107867807' - in: query name: passport_number required: false schema: type: string description: Filtra por número do passaporte, sem diferenciar maiúsculas ou acentos (busca por trecho). example: FG225776 - in: query name: phone required: false schema: type: string description: 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. example: '11934567890' - in: query name: kind required: false schema: type: string enum: - individual - company description: 'Filtra pelo tipo da pessoa: individual (pessoa física) ou company (pessoa jurídica).' example: individual - in: query name: code required: false schema: type: integer description: Filtra pelo código sequencial da pessoa (valor exato). example: 1024 - in: query name: email required: false schema: type: string description: Filtra por e-mail, sem diferenciar maiúsculas ou acentos (busca por trecho). example: contato@exemplo.com - in: query name: label_id required: false schema: type: string format: uuid description: Filtra as pessoas que têm o marcador informado (UUID, o `id` de [Consultar marcadores](#tag/Marcadores)). example: 2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50 - in: query name: birthday_from required: false schema: type: string format: date description: 'Início da janela de aniversário (YYYY-MM-DD). Traz as pessoas cujo dia e mês de nascimento caem entre `birthday_from` e `birthday_to`, qualquer que seja o ano, inclusive na janela que atravessa a virada do ano. Substitui a consulta Aniversariantes do Monde: para os aniversariantes de hoje, envie a data de hoje nos dois parâmetros. Informe os dois juntos; a janela vai até 366 dias.' example: '2026-12-28' - in: query name: birthday_to required: false schema: type: string format: date description: Fim da janela de aniversário (YYYY-MM-DD), inclusive. Veja `birthday_from`. example: '2027-01-05' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/people" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createPerson summary: Inserir pessoa x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma Idempotency-Key: devolve a resposta da primeira chamada, sem criar outra pessoa.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta repete uma requisição já processada. content: application/json: schema: "$ref": "#/components/schemas/person_detail" examples: person_detail: summary: Consulta de pessoa por ID "$ref": "#/components/examples/person_detail" '201': description: Pessoa criada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/person_detail" examples: person_detail: summary: Consulta de pessoa por ID "$ref": "#/components/examples/person_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/person_registration" examples: create_individual_person: summary: Cadastro de pessoa física "$ref": "#/components/examples/create_individual_person" create_company_person: summary: Cadastro de pessoa jurídica "$ref": "#/components/examples/create_company_person" "/people/{id}": get: operationId: getPerson summary: Consultar pessoa por ID x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - name: id in: path required: true schema: type: string format: uuid description: Identificador único (UUID) da pessoa. example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/person" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updatePerson summary: Alterar pessoa x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - name: id in: path required: true schema: type: string format: uuid description: Identificador único (UUID) da pessoa. example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Pessoa alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta repete uma requisição já processada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/person_detail" - "$ref": "#/components/schemas/entity_reference" examples: person_detail: summary: Consulta de pessoa por ID "$ref": "#/components/examples/person_detail" updated_person_reference: summary: Pessoa alterada, sem permissão de leitura "$ref": "#/components/examples/updated_person_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/person_update" examples: update_person: summary: Alteração de pessoa "$ref": "#/components/examples/update_person" delete: operationId: deletePerson summary: Excluir pessoa x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - name: id in: path required: true schema: type: string format: uuid description: Identificador único (UUID) da pessoa. example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Pessoa excluída com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'A pessoa não pode ser excluída: tem registros vinculados, tem anexos ou é usuário do sistema. Nada foi alterado.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - A pessoa não pode ser excluída porque possui registros vinculados, como vendas, lançamentos financeiros, notas fiscais ou tarefas. - A pessoa não pode ser excluída porque possui anexos, inclusive os já removidos. - A pessoa é usuário do sistema e não pode ser excluída pela API. example: errors: - A pessoa não pode ser excluída porque possui registros vinculados, como vendas, lançamentos financeiros, notas fiscais ou tarefas. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/people/{person_id}/photo": get: operationId: getPersonPhoto summary: Baixar foto da pessoa x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: 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`. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - name: person_id in: path required: true schema: type: string format: uuid description: Identificador único (UUID) da pessoa. example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: A imagem gravada no cadastro. content: image/jpeg: schema: type: string format: binary image/png: schema: type: string format: binary image/gif: schema: type: string format: binary image/bmp: schema: type: string format: binary '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': description: A pessoa não existe, não tem foto, ou a foto gravada não é uma imagem em formato conhecido. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O recurso solicitado não foi encontrado. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: uploadPersonPhoto summary: Enviar foto da pessoa x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_multipart" - "$ref": "#/components/parameters/idempotency_key_header" - name: person_id in: path required: true schema: type: string format: uuid description: Identificador único (UUID) da pessoa. example: f9d961b8-ea88-4346-8e52-afe94267417a requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary description: A imagem, em JPEG, com até 150 KB. responses: '200': description: 'Reenvio com a mesma Idempotency-Key e o mesmo arquivo: devolve a resposta da primeira chamada, sem gravar de novo.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição da primeira chamada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/person_detail" - "$ref": "#/components/schemas/entity_reference" examples: person_detail: summary: Consulta de pessoa por ID "$ref": "#/components/examples/person_detail" '201': description: Foto gravada. Devolve o cadastro da pessoa, ou só o `id` para quem não pode consultar pessoas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/person_detail" - "$ref": "#/components/schemas/entity_reference" examples: person_detail: summary: Consulta de pessoa por ID "$ref": "#/components/examples/person_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'Ocorreu um erro de validação. Verifique as mensagens de erro retornadas para mais detalhes. O erro de um item de lista traz a posição do item na lista enviada, contada a partir de 0, em cada nível: O campo ''insurances[0] passengers[2] person name'' é obrigatório fala do terceiro passageiro do primeiro seguro. A regra conferida sobre a lista inteira, como o contato repetido, vem no nome da lista, sem posição. O item nulo ou em branco dentro de uma lista ([null], [""]) é recusado.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O campo 'file' deve ser um arquivo JPEG '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deletePersonPhoto summary: Remover foto da pessoa x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - name: person_id in: path required: true schema: type: string format: uuid description: Identificador único (UUID) da pessoa. example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Foto removida. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': description: A pessoa não existe ou não tem foto. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O recurso solicitado não foi encontrado. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/people/{person_id}/conversion": post: operationId: convertPerson summary: Converter pessoa física em jurídica, ou o contrário x-badges: - name: Beta color: "#f5803e" tags: - Pessoas description: '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](#tag/Pessoas/paths/~1people~1{id}/patch), só aqui.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - name: person_id in: path required: true schema: type: string format: uuid description: Identificador único (UUID) da pessoa. example: f9d961b8-ea88-4346-8e52-afe94267417a requestBody: required: true content: application/json: schema: type: object required: - person_kind properties: person_kind: type: string enum: - individual - company description: 'Tipo de destino: `individual` (pessoa física) ou `company` (pessoa jurídica). Precisa ser diferente do tipo atual.' examples: convert_to_company: summary: Converter para pessoa jurídica value: person_kind: company responses: '200': description: Pessoa convertida. Devolve o cadastro já convertido, ou só o `id` para quem não pode consultar pessoas. O reenvio com a mesma Idempotency-Key devolve a mesma resposta, sem converter de novo. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição da primeira chamada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/person_detail" - "$ref": "#/components/schemas/entity_reference" examples: person_detail: summary: Consulta de pessoa por ID "$ref": "#/components/examples/person_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'Ocorreu um erro de validação. Verifique as mensagens de erro retornadas para mais detalhes. O erro de um item de lista traz a posição do item na lista enviada, contada a partir de 0, em cada nível: O campo ''insurances[0] passengers[2] person name'' é obrigatório fala do terceiro passageiro do primeiro seguro. A regra conferida sobre a lista inteira, como o contato repetido, vem no nome da lista, sem posição. O item nulo ou em branco dentro de uma lista ([null], [""]) é recusado.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Não é permitido que um cadastro de usuário seja convertido para pessoa jurídica - Não é permitido que um cadastro de empresa seja convertido para pessoa física example: errors: - Não é permitido que um cadastro de usuário seja convertido para pessoa jurídica '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/labels": get: operationId: listLabels summary: Consultar marcadores x-badges: - name: Beta color: "#f5803e" tags: - Marcadores description: Retorna a lista de marcadores cadastrados no sistema. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/labels" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createLabel summary: Criar marcador x-badges: - name: Beta color: "#f5803e" tags: - Marcadores description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma `Idempotency-Key`: devolve a resposta da criação original, sem criar outro marcador.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/label" examples: label: summary: Marcador VIP "$ref": "#/components/examples/label" '201': description: Marcador criado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/label" examples: label: summary: Marcador VIP "$ref": "#/components/examples/label" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/label_create" examples: create_label: summary: Criar marcador "$ref": "#/components/examples/create_label" "/labels/{id}": get: operationId: getLabel summary: Consultar marcador por ID x-badges: - name: Beta color: "#f5803e" tags: - Marcadores description: Retorna um marcador específico pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do marcador example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/label" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateLabel summary: Alterar marcador x-badges: - name: Beta color: "#f5803e" tags: - Marcadores description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do marcador example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Marcador alterado com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/label" - "$ref": "#/components/schemas/entity_reference" examples: label: summary: Marcador VIP "$ref": "#/components/examples/label" written_label_reference: summary: Alteração sem permissão de leitura "$ref": "#/components/examples/written_label_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/label_update" examples: update_label: summary: Renomear marcador "$ref": "#/components/examples/update_label" delete: operationId: deleteLabel summary: Excluir marcador x-badges: - name: Beta color: "#f5803e" tags: - Marcadores description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do marcador example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Marcador excluído com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/companies": get: operationId: listCompanies summary: Consultar empresas x-badges: - name: Beta color: "#f5803e" tags: - Empresas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/companies" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/companies/{id}": get: operationId: getCompany summary: Consultar empresa por ID x-badges: - name: Beta color: "#f5803e" tags: - Empresas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da empresa example: 8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10 responses: '200': "$ref": "#/components/responses/company" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills": get: operationId: listBills summary: Consultar contas a pagar e receber x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: 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}. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_field required: false schema: type: string enum: - issue_date - due_date - settlement_date description: '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.' example: due_date - in: query name: date_from required: false schema: type: string format: date description: Filtrar contas cujo campo escolhido em date_field seja igual ou posterior a esta data, no formato ISO 8601 (AAAA-MM-DD). example: '2024-01-01' - in: query name: date_to required: false schema: type: string format: date description: Filtrar contas cujo campo escolhido em date_field seja igual ou anterior a esta data, no formato ISO 8601 (AAAA-MM-DD). example: '2024-12-31' - in: query name: transaction_kind required: false schema: type: string enum: - credit - debit description: 'Filtra pela natureza do lançamento: credit (contas a receber) ou debit (contas a pagar). Quando ausente, retorna ambas.' example: credit - in: query name: kind required: false schema: type: string enum: - normal - sale_payment - sale_standalone - vendor_standalone - vendor_invoice - customer_invoice - credit_card_invoice - commission description: 'Origem do lançamento. ' example: customer_invoice - in: query name: status required: false schema: type: array items: type: string enum: - open - overdue - settled - canceled style: form explode: false description: 'Filtra pela situação. Aceita um ou mais valores separados por vírgula: Quando ausente, a API retorna só as contas open e overdue; liquidadas e canceladas só voltam quando pedidas explicitamente.' example: - open - overdue - in: query name: recurrence_group_id required: false schema: type: string format: uuid description: Filtra pelos lançamentos de uma série de parcelamento ou recorrência, pelo recurrence_group_id de qualquer um deles, como o devolvido na criação. Combine com status para incluir os já liquidados. example: 5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f - in: query name: number required: false schema: type: string description: 'Filtra pelo número do lançamento exibido no aplicativo (um por requisição). Lançamentos parcelados têm sufixo de parcela (ex.: 362-1), então informe o número exatamente como aparece.' example: '362' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/bills" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createBill summary: Inserir conta a pagar ou receber x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Requisição repetida com a mesma Idempotency-Key: devolve a resposta da criação original, sem criar outro lançamento.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma criação anterior. content: application/json: schema: "$ref": "#/components/schemas/bill_created" examples: receivable_bill: summary: Conta a receber (fatura de cliente) "$ref": "#/components/examples/receivable_bill_single" '201': description: Conta a pagar ou receber criada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/bill_created" examples: receivable_bill: summary: Conta a receber (fatura de cliente) "$ref": "#/components/examples/receivable_bill_single" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/bill_create" examples: create_bill: summary: Conta a pagar completa "$ref": "#/components/examples/create_bill" create_required_fields_bill: summary: Conta a receber só com os campos obrigatórios "$ref": "#/components/examples/create_required_fields_bill" create_sale_bill: summary: Conta a pagar da venda "$ref": "#/components/examples/create_sale_bill" create_settled_bill: summary: Conta a pagar já liquidada "$ref": "#/components/examples/create_settled_bill" create_settled_bill_with_fine: summary: Conta a pagar liquidada com multa "$ref": "#/components/examples/create_settled_bill_with_fine" create_partial_settled_bill: summary: Conta a pagar com pagamento parcial "$ref": "#/components/examples/create_partial_settled_bill" create_installment_bill: summary: Conta a pagar parcelada "$ref": "#/components/examples/create_installment_bill" create_recurrent_bill: summary: Conta a pagar recorrente "$ref": "#/components/examples/create_recurrent_bill" "/bills/{id}": get: operationId: getBill summary: Consultar conta a pagar ou receber por ID x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': "$ref": "#/components/responses/bill" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateBill summary: Alterar conta a pagar ou receber x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '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.Em todos, a categoria gerada pelo sistema (a da venda, a da fatura) não sai nem muda de valor: reenvie-a como está, com o mesmo category_id. A operação própria só é aceita no lançamento avulso (normal) sem número de fatura, como no Monde.

Lançamento liquidado. Exige também a permissão "Editar lançamento liquidado" de contas a pagar e receber. settlement_date muda a data de liquidação, que não pode ficar vazia nem passar da data da última movimentação. Mudar a data de liquidação para uma diferente da gravada exige também a permissão "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. A mesma data reenviada não pede a permissão. Cada item de movements com id aponta uma movimentação que o lançamento já tem, e muda só a conta, a forma de pagamento, a data, o valor, a taxa de cartão, o cheque ou o cartão enviados. O item sem id é uma movimentação nova, como o Adicionar do Monde, e vem com a conta, a forma de pagamento, a data e o valor. As movimentações não enviadas ficam como estão, e não é possível retirar movimentação. Os ids das movimentações vêm em movements de Consultar conta a pagar ou receber por ID. As movimentações precisam somar exatamente o valor final: mudar o valor pede a movimentação junto. Na movimentação com taxa de cartão (card_rate), o valor é o que o cliente pagou, e a conta recebe o valor menos a taxa: mudar só a taxa mantém o que o cliente pagou e muda o que entrou na conta, como no Monde, e a categoria de taxa de cartão acompanha, assim como a taxa cartão agência dos produtos da venda e a receita dela. A forma de pagamento da movimentação com taxa gerada pelo sistema não muda para outra que não seja cartão. A conta a receber pode passar para a conta cartão de crédito, com a forma cartão de crédito: é o estorno, que entra na fatura do cartão. A empresa do lançamento liquidado não muda. O caixa fechado e, em contas a receber, o bloqueio da data de movimentação valem como no Monde. Em lançamento em aberto, uma data em settlement_date ou uma movimentação em movements é recusada: esta operação não liquida.

Conciliação bancária. A alteração que muda o valor, a data ou a conta de uma movimentação conciliada desfaz a conciliação dela e responde 409, com o mesmo aviso do Monde, a menos que o pedido traga undo_bank_reconciliation como true. Com a confirmação, a alteração é gravada, e a conciliação dessa movimentação precisará ser refeita. A alteração que não mexe nas movimentações conciliadas, como a das categorias, dos rateios ou da descrição, mantém a conciliação e é gravada sem a confirmação.

Valor e categorias. As categories enviadas substituem as do lançamento, e a soma com sinal delas é o valor final, como na inserção: a diferença para amount é acréscimo ou desconto, sujeita ao bloqueio de acréscimo e desconto da empresa. A lista não pode ficar vazia. O amount enviado sem categories segue a regra do Monde: com uma categoria só, ela acompanha o novo valor; com mais de uma, o novo valor precisa ser igual à soma delas, senão é recusado e é preciso enviar as categorias junto.

Rateios. Só em agência. Cada rateio enviado substitui o do lançamento, e o que não veio fica como está: apportionments.per_cost_center pode ficar entre 0 e 100% do valor final, e apportionments.per_company, quando informado, precisa somar exatamente 100% e só aceita empresas em que a credencial também pode inserir lançamentos. A lista vazia retira o rateio.

Empresa. company_identifier leva o lançamento para outra empresa, e exige a permissão "Editar" de contas a pagar e receber também nela, que não pode estar somente leitura. O lançamento de outro usuário exige também, na empresa de destino, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); sem ele, a resposta é 403 com a mensagem do Monde. Sem account_id, a conta prevista continua a mesma se a nova empresa também a tem; senão, vale a conta de previsão padrão da nova empresa. Como no Monde, o lançamento com boleto registrado ou emitido não muda de empresa.

Regras. A emissão não pode ser maior que o vencimento. A descrição tem até 50 caracteres, como na inserção. A conta prevista precisa estar ativa e vinculada à empresa do lançamento, e a operação própria precisa estar ativa e só é aceita em agência. Em contas a receber, o vencimento alterado está sujeito ao bloqueio de vencimento da empresa. Só a credencial com "Ignorar bloqueios" na empresa do lançamento passa pelos bloqueios.

Parcelamento e recorrência. No lançamento de uma série, a alteração vale só para ele, a menos que recurrence_scope seja this_and_following: aí ela vale também para os lançamentos seguintes da série, como a opção "Atualizar este e próximos" do Monde. Os seguintes são alterados em segundo plano, logo depois da resposta. Nunca se levam a eles a liquidação, o número, o documento e os dados do boleto; o vencimento deles segue a periodicidade da série a partir do lançamento alterado, e na recorrência a emissão também. Cada seguinte só é alterado quando a credencial poderia alterá-lo diretamente, com as regras do fim desta descrição: a permissão "Editar" na empresa dele, que não pode estar somente leitura; no de outro usuário, o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, a "Editar lançamento liquidado". O seguinte que não atende a isso fica como está, sem interromper os demais. O seguinte excluído também fica como está. Em lançamento fora de uma série, this_and_following é recusado.

Exige a permissão "Editar" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura; o lançamento liquidado exige também a "Editar lançamento liquidado". A credencial altera o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. A resposta traz o lançamento alterado, igual a Consultar conta a pagar ou receber por ID, quando a credencial também tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento; sem ela, a alteração é gravada do mesmo jeito e a resposta traz apenas o id. Vale também para o lançamento que a própria credencial criou.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: Conta a pagar ou receber alterada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma alteração anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: receivable_bill: summary: Conta a receber (fatura de cliente) "$ref": "#/components/examples/receivable_bill_single" written_bill_reference: summary: Lançamento alterado, sem permissão de leitura "$ref": "#/components/examples/written_bill_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Requisição em conflito: uma requisição com a mesma chave de idempotência já está sendo processada, ou o lançamento não pode ser alterado: está excluído, é fatura inválida, ou a alteração desfaz a conciliação bancária de uma movimentação e o pedido não trouxe undo_bank_reconciliation como true.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. - O lançamento está excluído e não pode ser alterado. - Não é possível editar uma fatura inválida. - 'Este lançamento está na conciliação bancária, e a alteração muda o valor, a data ou a conta de uma movimentação conciliada: a conciliação dela será desfeita e precisará ser refeita. Para gravar mesmo assim, envie ''undo_bank_reconciliation'' como true.' - 'A fatura de cliente está aberta, e a conta de cobrança só entra com a fatura fechada: o boleto cobra o que ela tem. Para fechar a fatura junto, envie ''close_invoice'' como true.' example: errors: - 'Este lançamento está na conciliação bancária, e a alteração muda o valor, a data ou a conta de uma movimentação conciliada: a conciliação dela será desfeita e precisará ser refeita. Para gravar mesmo assim, envie ''undo_bank_reconciliation'' como true.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/bill_update" examples: update_bill: summary: Alteração da descrição, documento, vencimento e observações "$ref": "#/components/examples/update_bill" update_bill_values: summary: Alteração do valor, das categorias e do rateio por centro de custo "$ref": "#/components/examples/update_bill_values" update_settled_bill: summary: Alteração do valor de um lançamento liquidado e conciliado "$ref": "#/components/examples/update_settled_bill" delete: operationId: deleteBill summary: Excluir conta a pagar ou receber x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: |-

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:

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.

security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: Lançamento excluído com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: O lançamento não pode ser excluído, ou pede uma confirmação, que só vai no POST de exclusão com confirmação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - 'O lançamento está liquidado: excluí-lo remove a liquidação, e as movimentações dele saem das contas. Para excluir mesmo assim, use o POST /bills/{id}/removal com ''remove_settlement'' como true.' - 'Este lançamento está na conciliação bancária: excluí-lo desfaz a conciliação dele, que precisará ser refeita. Para excluir mesmo assim, use o POST /bills/{id}/removal com ''undo_bank_reconciliation'' como true.' example: errors: - 'O lançamento está liquidado: excluí-lo remove a liquidação, e as movimentações dele saem das contas. Para excluir mesmo assim, use o POST /bills/{id}/removal com ''remove_settlement'' como true.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/removal": post: operationId: removeBill summary: Excluir conta a pagar ou receber com confirmação x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: required: true content: application/json: schema: type: object properties: recurrence_scope: type: string enum: - only_this - this_and_following description: 'Só para lançamento de parcelamento ou recorrência: only_this (padrão) exclui só este; this_and_following exclui também os seguintes da série que não têm movimentação e que a credencial poderia excluir diretamente.' remove_settlement: type: boolean description: Confirma a exclusão do lançamento liquidado, que remove a liquidação e as movimentações dele. Obrigatório como true no lançamento liquidado. undo_bank_reconciliation: type: boolean description: Confirma que a conciliação bancária do lançamento será desfeita. Obrigatório como true no lançamento com movimentação conciliada. example: remove_settlement: true responses: '204': description: Lançamento excluído com sucesso. A resposta não tem corpo. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma exclusão anterior. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Requisição em conflito: uma requisição com a mesma chave de idempotência já está sendo processada, ou o lançamento não pode ser excluído, ou falta a confirmação de remover a liquidação ou de desfazer a conciliação. A mensagem diz o motivo. Nada foi alterado.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. - 'O lançamento está liquidado: excluí-lo remove a liquidação, e as movimentações dele saem das contas. Para excluir mesmo assim, use o POST /bills/{id}/removal com ''remove_settlement'' como true.' - 'Este lançamento está na conciliação bancária: excluí-lo desfaz a conciliação dele, que precisará ser refeita. Para excluir mesmo assim, use o POST /bills/{id}/removal com ''undo_bank_reconciliation'' como true.' example: errors: - 'O lançamento está liquidado: excluí-lo remove a liquidação, e as movimentações dele saem das contas. Para excluir mesmo assim, use o POST /bills/{id}/removal com ''remove_settlement'' como true.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/settlement": post: operationId: settleBill summary: Liquidar conta a pagar ou receber x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: |-

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:

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.

security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/bill_settlement" examples: settle_bill: summary: Liquidação pelo valor cheio "$ref": "#/components/examples/settle_bill" settle_bill_with_fine: summary: Liquidação com multa "$ref": "#/components/examples/settle_bill_with_fine" settle_bill_partially: summary: Pagamento parcial "$ref": "#/components/examples/settle_bill_partially" responses: '200': description: Conta a pagar ou receber liquidada com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma liquidação anterior. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill_settled" - "$ref": "#/components/schemas/entity_reference" examples: written_bill_reference: summary: Lançamento alterado, sem permissão de leitura "$ref": "#/components/examples/written_bill_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Requisição em conflito: uma requisição com a mesma chave de idempotência já está sendo processada, ou o lançamento não pode ser liquidado: já está liquidado, está excluído ou é fatura inválida. Nada foi alterado.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. - O lançamento já está liquidado. Para mudar a baixa, edite o lançamento; para refazê-la, desfaça a liquidação antes. - O lançamento está excluído e não pode ser alterado. - Não é possível editar uma fatura inválida. example: errors: - O lançamento já está liquidado. Para mudar a baixa, edite o lançamento; para refazê-la, desfaça a liquidação antes. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: reopenBill summary: Desfazer a liquidação de conta a pagar ou receber x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: Liquidação desfeita com sucesso. A resposta não tem corpo. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A liquidação não pode ser desfeita, ou pede a confirmação de desfazer a conciliação, que só vai no POST de desfazer com confirmação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento não está liquidado. - O lançamento está excluído e não pode ser alterado. - Não foi possível remover a liquidação. O saldo desta fatura está vinculado a outro lançamento. - 'Este lançamento está na conciliação bancária: desfazer a liquidação desfaz a conciliação dele, que precisará ser refeita. Para desfazer mesmo assim, use o POST /bills/{id}/settlement/removal com ''undo_bank_reconciliation'' como true.' example: errors: - 'Este lançamento está na conciliação bancária: desfazer a liquidação desfaz a conciliação dele, que precisará ser refeita. Para desfazer mesmo assim, use o POST /bills/{id}/settlement/removal com ''undo_bank_reconciliation'' como true.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/settlement/removal": post: operationId: removeBillSettlement summary: Desfazer a liquidação com confirmação x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: required: true content: application/json: schema: type: object properties: recurrence_scope: type: string enum: - only_this - this_and_following description: 'Só para lançamento de parcelamento ou recorrência: only_this (padrão) desfaz só a liquidação deste; this_and_following desfaz também a dos seguintes da série que estão liquidados.' undo_bank_reconciliation: type: boolean description: Confirma que a conciliação bancária do lançamento será desfeita. Obrigatório como true no lançamento com movimentação conciliada, e vale também para os seguintes da série com this_and_following. example: recurrence_scope: this_and_following undo_bank_reconciliation: true responses: '204': description: Liquidação desfeita com sucesso. A resposta não tem corpo. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de um pedido anterior. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Requisição em conflito: uma requisição com a mesma chave de idempotência já está sendo processada, ou a liquidação não pode ser desfeita, ou falta a confirmação de desfazer a conciliação. A mensagem diz o motivo. Nada foi alterado.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. - O lançamento não está liquidado. - O lançamento está excluído e não pode ser alterado. - Não foi possível remover a liquidação. O saldo desta fatura está vinculado a outro lançamento. - 'Este lançamento está na conciliação bancária: desfazer a liquidação desfaz a conciliação dele, que precisará ser refeita. Para desfazer mesmo assim, use o POST /bills/{id}/settlement/removal com ''undo_bank_reconciliation'' como true.' - 'Nenhuma liquidação foi desfeita: o lançamento seguinte 5f0c1a2b-3d4e-4f60-8a9b-0c1d2e3f4a5b, de vencimento 10/12/2026, não pode ser reaberto. A credencial não tem permissão para desfazer a liquidação deste lançamento.' example: errors: - 'Este lançamento está na conciliação bancária: desfazer a liquidação desfaz a conciliação dele, que precisará ser refeita. Para desfazer mesmo assim, use o POST /bills/{id}/settlement/removal com ''undo_bank_reconciliation'' como true.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bill_batch_settlements": post: operationId: settleBillsInBatch summary: Liquidar contas a pagar e receber em lote x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/bill_batch_settlement" examples: settle_bills_in_batch: summary: Liquidação de duas contas na mesma conta "$ref": "#/components/examples/settle_bills_in_batch" settle_sale_payments_in_batch: summary: Liquidação com os dados da venda "$ref": "#/components/examples/settle_sale_payments_in_batch" responses: '200': description: Contas a pagar e receber liquidadas com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma liquidação em lote anterior. content: application/json: schema: type: object required: - data properties: data: type: array description: 'Os lançamentos liquidados, na ordem do vencimento: cada um inteiro, ou só o id para a credencial que não lê contas na empresa dele.' items: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: batch_settled_bills_references: summary: Lançamentos liquidados, sem permissão de leitura "$ref": "#/components/examples/batch_settled_bills_references" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': description: Algum lançamento pedido não existe ou está fora do alcance da credencial. A mensagem traz os ids, e nada foi liquidado. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - 'Nenhum lançamento foi liquidado: estes lançamentos não foram encontrados: 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f.' '409': description: 'Requisição em conflito: uma requisição com a mesma chave de idempotência já está sendo processada, ou um dos lançamentos não pode ser liquidado: já está liquidado, está excluído ou é fatura inválida. A mensagem diz qual, e nada foi liquidado.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. - Não é possível liquidar o lançamento Nº 71. O lançamento já está liquidado. Para mudar a baixa, edite o lançamento; para refazê-la, desfaça a liquidação antes. example: errors: - Não é possível liquidar o lançamento Nº 71. O lançamento já está liquidado. Para mudar a baixa, edite o lançamento; para refazê-la, desfaça a liquidação antes. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/restoration": post: operationId: restoreBill summary: Restaurar conta a pagar ou receber excluída x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da conta a pagar ou receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: Lançamento restaurado. A resposta traz o lançamento, ou só o id para a credencial que não lê contas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: receivable_bill: summary: Conta a receber (fatura de cliente) "$ref": "#/components/examples/receivable_bill_single" written_bill_reference: summary: Lançamento alterado, sem permissão de leitura "$ref": "#/components/examples/written_bill_reference" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: O lançamento não pode ser restaurado. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento não está excluído. - Este lançamento foi gerado a partir de uma venda e deve ser restaurado a partir da venda. - Faturas ou lançamentos de comissão excluídos não podem ser restaurados. - 'Este tipo de lançamento não é restaurado pela API: restaure-o pelo Monde.' example: errors: - O lançamento não está excluído. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/billet": post: operationId: issueBillBillet summary: Gerar boleto de conta a receber x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: ID da conta a receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: required: false content: application/json: schema: type: object properties: billing_account_id: type: string format: uuid description: Conta de cobrança do boleto, pelo id de billing_accounts em GET /accounts/{id}. Só é usada quando o lançamento não tem conta de cobrança e a empresa tem mais de uma que emite sem registro. example: 6b7c2d1e-3f4a-4b5c-8d9e-0f1a2b3c4d5e exchange_rate: type: number format: double description: 'Câmbio da emissão, maior que zero, no lançamento em moeda estrangeira: o boleto sai em reais.' example: 5.4321 close_invoice: type: boolean description: Confirma o fechamento da fatura de cliente aberta, para gerar o boleto dela. Sem ela, a fatura aberta responde 409. example: true examples: issue_billet: summary: Gerar o boleto pela conta de cobrança do lançamento value: {} responses: '200': description: O boleto gerado, com o que o pagador precisa para pagá-lo. content: application/json: schema: type: object properties: bill: "$ref": "#/components/schemas/entity_reference" number: type: integer nullable: true description: Número do boleto. our_number: type: string nullable: true description: Nosso número do boleto. digitable_line: type: string nullable: true description: Linha digitável do boleto. barcode: type: string nullable: true description: Número do código de barras do boleto. amount: type: number format: double nullable: true description: Valor do boleto, em reais. due_date: type: string format: date nullable: true description: Vencimento do boleto. pix_code: type: string nullable: true description: Pix copia e cola do boleto registrado pelo PJBank; nulo nos demais. bank: type: object description: 'Banco do boleto: o número com o dígito e o nome.' properties: code: type: string nullable: true name: type: string nullable: true examples: issued_billet: summary: Boleto emitido pelo Itaú value: 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: bank: code: 341-7 name: Itaú '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - 'A fatura de cliente está aberta, e o boleto só sai da fatura fechada: ele cobra o que ela tem. Para fechar a fatura e gerar o boleto, envie ''close_invoice'' como true.' example: errors: - 'A fatura de cliente está aberta, e o boleto só sai da fatura fechada: ele cobra o que ela tem. Para fechar a fatura e gerar o boleto, envie ''close_invoice'' como true.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/billet.pdf": get: operationId: downloadBillBilletPdf summary: Baixar o PDF do boleto x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - in: path name: id required: true schema: type: string format: uuid description: ID da conta a receber. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: O PDF do boleto. content: application/pdf: schema: type: string format: binary '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - O boleto ainda não foi gerado. Gere-o antes em POST /bills/{id}/billet. example: errors: - O boleto ainda não foi gerado. Gere-o antes em POST /bills/{id}/billet. '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/invoice_closure": post: operationId: closeBillInvoice summary: Fechar fatura de cliente x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: A fatura fechada, ou só o id dela para a credencial que não lê contas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: written_bill_reference: summary: Lançamento alterado, sem permissão de leitura "$ref": "#/components/examples/written_bill_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - Só a fatura de cliente é fechada e reaberta. - A fatura já está fechada. example: errors: - A fatura já está fechada. '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: reopenBillInvoice summary: Reabrir fatura de cliente x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: A fatura foi reaberta. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - Só a fatura de cliente é fechada e reaberta. - A fatura não está fechada. example: errors: - A fatura não está fechada. '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/items/{id}": patch: operationId: updateBillItem summary: Alterar conferido ou centro de custo de item da fatura x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: bill_id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: id required: true schema: type: string format: uuid description: ID do item da fatura, o id de cada item de items em Consultar conta a pagar ou receber por ID. example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 requestBody: required: true content: application/json: schema: type: object properties: checked: type: boolean description: Marca o item como conferido (true) ou não (false). example: true cost_center: type: string nullable: true maxLength: 50 description: Centro de custo do item. null limpa o centro de custo. example: Diretoria examples: check_item: summary: Marcar o item como conferido value: checked: true responses: '200': &1 description: A fatura como ficou depois da ação, ou só o id dela para a credencial que não lê contas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: written_bill_reference: summary: Lançamento alterado, sem permissão de leitura "$ref": "#/components/examples/written_bill_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - Este lançamento não é uma fatura com itens. 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. - A fatura está liquidada. Para realizar esta operação, desfaça a liquidação antes. - A fatura está fechada. Para realizar esta operação, reabra a fatura antes. Se a fatura já foi enviada ao cliente, considere fazer as alterações na próxima fatura. - O item só é conferido na fatura de fornecedor gerada pelo Monde e no avulso de fornecedor. - O centro de custo do item só muda na fatura de cliente gerada pelo Monde. example: errors: - O item só é conferido na fatura de fornecedor gerada pelo Monde e no avulso de fornecedor. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/items/{id}/value_correction": post: operationId: correctBillItemValues summary: Corrigir valores de item da fatura x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: bill_id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: id required: true schema: type: string format: uuid description: ID do item da fatura, o id de cada item de items em Consultar conta a pagar ou receber por ID. example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 requestBody: required: true content: application/json: schema: type: object properties: value: type: number format: double description: Valor novo do item, com o sinal dele. A diferença vai para a próxima fatura. example: -80.0 commission_percentage: type: number format: double description: Percentual de comissão do produto da venda. Só na fatura de fornecedor. example: 10.0 commission_amount: type: number format: double description: Valor da comissão do produto da venda. Só na fatura de fornecedor. example: 20.0 over_percentage: type: number format: double description: Percentual de over do produto da venda. Só na fatura de fornecedor. example: 0.0 over_amount: type: number format: double description: Valor do over do produto da venda. Só na fatura de fornecedor. example: 0.0 cc_du_fee: type: number format: double description: Taxa CC DU do produto da venda, que não pode passar da taxa DU. Só na fatura de fornecedor de passagem aérea. example: 0.0 cc_rav_fee: type: number format: double description: Taxa CC RAV do produto da venda, que não pode passar da taxa RAV. Só na fatura de fornecedor. example: 4.0 examples: correct_commission: summary: Corrigir a comissão do produto da venda value: commission_amount: 20.0 responses: '200': *1 '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - Este lançamento não é uma fatura com itens. 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. - A fatura está liquidada. Para realizar esta operação, desfaça a liquidação antes. - A fatura está fechada. Para realizar esta operação, reabra a fatura antes. Se a fatura já foi enviada ao cliente, considere fazer as alterações na próxima fatura. - Corrigir valores só vale na fatura de cliente e na fatura de fornecedor geradas pelo Monde. - Corrigir valores só vale no item ligado a um produto de venda. example: errors: - Corrigir valores só vale na fatura de cliente e na fatura de fornecedor geradas pelo Monde. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/items": post: operationId: addBillItems summary: Adicionar itens à fatura x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: bill_id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: &2 required: true content: application/json: schema: type: object required: - item_ids properties: item_ids: type: array minItems: 1 items: type: string format: uuid description: IDs dos itens em que a ação age. examples: item_ids: summary: Itens da ação value: item_ids: - 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 responses: '200': *1 '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': &3 description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - Este lançamento não é uma fatura com itens. 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. - A fatura está liquidada. Para realizar esta operação, desfaça a liquidação antes. - A fatura está fechada. Para realizar esta operação, reabra a fatura antes. Se a fatura já foi enviada ao cliente, considere fazer as alterações na próxima fatura. example: errors: - A fatura está fechada. Para realizar esta operação, reabra a fatura antes. Se a fatura já foi enviada ao cliente, considere fazer as alterações na próxima fatura. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bill_items": get: operationId: listBillItems summary: Consultar itens das faturas x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: bill_id required: false schema: type: string format: uuid description: 'ID do lançamento: só os itens dele. É o bill da movimentação em Consultar movimentação por ID.' example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: query name: account_id required: false schema: type: string format: uuid description: 'ID da conta do lançamento: só os itens dos lançamentos dela.' example: 6e0216e5-5536-4f4b-8c93-36371398b3cf - in: query name: person_id required: false schema: type: string format: uuid description: ID da pessoa do item. example: 7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a - in: query name: side required: false schema: type: string enum: - vendor - customer description: 'Lado do item: customer (do cliente) ou vendor (do fornecedor).' example: vendor - in: query name: date_field required: false schema: type: string enum: - settlement_date - due_date - issue_date description: 'Data do período: settlement_date (liquidação do lançamento), due_date (vencimento do lançamento) ou issue_date (emissão do item). Obrigatório com date_from ou date_to.' example: settlement_date - in: query name: date_from required: false schema: type: string format: date description: Início do período, inclusive (AAAA-MM-DD). example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: Fim do período, inclusive (AAAA-MM-DD). example: '2026-10-31' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': description: Os itens das faturas, com o lançamento e a venda de cada um. content: application/json: schema: type: object properties: data: type: array items: allOf: - "$ref": "#/components/schemas/bill_item" - type: object properties: bill: "$ref": "#/components/schemas/entity_reference" settlement_date: type: string format: date nullable: true description: Liquidação do lançamento em que o item está, que é a data do pagamento que ele compõe. Nula no lançamento em aberto. pagination: "$ref": "#/components/schemas/pagination" examples: supplier_payment: summary: Itens do pagamento de uma fatura de fornecedor value: data: - id: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 description: Pacote Cancún cost_center: checked: true amount: -22000.0 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: 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: checked: true amount: 12000.0 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: bill: id: 212b54b8-27df-4859-80a9-79ad855bcd09 settlement_date: '2026-10-15' pagination: size: 20 has_next_page: false next_cursor: '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/item_candidates": get: operationId: listBillItemCandidates summary: Itens que podem entrar na fatura x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description:

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.

security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: bill_id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: query name: q required: false schema: type: string description: Texto a buscar nos itens. example: Hospedagem - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': description: Os itens que podem entrar na fatura. content: application/json: schema: type: object properties: data: type: array items: allOf: - "$ref": "#/components/schemas/bill_item" - type: object properties: bill: "$ref": "#/components/schemas/entity_reference" due_date: type: string format: date description: Vencimento da fatura em que o item está agora. pagination: "$ref": "#/components/schemas/pagination" examples: item_candidates: summary: Itens de outra fatura do mesmo fornecedor value: data: - id: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 description: Diárias de Hospedagem cost_center: checked: false amount: -400.0 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: bill: id: 212b54b8-27df-4859-80a9-79ad855bcd09 due_date: '2026-08-05' pagination: size: 20 has_next_page: false next_cursor: '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - Este lançamento não é uma fatura com itens. 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. example: errors: - Este lançamento não é uma fatura com itens. 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. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/item_reprocessing": post: operationId: reprocessBillItems summary: Remover itens da fatura ou recalcular o vencimento x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: bill_id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: *2 responses: '200': description: A fatura como ficou depois da ação, ou só o id dela para a credencial que não lê contas, com reprocessed_items. Quando todos os itens saíram e a fatura foi excluída, só reprocessed_items. content: application/json: schema: allOf: - anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" - type: object - type: object required: - reprocessed_items properties: reprocessed_items: type: array description: Onde cada item enviado ficou, um por id de item_ids. items: type: object properties: id: type: string format: uuid description: ID do item enviado. Deixa de existir quando o item foi somado a outro. bill: oneOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' description: Fatura em que o item ficou. Vem null se outra ação tirou o item de toda fatura ao mesmo tempo. item: allOf: - "$ref": "#/components/schemas/entity_reference" description: 'Item da fatura em que ele ficou: o mesmo id enviado ou, quando foi somado a um item igual, o desse item.' example: reprocessed_items: - id: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 bill: id: 9a1d6c3e-52b7-4e0f-8a3d-1f6b2c7e4d90 item: id: 0b7e2f4a-6c1d-4a9e-b3f5-8d2c1e7a6f40 '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: A fatura não aceita a ação. A mensagem diz o motivo. Nada foi alterado. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - O lançamento está excluído e não pode ser alterado. - Este lançamento não é uma fatura com itens. 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. - A fatura está liquidada. Para realizar esta operação, desfaça a liquidação antes. - A fatura está fechada. Para realizar esta operação, reabra a fatura antes. Se a fatura já foi enviada ao cliente, considere fazer as alterações na próxima fatura. - Remover itens vale na fatura de cliente lançada à mão, e Recalcular vencimento, na fatura gerada pelo Monde. Nenhum dos dois vale nesta fatura. example: errors: - Remover itens vale na fatura de cliente lançada à mão, e Recalcular vencimento, na fatura gerada pelo Monde. Nenhum dos dois vale nesta fatura. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/separate_invoice": post: operationId: separateBillItems summary: Faturar avulso os itens da fatura x-badges: - name: Beta color: "#f5803e" tags: - Contas a Pagar e Receber description: '

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

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: bill_id required: true schema: type: string format: uuid description: ID da fatura. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: required: true content: application/json: schema: type: object required: - item_ids properties: item_ids: type: array minItems: 1 items: type: string format: uuid description: IDs dos itens em que a ação age. due_date: type: string format: date description: Vencimento da fatura avulsa. Sem ele, vence hoje. example: '2026-12-10' examples: separate_items: summary: Faturar avulso um item, com vencimento hoje value: item_ids: - 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 responses: '201': description: A fatura avulsa nova, ou só o id dela para a credencial que não lê contas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: written_bill_reference: summary: Lançamento alterado, sem permissão de leitura "$ref": "#/components/examples/written_bill_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': *3 '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/account_movements": get: operationId: listAccountMovements summary: Consultar movimentações x-badges: - name: Beta color: "#f5803e" tags: - Movimentações description: 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}. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: account_id required: false schema: type: string format: uuid description: Filtra as movimentações de uma conta específica. example: f9d961b8-ea88-4346-8e52-afe94267417a - in: query name: payment_method_id required: false schema: type: string format: uuid description: Filtra as movimentações de uma forma de pagamento específica. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 - in: query name: transaction_kind required: false schema: type: string enum: - credit - debit description: |- Filtra pelo sentido do movimento. example: debit - in: query name: date_field required: false schema: type: string enum: - movement_date description: 'Campo de data usado no filtro. Valor aceito: movement_date (data da movimentação). Obrigatório quando date_from ou date_to é informado.' example: movement_date - in: query name: date_from required: false schema: type: string format: date description: Filtrar movimentações com data igual ou posterior a esta, no formato ISO 8601 (AAAA-MM-DD). example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: Filtrar movimentações com data igual ou anterior a esta, no formato ISO 8601 (AAAA-MM-DD). example: '2026-10-31' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/account_movements" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/account_movements/{id}": get: operationId: getAccountMovement summary: Consultar movimentação por ID x-badges: - name: Beta color: "#f5803e" tags: - Movimentações description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador da movimentação. example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 responses: '200': "$ref": "#/components/responses/account_movement" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/balance": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID da conta corrente ou caixa, o mesmo de [Contas e Cartões](#tag/Contas-e-Cartoes). example: f9d961b8-ea88-4346-8e52-afe94267417a get: operationId: getAccountBalance summary: Consultar saldo da conta x-badges: - name: Beta color: "#f5803e" tags: - Extrato e Caixa description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date required: false schema: type: string format: date description: 'Data do saldo (ISO 8601, `YYYY-MM-DD`). Padrão: hoje.' example: '2026-10-15' responses: '200': description: Saldo da conta content: application/json: schema: "$ref": "#/components/schemas/account_balance" examples: account_balance: "$ref": "#/components/examples/account_balance" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/statement": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID da conta corrente ou caixa, o mesmo de [Contas e Cartões](#tag/Contas-e-Cartoes). example: f9d961b8-ea88-4346-8e52-afe94267417a get: operationId: getAccountStatement summary: Consultar extrato da conta x-badges: - name: Beta color: "#f5803e" tags: - Extrato e Caixa description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_from required: true schema: type: string format: date description: Primeiro dia do extrato (ISO 8601, `YYYY-MM-DD`). Obrigatório. example: '2026-10-01' - in: query name: date_to required: true schema: type: string format: date description: Último dia do extrato (ISO 8601, `YYYY-MM-DD`). Obrigatório; o período tem no máximo 45 dias, como no Monde. example: '2026-10-15' responses: '200': description: Extrato da conta content: application/json: schema: "$ref": "#/components/schemas/account_statement" examples: account_statement: "$ref": "#/components/examples/account_statement" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/cash_closures": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID da conta corrente ou caixa, o mesmo de [Contas e Cartões](#tag/Contas-e-Cartoes). example: f9d961b8-ea88-4346-8e52-afe94267417a post: operationId: closeAccountCash summary: Fechar caixa x-badges: - name: Beta color: "#f5803e" tags: - Extrato e Caixa description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cash_closure_create" examples: close_cash: "$ref": "#/components/examples/close_cash" responses: '200': description: Caixa fechado headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: "$ref": "#/components/schemas/cash_closure" examples: cash_closure: "$ref": "#/components/examples/cash_closure" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/cash_closures/{date}": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID da conta corrente ou caixa, o mesmo de [Contas e Cartões](#tag/Contas-e-Cartoes). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: date required: true schema: type: string format: date description: Dia a reabrir (ISO 8601, `YYYY-MM-DD`). O caixa volta a ficar aberto nele e nos dias seguintes. example: '2026-10-10' delete: operationId: reopenAccountCash summary: Reabrir caixa x-badges: - name: Beta color: "#f5803e" tags: - Extrato e Caixa description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '204': description: Caixa reaberto '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/transfers": get: operationId: listTransfers summary: Listar transferências x-badges: - name: Beta color: "#f5803e" tags: - Transferências entre Contas description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" - in: query name: account_id required: false schema: type: string format: uuid description: Filtra as transferências que saem ou entram nesta conta (UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: query name: date_from required: false schema: type: string format: date description: Data inicial da transferência (ISO 8601, `YYYY-MM-DD`). example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: Data final da transferência (ISO 8601, `YYYY-MM-DD`). example: '2026-10-31' responses: '200': description: Lista de transferências content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/transfer" pagination: "$ref": "#/components/schemas/pagination" examples: transfers: "$ref": "#/components/examples/transfers" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTransfer summary: Inserir transferência x-badges: - name: Beta color: "#f5803e" tags: - Transferências entre Contas description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/transfer_create" examples: create_transfer: "$ref": "#/components/examples/create_transfer" responses: '200': description: 'Repetição de uma requisição já processada com a mesma `Idempotency-Key`: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/transfer" - "$ref": "#/components/schemas/entity_reference" examples: transfer: "$ref": "#/components/examples/transfer" '201': description: Transferência criada content: application/json: schema: anyOf: - "$ref": "#/components/schemas/transfer" - "$ref": "#/components/schemas/entity_reference" examples: transfer: "$ref": "#/components/examples/transfer" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/transfers/{id}": parameters: - in: path name: id required: true schema: type: string format: uuid description: 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. example: 857569b5-2721-4756-a27a-748168e00606 get: operationId: getTransfer summary: Consultar transferência x-badges: - name: Beta color: "#f5803e" tags: - Transferências entre Contas description: Devolve a transferência. Ela pode ser aberta pelo ID de qualquer das duas movimentações, e responde sempre pela de origem. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '200': description: Transferência encontrada content: application/json: schema: "$ref": "#/components/schemas/transfer" examples: transfer: "$ref": "#/components/examples/transfer" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTransfer summary: Alterar transferência x-badges: - name: Beta color: "#f5803e" tags: - Transferências entre Contas description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/transfer_update" examples: update_transfer: "$ref": "#/components/examples/update_transfer" responses: '200': description: Transferência alterada content: application/json: schema: anyOf: - "$ref": "#/components/schemas/transfer" - "$ref": "#/components/schemas/entity_reference" examples: transfer: "$ref": "#/components/examples/transfer" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deleteTransfer summary: Excluir transferência x-badges: - name: Beta color: "#f5803e" tags: - Transferências entre Contas description: '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](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}~1removal/post). 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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '204': description: Transferência excluída '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/transfers/{id}/removal": parameters: - in: path name: id required: true schema: type: string format: uuid description: 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. example: 857569b5-2721-4756-a27a-748168e00606 post: operationId: removeTransfer summary: Excluir transferência com confirmação x-badges: - name: Beta color: "#f5803e" tags: - Transferências entre Contas description: '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](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}/delete), 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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/transfer_exclusion" examples: delete_reconciled_transfer: "$ref": "#/components/examples/delete_reconciled_transfer" responses: '204': description: Transferência excluída headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/refunds": get: operationId: listRefunds summary: Consultar reembolsos x-badges: - name: Beta color: "#f5803e" tags: - Reembolsos description: Retorna os reembolsos das empresas em que a credencial tem permissão. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: refund_type required: false schema: type: string enum: - customer - vendor description: |- Filtra pelo lado do reembolso. example: customer - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/refunds" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/refunds/{id}": get: operationId: getRefund summary: Consultar reembolso por ID x-badges: - name: Beta color: "#f5803e" tags: - Reembolsos description: Retorna um reembolso pelo identificador. É o endpoint que resolve as referências a reembolsos devolvidas por outros recursos. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador do reembolso. example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 responses: '200': "$ref": "#/components/responses/refund" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deleteRefund summary: Excluir reembolso x-badges: - name: Beta color: "#f5803e" tags: - Reembolsos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador do reembolso. example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 responses: '204': description: Reembolso excluído com sucesso. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/refunds/{id}/removal": post: operationId: removeRefund summary: Excluir reembolso com confirmação x-badges: - name: Beta color: "#f5803e" tags: - Reembolsos description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador do reembolso. example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 requestBody: required: true content: application/json: schema: type: object properties: remove_from_bill: type: boolean description: 'Confirma a exclusão do reembolso do fornecedor que já virou conta a pagar/receber: a conta inteira é excluída, e os outros itens dela voltam a ficar pendentes, sem fatura. Obrigatório como true nesse caso; nos demais, não muda nada. Valor que não é booleano responde 422.' example: remove_from_bill: true responses: '204': description: Reembolso excluído com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma exclusão anterior. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{id}/refunds": post: operationId: createRefund summary: Lançar reembolso na venda x-badges: - name: Beta color: "#f5803e" tags: - Reembolsos description: |- 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. Em billing, invoice (Faturar) manda o reembolso para a fatura pelas regras de faturamento, em segundo plano: a do cliente sempre; a do fornecedor só com a fatura automática de fornecedor ligada, e fora dos produtos da CVC. Até lá, bill volta nulo. bill (Gerar conta a pagar/receber) gera na hora uma fatura avulsa só com o reembolso, com vencimento no dia, que volta em bill.

Como no Monde, a venda pode estar aberta ou fechada, mas não excluída (409), e o produto não pode estar excluído. O reembolso ao cliente só existe na agência: na operadora, responde 403. São recusados com 422: o reembolso com o controle de crédito ligado, o reembolso do fornecedor de operação própria e o reembolso sem a categoria padrão de reembolso configurada na empresa.

No Monde, lançar o reembolso é editar a venda, sem permissão própria: exige a permissão Editar de Vendas na empresa da venda, que não pode ser somente leitura, e, na venda que a credencial não criou, Editar vendas de outros vendedores. Na venda com recibo impresso, o reembolso ao cliente e o do fornecedor exigem também Alterar vendas com recibo impresso, porque mudam a receita da venda. A resposta traz o reembolso completo só para quem também tem a permissão de ler reembolsos nessa empresa; para os demais, só o id. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da venda do produto reembolsado. example: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63 responses: '200': description: 'Reembolso já lançado com a mesma chave de idempotência: a resposta original é devolvida.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indica que a resposta é a repetição de uma requisição já processada. content: application/json: schema: "$ref": "#/components/schemas/refund" examples: customer_refund: summary: Reembolso de cliente "$ref": "#/components/examples/customer_refund" '201': description: Reembolso lançado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/refund" examples: customer_refund: summary: Reembolso de cliente "$ref": "#/components/examples/customer_refund" vendor_refund: summary: Reembolso de fornecedor "$ref": "#/components/examples/vendor_refund" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/refund_create" examples: create_customer_refund: summary: Reembolso ao cliente para faturar "$ref": "#/components/examples/create_customer_refund" create_vendor_refund: summary: Reembolso do fornecedor com conta a pagar "$ref": "#/components/examples/create_vendor_refund" "/reports/passenger_lists": get: operationId: listPassengerList summary: Consultar lista de passageiros x-badges: - name: Beta color: "#f5803e" tags: - Relatórios description: |- 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_field required: false schema: type: string enum: - departure_date - arrival_date - sale_date - canceled_at description: 'Data que `date_from` e `date_to` filtram: `departure_date` (embarque ou início do produto), `arrival_date` (chegada ou fim do produto), `sale_date` (data da venda) ou `canceled_at` (cancelamento do passageiro). Obrigatório quando vem `date_from` ou `date_to`.' example: departure_date - in: query name: date_from required: false schema: type: string format: date description: Primeiro dia do período (ISO 8601, `YYYY-MM-DD`), inclusive. example: '2026-11-01' - in: query name: date_to required: false schema: type: string format: date description: Último dia do período (ISO 8601, `YYYY-MM-DD`), inclusive. example: '2026-11-30' - in: query name: status required: false schema: type: array items: type: string enum: - opened - closed - canceled style: form explode: false description: 'Situações da venda, separadas por vírgula: `opened`, `closed` e `canceled`. Padrão: `opened,closed`, como no Monde.' example: - opened - closed - in: query name: include_canceled required: false schema: type: boolean description: 'Com `true`, inclui os passageiros cancelados no produto. Padrão: `false`. O filtro pela data de cancelamento (`date_field=canceled_at`) já os inclui.' example: false - in: query name: person_id required: false schema: type: string format: uuid description: Só o passageiro desta pessoa. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: payer_id required: false schema: type: string format: uuid description: Só as vendas deste pagante. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: seller_id required: false schema: type: string format: uuid description: Só as vendas deste vendedor. Junto de `intermediary_id`, vêm as vendas em que a pessoa é o vendedor **ou** o intermediário, como no Monde. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: intermediary_id required: false schema: type: string format: uuid description: Só as vendas deste intermediário. Junto de `seller_id`, vêm as vendas em que a pessoa é o vendedor **ou** o intermediário, como no Monde. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: requester_id required: false schema: type: string format: uuid description: Só as vendas deste solicitante. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: approver_id required: false schema: type: string format: uuid description: Só as vendas deste aprovador. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: promoter_id required: false schema: type: string format: uuid description: Só as vendas deste promotor. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: product_id required: false schema: type: string format: uuid description: Só os produtos deste produto do cadastro, inclusive as vendas em que ele é a operação própria, como no Monde. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: supplier_id required: false schema: type: string format: uuid description: Só os produtos deste fornecedor. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: representative_id required: false schema: type: string format: uuid description: Só os produtos deste representante. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: city_id required: false schema: type: string format: uuid description: Só os passageiros que moram nesta cidade, a do cadastro da pessoa. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: company_id required: false schema: type: array items: type: string format: uuid style: form explode: false description: Só as vendas destas empresas, separadas por vírgula. example: - e5d9aaed-33bb-4679-b392-b45e5cd78eb4 - in: query name: label_id required: false schema: type: array items: type: string format: uuid style: form explode: false description: Só os passageiros com algum destes marcadores, separados por vírgula. example: - e5d9aaed-33bb-4679-b392-b45e5cd78eb4 - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/passenger_lists" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/reports/sales_by_products": get: operationId: listSalesByProduct summary: Consultar vendas por produto x-badges: - name: Beta color: "#f5803e" tags: - Relatórios description: |- 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_field required: false schema: type: string enum: - sale_date - departure_date - arrival_date - canceled_at description: 'Data que `date_from` e `date_to` filtram, como o "Data de" do Monde: `sale_date` (data da venda), `departure_date` (início do produto), `arrival_date` (fim do produto) ou `canceled_at` (cancelamento do produto). Obrigatório quando vem `date_from` ou `date_to`.' example: sale_date - in: query name: date_from required: false schema: type: string format: date description: Primeiro dia do período (ISO 8601, `YYYY-MM-DD`), inclusive. example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: Último dia do período (ISO 8601, `YYYY-MM-DD`), inclusive. example: '2026-10-31' - in: query name: status required: false schema: type: array items: type: string enum: - opened - closed - canceled style: form explode: false description: 'Situações da venda, separadas por vírgula: `opened`, `closed` e `canceled`. Padrão: `opened,closed`, como no Monde.' example: - opened - closed - in: query name: product_status required: false schema: type: array items: type: string enum: - active - canceled style: form explode: false description: 'Situações do produto, separadas por vírgula: `active` e `canceled`. Padrão: `active`, como no Monde. Com `date_field=canceled_at`, vêm as duas, qualquer que seja o valor enviado.' example: - active - in: query name: seller_id required: false schema: type: string format: uuid description: Só as vendas deste vendedor. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: product_id required: false schema: type: string format: uuid description: Só os produtos vendidos deste produto do cadastro. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: supplier_representative_id required: false schema: type: string format: uuid description: Só os produtos em que esta pessoa é o fornecedor **ou** o representante, como o filtro Fornecedor/Representante do Monde. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: own_operation_id required: false schema: type: string format: uuid description: Só as vendas desta operação própria. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: company_id required: false schema: type: array items: type: string format: uuid style: form explode: false description: Só as vendas destas empresas, separadas por vírgula. example: - e5d9aaed-33bb-4679-b392-b45e5cd78eb4 - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/sales_by_products" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/reports/sales_by_sellers": get: operationId: listSalesBySeller summary: Consultar vendas por vendedor x-badges: - name: Beta color: "#f5803e" tags: - Relatórios description: |- 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_field required: false schema: type: string enum: - sale_date description: Data que `date_from` e `date_to` filtram. O relatório tem uma só, a da venda (`sale_date`), então o parâmetro pode ser omitido. example: sale_date - in: query name: date_from required: true schema: type: string format: date description: Primeiro dia do período da venda (ISO 8601, `YYYY-MM-DD`), inclusive. Obrigatório. example: '2026-10-01' - in: query name: date_to required: true schema: type: string format: date description: Último dia do período da venda (ISO 8601, `YYYY-MM-DD`), inclusive. Obrigatório. example: '2026-10-31' - in: query name: status required: false schema: type: array items: type: string enum: - opened - closed style: form explode: false description: 'Situações da venda, separadas por vírgula: `opened` e `closed`. Padrão: as duas, como no Monde. A venda cancelada não entra no relatório.' example: - closed - in: query name: product_status required: false schema: type: array items: type: string enum: - active - canceled style: form explode: false description: 'Situações do produto, separadas por vírgula: `active` e `canceled`. Padrão: `active`, como no Monde.' example: - active - in: query name: seller_id required: false schema: type: array items: type: string format: uuid style: form explode: false description: Só estes vendedores, separados por vírgula. example: - 7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f - in: query name: company_id required: false schema: type: array items: type: string format: uuid style: form explode: false description: Só as vendas destas empresas, separadas por vírgula. example: - e5d9aaed-33bb-4679-b392-b45e5cd78eb4 - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/sales_by_sellers" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cvc_statements": get: operationId: listCvcStatements summary: Consultar extrato CVC x-badges: - name: Beta color: "#f5803e" tags: - Extrato CVC description: Retorna os recibos das empresas em que a credencial tem permissão. Recibo excluído não é retornado. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/cvc_statements" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cvc_statements/{id}": get: operationId: getCvcStatement summary: Consultar extrato CVC por ID x-badges: - name: Beta color: "#f5803e" tags: - Extrato CVC description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador do recibo do extrato CVC. example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 responses: '200': "$ref": "#/components/responses/cvc_statement" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cvc_master_statements": get: operationId: listCvcMasterStatements summary: Consultar Master - Extrato CVC x-badges: - name: Beta color: "#f5803e" tags: - Master - Extrato CVC description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': description: Lista de recibos retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/cvc_statements_response" examples: cvc_master_statements: summary: Recibos do Master - Extrato "$ref": "#/components/examples/cvc_master_statements" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cvc_master_statements/{id}": get: operationId: getCvcMasterStatement summary: Consultar recibo do Master - Extrato por ID x-badges: - name: Beta color: "#f5803e" tags: - Master - Extrato CVC description: '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](#tag/Extrato-CVC).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador do recibo do Master - Extrato. example: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84 responses: '200': description: Recibo retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/cvc_statement" examples: cvc_master_statement: summary: Recibo do Master - Extrato "$ref": "#/components/examples/cvc_master_statement" cvc_master_statement_with_nf: summary: Recibo com a nota fiscal gerada "$ref": "#/components/examples/cvc_master_statement_with_nf" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs": get: operationId: listNfs summary: Consultar notas fiscais x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: status required: false schema: type: string enum: - unissued - issued - processing - processing_cancellation - awaiting_processing - canceled - awaiting_issue - awaiting_cancellation description: |- Filtra pela situação da nota fiscal. example: issued - in: query name: period_start required: false schema: type: string format: date description: Filtra as notas fiscais emitidas a partir desta data, no formato ISO 8601 (YYYY-MM-DD). example: '2023-01-01' - in: query name: period_end required: false schema: type: string format: date description: Filtra as notas fiscais emitidas até esta data, no formato ISO 8601 (YYYY-MM-DD). example: '2023-12-31' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/nfs" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createNf summary: Inserir nota fiscal avulsa x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '201': description: Nota fiscal inserida com sucesso. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: created_nf: "$ref": "#/components/examples/created_nf" written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/nf_create" examples: create_nf: "$ref": "#/components/examples/create_nf" create_nf_for_person: "$ref": "#/components/examples/create_nf_for_person" "/nfs/{id}": get: operationId: getNf summary: Consultar nota fiscal por ID x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': "$ref": "#/components/responses/nf" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateNf summary: Editar nota fiscal avulsa x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': description: Nota fiscal alterada com sucesso. Sem a permissão de ler notas fiscais na empresa, a resposta traz só os identificadores. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: created_nf: "$ref": "#/components/examples/created_nf" written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/nf_update" examples: update_nf: "$ref": "#/components/examples/update_nf" delete: operationId: deleteNf summary: Excluir nota fiscal x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '204': description: Nota fiscal excluída com sucesso. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs/{id}/issuance": post: operationId: issueNf summary: Emitir NFS-e x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '202': description: Nota fiscal enviada para emissão. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: issuance_accepted: "$ref": "#/components/examples/issuance_accepted" written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs/{id}/cancellation": post: operationId: cancelNf summary: Cancelar nota fiscal x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': description: Nota fiscal cancelada no Monde. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '202': description: Cancelamento enviado à prefeitura pelo e-Notas. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs/{id}/manual_issuance": post: operationId: registerNfManualIssuance summary: Informar emissão manual de NFS-e x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: '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).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': description: Emissão manual registrada. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/nf_manual_issuance" examples: manual_issuance: "$ref": "#/components/examples/manual_issuance" "/nfs/{id}/amount_adjustment": post: operationId: adjustNfAmount summary: Ajustar valor da nota fiscal x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': description: Valor ajustado. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/nf_amount_adjustment" examples: amount_adjustment: "$ref": "#/components/examples/amount_adjustment" "/nfs/{id}/numbering": delete: operationId: removeNfNumbering summary: Remover numeração da nota fiscal x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '204': description: Numeração removida. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs/{id}/reissue_copy": post: operationId: copyNfForReissue summary: Criar cópia para reemissão x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '201': description: Cópia criada. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/nf" - "$ref": "#/components/schemas/nf_written_reference" examples: created_nf: "$ref": "#/components/examples/created_nf" written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs/{id}/xml": get: operationId: downloadNfXml summary: Baixar XML da NFS-e x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': description: Arquivo XML da NFS-e. content: application/xml: schema: type: string format: binary '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs/{id}/pdf": get: operationId: downloadNfPdf summary: Baixar PDF da NFS-e x-badges: - name: Beta color: "#f5803e" tags: - Notas Fiscais description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador da nota fiscal. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '302': description: Redireciona para o PDF da NFS-e no e-Notas. headers: Location: schema: type: string format: uri description: Endereço do PDF no e-Notas. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nf_generations": get: operationId: previewNfGeneration summary: Consultar as notas a gerar x-badges: - name: Beta color: "#f5803e" tags: - Gerar Notas Fiscais description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: company_identifier required: true schema: type: string description: 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. example: '11222333000181' - in: query name: date_field required: false schema: type: string enum: - sale_date - product_start description: |- A data que o período filtra. Obrigatório quando `date_from` ou `date_to` é informado. example: sale_date - in: query name: date_from required: false schema: type: string format: date description: Início do período, no formato ISO 8601 (YYYY-MM-DD). example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: Fim do período, no formato ISO 8601 (YYYY-MM-DD). example: '2026-10-31' - in: query name: supplier_representative_id required: false schema: type: string format: uuid description: Traz só os produtos em que esta pessoa é o fornecedor ou o representante. example: 0f3c1d52-7f0a-4a55-9a2e-1b6d1c2f3a4b - in: query name: include_without_revenue required: false schema: type: boolean default: false description: 'Inclui os produtos sem receita, com as notas de valor zero que as regras montam para eles. Padrão: `false`.' example: false - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/nf_generations" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createNfGeneration summary: Gerar notas fiscais x-badges: - name: Beta color: "#f5803e" tags: - Gerar Notas Fiscais description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/nf_generation_create" examples: generate_nfs: summary: Gerar a nota do pagante de um produto "$ref": "#/components/examples/generate_nfs" responses: '200': description: 'Repetição de uma geração já concluída com a mesma chave de idempotência: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma geração anterior. content: application/json: schema: "$ref": "#/components/schemas/nf_generation_created" examples: generated_nfs: summary: Nota gerada "$ref": "#/components/examples/generated_nfs" '201': "$ref": "#/components/responses/nf_generation_created" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/logs": get: operationId: listLogs summary: Consultar logs x-badges: - name: Beta color: "#f5803e" tags: - Logs description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: person_id required: false schema: type: string format: uuid description: Filtra pelo identificador do autor da alteração. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: resource_id required: false schema: type: string format: uuid description: Filtra pelo identificador do registro auditado. example: 9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118 - in: query name: kind required: false schema: type: string enum: - insertion - edition - deletion - custom - export - email description: |- Filtra pela ação registrada. example: edition - in: query name: origin required: false schema: type: string description: Filtra pela origem da alteração, com o valor exato gravado no log. Um valor por chamada. example: financeiro_categoria - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/logs" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/logs/{id}": get: operationId: getLog summary: Consultar logs por ID x-badges: - name: Beta color: "#f5803e" tags: - Logs description: Retorna uma linha do histórico pelo identificador, com as referências para o autor da alteração e para o registro auditado. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador da linha do histórico. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': "$ref": "#/components/responses/log" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/custom_fields": get: operationId: listCustomFields summary: Consultar campos personalizados x-badges: - name: Beta color: "#f5803e" tags: - Campos Personalizados description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: resource required: false schema: type: string enum: - sales - travels - people - bills - tasks description: |- Filtra pelo recurso (origem) do campo personalizado. Um valor por chamada; ausente lista todos os recursos. example: sales - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/custom_fields" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/custom_fields/{id}": get: operationId: getCustomField summary: Consultar campo personalizado por ID x-badges: - name: Beta color: "#f5803e" tags: - Campos Personalizados description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identificador do campo personalizado a consultar. example: 123 responses: '200': "$ref": "#/components/responses/custom_field" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sale_product_additional_fields": get: operationId: listSaleProductAdditionalFields summary: Consultar campos adicionais do produto x-badges: - name: Beta color: "#f5803e" tags: - Vendas description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '200': "$ref": "#/components/responses/sale_product_additional_fields" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/commission_plans": get: operationId: listCommissionPlans summary: Consultar planos de comissão x-badges: - name: Beta color: "#f5803e" tags: - Planos de Comissão description: Retorna a lista de planos de comissão, por nome. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/commission_plans" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/commission_plans/{id}": get: operationId: getCommissionPlan summary: Consultar plano de comissão por ID x-badges: - name: Beta color: "#f5803e" tags: - Planos de Comissão description: 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. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do plano de comissão example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '200': "$ref": "#/components/responses/commission_plan" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/goals": get: operationId: listGoals summary: Consultar metas x-badges: - name: Beta color: "#f5803e" tags: - Metas description: Retorna as metas, do ano mais recente para o mais antigo, com filtros opcionais por ano, função e pessoa. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: year required: false schema: type: integer description: Ano da meta, com quatro dígitos example: 2026 - in: query name: person_role_id required: false schema: type: string format: uuid description: Identificador da função example: f453b283-750d-4c5d-a493-a6bf8064090e - in: query name: person_id required: false schema: type: string format: uuid description: Identificador da pessoa example: 3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7 - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/goals" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/goals/{id}": get: operationId: getGoal summary: Consultar meta por ID x-badges: - name: Beta color: "#f5803e" tags: - Metas description: Retorna uma meta específica pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único da meta example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '200': "$ref": "#/components/responses/goal" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bank_reconciliations": get: operationId: listBankReconciliations summary: Consultar extratos enviados x-badges: - name: Beta color: "#f5803e" tags: - Conciliação Bancária description: 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`. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: account_id required: false schema: type: string format: uuid description: Só os extratos desta conta corrente (UUID). - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': description: Lista de extratos retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliations_response" examples: list: summary: Extratos enviados "$ref": "#/components/examples/bank_reconciliation_list" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: uploadBankStatement summary: Enviar extrato x-badges: - name: Beta color: "#f5803e" tags: - Conciliação Bancária description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_multipart" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: multipart/form-data: schema: "$ref": "#/components/schemas/bank_statement_upload" responses: '200': description: 'Repetição de uma requisição já concluída com a mesma Idempotency-Key: a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição da original. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliation" examples: detail: summary: Extrato com o resumo "$ref": "#/components/examples/bank_reconciliation_detail" '201': description: Extrato importado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliation" examples: detail: summary: Extrato com o resumo "$ref": "#/components/examples/bank_reconciliation_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bank_reconciliations/{id}": get: operationId: getBankReconciliation summary: Consultar extrato por ID x-badges: - name: Beta color: "#f5803e" tags: - Conciliação Bancária description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador (UUID) do extrato enviado. example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 responses: '200': description: Extrato retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliation" examples: detail: summary: Extrato com o resumo "$ref": "#/components/examples/bank_reconciliation_detail" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: discardBankStatement summary: Descartar extrato x-badges: - name: Beta color: "#f5803e" tags: - Conciliação Bancária description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador (UUID) do extrato enviado. example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 responses: '204': description: Extrato descartado com sucesso. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/category_groups": get: operationId: listCategoryGroups summary: Consultar grupos de categorias x-badges: - name: Beta color: "#f5803e" tags: - Grupos de Categorias description: Retorna os grupos de categorias, os de despesa antes dos de receita, em ordem de nome. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/category_groups" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCategoryGroup summary: Inserir grupo de categorias x-badges: - name: Beta color: "#f5803e" tags: - Grupos de Categorias description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já processada com a mesma chave de idempotência: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: "$ref": "#/components/schemas/category_group_detail" examples: category_group_detail: summary: Grupo de despesa "$ref": "#/components/examples/category_group_detail" '201': description: Grupo cadastrado. content: application/json: schema: "$ref": "#/components/schemas/category_group_detail" examples: category_group_detail: summary: Grupo de despesa "$ref": "#/components/examples/category_group_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_group_detail_create" examples: create_category_group_detail: summary: Novo grupo "$ref": "#/components/examples/create_category_group_detail" "/category_groups/{id}": get: operationId: getCategoryGroup summary: Consultar grupo de categorias por ID x-badges: - name: Beta color: "#f5803e" tags: - Grupos de Categorias description: Retorna um grupo de categorias pelo seu identificador. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do grupo example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 responses: '200': "$ref": "#/components/responses/category_group_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCategoryGroup summary: Alterar grupo de categorias x-badges: - name: Beta color: "#f5803e" tags: - Grupos de Categorias description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do grupo example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 responses: '200': description: Grupo alterado. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/category_group_detail" - "$ref": "#/components/schemas/entity_reference" examples: category_group_detail: summary: Grupo de despesa "$ref": "#/components/examples/category_group_detail" written_category_group_detail_reference: summary: Só o id "$ref": "#/components/examples/written_category_group_detail_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_group_detail_update" examples: update_category_group_detail: summary: Renomear grupo "$ref": "#/components/examples/update_category_group_detail" delete: operationId: deleteCategoryGroup summary: Excluir grupo de categorias x-badges: - name: Beta color: "#f5803e" tags: - Grupos de Categorias description: '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](#tag/Grupos-de-Categorias/paths/~1category_groups~1{id}~1removal/post). Exige a permissão **Excluir** de Categorias numa empresa ativa que não seja somente leitura. Não exige `Idempotency-Key`: repetir responde 404.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do grupo example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 responses: '204': description: Grupo excluído. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/category_groups/{id}/removal": post: operationId: removeCategoryGroup summary: Excluir grupo de categorias com confirmação x-badges: - name: Beta color: "#f5803e" tags: - Grupos de Categorias description: '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](#tag/Grupos-de-Categorias/paths/~1category_groups~1{id}/delete), 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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Identificador único do grupo example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_group_exclusion" examples: delete_category_group_with_categories: "$ref": "#/components/examples/delete_category_group_with_categories" responses: '204': description: Grupo excluído. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente com o valor `true` quando a resposta é a repetição de uma requisição já processada. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/webhooks": get: operationId: listWebhooks summary: Listar webhooks x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: Lista os webhooks da credencial autenticada, do mais recente para o mais antigo. O segredo nunca é devolvido. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/webhooks" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createWebhook summary: Criar webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repetição de uma requisição já concluída com a mesma `Idempotency-Key`: devolve a resposta original.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma requisição já concluída. content: application/json: schema: "$ref": "#/components/schemas/webhook_created" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' secret: aZ3kP9qX7mL2nB8vC4tY6wR1sD5fG0hJ7kL9mN3pQ2rS8tU4 '201': description: Webhook criado. O campo `secret` vem só quando a API gerou o segredo. content: application/json: schema: "$ref": "#/components/schemas/webhook_created" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' secret: aZ3kP9qX7mL2nB8vC4tY6wR1sD5fG0hJ7kL9mN3pQ2rS8tU4 '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook_write" example: url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed "/webhooks/{id}": get: operationId: getWebhook summary: Consultar webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: Devolve um webhook da credencial autenticada. O webhook de outra credencial responde 404. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: ID do webhook. responses: '200': description: Webhook. content: application/json: schema: "$ref": "#/components/schemas/webhook" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateWebhook summary: Alterar webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: '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`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: ID do webhook. responses: '200': description: Webhook alterado. A quem grava sem a permissão de ler webhooks, a resposta traz só o `id`. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Presente quando a resposta é a repetição de uma requisição já concluída. content: application/json: schema: "$ref": "#/components/schemas/webhook" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook_write" example: url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed delete: operationId: deleteWebhook summary: Excluir webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: Exclui o webhook e o histórico das entregas dele. As entregas ainda pendentes não são feitas. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: ID do webhook. responses: '204': description: Webhook excluído. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/webhooks/{webhook_id}/deliveries": get: operationId: listWebhookDeliveries summary: Listar entregas do webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: '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.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" - in: path name: webhook_id required: true schema: type: string format: uuid description: ID do webhook. responses: '200': "$ref": "#/components/responses/webhook_deliveries" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/webhook_events": get: operationId: listWebhookEvents summary: Listar eventos de webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: 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). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '200': "$ref": "#/components/responses/webhook_events" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" tags: - name: Disponibilidade dos endpoints description: " Cada endpoint tem uma etiqueta que indica se você já pode utilizá-lo: " - name: Autenticação description: " Para acessar os endpoints, é necessário enviar uma credencial válida no cabeçalho Authorization da requisição, com o esquema Bearer.

Exemplo de cabeçalho de autenticação:
Authorization: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

Sobre a autenticação:

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

Como usar

Comportamento

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

Limite

Quando o limite é excedido

Recomendação

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

Percorrer a consulta inteira

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

Tamanho da página

O cursor

" - name: Anexos description: Operações de envio, download e exclusão de anexos associados a recursos. - name: Vendas description: '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).

' - name: Produtos description: '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.' - name: Cabines description: Consulte e mantenha os tipos de cabine cadastrados no sistema para utilizar em produtos de cruzeiro. - name: Navios description: Consulte e mantenha os navios cadastrados no sistema para utilizar em produtos de cruzeiro. - name: Pacotes description: Consulte e mantenha os pacotes turísticos usados nos produtos de pacote turístico das vendas. - name: Centros de Custo description: Consulte e mantenha os centros de custo cadastrados no sistema para utilizar em lançamentos financeiros. - name: Moedas description: Consulte e mantenha as moedas cadastradas no sistema e as cotações delas, para utilizar em produtos de venda e lançamentos financeiros. - name: Categorias description: Consulte e mantenha as categorias financeiras cadastradas no sistema, agrupadas por tipo (receita ou despesa) e grupo. - name: Grupos de Categorias description: '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.' - name: Cidades description: 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`. - name: Funções description: '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](#tag/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".' - name: Vendedores description: '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.' - name: Formas de Pagamento description: Consulte e mantenha as formas de pagamento cadastradas no sistema para utilizar em lançamentos financeiros. - name: Contas e Cartões description: '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.' - name: Bancos description: '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.' - name: Regras da Nota Fiscal description: '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.' - name: Tarefas description: 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). - name: Categorias de Tarefas description: '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.' - name: Viagens description: 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). - name: Orçamentos description: Consulte, crie, altere, duplique e exclua os orçamentos cadastrados no sistema, com validade, situação e o link público de visualização. - name: Guias description: '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.' - name: Regras de Faturamento description: 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. - name: Integrações description: '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.' - name: Pessoas description: Consulte as pessoas cadastradas no sistema, com dados de contato, documentos e informações adicionais. - name: Marcadores description: '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.' - name: Empresas description: '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`.' - name: Contas a Pagar e Receber description: '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).' - name: Movimentações description: '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.' - name: Extrato e Caixa description: '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](#tag/Contas-e-Cartoes), 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.' - name: Transferências entre Contas description: '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](#tag/Movimentacoes) e no [extrato](#tag/Extrato-e-Caixa). 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](#tag/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.' - name: Reembolsos description: '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.' - name: Relatórios description: '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.' - name: Extrato CVC description: '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.' - name: Master - Extrato CVC description: '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](#tag/Extrato-CVC).' - name: Notas Fiscais description: '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.' - name: Gerar Notas Fiscais description: '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](#tag/Gerar-Notas-Fiscais/paths/~1nf_generations/get) 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](#tag/Gerar-Notas-Fiscais/paths/~1nf_generations/post) 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](#tag/Notas-Fiscais/paths/~1nfs/get). O recurso não existe em instalações de operadora.' - name: Logs description: '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.' - name: Campos Personalizados description: '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.' - name: Planos de Comissão description: '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.' - name: Metas description: '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](#tag/Funcoes/paths/~1person_roles~1{id}/patch), 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.' - name: Conciliação Bancária description: '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.' - name: Webhooks description: | 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ó. ```json { "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](#tag/Webhooks/paths/~1webhook_events/get): `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](#tag/Logs/paths/~1logs~1{id}/get) 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=`: o HMAC-SHA256 de `"."` 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](#tag/Webhooks/paths/~1webhooks~1{webhook_id}~1deliveries/get). **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. - name: Perguntas frequentes description: | As dúvidas que mais chegam sobre a API v3, com a resposta curta e o link para a seção que detalha o assunto. # Acesso e credenciais ## Qual a diferença entre a API v2 e a API v3? A v2 continua funcionando, mas é legada e não recebe mais atualizações: toda integração deve usar a v3, que é a desta documentação. A v3 autentica com a credencial gerada pela agência; a v2 usa login e senha de um usuário do Monde e tem documentação própria. ## Como acesso a API? O token expira? Envie a credencial no cabeçalho `Authorization` com o esquema `Bearer`, como mostra a seção [Autenticação](#tag/Autenticacao). A credencial não expira, mas a agência pode revogá-la a qualquer momento. ## Onde a agência gera a credencial? No Monde, em **Cadastros > Integrações**, na integração **API Monde**. É ali que a agência escolhe as permissões da credencial, por empresa e por recurso, e de lá repassa a credencial a quem vai integrar. ## Dá para ter um acesso só de leitura? Sim. Ao gerar a credencial, a agência concede só as permissões de leitura dos recursos que quiser liberar. As gravações respondem `403`. ## Uma credencial atende várias empresas ou lojas? Sim. Uma credencial acessa todas as empresas da agência que receberam permissão nela. Toda empresa com licença ativa do Monde pode ser usada pela API, sem licença à parte. A empresa somente leitura só é consultada: as gravações nela respondem `403` com "A empresa está somente leitura: os registros dela podem ser consultados pela API, mas não gravados.". ## A credencial vê e altera os registros de outros usuários? Como no Monde, cada permissão vale para o que a própria credencial criou, e as permissões "de outros" estendem o alcance aos demais: em vendas, **Consultar**, **Abrir** e **Editar vendas de outros vendedores**; em contas a pagar e receber, **Acessar lançamentos de todos os usuários e do sistema** ou um dos recortes (faturas de clientes, de fornecedores, de cartão, lançamentos com operação própria e com venda); em tarefas, **Ver tarefas de outros usuários**. A viagem é da credencial quando ela a cadastrou ou criou uma venda dela, e as demais seguem **Consultar vendas de outros vendedores**. Listar e consultar pedem a permissão "Visualizar" do recurso também no que a própria credencial criou, como no Monde, em que sem ela não se abre o cadastro; a resposta da alteração sem essa permissão traz só os identificadores, e a da criação traz o registro criado inteiro. O registro de outro usuário fora do alcance responde `404`; o que ela lê mas não pode alterar responde `403` com a mensagem do Monde. A credencial gerada antes dessas permissões continua alcançando todos os registros, como antes. ## Recebi o erro 403. O que falta? Falta a permissão daquele recurso na credencial, a empresa não tem licença ativa do Monde ou está somente leitura numa gravação, ou o recurso exige a licença Monde Pro, como os [Guias](#tag/Guias). A mensagem da resposta diz qual é a causa. Quando é permissão, não é preciso gerar uma nova credencial: basta a agência marcar a permissão na credencial existente. ## Sou um sistema parceiro que atende várias agências. Como me conecto? Pela [Conexão automática](#tag/Conexao-automatica). A agência autoriza o parceiro no próprio Monde, sem compartilhar uma credencial, e as permissões são as definidas na aprovação do parceiro. # Uso e limites ## Existe ambiente de testes (sandbox)? Por enquanto, não: a API atende a base de produção da agência. Durante o desenvolvimento, comece pelas consultas, com uma credencial só de leitura, e use a [idempotência](#tag/Idempotencia) nas gravações para não duplicar registros ao repetir uma requisição. ## Qual o limite de requisições? Tem cota diária? O limite é por janela curta de tempo, contado por IP, e não existe cota diária ou mensal. Os valores e o que fazer ao receber `429` estão em [Limites de requisição](#tag/Limites-de-requisicao). ## Como funciona a paginação? Por cursor, com até 50 registros por página. Repita a consulta enviando o `next_cursor` da resposta anterior enquanto `has_next_page` for `true`. Veja [Paginação](#tag/Paginacao). ## Os dados são em tempo real? Sim. A API lê e grava a mesma base que a agência usa no Monde, sem cópia nem atraso de sincronização. ## A API avisa quando algo muda (webhooks)? Sim, na credencial criada pela própria agência: cadastre um endereço https em [Webhooks](#tag/Webhooks) e receba um `POST` assinado quando registros mudam. A permissão **Webhooks** não é oferecida na [Conexão automática](#tag/Conexao-automatica): ali a integração consulta a API periodicamente. Em vendas, o filtro `updated_since` traz só o que mudou desde a última consulta, inclusive quando a mudança foi numa parte da venda, como um produto, passageiro ou pagamento. ## Como sou avisado das mudanças na API? Pelo [Changelog](#tag/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](#tag/Disponibilidade-dos-endpoints). ## Posso usar a API com Power BI, planilhas ou agentes de IA? Sim. Qualquer ferramenta que faça requisições HTTP com o cabeçalho de autenticação consegue consumir a API. Para o agente de IA que gera código, a documentação também está disponível em texto em `https://web.monde.com.br/llms.txt`. # Consulta de vendas ## Como filtro as vendas por período? Em [Consultar vendas](#tag/Vendas/paths/~1sales/get), escolha a data em `date_field` (data da venda, de embarque ou de retorno) e informe o intervalo em `date_from` e `date_to`. ## Como busco só o que mudou desde a última consulta? Use `updated_since` em [Consultar vendas](#tag/Vendas/paths/~1sales/get), 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](#tag/Vendas/paths/~1sales~1{id}/get), como produtos, passageiros, pagamentos e contas vinculadas. A lista completa está na descrição do filtro. Guarde o instante em que a consulta começou, antes da primeira página, e na consulta seguinte parta dele com uma folga de alguns minutos para trás. Regrave cada venda pelo id, e envie `status=opened,closed,canceled` para receber também as exclusões. Hoje esse filtro existe só em vendas. ## Como filtro as vendas de um cliente ou de um vendedor? Use `people_id` com o ID da pessoa, que pode ser buscado em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). 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](#tag/Vendas/paths/~1sales~1{id}/get). ## Por que a lista não traz os produtos da venda? A [consulta de vendas](#tag/Vendas/paths/~1sales/get) 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](#tag/Vendas/paths/~1sales~1{id}/get). ## Por que as vendas excluídas não aparecem? Por padrão, a consulta traz só as vendas abertas e fechadas. Para as excluídas, envie `status=canceled`. ## A venda traz só o ID do fornecedor. Como pego o nome? Fornecedores, representantes, pagantes e passageiros são cadastros de pessoa. Consulte-os em [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) e guarde o resultado para não repetir a mesma consulta a cada venda. ## Existem campos de faturamento, markup ou rentabilidade? Não com esses nomes. A venda traz o valor de cada produto, as taxas, as comissões e o over, a receita e os totais, e cada integração monta os indicadores dela a partir desses valores. ## A API tem relatórios prontos, como vendas por vendedor ou por produto? Não. A API entrega os registros, e o relatório é montado do lado de quem integra, a partir das vendas consultadas. ## Como leio o financeiro (contas a pagar e receber)? Em [Contas a Pagar e Receber](#tag/Contas-a-Pagar-e-Receber), [Movimentações](#tag/Movimentacoes), [Reembolsos](#tag/Reembolsos) e [Notas Fiscais](#tag/Notas-Fiscais). A venda também traz, no detalhe, as contas que gerou. # Gravação ## Dá para criar vendas pela API? Sim, em [Inserir venda](#tag/Vendas/paths/~1sales/post), uma venda por requisição. Os produtos aceitos e os campos obrigatórios estão na descrição da operação. ## Dá para enviar ou alterar várias vendas numa requisição só? Não. Cada requisição grava uma venda. Para volume, envie uma após a outra, respeitando os [limites de requisição](#tag/Limites-de-requisicao). ## Como evito venda duplicada ao repetir uma requisição? Envie o cabeçalho `Idempotency-Key`, obrigatório em [Inserir venda](#tag/Vendas/paths/~1sales/post). 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](#tag/Idempotencia). ## Como evito cadastrar o mesmo fornecedor ou cliente duas vezes? Na venda, cada pessoa é procurada pelo `external_id` que a sua integração enviou antes e, sem esse vínculo, pelo CPF ou CNPJ. Só quando nenhum dos dois encontra a pessoa é que ela é cadastrada. Envie sempre o CPF ou o CNPJ para reaproveitar o cadastro que já existe no Monde. ## O que mais dá para gravar além de vendas? Pessoas, tarefas, anexos e contas a pagar e receber. A etiqueta de cada operação diz se ela já está disponível, e o [Changelog](#tag/Changelog) registra cada nova operação. ## Dá para criar viagens pela API? Sim. Em [Viagens](#tag/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. - name: Changelog description: | A API v3 está em fase **beta**: já disponível para uso, mas ainda em fase de testes e ajustes — campos e endpoints podem sofrer alterações. Acompanhe esta seção para as mudanças. ## 2026-11-15 ### Orçamentos e guias: três colunas - O `details` dos [guias](#tag/Guias) e dos [orçamentos](#tag/Orcamentos) passa a aceitar as colunas com dois ou três `
`. Antes, só com dois. ## 2026-11-13 ### Orçamentos e guias: miniaturas no carrossel - O `details` dos [guias](#tag/Guias) e dos [orçamentos](#tag/Orcamentos) passa a aceitar `data-carousel="thumbnails"` no parágrafo das imagens do carrossel, que mostra miniaturas embaixo, no lugar das bolinhas. Outro valor, ou o atributo em outra tag, é descartado. - As imagens seguidas no mesmo parágrafo formam o carrossel mesmo com espaço (` `) entre elas. ## 2026-11-12 ### Orçamentos: capa e campos opcionais - Os [orçamentos](#tag/Orcamentos) passam a devolver a capa do link público: `cover_kind` (`color`, `image` ou `none`), `cover_color`, `cover_show_title`, `cover_show_subtitle` e `cover_image_url`. - [Criar orçamento](#tag/Orcamentos/paths/~1quotes/post) e [Alterar orçamento](#tag/Orcamentos/paths/~1quotes~1{id}/patch) aceitam `cover_kind`, `cover_color`, `cover_show_title` e `cover_show_subtitle`. A imagem da capa só se escolhe pelo Monde Web. Sem a capa, o orçamento novo nasce com a capa `color`, na cor principal das Configurações de Orçamentos da empresa. - `subtitle` e `details` deixam de ser obrigatórios: na criação podem ser omitidos, e na alteração o nulo os deixa em branco. ### Vendas: vendedor inativo - Em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), o `seller` que é um vendedor inativo no Monde passa a ser recusado com 422, como no Monde, em vez de responder 500. A credencial sem a permissão de editar Vendedores continua recebendo 403, como para o vendedor ainda não cadastrado. Na alteração, o vendedor que a venda já tem continua aceito, mesmo inativo. ### Guias: capa nova e conteúdo opcional - A capa dos [guias](#tag/Guias) passa a ser `color`, `image` ou `none`, como a dos orçamentos, e os guias devolvem também `cover_show_title`, `cover_show_subtitle` e `cover_image_url`. Os guias que tinham a capa `default` passaram para `color`, no tom `#5f6777`. - [Criar guia](#tag/Guias/paths/~1guides/post) e [Alterar guia](#tag/Guias/paths/~1guides~1{id}/patch) aceitam `cover_show_title` e `cover_show_subtitle`. O `hide_cover_text` continua aceito e vale pelos dois, e a capa `default` continua aceita e vale como `color` no tom `#5f6777`. Sem a capa, o guia novo nasce com a capa `color` nesse tom. - `details` deixa de ser obrigatório: na criação pode ser omitido, e na alteração o nulo o deixa em branco. ## 2026-11-11 ### Orçamentos: blocos no conteúdo - O `details` dos [orçamentos](#tag/Orcamentos) passa a aceitar os três blocos dos guias: caixa de destaque, seção com imagem de fundo e duas colunas, como `
`. Antes eles viravam texto comum. ## 2026-11-10 ### Guias: imagem na caixa de destaque e na seção com imagem de fundo - No `details` dos [guias](#tag/Guias), a caixa de destaque passa a ser só de texto: a imagem vai para um parágrafo logo depois dela, e a tabela, a citação, o código e a linha divisória vão para depois dela. A seção com imagem de fundo fica só com a primeira imagem, e as outras são descartadas. ### Logs: envio de e-mail com ação própria - O `kind` de [Consultar logs](#tag/Logs/paths/~1logs/get) e de [Consultar logs por ID](#tag/Logs/paths/~1logs~1{id}/get) 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](#tag/Logs/paths/~1logs/get) passa a aceitar `email`. - **Atenção, mudança no contrato:** essas linhas vinham com o `kind` em texto livre, fora do conjunto documentado (`Enviado por e-mail`). Quem lia esse valor passa a receber `email`. ### Faturas: o item que é somado a outro e o destino do item removido - **Atenção, mudança no contrato:** [Remover itens da fatura ou recalcular o vencimento](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1item_reprocessing/post) passa a trazer `reprocessed_items`: para cada item enviado, a fatura em que ele ficou (`bill`) e o item nela (`item`), que é outro quando a fatura de destino já tinha um item igual e os dois foram somados. Quando todos os itens saem e a fatura é excluída, a resposta deixa de ser `204` sem corpo e passa a ser `200` só com `reprocessed_items`. - A documentação das ações sobre os itens da fatura passa a dizer o que acontece com o `id` do item que é somado a outro igual, em [Alterar conferido ou centro de custo de item da fatura](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1items~1{id}/patch): ele deixa de existir, e os `id` que valem são os de `items` da resposta. Nada muda no comportamento dessas ações. - **Atenção, mudança no contrato:** quando a ação tira o último item e a fatura é excluída, o reenvio com a mesma `Idempotency-Key` passa a repetir a resposta original, com `X-Idempotent-Replay: true`, em vez de `404`. Vale para [Remover itens da fatura ou recalcular o vencimento](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1item_reprocessing/post) e para [Faturar avulso os itens da fatura](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1separate_invoice/post). Uma chave nova na fatura excluída continua respondendo `404`. ## 2026-11-09 ### Vendas: Devolução Conta a Pagar nos pagamentos - Novo campo `overpayment_return` no Outros da agência (`payments[].agency.others`), em [Inserir venda](#tag/Vendas/paths/~1sales/post) e na inclusão de pagamento por [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch): com `true`, o pagamento é a Devolução › Gerar Conta a Pagar do Monde, que devolve ao cliente o que ele pagou a mais. Só é aceita com algum produto de saldo do cliente negativo antes dela. O `amount` de cada produto vai com o sinal do saldo do cliente nele (negativo no de saldo negativo, positivo nos outros), e o sinal que não bate é recusado com 422. Grava um lançamento em aberto, de débito quando a soma é negativa, com as categorias de pagamento e de recebimento do cliente. Não aceita `description` nem `details`. Vale também na operadora. Pede a mesma permissão de editar vendas. ### Exclusões com confirmação passam a ser POST de ação - Novos endpoints para excluir com confirmação: [Excluir conta a pagar ou receber com confirmação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1removal/post) (`recurrence_scope`, `remove_settlement`, `undo_bank_reconciliation`), [Desfazer a liquidação com confirmação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement~1removal/post) (`recurrence_scope`, `undo_bank_reconciliation`), [Excluir reembolso com confirmação](#tag/Reembolsos/paths/~1refunds~1{id}~1removal/post) (`remove_from_bill`), [Excluir transferência com confirmação](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}~1removal/post) (`undo_bank_reconciliation`) e [Excluir grupo de categorias com confirmação](#tag/Grupos-de-Categorias/paths/~1category_groups~1{id}~1removal/post) (`delete_categories`). - Cada um tem as mesmas regras, permissões e respostas do DELETE correspondente: `204` sem corpo no sucesso, `409` sem a confirmação, `422` com a confirmação fora do formato. Todos exigem `Idempotency-Key`. - **Atenção, mudança no contrato:** os DELETE de [conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/delete), da [liquidação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete), de [reembolso](#tag/Reembolsos/paths/~1refunds~1{id}/delete), de [transferência](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}/delete) e de [grupo de categorias](#tag/Grupos-de-Categorias/paths/~1category_groups~1{id}/delete) deixam de ler o corpo: a confirmação só vale no POST. Quem mandava a confirmação no corpo do DELETE passa a receber `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. - Por quê: o HTTP (RFC 9110) não dá significado ao corpo do DELETE, e proxies e clientes HTTP podem descartá-lo no caminho. Assim, a confirmação podia se perder sem aviso. ## 2026-11-06 ### Vendas: Faturar e Devolução Faturar como ações da venda - Novo endpoint [Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice/post), o Faturar da aba Financeiro da venda no Monde: o pagante (`payer_id`, ou o da venda), o centro de custo e o valor de cada produto, com o sinal do saldo do cliente dele. Responde `202`: os itens a faturar ficam gravados, e a fatura automática os leva à fatura de cliente logo depois. - Novo endpoint [Devolução Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice_returns/post), o Devolução › Faturar do Monde: o valor que a agência devolve ao cliente pela fatura de cliente, com descrição. Só é aceita quando algum produto tem saldo do cliente negativo. - Novo endpoint [Remover linha do Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice~1removal/post), o Excluir da grade de pagamentos do Monde: remove a linha inteira da fatura de cliente, e o saldo do cliente volta. A venda fechada só com `reopen_sale` e a permissão "Reabrir venda"; a fatura liquidada só com `remove_settlement`; a fatura fechada, reaberta antes. - Os três pedem a permissão de editar vendas na empresa da venda, e na venda com recibo impresso também "Alterar vendas com recibo impresso". - **Atenção, mudança no contrato:** `payments[].agency.to_invoice` sai da [criação](#tag/Vendas/paths/~1sales/post) e da [alteração](#tag/Vendas/paths/~1sales~1{id}/patch) da venda e passa a ser ignorado, como campo desconhecido. Na alteração, a lista `payments` não mantém nem remove o Faturar e a Devolução Faturar: eles só mudam pelos endpoints acima. - **Atenção, mudança no contrato:** `payments.agency.to_invoice` da [consulta da venda](#tag/Vendas/paths/~1sales~1{id}/get) é só leitura e muda de forma. Cada item é uma linha do Faturar que já entrou numa fatura de cliente, por fatura e centro de custo: `bill`, `cost_center`, `amount` (com o sinal; negativo é Devolução Faturar) e `products` (`sale_product` e `amount`). Saem `id`, `due_date`, `description`, `payer`, `bills` e o `id` dos produtos: o pagante e o vencimento são os da fatura. O Faturar que ainda não entrou em fatura não aparece. A Devolução Faturar, antes só referenciada pela fatura em `payments.agency.bills`, passa a aparecer na linha. ## 2026-11-05 ### Vendas: produto Visto - Novo produto **Visto** (`visas[]`) em [Inserir venda](#tag/Vendas/paths/~1sales/post), [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) e [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get). É um produto do sistema, como a Excursão: não é preciso informar o produto, e ele passa a valer na primeira venda. Campos próprios: `visa_type` (tipo do visto, obrigatório, até 50 caracteres, como "Turismo") e `destination_country` (país do visto, obrigatório, código ISO 3166-1 alpha-2, como "US"; código fora do cadastro de países é recusado com 422). - Não há campo próprio para a taxa consular nem para a taxa de serviço: a taxa consular de cada solicitante vai em `passengers[].fees`, e a taxa de serviço da agência em `agency_service_fee` do produto. - O filtro `kind` de [Consultar vendas](#tag/Vendas/paths/~1sales/get) e de [Produtos](#tag/Produtos/paths/~1products/get) passa a aceitar `visa`, e o `kind` dos produtos passa a trazer `visa`. ### Faturas: composição dos itens e movimentações por período - Os itens da fatura, em [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) e nos itens que podem entrar na fatura, passam a trazer o lado do item (`side`: `customer` ou `vendor`), o tipo (`kind`), o documento do produto da venda (`document`), a emissão (`issue_date`) e a pessoa (`person`). Com eles, o pagamento de uma fatura de fornecedor se abre em cada venda: o que foi pago ao fornecedor e o que foi recebido do cliente. - [Consultar movimentações](#tag/Movimentacoes/paths/~1account_movements/get) passa a filtrar pela data da movimentação, com `date_field=movement_date` e `date_from`/`date_to`. ### Faturas: consulta dos itens de todas as faturas - Novo endpoint [Consultar itens das faturas](#tag/Contas-a-Pagar-e-Receber/paths/~1bill_items/get): os itens das faturas e das contas a pagar e receber numa listagem só, cada um com o lançamento, a liquidação dele e a venda. Filtra por lançamento (`bill_id`), conta, pessoa, lado (`side`) e período (`date_field` = `settlement_date`, `due_date` ou `issue_date`). Com ele, a composição dos pagamentos do mês sai numa consulta, sem uma chamada por fatura. Pede a permissão "Visualizar" de contas a pagar e receber, já concedida a quem lê os lançamentos. ### Contas a Pagar e Receber: rateio da fatura de cartão - [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch) passa a aceitar `apportionments` na fatura de cartão (`credit_card_invoice`), como a aba Rateios do Monde. O rateio divide o valor final da fatura, que é a soma das compras do cartão. As categorias continuam recusadas. - A fatura de cartão com rateio gravado no Monde deixa de ser recusada com rateio inválido ao ser alterada. Quando o valor da fatura muda depois do rateio, porque uma compra entrou ou saiu, a alteração seguinte responde 422 até o rateio ser reenviado, como no Monde. ### Relatórios: Vendas por Vendedor - Novo endpoint [Consultar vendas por vendedor](#tag/Relatorios/paths/~1reports~1sales_by_sellers/get), o relatório Vendas por Vendedor do Monde: uma linha por vendedor e empresa, com a quantidade de vendas e de produtos, os valores somados, a comissão, o over e as receitas. Pede o período da venda (`date_from` e `date_to`) e filtra também por situação da venda e do produto, vendedor e empresa. - Novas permissões da credencial, as do Monde, no recurso Vendas por Vendedor: "Vendas por Vendedor" (`sales_by_sellers.read_all`) e "Consultar vendas de outros vendedores/intermediários" (`sales_by_sellers.read_from_other_sellers`), desmarcadas nas credenciais que já existem. ## 2026-11-04 ### Limites de requisição: IPv6 contado por rede /64 - Em IPv6, o [limite de requisições](#tag/Limites-de-requisicao) passa a ser contado por rede `/64`, e não por endereço: todos os endereços da mesma rede `/64` somam no mesmo limite. Em IPv4 nada muda. ### Contas a Pagar e Receber: bloqueio de acréscimo e desconto na diferença - Na [liquidação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post) e em [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) já liquidada, a diferença enviada com `balance_resolution: category` passa pelo bloqueio de acréscimo e desconto da empresa, como no Monde. Acima do limite, o pedido é recusado com 422. ### Relatórios: Vendas por Produto - Novo endpoint [Consultar vendas por produto](#tag/Relatorios/paths/~1reports~1sales_by_products/get), o relatório Vendas por Produto do Monde: uma linha por produto vendido, com as pessoas da venda, os detalhes, os valores e a comissão do produto, os passageiros, as notas fiscais, os trechos aéreos e os campos personalizados. Filtra por data, situação da venda e do produto, vendedor, produto, fornecedor ou representante, operação própria e empresa. - Novas permissões da credencial, as do Monde, no recurso Vendas por Produto: "Vendas por Produto" (`sales_by_products.read_all`), "Consultar vendas de outros vendedores/intermediários" (`sales_by_products.read_from_other_sellers`) e "Visualizar comissão, over e receitas" (`sales_by_products.view_commission_columns`), desmarcadas nas credenciais que já existem. - Os relatórios passam a ficar juntos, na seção [Relatórios](#tag/Relatorios). A Lista de Passageiros saiu da seção própria e entrou nela; o endpoint não mudou. ### Relatórios e Gerar Notas Fiscais: sem o filtro de texto livre - **Mudança no contrato:** [Consultar lista de passageiros](#tag/Relatorios/paths/~1reports~1passenger_lists/get) e [Consultar as notas a gerar](#tag/Gerar-Notas-Fiscais/paths/~1nf_generations/get) deixaram de aceitar o `search`. O parâmetro é ignorado e a lista vem sem ele; para restringir a lista, use os demais filtros de cada um. ### Conciliação bancária: confirmação só quando a alteração a desfaz - Em [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch) e [Alterar transferência](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}/patch), `undo_bank_reconciliation` passa a ser exigido só quando a alteração muda o valor, a data ou a conta de uma movimentação conciliada, como o aviso do Monde. A alteração que não mexe nas movimentações conciliadas (categorias, rateios, descrição e demais dados) é gravada sem a confirmação e mantém a conciliação. Quem já envia a confirmação continua gravando como antes. ### Vendas - **Mudança no contrato:** em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), o `external_id` deixou de ser aceito nos produtos da venda e nos `products[]` dos pagamentos. O produto identifica-se só por `local_id` (obrigatório, até 50 caracteres e único na venda), e o pagamento aponta o produto por `sale_product_local_id` ou `sale_product_id`. O produto sem `local_id` e o item de pagamento sem referência ao produto são recusados com 422. ### Contas a Pagar e Receber: fatura de cartão de crédito - [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch), [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post), [Liquidar contas a pagar e receber em lote](#tag/Contas-a-Pagar-e-Receber/paths/~1bill_batch_settlements/post) e [Desfazer a liquidação de conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete) passam a aceitar a fatura de cartão de crédito (`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. ## 2026-11-03 ### Guias: blocos no conteúdo - O `details` dos [guias](#tag/Guias) aceita três blocos: caixa de destaque, seção com imagem de fundo e duas colunas, como `
`. O formato está na descrição do campo. Nos orçamentos, nada muda. ### Guias: capa e subtítulo opcional - Os [guias](#tag/Guias) passam a devolver a capa do link público: `cover_kind` (`default`, `image` ou `color`), `cover_color`, `hide_cover_text` e `cover_image_url`. - [Criar guia](#tag/Guias/paths/~1guides/post) e [Alterar guia](#tag/Guias/paths/~1guides~1{id}/patch) aceitam `cover_kind`, `cover_color` e `hide_cover_text`. A imagem da capa só se escolhe pelo Monde Web. - O `subtitle` deixa de ser obrigatório. Na alteração, enviado como nulo, tira o subtítulo. Nada muda para quem já envia o subtítulo. ### Vendas: campos adicionais do produto - Todo produto da venda passa a aceitar e devolver os três campos adicionais que o Monde mostra na tela do produto: `external_number`, `additional1` e `additional2`, com até 20 caracteres cada. Cada agência dá a esses campos o título que quiser (por exemplo, "Nº Pedido"). - Novo endpoint [Consultar campos adicionais do produto](#tag/Vendas/paths/~1sale_product_additional_fields/get), que diz o título de cada campo. Pede a permissão de consultar vendas. - O campo sem título não aparece no Monde: a API ignora o valor enviado nele e não o devolve na consulta. ### Lista de Passageiros - Novo endpoint [Consultar lista de passageiros](#tag/Relatorios/paths/~1reports~1passenger_lists/get), o relatório Lista de Passageiros do Monde: uma linha por passageiro de produto vendido, com contato, documentos, endereço, os trechos aéreos com o assento do passageiro, os detalhes e os valores do produto, as pessoas da venda e os campos personalizados. Filtra por data, situação da venda, pessoas, produto, fornecedor, representante, cidade, marcador, empresa e texto livre. - Novas permissões da credencial, as do Monde, no recurso Lista de Passageiros: "Lista de Passageiros" (`passenger_lists.read_all`) e "Consultar passageiros de outros vendedores/intermediários" (`passenger_lists.read_from_other_sellers`), desmarcadas nas credenciais que já existem. ### Planos de Comissão: novas partes da receita no `calculated_on` - Nos [planos de comissão](#tag/Planos-de-Comissao), o `calculated_on` pode trazer `customer_refund`, `vendor_refund`, `agency_card_rate`, `supplier_fine` e `deleted_balance`, quando o plano é calculado sobre esses valores. ### Contas a Pagar e Receber: liquidação em lote - Novo endpoint [Liquidar contas a pagar e receber em lote](#tag/Contas-a-Pagar-e-Receber/paths/~1bill_batch_settlements/post), que liquida até 100 lançamentos numa chamada, cada um pelo valor final, na mesma data e na mesma conta, como a liquidação dos lançamentos marcados no Monde. Vai tudo ou nada. Com `use_sale_data`, cada pagamento da venda leva a forma e os dados de cheque ou cartão da própria venda. - Pede, em cada lançamento, as mesmas permissões da liquidação de um lançamento. Nada muda para as credenciais que já liquidam. ### Moedas: só ativar e desativar, em todas as agências - [Alterar moeda](#tag/Moedas/paths/~1currencies~1{code}/patch) só ativa ou desativa a moeda, em todas as agências: código, descrição e símbolo não mudam (`422`). Antes, isso valia só com multimoedas. - [Excluir moeda](#tag/Moedas/paths/~1currencies~1{code}/delete) passa a responder sempre `409`: desative a moeda que você não usa. ## 2026-10-30 ### Remoção: configuração do sistema, administração e processos internos - **Atenção:** a API v3 deixa de oferecer o que não cabe numa API de integração. As rotas abaixo passam a responder `404`: - Configurações: todo o `/settings` (as abas, e-mail, e-Notas e o certificado, Bloqueios, Segurança, CVC, licenças, configurações de orçamento e de roteiro e o cadastro da empresa em `/settings/company`, que o [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) já cobre) e o `/payment_method_details`. - Integrações: a inclusão, a alteração e a exclusão em `/integrations`, o `/integration_vendors`, os vínculos de produto e de pessoa, o `/integration_credentials` e o `/supplier_authorizations`. A [consulta das integrações](#tag/Integracoes) continua. - Regras da nota fiscal e de faturamento: a inclusão, a alteração e a exclusão. A consulta continua. - Campos personalizados: a inclusão e a alteração das definições. A consulta continua, e o valor do campo segue informado na venda, na pessoa e no lançamento. - Conciliação bancária: o casamento, as linhas com os candidatos e os vínculos, e a conferência. O envio do extrato OFX, a lista, o detalhe e o descarte continuam. - Comissões: `/commissions`, `/commission_closings` e `/commission_payments`, e a inclusão, a alteração e a exclusão de planos de comissão. A consulta dos planos continua. - CVC: em `/cvc_statements` e `/cvc_master_statements`, tudo menos a lista e o detalhe; e os fechamentos de extrato, o `/cvc_imports` e o `/cvc_deposit_checks`. - As permissões da credencial que só serviam a essas rotas deixam de ser oferecidas. A credencial que já as tem continua valendo para o resto, e salvar a credencial no Monde as retira. ### Contas a Pagar e Receber: moeda do lançamento - Em [Incluir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post), o lançamento passa a aceitar a moeda (`currency`), entre as ativas, quando o Monde trabalha com mais de uma: na operadora ou com multimoedas. Omitida, continua em real. As movimentações da liquidação feita na criação passam a aceitar `exchange_rate` e `reference_exchange_rate`, como a [liquidação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post). - A leitura e a lista de lançamentos passam a trazer a moeda (`currency`). ### Notas Fiscais: PDF da NFS-e - Novo endpoint [Baixar PDF da NFS-e](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1pdf/get), que redireciona para o PDF da nota emitida ou cancelada no e-Notas, como o Monde o abre. ### Contas a Pagar e Receber: movimentação nova na edição e anexo renomeado - Em [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch), o item de `movements` sem `id` passa a incluir uma movimentação nova no lançamento liquidado, como o Adicionar do Monde, com as parcelas (`installments`) na conta cartão de crédito. Antes, toda movimentação precisava do `id`. - Novo endpoint [Renomear anexo](#tag/Anexos/paths/~1attachments~1{id}/patch), com a permissão de anexar do cadastro dono. ### Contas a Pagar e Receber: boleto e conta de cobrança - Em [Incluir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) e [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch), a conta a receber passa a aceitar a conta de cobrança (`billing_account_id`) e o demonstrativo do boleto (`billet_demonstrative`), como a aba Boleto do Monde. Na fatura de cliente aberta, a conta de cobrança responde 409 até o pedido trazer `close_invoice` como `true`, que fecha a fatura junto. - Novos endpoints: [Gerar boleto de conta a receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1billet/post), que emite o boleto e devolve a linha digitável, o código de barras e, no PJBank, o Pix (na fatura de cliente aberta, com `close_invoice` como `true`, que a fecha antes, como o Monde), e [Baixar o PDF do boleto](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1billet.pdf/get). - Novas permissões da credencial, as do Monde: "Imprimir boleto" (`sales.print_billet`) e "Gerar boletos" (`bills.generate_billet`), desmarcadas nas credenciais que já existem. ### Contas a Pagar e Receber: fechar e reabrir a fatura de cliente - Novos endpoints, como os botões Fechar Fatura e Reabrir Fatura do Monde: [Fechar fatura de cliente](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1invoice_closure/post) e [Reabrir fatura de cliente](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1invoice_closure/delete). - Novas permissões da credencial, as do Monde: "Fechar Fatura" (`bills.close_invoice`) e "Reabrir Fatura" (`bills.reopen_invoice`), desmarcadas nas credenciais que já existem. ### Contas a Pagar e Receber: ações sobre os itens da fatura - Cada item de `items` em [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) passa a trazer o `id`, que as ações abaixo recebem. - Novos endpoints, como as ações da aba Itens da fatura no Monde: [Alterar conferido ou centro de custo de item da fatura](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1items~1{id}/patch), [Corrigir valores de item da fatura](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1items~1{id}~1value_correction/post), [Itens que podem entrar na fatura](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1item_candidates/get), [Adicionar itens à fatura](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1items/post), [Remover itens da fatura ou recalcular o vencimento](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1item_reprocessing/post) e [Faturar avulso os itens da fatura](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{bill_id}~1separate_invoice/post). - Novas permissões da credencial, as do Monde: "Alterar taxa CC" (`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. ### Contas a Pagar e Receber: liquidar o avulso da venda e a comissão - Em [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post) e [Desfazer a liquidação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete), o avulso da venda (`sale_standalone`) e a comissão (`commission`) passam a ser liquidados e reabertos como o lançamento avulso, como no Monde. Antes, respondiam 409. As permissões são as mesmas do avulso. - O avulso da venda pede a forma de pagamento: os dados de pagamento da venda valem só para o pagamento da venda. No pagamento parcial, o saldo fica num lançamento novo do mesmo tipo, preso à mesma venda no avulso; na comissão, as comissões pagas continuam no lançamento original. - A [conciliação bancária](#tag/Conciliacao-Bancaria) passa a oferecer e a liquidar os dois tipos. ## 2026-10-29 ### Vendas: documento do passageiro de hospedagem, cruzeiro e locação - Em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get), o passageiro de `hotels`, `cruises` e `car_rentals` passa a trazer o `document`, a identificação do passageiro no produto, como o número do quarto ou da cabine. - Em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), esses passageiros passam a aceitar o `document` (até 30 caracteres). Antes ele era descartado. **Atenção:** na alteração, o passageiro enviado sem `document` fica sem ele, como nos demais produtos; reenvie o valor lido para mantê-lo. ### Inclusões e alterações: o texto vazio é um valor de texto - Em toda inclusão (`POST`) e alteração (`PATCH`), o texto vazio (`""`) passa a seguir uma regra só: no campo de texto, é gravado como foi enviado; no campo de texto obrigatório, é recusado (422); em campo de outro tipo (objeto, lista, número, booleano, data, opção ou referência por id), é recusado (422). Para retirar um valor na alteração, envie `null`. A regra está na introdução desta documentação. - **Atenção:** antes, o `""` variava por endpoint. Na inclusão, valia como campo não enviado. Na alteração, conforme o campo, limpava o valor como o `null`, era ignorado (inclusive objetos e listas, como `seller` e `payer` da venda, que respondiam 200 sem mudar nada) ou deixava o valor como estava. A integração que envia `""` esperando que nada aconteça passa a gravar o texto vazio ou a receber 422. ### Pessoas: documento inválido na alteração - [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) passou a devolver 422 no campo `cpf_cnpj` quando o CPF/CNPJ gravado na pessoa não é válido, qualquer que seja o campo alterado, como no Monde, que confere o documento a cada gravação. Para destravar, envie o `cpf_cnpj` corrigido, ou nulo para retirá-lo. Antes, a alteração estourava erro interno (500). ### Vendas: pagamento avulso e sinal ao fornecedor - Novo endpoint [Gerar pagamento avulso ou sinal ao fornecedor da venda](#tag/Vendas/paths/~1sales~1{sale_id}~1vendor_invoices/post): gera a fatura do pagamento avulso (`advance`) ou do sinal (`deposit`) com os itens do fornecedor em aberto de `financial.vendor_items`, cada um com o valor a gerar, como o Gerar Pagamento Avulso ou Sinal e o Sinal Fornecedor do Monde. O valor menor que o do item divide o item, e a sobra fica em aberto. Responde `201` com a fatura gerada. Pede a permissão de editar vendas, "Ver aba financeiro" (menos no `deposit` com `product_id`, o Sinal Fornecedor do produto) e "Gerar Fatura" quando a fatura automática do fornecedor está desligada ou a venda é da CVC. - Nova permissão "Gerar Fatura" (`bills.generate_supplier_invoice`) na credencial. ### Vendas: itens do fornecedor - Em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get), novo campo `financial.vendor_items`: os itens do fornecedor da venda, como na aba Financeiro do Monde, cada um com `id`, `kind`, `description`, `due_date`, `amount`, `currency`, o produto (`sale_product`), o fornecedor ou representante (`person`), o lançamento em que está (`bill`) e o pagamento direto ao fornecedor que o quita (`payment`). Vem com "Ver aba financeiro", como o resto de `financial`. - Novo endpoint [Alterar item do fornecedor da venda](#tag/Vendas/paths/~1sales~1{sale_id}~1vendor_items~1{id}/patch): muda o vencimento e a descrição do item que ainda não está num lançamento nem foi pago direto, como o Editar do item no Monde, e responde com a venda inteira. O item num lançamento, pago direto ou de crédito gerado, e a venda excluída, respondem 409; vencimento nulo ou vazio responde 422. Pede a permissão de editar vendas e "Ver aba financeiro". ### Contas a Pagar e Receber: conta a pagar ou a receber da venda - Em [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post), novo campo `sale_id`: lança a conta a pagar ou a receber na venda, como o botão da aba Financeiro da venda no Monde. O lançamento nasce como avulso da venda (`kind` igual a `sale_standalone`), na empresa dela, e aparece em `financial.standalone_bills` de [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get). Com `sale_id`, o `company_identifier` pode ser omitido e, enviado, precisa ser o CNPJ da empresa da venda. Exige também a permissão "Ver aba financeiro" de vendas, na empresa da venda. A venda fechada aceita o lançamento, e a excluída responde 409. `operation_id` e `recurrence_kind` são recusados com 422 no lançamento da venda, e sem `account_id` ele fica sem conta prevista, como no Monde. - Na descrição de [Alterar](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch), [Excluir](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/delete) e [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post), os tipos de lançamento passam a aparecer com os valores que o `kind` traz: `sale_standalone`, `vendor_standalone` e `customer_invoice`. A API não mudou. ### Tarefas: anexos no comentário - Em [Comentar na tarefa](#tag/Tarefas/paths/~1tasks~1{task_id}~1history/post), novo campo `attachment_ids`: os anexos já enviados à tarefa em [Enviar anexo](#tag/Anexos/paths/~1attachments/post) ficam ligados ao comentário e aparecem dentro dele no Monde. Com anexos, o texto é opcional. O anexo de outra tarefa, excluído ou já ligado a outro comentário responde 422. Pede a mesma permissão de comentar. - Em [Consultar tarefa por ID](#tag/Tarefas/paths/~1tasks~1{id}/get), cada item de `history` passa a trazer os anexos dele em `attachments`. **Atenção:** o `text` do comentário com anexo feito no Monde passa a vir sem a marcação `(att:)` que o Monde guarda no lugar do arquivo. ### Contas e Cartões: próximo número de boleto - Em [Consultar conta ou cartão por ID](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get), novo campo `next_bank_slip_number`: o número do próximo boleto que a conta corrente emitir. Vem nulo nas demais contas. - Em [Alterar conta ou cartão](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/patch), o mesmo campo muda a numeração dos boletos da conta corrente, como o botão **Alterar** do cadastro de conta do Monde, e a mudança entra no log da conta. A numeração só anda para a frente: o número menor que o atual, ou que não seja maior que o último boleto emitido, responde 422. Nas demais contas, o campo é ignorado. Pede a permissão **Editar** de Contas e Cartões. ### Regras de Faturamento: recalcular os vencimentos em aberto - Em [Alterar regra de faturamento](#tag/Regras-de-Faturamento/paths/~1invoice_rules~1{id}/patch), novo campo `recalculate_open_invoices`. Com `true`, depois de gravar a alteração, os vencimentos das faturas em aberto que caem nas regras da pessoa são recalculados em segundo plano, como no botão Recalcular vencimentos do Monde. Omitido ou `false`, nada muda: só a regra é gravada. Valor que não é booleano responde 422. ### Grupos de Categorias: excluir o grupo com as categorias - [Excluir grupo de categorias](#tag/Grupos-de-Categorias/paths/~1category_groups~1{id}/delete) passa a excluir o grupo com categorias junto com as categorias dele, como no Monde, quando o pedido confirma com `delete_categories: true`. Sem a confirmação, a resposta continua 409. Se alguma categoria for usada em lançamento financeiro ou numa configuração do Monde, nada é excluído (409). Valor que não seja `true` ou `false` responde 422. - [Excluir categoria](#tag/Categorias/paths/~1categories~1{id}/delete) passa a excluir também o grupo que fica sem categorias, como no Monde. ### Vendas: o passageiro é a pessoa no produto - Em [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), a lista `passengers` de um produto passa a alterar o mesmo passageiro, como no Monde, em vez de apagar e recriar a lista. O passageiro é identificado pela pessoa: a que já é passageiro ativo tem o mesmo passageiro alterado, a nova entra e o ativo que não vier sai. - O passageiro cancelado fica, venha ou não na lista. Reenviado igual ao lido, nada muda; antes, ele voltava como um passageiro ativo novo e era cobrado de novo. Com algum valor diferente, a resposta é 422: o cancelado só muda pela [reativação](#tag/Vendas/paths/~1sales~1{sale_id}~1products~1{product_id}~1reactivation/post). A lista com só passageiros cancelados também responde 422. - Em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), a mesma pessoa duas vezes nos passageiros de um produto passa a responder 422. **Atenção:** antes ela entrava duas vezes. - O passageiro passa a aceitar a pessoa já cadastrada só pelo `person.id`, como a consulta da venda devolve, além dos dados da pessoa com o `external_id`. A pessoa apontada pelo `id` não é alterada, e o `id` exige a permissão de ler pessoas; sem ela, ou com uma pessoa jurídica, a resposta é 422. ## 2026-10-28 ### Vendas: alterar um pagamento da venda - Em [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), o pagamento enviado com o `id` e a forma com que ele foi incluído passa a ser alterado, como no Monde, em vez de ser recusado. Mudam o pagante, o vencimento, a descrição e os dados da forma (cartão, cheque, `details`, `observations` e o `cost_center` do Faturar), e só o que foi enviado; o `id` do pagamento continua o mesmo. - O valor e a forma não mudam: `products`, a conta e a liquidação na alteração são recusados com 422, e outra forma também. Para mudá-los, retire o pagamento da lista e inclua um novo, como antes. - As travas são as do Monde: o pagamento liquidado ou faturado não se altera (422), e a venda fechada só se altera reaberta (409). O Retido pelo Intermediário não se altera por aqui (422). ### Notas Fiscais: dados originais da CVC - Em [Consultar notas fiscais](#tag/Notas-Fiscais/paths/~1nfs/get) e [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get), novo campo `cvc_original_data`, só de leitura: os dados originais da nota importada do arquivo da CVC, que o Monde mostra na aba CVC da nota fiscal. Vem nulo quando a nota não veio desse arquivo. Vem também em toda resposta que traz a nota, como as gravações em `/nfs` e a geração de notas, e pede a mesma permissão de ler notas fiscais. ### Vendas: Dinheiro, Cheque e Outros - Novas formas de pagamento em [Inserir venda](#tag/Vendas/paths/~1sales/post) e na inclusão de pagamento por [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), como no Monde: em `agency`, `cash` (Dinheiro), `check` (Cheque) e `others` (Outros); em `vendor`, `check` (Cheque direto ao fornecedor). Cada pagamento em cheque é um cheque, com `check_number` obrigatório, `bank_code` e o CPF/CNPJ em `document`. - Dinheiro e Cheque geram o lançamento na conta de Dinheiro ou de Cheque das configurações de Vendas, que não vem no payload, e seguem a liquidação automática configurada ali. O Outros gera um lançamento em aberto, sem conta, com `details` nas observações. O Cheque direto ao fornecedor não gera lançamento. - O vencimento das quatro formas não pode ser anterior à data da venda. Nenhuma delas é aceita na operadora (422), como no Monde. ### Anexos: viagens, tarefas e exclusão - [Enviar anexo](#tag/Anexos/paths/~1attachments/post) passa a aceitar `resource_type` `travel` (viagem) e `task` (tarefa). Como no Monde, anexar pede **Adicionar anexos** e a permissão de editar a viagem ou a tarefa, na empresa dela. - Novo endpoint [Excluir anexo](#tag/Anexos/paths/~1attachments~1{id}/delete), para os anexos de vendas, contas a pagar e receber, pessoas, viagens e tarefas: o anexo vai para a lixeira do registro, de onde é restaurado no Monde. Como no Monde, pede só **Excluir anexos** do recurso, com o mesmo alcance de anexar. - Novas permissões **Adicionar anexos** em Viagens e em Tarefas e **Excluir anexos** em Vendas, Contas a Pagar e Receber, Pessoas, Viagens e Tarefas, as do Monde. A credencial alcança a viagem e a tarefa que criou; as demais pedem **Consultar vendas de outros vendedores/intermediários** (viagem) ou **Ver tarefas de outros usuários** (tarefa). As credenciais existentes não as recebem: é preciso marcá-las. ### Planos de Comissão e Metas - Novo recurso [Planos de Comissão](#tag/Planos-de-Comissao), com consulta, cadastro, alteração (PATCH) e exclusão, e as regras do cadastro de planos do Monde. O plano traz as faixas da meta atingida, os produtos de cada faixa e os valores de cada função. Na alteração, como no Monde, só muda o que foi enviado: a faixa, o produto e a regra com `id` continuam os mesmos, os sem `id` entram e os que ficaram fora da lista saem. O plano em uso por alguém numa função não é excluído (`409`). - Novo recurso [Metas](#tag/Metas), só de consulta. Como no Monde, a meta é gravada pela função: a lista `goals` de cada pessoa em `people` de [Funções](#tag/Funcoes), com a permissão **Editar** de Funções. A [consulta de funções](#tag/Funcoes/paths/~1person_roles~1{id}/get) passa a trazer as metas de cada pessoa. - Os dois recursos são só da agência: na instalação de operadora, respondem `403`. - Novos recursos de permissão **Planos de Comissão** (**Visualizar**, **Editar** e **Excluir**, do Monde) e **Metas** (**Visualizar**). Pela conexão automática, gravar e excluir planos de comissão é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: o plano vale para a agência inteira. ### Webhooks - Novos eventos no catálogo de [Webhooks](#tag/Webhooks): `changed` e `deleted` de navios, cabines, categorias de tarefa e categorias financeiras; `currencies.changed` (a moeda só avisa a alteração); a tarefa vencida (`tasks.overdue`); e a importação concluída (`integrations.import_completed` e `cvc_statements.import_completed`). ### Integrações: campo não documentado é ignorado - **Mudança de comportamento:** na gravação de [Integrações](#tag/Integracoes) (integração e vínculos de produto e de pessoa) e de [Credenciais de Integração](#tag/Credenciais-de-Integracao), o campo que o endpoint não documenta passa a ser ignorado, como no resto da API. Antes a gravação era recusada com 422. Na alteração, o `vendor_id` da integração e o `user_id` e o `integration_id` da credencial, que não mudam depois do cadastro, também são ignorados. ## 2026-10-27 ### Configurações: Bloqueios, Segurança e CVC - Novo endpoint `/settings/payment_blocks`, para consultar e alterar os Bloqueios de Contas a Pagar e Receber (acréscimo e desconto, dias de movimentação e de vencimento), com a permissão **Configurar bloqueios**, a mesma do Monde, que a permissão da aba Contas a Pagar e Receber não abre. Toda alteração fica no log da empresa, campo a campo. - Novos endpoints para as abas que no Monde só o administrador abre, só para consulta e com permissão própria da API: `/settings/security`, que diz se o Monde pede o código por e-mail ao entrar num computador novo (**Configurações - Segurança**); e `/settings/cvc`, com os recursos da CVC e o FTP dos extratos, sem a senha (só `ftp_password_configured`), cuja alteração é sempre recusada (409), porque no Monde só quem tem acesso total altera a aba CVC (**Configurações - CVC**). - Como as demais permissões de Configurações, estas não são oferecidas na [Conexão automática](#tag/Conexao-automatica). ### Vendas: o `updated_since` considera as partes da venda - Em [Consultar vendas](#tag/Vendas/paths/~1sales/get), o filtro `updated_since` passa a trazer a venda também quando muda uma parte dela, e não só o cabeçalho: produtos, passageiros, trechos e assentos, comissões, anexos, pagamentos e a inclusão, o cancelamento ou a exclusão das contas vinculadas. Vale para a alteração feita pelo Monde, pela API e por qualquer outro meio. A liquidação de uma conta só traz a venda quando muda a taxa cartão agência dos produtos ou quando é parcial e gera a conta do saldo. **Atenção:** a sincronização passa a receber vendas que antes ficavam de fora. - Recomendação nova no filtro: guardar o instante em que a consulta começou, antes da primeira página, partir dele na consulta seguinte com uma folga de alguns minutos para trás e regravar cada venda pelo id. Para acompanhar também as exclusões, enviar `status=opened,closed,canceled` junto. ### Notas Fiscais - Novos endpoints [Inserir nota fiscal avulsa](#tag/Notas-Fiscais/paths/~1nfs/post), [Editar nota fiscal avulsa](#tag/Notas-Fiscais/paths/~1nfs~1{id}/patch) e [Excluir nota fiscal](#tag/Notas-Fiscais/paths/~1nfs~1{id}/delete), com as regras da tela de Notas Fiscais. O tomador é a pessoa do cadastro (`person_id`) ou os dados informados em `recipient`; o valor é a soma dos itens, e os tributos são calculados na gravação. Só a nota não emitida é editada ou excluída (409 nas demais). Na edição, a lista `items` enviada é a final: o item com `id` permanece, o sem `id` entra e o que não veio sai. Cada item novo pode trazer um `local_id`, devolvido na resposta ao lado do `id` gerado. - Novas ações sobre a nota: [Emitir NFS-e](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1issuance/post), assíncrona (responde 202 com a nota aguardando emissão; o andamento se acompanha pela consulta da nota por ID), [Cancelar](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1cancellation/post) (202 quando o cancelamento vai à prefeitura pelo e-Notas), [Informar emissão manual](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1manual_issuance/post), [Ajustar valor](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1amount_adjustment/post), [Remover numeração](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1numbering/delete), [Criar cópia para reemissão](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1reissue_copy/post) e [Baixar XML da NFS-e](#tag/Notas-Fiscais/paths/~1nfs~1{id}~1xml/get). A data de emissão se troca pela edição. - Novas permissões em Notas Fiscais, as do Monde: **Editar** (gravação, emissão manual, ajuste de valor, numeração e cancelamento só no Monde), **Excluir**, **Emitir NFS-e** (emissão e cancelamento pelo e-Notas) e **Criar cópia para reemissão**. Pela conexão automática, elas são exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: a nota vale para a agência inteira. Baixar o XML pede só a de ler. Na instalação de operadora (consolidadora), onde as notas fiscais não existem, a gravação responde 403. - A consulta da nota por ID passa a trazer o `id` de cada item, usado para manter o item na edição. - Na edição de uma nota ligada a uma pessoa do cadastro, `recipient` só vale com `person_id` enviado como `null`, a escolha explícita do tomador digitado, como no Monde; sem isso, ele é ignorado, e reenviar o corpo lido não desliga a pessoa. - A nota inserida, copiada ou cancelada pela API não grava a pessoa da credencial em `created_by` nem em `canceled_by`: quem gravou é a credencial, registrada no log. ### Gerar Notas Fiscais - Novo recurso [Gerar Notas Fiscais](#tag/Gerar-Notas-Fiscais), o mesmo da tela Gerar Notas Fiscais do Monde: [Consultar as notas a gerar](#tag/Gerar-Notas-Fiscais/paths/~1nf_generations/get) mostra, para cada produto de venda fechada, as notas que as regras de nota fiscal montam, e [Gerar notas fiscais](#tag/Gerar-Notas-Fiscais/paths/~1nf_generations/post) grava as escolhidas, todas ou nenhuma. O pedido aceita só os produtos que a consulta mostraria. - A credencial ganhou a permissão **Gerar Notas Fiscais** (`nf_generations.access`), a mesma do Monde, que consulta e gera. Como no Monde, ela alcança as vendas que a própria credencial criou; as dos demais vendedores pedem também **Consultar vendas de outros vendedores/intermediários** em Vendas. - Na [Conexão automática](#tag/Conexao-automatica), **Gerar Notas Fiscais** é exceção: o parceiro só a recebe com o motivo informado na aprovação, mostrado em destaque no consentimento. ### Regras da Nota Fiscal - Novos endpoints [Criar regra da nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules/post), [Alterar regra da nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules~1{id}/patch) e [Excluir regra da nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules~1{id}/delete), com as regras do cadastro do Monde. O corpo segue o formato da consulta: `product`, `payer`, `supplier` e `representative` por `{ "id": ... }`, `representative_scope`, e as notas de cada destinatário em `payer_rule`, `supplier_rule` e `representative_rule`, com `recipient`, `revenues` e `discounts`. A alteração só muda o que foi enviado, e a lista enviada é a lista final. A mesma aplicação só tem uma regra e o mesmo valor só entra na nota de um destinatário (422). A base de operadora, que não tem o cadastro de regras, responde 403 à gravação. - Reenviar na alteração o que a consulta devolveu não responde 422: o valor que a regra já tem e que o destinatário não pode receber, gravado fora da tela, é aceito e sai da regra, como na tela. - A regra gravada pela API fica sem autor (`created_by` nulo); o log da regra diz qual credencial a gravou. - Informar produto ou pessoa na regra exige a permissão "Visualizar" de Produtos ou de Pessoas; sem ela, a resposta é a do id que não existe. O que a regra já usa pode ser reenviado sem essa permissão. - Novas permissões **Editar** e **Excluir** em Regras da Nota Fiscal, oferecidas na credencial da API. Na [Conexão automática](#tag/Conexao-automatica), as duas são exceção (acesso ampliado): a regra vale para a agência inteira. - Os campos de lista de valores simples, como `revenues` e `discounts`, recusam com 422 a lista enviada como texto ou objeto e o item que é lista ou objeto, como os demais campos. - **Mudança no contrato:** em [Consultar regras da nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules/get) e [Consultar regra da nota fiscal por ID](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules~1{id}/get), o `representative_scope` passa a vir como a tela do Monde abre a regra: a regra gravada sem a marca de representante e sem representante, que não alcança venda nenhuma, vem `none` (antes vinha `any`), e a que tem o representante escolhido vem `specific` mesmo sem a marca (antes podia vir `none`). ### Regras de Faturamento - Regras de faturamento passam a ser gravadas pela API: [Criar regra de faturamento](#tag/Regras-de-Faturamento/paths/~1invoice_rules/post), [Alterar regra de faturamento](#tag/Regras-de-Faturamento/paths/~1invoice_rules~1{id}/patch) e [Excluir regra de faturamento](#tag/Regras-de-Faturamento/paths/~1invoice_rules~1{id}/delete). A regra informa o tipo e a pessoa dona (`person_kind` e `person_id`), e a gravação segue as mesmas regras da tela do Monde. Como no Monde, criar, alterar e tirar a regra de uma pessoa que tem outras exigem a permissão **Editar** de Regras de Faturamento; excluir a última regra da pessoa, que leva junto o cadastro de regras dela, exige **Excluir**. Na [Conexão automática](#tag/Conexao-automatica), gravar e excluir regras de faturamento é exceção concedida pelo Monde na aprovação, porque elas valem para a agência inteira. ### Cadastros financeiros - [Categorias](#tag/Categorias): novos endpoints para inserir, alterar e excluir categorias. A categoria só troca para outro grupo do mesmo tipo, e a usada em lançamentos ou numa configuração do Monde não se exclui (409). - Novo recurso [Grupos de Categorias](#tag/Grupos-de-Categorias), com consulta, inclusão, alteração e exclusão. O tipo do grupo (`expense` ou `revenue`) não muda depois da inclusão, e o grupo com categorias não se exclui (409). Usa as permissões de Categorias. - [Centros de Custo](#tag/Centros-de-Custo): novos endpoints para inserir, alterar e excluir. O centro de custo usado no rateio de um lançamento não se exclui (409). - [Formas de Pagamento](#tag/Formas-de-Pagamento): novos endpoints para inserir, alterar e excluir a forma de pagamento da agência. A forma do sistema não se altera nem se exclui (409), e a de uso interno responde 404. - Novo recurso [Informações das Formas de Pagamento](#tag/Informacoes-das-Formas-de-Pagamento): os textos pré-cadastrados que o pagamento da venda copia, com consulta, inclusão, alteração e exclusão, e as permissões próprias do Monde: **Editar**, que também deixa consultar, e **Excluir**. - Novas permissões **Editar** e **Excluir** em Categorias, Centros de Custo, Formas de Pagamento e Informações das Formas de Pagamento, oferecidas na credencial da API. Na [Conexão automática](#tag/Conexao-automatica), gravar e excluir esses cadastros é exceção, porque eles valem para a agência inteira. Toda gravação exige `Idempotency-Key`, e o campo que o endpoint não documenta é ignorado, como no resto da API. ### Fechamento de Comissões - Novo recurso [Fechamento de Comissões](#tag/Fechamento-de-Comissoes), com o cálculo e as regras das telas Fechar Comissões e Pagar Comissões do Monde: [Apurar comissões](#tag/Fechamento-de-Comissoes/paths/~1commissions/get), [Fechar comissões](#tag/Fechamento-de-Comissoes/paths/~1commission_closings/post) (com a comissão vista por pessoa: se ela mudou, o fechamento é recusado), consultar e excluir comissões fechadas, [Pagar comissões](#tag/Fechamento-de-Comissoes/paths/~1commission_payments/post) e excluir o pagamento. - Novas permissões da credencial, as do Monde: **Fechar Comissões** (com Fechar comissões de Vendedores, de Intermediários e de Outras Funções) e **Pagar Comissões** (com Excluir). Pagar pede também o Editar de Contas a Pagar e Receber, e excluir o pagamento, o Excluir de Contas a Pagar e Receber. - Na [Conexão automática](#tag/Conexao-automatica), as permissões de Fechar Comissões e de Pagar Comissões são exceções: alcançam as comissões de todos os vendedores da agência e só são concedidas com o motivo. ### Extrato CVC - O Extrato CVC passou a aceitar gravação, nas agências CVC: [Lançar recibo](#tag/Extrato-CVC/paths/~1cvc_statements/post) (`POST /cvc_statements`), [Alterar recibo](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}/patch) (`PATCH`, o campo omitido permanece), [Excluir recibo](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}/delete) (exclusão lógica) e [Restaurar recibo](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}~1restoration/post). As ações do recibo viraram sub-recursos: [vincular](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}~1sale_link/post) e [desvincular](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}~1sale_link/delete) a venda pelo número do recibo, [processar a baixa de OPFAX](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}~1opfax_processing/post) e [fechar a venda](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}~1sale_closing/post). As permissões são as do Monde: lançar o recibo, vincular a venda, processar a OPFAX e fechar a venda pedem só a consulta do Extrato (as duas últimas, também a de fechar vendas); alterar pede as novas Editar registros ou Editar registros importados, e excluir, restaurar e desvincular a venda pedem Excluir, Restaurar e Desvincular Venda do Recibo, a empresa com os recursos para lojas CVC ligados e não existe em base de operadora. - Em [Consultar extrato CVC por ID](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}/get), o tipo do movimento (`movement_kind`) passou a trazer também o código da CVC (`code`), que é o que o lançamento informa em `movement_kind_code`. - Na [Conexão automática](#tag/Conexao-automatica), as permissões do **Extrato CVC**, inclusive a consulta, que lança recibos e vincula vendas, são exceção concedida pelo Monde na aprovação, e o modelo "Somente leitura" deixa a consulta de fora: o recibo não tem quem o criou (vem da importação ou do lançamento no Monde), e quem o grava alcança os que a agência cadastrou. ### Master - Extrato CVC - Novo recurso [Master - Extrato CVC](#tag/Master-Extrato-CVC), com os recibos de "Repasse Master Franqueado": [consultar](#tag/Master-Extrato-CVC/paths/~1cvc_master_statements/get), [consultar por ID](#tag/Master-Extrato-CVC/paths/~1cvc_master_statements~1{id}/get), [inserir](#tag/Master-Extrato-CVC/paths/~1cvc_master_statements/post), [alterar](#tag/Master-Extrato-CVC/paths/~1cvc_master_statements~1{id}/patch), [excluir](#tag/Master-Extrato-CVC/paths/~1cvc_master_statements~1{id}/delete) e [gerar a nota fiscal](#tag/Master-Extrato-CVC/paths/~1cvc_master_statements~1{id}~1nf/post) do recibo, com as regras do Master - Extrato do Monde. Vale só na empresa ligada como agência master franqueado, em Configurações › CVC. - Permissões, como no Monde: consultar e excluir pedem **Visualizar** e **Excluir** de **Master - Extrato CVC**, novas na credencial; incluir e alterar pedem também **Editar registros** de **Extrato CVC** (o recibo importado, **Editar registros importados**), e gerar a nota, **Editar** de **Notas Fiscais**, as três novas na credencial. - Na [Conexão automática](#tag/Conexao-automatica), todo o **Master - Extrato CVC**, inclusive a consulta, **Editar registros** e **Editar registros importados** de **Extrato CVC** e **Editar** de **Notas Fiscais** são exceção (acesso ampliado): esses registros valem para a agência inteira. ### Fechamento de Extrato CVC - Novo recurso [Fechamento de Extrato CVC](#tag/Fechamento-de-Extrato-CVC), com as regras do Fechamento de Extrato do Monde, numa empresa (`company_identifier`) e num período por vez: [Consultar o resumo do fechamento](#tag/Fechamento-de-Extrato-CVC/paths/~1cvc_statement_closings~1summary/get), [Consultar os movimentos do fechamento](#tag/Fechamento-de-Extrato-CVC/paths/~1cvc_statement_closings~1movements/get), cada um com `valid`, [Marcar movimento como conferido](#tag/Fechamento-de-Extrato-CVC/paths/~1cvc_statement_closings~1movements~1{id}/patch) e [Fechar o extrato](#tag/Fechamento-de-Extrato-CVC/paths/~1cvc_statement_closings/post), que gera as faturas do fornecedor e devolve o `id` delas. Reabrir é excluir a fatura gerada em [Excluir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/delete). - O mesmo fechamento para os repasses de master franqueado em [Master - Fechamento de Extrato CVC](#tag/Master-Fechamento-de-Extrato-CVC), em `/cvc_master_statement_closings`. - Novas permissões **Fechamento de Extrato CVC** e **Master - Fechamento de Extrato CVC**, uma por tela, como no Monde: a mesma permissão consulta, marca o conferido e fecha. O fechamento exige o `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. ### Conferência Depósito CVC - Novo recurso Conferência Depósito CVC, só leitura, como a tela Conferência Depósito do Monde: `GET /cvc_deposit_checks` e `GET /cvc_deposit_checks/{id}`, com o depósito de cada movimento do extrato ao lado do faturado, retido e recebido do cliente e do saldo. Filtros `period_start`, `period_end` e `only_closed_sales` (padrão `true`, como no Monde). Exige a nova permissão **Conferência Depósito CVC**. - Na [Conexão automática](#tag/Conexao-automatica), as permissões **Fechamento de Extrato CVC**, **Master - Fechamento de Extrato CVC** e **Conferência Depósito CVC** são acesso ampliado, inclusive para consultar: alcançam o extrato da agência inteira, e a Monde só as concede ao parceiro com o motivo. ### Importação de Extratos CVC - Novo recurso [Importação de Extratos CVC](#tag/Importacao-de-Extratos-CVC), com [Importar extratos CVC](#tag/Importacao-de-Extratos-CVC/paths/~1cvc_imports/post), [Consultar situação da importação CVC](#tag/Importacao-de-Extratos-CVC/paths/~1cvc_imports~1status/get), [Consultar importações CVC](#tag/Importacao-de-Extratos-CVC/paths/~1cvc_imports/get), [Consultar importação CVC por ID](#tag/Importacao-de-Extratos-CVC/paths/~1cvc_imports~1{id}/get) e [Ligar ou desligar a importação automática CVC](#tag/Importacao-de-Extratos-CVC/paths/~1cvc_imports~1automation/patch). A importação busca os arquivos no FTP da CVC, como o botão Importar da tela, e é assíncrona: responde `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. - Pela [Conexão automática](#tag/Conexao-automatica), a **Importação de Extratos** é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: a importação grava as vendas e os cadastros da empresa vindos da CVC, de qualquer origem. ### Webhooks - Novo recurso [Webhooks](#tag/Webhooks): cadastre um endereço https e receba um `POST` assinado (HMAC-SHA256) quando registros mudam: um aviso por evento, com até 100 ids e a empresa de cada um. Endpoints para listar, criar, consultar, alterar (PATCH) e excluir webhooks, o histórico das entregas (`GET /webhooks/{webhook_id}/deliveries`) e o catálogo de eventos (`GET /webhook_events`): `changed` (criado ou alterado) e `deleted` de cada recurso e os eventos de negócio da venda e da nota fiscal. Entrega com repetição e espera crescente, e desativação depois de falhas seguidas. - Nova permissão **Webhooks** (ler, criar e editar, excluir) na credencial da API. - A permissão **Webhooks** não é oferecida na [Conexão automática](#tag/Conexao-automatica): só a credencial criada pela própria agência pode recebê-la. ### Integrações - [Integrações](#tag/Integracoes) passaram a ser gravadas pela API: [Inserir integração](#tag/Integracoes/paths/~1integrations/post), [Alterar integração](#tag/Integracoes/paths/~1integrations~1{id}/patch) e [Excluir integração](#tag/Integracoes/paths/~1integrations~1{id}/delete), com as regras da tela de Integrações. Os campos adicionais de cada fornecedor vão em `additional_fields`, e a [consulta por ID](#tag/Integracoes/paths/~1integrations~1{id}/get) passou a trazê-los, com valor só no endereço do serviço e na identificação da agência; usuário, senha, token, chaves de API e PIN nunca são retornados (`filled` diz se estão preenchidos). A consulta passou a trazer também o `vendor_id`. - Novo [Consultar fornecedores de integração](#tag/Integracoes/paths/~1integration_vendors/get), com o catálogo de fornecedores e os campos que cada um pede. - Novos vínculos de produto e de pessoa da integração, em `/integrations/{integration_id}/product_links` e `/integrations/{integration_id}/person_links`, com consulta, inclusão, alteração e exclusão. Como o vínculo vale para todas as integrações do fornecedor, gravar e excluir exigem a permissão de inserir e editar integrações em cada uma delas. - Novas permissões **Editar** e **Excluir** em Integrações, oferecidas na credencial da API. ### Credenciais de Integração - Novo recurso [Credenciais de Integração](#tag/Credenciais-de-Integracao), com o login e a senha de cada usuário no fornecedor das integrações que autenticam por usuário: consulta, inclusão, alteração e exclusão. A senha nunca é retornada (`password_filled` diz se está preenchida). Ler exige a nova permissão **Ver Aba Usuário** em Pessoas, como a aba Usuário do cadastro de pessoa no Monde; incluir, alterar e excluir exigem também **Editar** em Pessoas. - As permissões **Editar** e **Excluir** em Integrações e **Ver Aba Usuário** em Pessoas não são oferecidas na [Conexão automática](#tag/Conexao-automatica): só a credencial criada pela própria agência pode recebê-las. ## 2026-10-26 ### Integrações de parceiros - Novos endpoints [Consultar integrações de parceiros](#tag/Integracoes-de-parceiros/paths/~1supplier_authorizations/get), [Consultar integração de parceiro por ID](#tag/Integracoes-de-parceiros/paths/~1supplier_authorizations~1{id}/get), [Renomear integração de parceiro](#tag/Integracoes-de-parceiros/paths/~1supplier_authorizations~1{id}/patch) e [Excluir integração de parceiro](#tag/Integracoes-de-parceiros/paths/~1supplier_authorizations~1{id}/delete), para as autorizações dadas aos parceiros pela [Conexão automática](#tag/Conexao-automatica), como na tela de Integrações do Monde. Excluir corta o acesso do parceiro na hora, e a integração continua na consulta com `active` igual a `false`. Não há criação pela API. - [Consultar integração de parceiro por ID](#tag/Integracoes-de-parceiros/paths/~1supplier_authorizations~1{id}/get) e [Renomear integração de parceiro](#tag/Integracoes-de-parceiros/paths/~1supplier_authorizations~1{id}/patch) trazem `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. - Nova permissão **Integrações de parceiros** (ler, renomear e excluir), oferecida na credencial da API. A credencial de uma conexão automática não acessa o recurso, nem o parceiro pode recebê-lo. ### Conexão automática - Nova forma de conectar: a agência inicia a conexão pela tela de Integrações do Monde, e o parceiro recebe cada conexão nova, já com o token, ao consultar `POST /oauth/connections` com o `client_id` e o `client_secret`. A resposta traz as conexões em `data` e o nó `pagination` da API. Cada conexão é entregue uma única vez e espera a consulta por 72 horas; depois disso, a integração é excluída na conta da agência. O parceiro só aparece para a agência depois de marcar **Conexão iniciada pela agência** na área do parceiro. Veja o passo 7 da [Conexão automática](#tag/Conexao-automatica). ### Configurações - Novo recurso Configurações, com as abas da tela de Configurações do Monde por empresa: consulta e alteração em `/settings/{tab}` para Geral, Vendas, Recebimento, Contas a Pagar e Receber, Comissão, Metas, Fatura Cliente, Fatura Fornecedor, Notas Fiscais e Exportação Cartão Passagem. A alteração grava só os campos enviados, com as regras da tela, e fica no log da empresa. Cada aba pede a permissão do Monde para ela (como **Configurações - Geral**), que libera consultar e alterar a aba. - Novo endpoint `/settings/email`, para consultar e alterar o servidor e o remetente dos e-mails da empresa, com a permissão **Configurações - E-mail (Geral)** do Monde. A senha do servidor só se grava. - Novo endpoint `/settings/company`, para consultar e alterar o cadastro da empresa (nome, razão social, inscrições, contatos e endereço; o CNPJ não muda), e `/settings/licenses`, para consultar as licenças das empresas. Exigem a nova permissão **Cadastro da Empresa e Licenças**. - Novo endpoint `/settings/enotas`, para consultar e alterar a emissão de NFS-e pelo e-Notas da empresa (regime, alíquotas, série e RPS, ambiente de teste e o acesso à prefeitura), e `/settings/enotas/certificate`, para enviar o certificado digital em multipart. Usuário, senha, token e certificado só se gravam: a consulta diz apenas se estão configurados e o vencimento do certificado. Exige a permissão da aba Notas Fiscais, a configuração de NF do Monde. - As permissões das abas de **Configurações** e a de **Cadastro da Empresa e Licenças** não são oferecidas na [Conexão automática](#tag/Conexao-automatica): só a credencial criada pela própria agência pode recebê-las. ## 2026-10-24 ### Cidades: busca pelos outros nomes - O filtro `name` de [Consultar cidades](#tag/Cidades/paths/~1cities/get) passa a achar a cidade também pelos outros nomes dela na lista de cidades do Monde: `?name=New York` e `?name=Nova York` acham Nova Iorque, `?name=Asunción` acha Assunção. Acha também pelo início das palavras, pelo estado e pelo país, como o campo Cidade do Monde. O trecho em qualquer posição do nome continua achando. - **Mudança no contrato:** com o filtro `name`, a lista deixa de vir em ordem alfabética: a cidade cujo nome é o informado vem primeiro, depois a que tem esse nome entre os outros nomes, a que começa por ele, a que o contém e, por fim, as demais; em cada grupo, a maior primeiro. Sem o filtro, a ordem continua pelo nome. O `cursor` de uma busca só vale para o mesmo `name`. ## 2026-10-23 ### Mensagens de erro: posição do item na lista - Em [Inserir venda](#tag/Vendas/paths/~1sales/post), [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), [Inserir pessoa](#tag/Pessoas/paths/~1people/post), [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch), [Inserir tarefa](#tag/Tarefas/paths/~1tasks/post) e [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch), o erro de um item de lista passa a trazer a posição do item na lista enviada, contada a partir de 0, em cada nível. Antes, `O campo 'insurances passengers person name' é obrigatório` não dizia de qual seguro nem de qual passageiro; agora vem `O campo 'insurances[0] passengers[2] person name' é obrigatório`. Vale para os produtos da venda, `passengers`, `segments`, `seats`, `payments` e os `products` deles, `commissions`, `contacts`, `history` e `custom_fields`. Dois itens com o mesmo erro passam a ter uma mensagem cada. **Atenção:** quem compara o texto da mensagem precisa considerar a posição. - O erro de formato de um campo de item de lista, em todas as rotas, também passa a trazer a posição: `O campo 'movements[0] check' deve ser uma lista ou um objeto…`. O item que não é objeto passa a ser apontado pela posição: `O campo 'labels[1]' deve ser um objeto…`. - O erro geral de um item que é uma frase completa sai com o caminho do item antes: `'credit_cards[1]': Não é possível cadastrar um cartão vencido.`, no lugar de `O campo 'credit_cards[1]' Não é possível…`. Vale para `credit_cards`, `cost_centers` e `kandir_law` da pessoa. - Comissões: a venda que não fica fechada responde uma vez, na lista: `O campo 'commissions' só pode ser enviado em venda fechada…`, e não mais uma mensagem por comissão. A comissão de intermediário sem intermediário na venda responde `O campo 'commissions[0]' é de intermediário, e a venda não tem intermediário informado`. - O item nulo ou em branco dentro de uma lista (`"contacts": [null]` ou `[""]`) passa a responder `422`. Antes ele era ignorado, e os itens seguintes mudavam de posição. A lista inteira enviada como `null` continua valendo como antes. ### Cidades: consulta sem permissão - [Consultar cidades](#tag/Cidades/paths/~1cities/get) e [Consultar cidade por ID](#tag/Cidades/paths/~1cities~1{id}/get) deixam de pedir a permissão de Cidades: toda credencial consulta. As cidades vêm da lista do Monde e não têm mais permissão no Monde. - As permissões de Cidades (consultar e consultar o histórico) deixam de ser oferecidas na credencial. A já gravada continua aceita, sem efeito. O histórico das cidades em [Consultar logs](#tag/Logs/paths/~1logs/get) fica só com a credencial que lê todo o histórico. ### Pessoas: a cidade não é mais cadastrada - Em [Inserir pessoa](#tag/Pessoas/paths/~1people/post), [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) e nas pessoas enviadas com a venda ([Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch)), a cidade do endereço e da naturalidade (`birthplace`) não é mais cadastrada. Sem o `city_ibge`, o `city_name` é procurado entre as cidades da agência e as da lista de cidades do Monde ([Consultar cidades](#tag/Cidades/paths/~1cities/get)), sem diferenciar acento nem maiúscula: no Brasil, no estado do `state_code`; no exterior, no país do `country_code`. - A cidade do exterior enviada com `state_code` é procurada primeiro como "Nome, UF", a forma em que a API cadastrava essas cidades antes, e depois só pelo nome no país. - O nome que não corresponde a nenhuma cidade responde `422` em `city_name`, e nada é gravado. Antes, a cidade era cadastrada com o nome enviado. ### Vendas: taxa do cartão da agência - Em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), o pagamento com cartão de crédito da agência (`agency.credit_card`) passa a lançar a taxa do cartão, como no Monde. Sem taxa no payload, vale a "Taxa cartão de crédito" das configurações de Vendas. Para enviar outra, use `card_rate_percentage` (%) ou `card_rate` (valor), um dos dois. A taxa é rateada no `agency_card_rate` dos produtos pagos e abate o valor final do lançamento na categoria de taxa de cartão da empresa. Sem essa categoria configurada, a taxa maior que zero responde `422`. **Atenção:** quem já envia esse pagamento passa a ter a taxa padrão da empresa lançada quando ela estiver configurada; para manter o lançamento sem taxa, envie `card_rate_percentage` igual a `0`. - Na alteração da venda, o pagamento retirado leva a taxa dele junto: o `agency_card_rate` dos produtos é refeito com os pagamentos que ficam. ### Vendas - Novo endpoint [Cancelar produto da venda](#tag/Vendas/paths/~1sales~1{sale_id}~1products~1{product_id}~1cancellation/post), com as regras do cancelamento do Monde: cancela o produto inteiro ou parte dos passageiros, com as opções de excluir o saldo pendente do cliente, excluir o saldo em aberto do fornecedor com multa e manter o produto na meta dos planos de comissão. O cancelamento é sempre pela lista `passengers`, com a pessoa (`person.id`) e a data de cancelamento de cada passageiro; o produto fica cancelado quando a lista cancela os que faltavam. O produto sem passageiros é cancelado sem a lista, na data do dia. O produto cancelado continua somando no valor da venda. Exige, na empresa da venda, a permissão de editar vendas e a permissão "Cancelar produto", nova na credencial, como no Monde; a credencial existente começa sem ela. - Novo endpoint [Reativar produto da venda](#tag/Vendas/paths/~1sales~1{sale_id}~1products~1{product_id}~1reactivation/post), que desfaz o cancelamento do produto inteiro ou só de parte dos passageiros, como o descancelamento do Monde, pela lista `passengers` com a pessoa de cada passageiro que volta. Reativando todos os passageiros cancelados, devolve ao financeiro o que o cancelamento tinha excluído; reativando só parte, a multa e o saldo excluído ficam. Com a fatura automática do fornecedor, responde 409 enquanto a multa do cancelamento ainda está sendo lançada na fatura: repita em alguns segundos. Exige as mesmas permissões do cancelamento. - Em [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), a lista de passageiros vazia (ou nula) num produto em que o passageiro não é obrigatório e que tem passageiro cancelado passa a responder 422: ela tiraria todos os passageiros ativos e deixaria o produto ativo só com passageiros cancelados. Envie ao menos um passageiro ativo, ou cancele os passageiros pelo cancelamento do produto. - Na agência, o valor a faturar ao fornecedor do produto, em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passa a ter a mesma conta do Monde, que é também a do descancelamento: os produtos, as taxas e as taxas de cartão da DU e da RAV, menos a comissão, o over e os abatimentos. Antes o over, os abatimentos e a taxa de cartão da DU ficavam de fora. As vendas já criadas pela API não mudam sozinhas: na alteração, entra na fatura só a diferença do que mudou, e a troca de fornecedor recalcula o valor inteiro. - [Listar vendas](#tag/Vendas/paths/~1sales/get) ganha o filtro `kind`, pelo tipo de produto: a venda entra quando tem algum produto não excluído de um dos tipos informados. - A passagem aérea (`airline_tickets`) passa a aceitar `observations` na criação e na alteração, e passa a recusar com 422 o destino `cruise`: como no Monde, ela é `national` ou `international`. A passagem que a API gravou antes com `cruise` continua vindo assim na consulta e só é alterada com o destino trocado para `national` ou `international`: o `cruise` é recusado também quando o destino é omitido. - **Mudança de valor:** na agência, [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passa a manter fora do total do cliente, do valor total, do faturamento e da base da comissão os abatimentos que o produto já tinha no Monde, como o Monde faz. Antes, a alteração pela API recalculava o produto como se ele não tivesse abatimento, e o total subia. - **Mudança de valor:** [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passam a reter a Lei Kandir (IR, CSLL, PIS e COFINS) e, na passagem aérea, o ISS quando o pagante tem retenção cadastrada para o produto, como o Monde: o retido sai do valor total do produto e vira um lançamento a receber do fornecedor. Exemplo: seguro de R$ 1.000,00 para um pagante com 4,65% de retenção sai com valor total de R$ 953,50 e R$ 46,50 a receber do fornecedor; antes, saía com R$ 1.000,00 e sem o lançamento. A troca do pagante refaz a retenção de todos os produtos da venda, e a alteração de um produto que já tinha retenção deixa de devolver o retido ao valor total. - Na operadora (consolidadora), [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passam a gravar o promotor da venda (`promoter`) como o Monde: é o promotor do cadastro do intermediário, copiado quando a venda é criada e a cada troca de intermediário. O promotor não é enviado no payload. - Novo campo `reservation_due_date` (data de vencimento da reserva) nos produtos da venda, exclusivo da operadora: gravado em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) e devolvido na consulta. Na agência, é recusado com 422 e vem nulo na consulta. - Na operadora, a operação própria (`operation` e `operation_id`) passa a ser recusada com 422, como no Monde, em que ela é exclusiva da agência. - Na operadora, o aprovador (`approver`) enviado com valor em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passa a ser recusado com 422, como no Monde, em que a venda da operadora não tem aprovador. Enviado como `null` na alteração, ele é retirado da venda. - [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passam a aceitar três formas de pagamento à agência sem lançamento: `agency.credit` (Crédito na Agência), `agency.to_invoice` (Faturar, com vencimento, centro de custo e descrição, que entra na fatura de cliente pela fatura automática) e `agency.retained_by_intermediary` (Retido pelo Intermediário, só na agência e em venda com intermediário). O Crédito na Agência e o Retido pelo Intermediário respondem 422 na operadora. Sem `payer`, o Faturar fica no pagante da venda, também na operadora, como no Monde. - Com o controle de crédito do Monde ativo, o Crédito na Agência e o Crédito no Fornecedor (`vendor.credit`) passam a conferir o saldo do pagante, somando os pagamentos com crédito da requisição, e a consumi-lo ao gravar a venda; sem saldo suficiente, a resposta é 422 com o saldo disponível. Retirados da venda na alteração, o crédito usado volta ao pagante. Como no Monde, o Crédito no Fornecedor usa, para o valor todo do pagamento, o saldo de um fornecedor e representante só: os do primeiro produto do pagamento, por ordem alfabética do representante e, depois, do fornecedor, mesmo quando o pagamento paga também produtos de outro fornecedor. - A alteração da venda passa a retirar o Crédito na Agência que fica de fora de `payments`, devolvendo o crédito usado. Antes, ele só saía pelo Monde. - **Mudança no contrato:** na consulta da venda, o Faturar sai na nova lista `payments.agency.to_invoice`, com `id` próprio, e as faturas em `bills`. A fatura de cliente do Faturar deixa de aparecer em `payments.agency.bills`, e o `id` dela deixa de manter o pagamento na alteração: use o `id` do Faturar. O Faturar que ainda não entrou em fatura passa a aparecer. - Na consulta da venda, cada produto do Faturar e do Retido pelo Intermediário (`products[]`) ganha o `id` do item gravado para ele. A alteração mantém a linha pelo `id` dela ou pelo de qualquer um desses itens: quando um pagamento igual incluído depois entra na mesma linha e troca o `id` dela, o `id` guardado antes continua valendo. - **Mudança no contrato:** o Retido pelo Intermediário (`payments.agency.retained_by_intermediary`) ganha `id`, e os dois passam a ser mantidos ou retirados pela lista `payments` da alteração: a alteração que envia `payments` sem o `id` deles os retira, o que antes não acontecia. O Faturar em fatura de cliente fechada ou liquidada não sai. - Quando o item do Faturar entra na fatura de cliente, ele passa a ter o vencimento da fatura, e a parte que entrou pode virar outra linha, com outro `id`, como no Monde. Como no Monde, que só tira essa parte quando o usuário exclui aquela linha, a alteração não a retira por ficar de fora de `payments` enquanto a lista mantém outra linha do mesmo Faturar (mesmo pagante, centro de custo e descrição); ela sai quando nenhuma linha do Faturar fica na lista. Para manter o Faturar inteiro depois da divisão, envie o `id` de cada linha dele (ou de cada item em `products`). - **Mudança no contrato:** como no Monde, o pagante da venda não muda enquanto a venda tem Faturar ou Retido pelo Intermediário: a alteração que troca o `payer` sem tirá-los de `payments` responde 422. Antes, o pagante mudava e os itens ficavam no nome do pagante anterior. - As observações da venda (`observations`) passam a ser aceitas na criação e na alteração, também na venda fechada, como no Monde. A alteração vai para o histórico da venda. ### Reembolsos - Novo endpoint [Lançar reembolso na venda](#tag/Reembolsos/paths/~1sales~1{id}~1refunds/post), para o reembolso de um produto da venda ao cliente (`customer`) ou com o fornecedor (`vendor`), com as regras das ações Reembolso Cliente e Reembolso Fornecedor do Monde: o reembolso vai para a fatura pelas regras de faturamento (`invoice`) ou gera na hora uma fatura avulsa só com ele (`bill`), e entra no reembolso do produto e na receita da venda. O reembolso ao cliente só existe na agência: na operadora, responde `403`. Como no Monde, lançar o reembolso é editar a venda: exige a permissão **Editar** de Vendas (na venda que a credencial não criou, também **Editar vendas de outros vendedores**; na venda com recibo impresso, também **Alterar vendas com recibo impresso**, no reembolso ao cliente e no do fornecedor) e o `Idempotency-Key`. - Novo endpoint [Excluir reembolso](#tag/Reembolsos/paths/~1refunds~1{id}/delete), que tira o reembolso da venda e da fatura em que ele estiver. A fatura liquidada ou fechada responde `409`, e o reembolso ao cliente na venda fechada também. O reembolso do fornecedor que já virou conta a pagar/receber (a conta gerada só para ele ou, com a fatura automática de fornecedor desligada, qualquer fatura) só é excluído com `remove_from_bill` como `true`, como a confirmação do Monde ao excluir a conta: sem ela, responde `409`; com ela, a conta inteira é excluída, como no Monde: o reembolso sai, e os outros itens da conta voltam a ficar pendentes, sem fatura. Exige as mesmas permissões do lançamento (inclusive **Alterar vendas com recibo impresso** na venda com recibo impresso), mais **Ver aba financeiro** no reembolso do fornecedor, e o `Idempotency-Key`. Excluir a conta inteira com `remove_from_bill` exige também **Editar** e **Excluir** de Contas a Pagar e Receber sobre ela (e, na conta de outro usuário, o acesso aos lançamentos dos outros usuários), como excluir o lançamento no Monde; sem elas, `403`. ### Viagens - Novos endpoints [Criar viagem](#tag/Viagens/paths/~1travels/post), [Alterar viagem](#tag/Viagens/paths/~1travels~1{id}/patch) e [Excluir viagem](#tag/Viagens/paths/~1travels~1{id}/delete), com as regras do Monde: descrição (até 60 caracteres), cliente e vendedor ativo obrigatórios, número gerado na gravação e empresa que não muda depois do cadastro. Na alteração, descrição, cliente, vendedor e empresa enviados como nulo ou vazio respondem 422, como na tarefa, e o vendedor atual reenviado é aceito mesmo inativo. Exigem as permissões **Editar** e **Excluir** de Viagens, as mesmas do Monde, novas na credencial da API e na conexão automática. A viagem que a credencial cadastrou, ou com venda que ela criou, é dela. Na viagem de outro vendedor ou de outra credencial, alterar e excluir pedem também **Consultar vendas de outros vendedores**, como a consulta; fora desse alcance, a viagem responde 404. A viagem com anexos não é excluída (409), como no Monde. - Novos endpoints [Vincular venda à viagem](#tag/Viagens/paths/~1travels~1{id}~1sales~1{sale_id}/post) e [Desvincular venda da viagem](#tag/Viagens/paths/~1travels~1{id}~1sales~1{sale_id}/delete), com a permissão **Editar** de Viagens. Como no Monde, a credencial precisa abrir a venda: a que ela criou ou, a de outro vendedor, com **Abrir vendas de outros vendedores/intermediários**; a venda fora desse alcance, ou de outra empresa, responde 404. A venda vinculada não pode estar excluída e precisa ter um produto ativo; a que está em outra viagem é transferida, sem conferir o acesso à viagem de origem, como no Monde. Na empresa configurada para aceitar só vendas cadastradas dentro de uma viagem, a API não desvincula venda nem exclui viagem com vendas (409): no Monde, só o administrador faz isso. - A [consulta da viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get) passou a trazer os campos personalizados em `custom_fields`. ### Conciliação Bancária - Novo recurso [Conciliação Bancária](#tag/Conciliacao-Bancaria), com as regras da tela de Conciliação Bancária do Monde Web: enviar o extrato OFX de uma conta corrente (`POST /bank_reconciliations`, em `multipart/form-data`), consultar e descartar os extratos enviados, refazer o casamento automático, consultar as linhas da conciliação com a situação de cada uma, consultar os candidatos de uma linha, vincular a linha (`PATCH`, com a lista final de movimentações e as contas a pagar ou receber em aberto a liquidar na data da linha), recusar a sugestão e conferir ou desfazer a conferência de cada movimentação. - Nova permissão **Conciliação Bancária** na credencial da API, a mesma do Monde: ela libera consultar, enviar e descartar extratos e vincular as linhas, numa empresa da conta corrente. Conferir a movimentação, inclusive no vínculo que já sai conferido, exige também **Editar lançamento**, como no Monde. - Liquidar uma conta em aberto pelo vínculo segue [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post): aceita as mesmas contas (inclusive o pagamento da venda), recusa as outras, como a comissão, com a mesma mensagem e exige as mesmas permissões, **Editar lançamento** e **Liquidar conta a pagar** ou **Liquidar conta a receber**. - Pela conexão automática, a conciliação é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: ela alcança o extrato e as movimentações da conta inteira, de qualquer origem. ### Contas a Pagar e Receber: lançamento em outra moeda - [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post) passa a liquidar o lançamento em outra moeda, como o Monde. O `amount` da movimentação é na moeda do lançamento; na conta em outra moeda, ele entra convertido pela última cotação, e sem cotação cadastrada a movimentação responde `422`. Antes, o lançamento fora do real respondia `422`. Pelo vínculo da conciliação bancária, a conta em aberto na moeda da conta corrente também se liquida. - A movimentação gravada numa conta fora do real (na liquidação, na inserção já liquidada, na troca de conta da alteração e no vínculo da conciliação) guarda o câmbio de referência, que converte a moeda da conta para o real, pela última cotação da moeda da conta, como o Monde. Antes, guardava 1. **Muda o valor gravado**: na conta em dólar com a cotação de 5,25, a movimentação passa a guardar o câmbio de referência 5,25, e não mais 1. A conta em real, ou a moeda sem cotação cadastrada, continua com 1. - Como no Monde, o câmbio sugerido pode ser corrigido pelo usado no banco. Em [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post), cada movimentação aceita `exchange_rate`, que converte a moeda do lançamento na da conta (só na conta em outra moeda; com ele, a falta de cotação cadastrada deixa de responder `422`), e `reference_exchange_rate`, o câmbio de referência da conta fora do real. No vínculo da [conciliação](#tag/Conciliacao-Bancaria), cada conta em aberto de `open_bills` aceita `reference_exchange_rate` na conta corrente fora do real. Os dois são opcionais, maiores que zero e gravados com 6 casas decimais; omitidos, valem as últimas cotações, e enviados onde não se aplicam são ignorados. ### Extrato e Caixa - Novo endpoint [Consultar saldo da conta](#tag/Extrato-e-Caixa/paths/~1accounts~1{account_id}~1balance/get): o saldo de uma conta corrente ou caixa ao fim de uma data, o mesmo com que o extrato fecha o dia. - Novo endpoint [Consultar extrato da conta](#tag/Extrato-e-Caixa/paths/~1accounts~1{account_id}~1statement/get): o extrato de até 45 dias, linha a linha como no Monde, com o saldo anterior, as movimentações e o saldo de cada dia com a indicação de caixa fechado. - Novos endpoints [Fechar caixa](#tag/Extrato-e-Caixa/paths/~1accounts~1{account_id}~1cash_closures/post) e [Reabrir caixa](#tag/Extrato-e-Caixa/paths/~1accounts~1{account_id}~1cash_closures~1{date}/delete), com as regras do Monde. - Novo recurso de permissão **Saldo e Extrato**, com a permissão **Extrato de Conta** do Monde. Fechar e reabrir o caixa pedem as permissões **Fechar Caixa** e **Reabrir Caixa**, do Monde, em **Contas e Cartões**. Pela conexão automática, ler o saldo e o extrato e fechar e reabrir o caixa é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: o extrato traz todas as movimentações da conta e o fechamento vale para a conta inteira, inclusive para o que a agência lançou. ### Transferências entre Contas - Novos endpoints para [listar](#tag/Transferencias-entre-Contas/paths/~1transfers/get), [consultar](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}/get), [inserir](#tag/Transferencias-entre-Contas/paths/~1transfers/post), [alterar](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}/patch) e [excluir](#tag/Transferencias-entre-Contas/paths/~1transfers~1{id}/delete) transferências entre contas, com as regras da tela de Transferência do Monde. - Novo recurso de permissão **Transferências entre Contas**, com as permissões do Monde: **Transferência entre Contas** (consultar), **Editar** (inserir e alterar), **Excluir** e **Visualizar Log**. O log das transferências em [Logs](#tag/Logs) (origem `conta_movimento`) passa a pedir **Visualizar Log** de Transferências entre Contas, como no Monde, e não mais ler as Movimentações. Pela conexão automática, consultar, editar, excluir e ver o log das transferências é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: a transferência não guarda quem a lançou, então quem as lê ou grava alcança também as que a agência lançou. ### Orçamentos - Novos endpoints [Criar orçamento](#tag/Orcamentos/paths/~1quotes/post), [Alterar orçamento](#tag/Orcamentos/paths/~1quotes~1{id}/patch), [Excluir orçamento](#tag/Orcamentos/paths/~1quotes~1{id}/delete) e [Duplicar orçamento](#tag/Orcamentos/paths/~1quotes~1{id}~1duplication/post), com as regras da tela de Orçamentos do Monde Web. Exigem as novas permissões de orçamentos da credencial: **Criar e editar** (criar, alterar e duplicar) e **Excluir**. - Novo endpoint [Consultar configurações de orçamento](#tag/Orcamentos/paths/~1settings~1quotes/get), por empresa (`company_identifier`): cor, redes sociais, condições gerais, modelo de conteúdo e logotipo. [Alterar configurações de orçamento](#tag/Orcamentos/paths/~1settings~1quotes/patch) responde sempre `409`, sem gravar nada: como no Monde, só o administrador altera as configurações, pela tela do Monde Web. - A consulta de orçamentos passou a trazer `updated_at`, e a consulta por ID, também o dono do orçamento em `user`. - Informar a pessoa (`person_id`) ao criar, alterar ou duplicar um orçamento exige a permissão **Ler todas as pessoas**. Sem ela, a pessoa é recusada (`422`) com a mesma mensagem da pessoa que não existe. - Informar o cliente da viagem (`customer_id`) ao criá-la ou alterá-la e a pessoa do reembolso ao cliente (`person_id`) também exige **Ler todas as pessoas**, com a mesma recusa. ### Guias - Novo endpoint [Duplicar guia](#tag/Guias/paths/~1guides~1{id}~1duplication/post), com a permissão de criar e editar guias. - Novo endpoint [Consultar configurações de guia](#tag/Guias/paths/~1settings~1guides/get), por empresa (`company_identifier`): o rodapé da página pública dos guias. [Alterar configurações de guia](#tag/Guias/paths/~1settings~1guides/patch) responde sempre `409`, sem gravar nada: como no Monde, só o administrador altera as configurações, pela tela do Monde Web. - [Alterar guia](#tag/Guias/paths/~1guides~1{id}/patch) que leva o guia para outra empresa (`company_identifier`) sem informar o dono (`user_id`) passa a responder `422` quando o dono atual não tem acesso à empresa de destino, pedindo um dono que tenha. Antes, o guia mudava de empresa e ficava com um dono que não o alcança. Quando o dono atual tem acesso às duas empresas, nada muda. ### Contas e Cartões - [Contas e Cartões](#tag/Contas-e-Cartoes) passa a aceitar escrita, com [Inserir conta ou cartão](#tag/Contas-e-Cartoes/paths/~1accounts/post), [Alterar conta ou cartão](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/patch) e [Excluir conta ou cartão](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/delete): conta caixa, conta corrente e cartão de crédito, com as empresas em que a conta fica disponível (`companies`), os grupos de usuários com acesso (`user_groups`) e a cobrança da conta corrente (`billing_accounts`, Monde Bancos e CobreBem). Exigem as novas permissões **Editar** e **Excluir** de Contas e Cartões, como no Monde. - O campo que não é do tipo da conta (como `agency` ou `initial_balance` num cartão, ou `billing_accounts` fora da conta corrente) é ignorado, como o campo que não existe: não é gravado e não responde `422`. - Em [Alterar conta ou cartão](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/patch), mudar o saldo inicial (`initial_balance`) reabre os caixas fechados da conta e exige também a nova permissão **Reabrir Caixa** de Contas e Cartões, como no Monde; sem ela, a resposta é 403 com a mensagem do Monde. Reenviar o saldo gravado não pede a permissão. - Na cobrança pelo CobreBem, `registered` é gravado como a tela permite; no Monde Bancos, ele sai da carteira escolhida, e o valor enviado é ignorado. - [Consultar conta ou cartão por ID](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get) ganha os campos `invoice_company`, `user_groups` e `billing_accounts`. - Pela conexão automática, gravar e excluir contas e cartões e reabrir o caixa delas é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: as contas valem para a agência inteira, como os produtos. ### Bancos - Novo recurso [Bancos](#tag/Bancos), com [Consultar bancos](#tag/Bancos/paths/~1banks/get) e [Consultar banco por ID](#tag/Bancos/paths/~1banks~1{id}/get): a tabela de bancos usada no cadastro de conta corrente. Exige a nova permissão **Visualizar** de Bancos, como no Monde. ### Contas a pagar e receber: pagamento parcial com itens - Em [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post) com `balance_resolution` igual a `partial`, no lançamento com itens (como o pagamento da venda), o item dividido entre a conta paga e a do saldo passa a repartir a taxa cartão agência na proporção do valor de cada parte. Antes, a parte que ia para o saldo levava a taxa inteira do item, e a taxa cartão agência do produto ficava contada duas vezes até o saldo ser liquidado. - Na mesma liquidação, a empresa sem as categorias padrão de fatura, de onde a conta do saldo tira as categorias, passa a responder 422 com a mensagem do Monde, e nada é gravado. Antes a resposta era 500. ## 2026-10-22 ### Contas a pagar e receber: pagamento da venda - [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post) e [Desfazer a liquidação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete) passam a aceitar o pagamento da venda (`sale_payment`), cujo `id` vem em `payments.agency.bills` da venda. A baixa usa a forma e os dados de pagamento da venda: `payment_method_id` fica opcional na movimentação, e a taxa de cartão calculada na venda passa para a movimentação sem precisar enviar `card_rate`. Como em toda movimentação com taxa, `amount` é o que o cliente pagou, e a conta recebe `amount` menos a taxa. Ao desfazer, a taxa de cartão fica no lançamento. - [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post), [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch) e [Desfazer a liquidação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete) passam a ratear a taxa de cartão das movimentações entre os produtos da venda, na taxa cartão agência deles, e a recalcular a receita da venda, como no Monde. Antes, a taxa mudava só o lançamento, e a receita da venda não a descontava. Desfazer a liquidação volta a taxa cartão agência dos produtos a zero. ### Pacotes, Navios e Cabines - Novo recurso [Pacotes](#tag/Pacotes): consulta, cadastro, alteração e exclusão dos pacotes usados no produto de pacote turístico (`package_name`), com os serviços inclusos. - [Navios](#tag/Navios) e [Cabines](#tag/Cabines) passam a ter consulta por nome, cadastro, alteração e exclusão. O nome é a chave do registro e vai no caminho com codificação de URL (`/ships/MSC%20Preziosa`). Renomear leva o nome novo para os produtos de venda que usam o registro, e o registro usado em produto de venda não é excluído (`409`). - Cada recurso ganhou as permissões **Editar** e **Excluir** na credencial da API. ### Moedas - [Alterar moeda](#tag/Moedas/paths/~1currencies~1{code}/patch) e [Excluir moeda](#tag/Moedas/paths/~1currencies~1{code}/delete), com as regras da tela de Moedas: com a lista interna de moedas (multimoedas) só se ativa ou desativa a moeda, e nenhuma é excluída. Fora dela, como no Monde, a moeda com cotação gravada não é excluída (`409`): desative-a. - [Consultar cotações da moeda](#tag/Moedas/paths/~1currencies~1{code}~1exchange_rates/get) e [Consultar cotação por ID](#tag/Moedas/paths/~1currencies~1{code}~1exchange_rates~1{id}/get). - Operadoras: [Gravar cotação da moeda](#tag/Moedas/paths/~1currencies~1{code}~1exchange_rates/post) e [Atualizar câmbios](#tag/Moedas/paths/~1currencies~1exchange_rates/post), que grava a cotação de várias moedas de uma vez, como a ferramenta Atualizar Câmbios do Monde. As duas respondem `201` quando gravam e `200` quando o valor é igual ao da cotação vigente e nada é gravado (no lote, com a lista vazia). Na agência, as duas respondem `403`. - **Moedas** ganhou as permissões **Editar moedas e gravar câmbios** e **Excluir** na credencial da API. ### Alterações (PATCH): o campo nulo é retirado - Em todas as alterações, o campo omitido continua como está, e o enviado como `null` passa a ser **retirado** do registro, em vez de valer como omitido. O que o registro não pode ficar sem enviado como `null` responde `422`. A lista enviada como `null` vale como a vazia, e o item de `custom_fields` com `value` nulo ou vazio limpa aquele campo (o obrigatório responde `422`). A criação não muda. [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) já seguia essa regra. - [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch): textos, `address`, `birthplace`, `additional_data`, `airline`, `seller`, `promoter` e as listas se esvaziam. `name`, `person_kind`, `external_id`, `foreigner`, `charge_billet_fee`, as retenções, o e-mail de usuário do Monde, os dados obrigatórios do cartão e os percentuais da Lei Kandir respondem `422`. - [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch): descrição e pessoa se esvaziam, como já acontecia com vencimento, categoria e vínculos; `title`, `assignee_id` e `completed` respondem `422`. - [Alterar guia](#tag/Guias/paths/~1guides~1{id}/patch): `internal_observations` fica em branco; `title`, `subtitle`, `details`, `active`, `user_id` e `company_identifier` respondem `422`. - [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch): `apportionments` nulo esvazia os rateios, e `per_cost_center` ou `per_company` nulo esvazia só aquele; `company_identifier` nulo responde `422`. - [Alterar função](#tag/Funcoes/paths/~1person_roles~1{id}/patch): `people` nulo desfaz todos os vínculos; `person` e `not_commissioned` nulos num item de `people` respondem `422`. - [Alterar marcador](#tag/Marcadores/paths/~1labels~1{id}/patch), [Alterar vendedor](#tag/Vendedores/paths/~1sellers~1{id}/patch), [Alterar categoria de tarefa](#tag/Categorias-de-Tarefas/paths/~1task_categories~1{id}/patch) e [Alterar campo personalizado](#tag/Campos-Personalizados/paths/~1custom_fields~1{id}/patch): nenhum campo pode ser retirado, e o nulo responde `422`. As exceções são `kanban_position`, aceito nulo quando a categoria sai do quadro, e `choices`, em que o nulo vale como lista vazia. ### Produtos - [Produtos](#tag/Produtos) passam a ser gravados pela API: criar (`POST /products`, tipos `others` e `operation`), alterar (`PATCH /products/{id}`) e excluir (`DELETE /products/{id}`). Produto CVC não se altera, e produto do sistema ou com vínculos não se exclui: os dois casos respondem `409`. Exigem as novas permissões **Editar** e **Excluir** de produtos. - Fornecedores do produto em `/products/{product_id}/supplies` e representantes de cada fornecedor em `/products/{product_id}/supplies/{supply_id}/representations`, com consulta em lista, consulta por ID, criação, alteração (`PATCH`) e exclusão. A consulta usa a permissão de ler produtos; a gravação e a exclusão têm permissões próprias, como no Monde: **Adicionar Fornecedor**, **Editar Fornecedor**, **Excluir Fornecedor**, **Adicionar Representante**, **Editar Representante** e **Excluir Representante**. - Na alteração de produto, fornecedor e representante, o campo omitido fica como está e o enviado como `null` é retirado. O campo que não pode ficar vazio (como `name`, `active`, `supplier` e os da comissão) enviado como `null` responde `422`. - A consulta de produto por ID passa a trazer o `id` de cada fornecimento e de cada representante. - Pela conexão automática, gravar e excluir produtos, fornecedores e representantes é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento: esses cadastros valem para a agência inteira, como os campos personalizados, as categorias de tarefa, os marcadores e as funções. ### Vendas - [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passou a reabrir a venda fechada com `status: opened`, como o Monde: a venda reabre antes de o resto do pedido ser aplicado, e a alteração vale por inteiro ou nada muda. Reabrir só muda a situação da venda; as comissões e o financeiro ficam como estão. Exige a permissão "Reabrir venda", nova na credencial e conferida na empresa da venda, como no Monde; "Fechar venda" não reabre. A venda excluída continua respondendo 409. ### Permissões espelhadas do Monde - Em [Inserir pessoa](#tag/Pessoas/paths/~1people/post) e [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch), enviar `credit_cards` ou `kandir_law` com algum item, ou retirando os da pessoa, passou a exigir a permissão "Ver aba financeiro" de pessoas, como no Monde, em que os cartões e a Lei Kandir ficam na aba Financeiro da pessoa. Cada operação nos cartões pede também a permissão dela: incluir cartão (item sem `id`), "Cadastrar Cartão de Crédito"; alterar cartão (item com `id` e algum campo a mudar), "Visualizar dados do Cartão de Crédito" e "Editar Cartão de Crédito"; deixar de fora da lista um cartão que a pessoa tem, "Remover Cartão de Crédito". Sem a permissão, a resposta é 403 com a mensagem do Monde, e nada é gravado. - Em [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) e na resposta da inserção e da alteração, `credit_cards` e `kandir_law` só vêm com "Ver aba financeiro", e `credit_cards`, também com "Visualizar dados do Cartão de Crédito". Sem a permissão, o campo não vem: é omitido, não vem nulo. - Em [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch), retirar o vendedor ou o promotor (`seller` ou `promoter` nulos, na pessoa que tem) passou a exigir "Alterar Vendedor" ou "Alterar Promotor", como trocar já exigia. - Em [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch), mudar a `settlement_date` do lançamento liquidado para uma data diferente da gravada passou a exigir também "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, como no Monde. Reenviar a mesma data não pede a permissão. - Em [Inserir venda](#tag/Vendas/paths/~1sales/post), `commissions` com alguma comissão passou a exigir "Ver aba comissões" e "Adicionar comissões". Em [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), enviar `commissions`, mesmo vazia ou nula, passou a exigir também "Ver aba comissões", além de "Adicionar comissões" e "Excluir comissões". - [Enviar anexo](#tag/Anexos/paths/~1attachments/post) na venda, na conta a pagar ou receber e na pessoa passou a exigir, além da permissão de adicionar anexos, a "Editar" do recurso (vendas, contas a pagar e receber, pessoas), como no Monde, em que anexar grava o cadastro. - Fornecedores e representantes do produto têm permissões separadas para incluir, alterar e excluir, com os nomes do Monde: [Adicionar fornecedor ao produto](#tag/Produtos/paths/~1products~1{product_id}~1supplies/post) exige "Adicionar Fornecedor", [Alterar fornecedor do produto](#tag/Produtos/paths/~1products~1{product_id}~1supplies~1{id}/patch) exige "Editar Fornecedor" e [Remover fornecedor do produto](#tag/Produtos/paths/~1products~1{product_id}~1supplies~1{id}/delete) exige "Excluir Fornecedor"; nos [representantes](#tag/Produtos/paths/~1products~1{product_id}~1supplies~1{supply_id}~1representations/post), "Adicionar Representante", "Editar Representante" e "Excluir Representante". - Em [Consultar logs](#tag/Logs/paths/~1logs/get) e [Consultar logs por ID](#tag/Logs/paths/~1logs~1{id}/get), o log de cidades (`cidade`) passou a vir a quem tem "Visualizar Log" de cidades, em vez de a quem lê as cidades. - Consultar e listar [vendas](#tag/Vendas), [contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber), [tarefas](#tag/Tarefas) e [viagens](#tag/Viagens) passaram a pedir a permissão "Visualizar" do recurso também no registro que a própria credencial criou, como no Monde, em que sem "Visualizar" não se abre o cadastro. O registro de outra origem continua pedindo também a permissão "de outros". Sem "Visualizar", a resposta da alteração traz só os identificadores, mesmo no registro que a credencial criou: o `id` e, na venda, também o `id` e o `local_id` dos produtos e pagamentos enviados; o mesmo vale para a liquidação e a restauração do lançamento e para o comentário na tarefa. Uma alteração sem nenhum campo não serve de consulta. A criação continua devolvendo o registro criado inteiro, com os campos protegidos ocultos conforme as permissões de campo. O download de anexo segue a consulta do registro dono dele, com a mesma regra. - A credencial ainda gravada no catálogo anterior, de antes das permissões espelhadas do Monde, continua fazendo o que fazia: nela, "Ver aba financeiro" e "Visualizar dados do Cartão de Crédito" valem pela "Visualizar" ou pela "Editar" de pessoas, as de cadastrar, editar e remover cartão e as de retirar vendedor e promotor, pela "Editar" de pessoas; a de liquidar, pela "Editar" de contas a pagar e receber; e "Ver aba comissões", pela "Visualizar" ou pela "Editar" de vendas. A inserção de venda com comissões e o envio de anexo seguem sem a exigência nova, e ela continua consultando, alterando com a resposta inteira e baixando os anexos do que ela mesma criou com qualquer permissão do recurso, como fazia a conexão automática. ## 2026-10-21 ### Permissões "de outros", como no Monde - Cada permissão de [vendas](#tag/Vendas), [contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber), [tarefas](#tag/Tarefas) e [viagens](#tag/Viagens) vale para o que a própria credencial criou, e as permissões "de outros" do Monde estendem o alcance aos demais registros: **Consultar**, **Abrir** e **Editar vendas de outros vendedores**; **Acessar lançamentos de todos os usuários e do sistema** e os recortes dele; **Ver tarefas de outros usuários**. A viagem dos outros vendedores segue **Consultar vendas de outros vendedores**. - A credencial sempre lê o que criou: qualquer permissão do recurso na empresa basta para listar e consultar o próprio registro. Isso vale também pela conexão automática, que passa a listar e consultar as vendas, os lançamentos e as tarefas que o parceiro criou. - O registro de outro usuário fora do alcance responde 404. O que a credencial lê mas não pode alterar responde 403 com a mensagem do Monde, inclusive pela conexão automática, que antes recebia 404 na venda e 403 sem mensagem no lançamento. - [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post) passa a exigir **Liquidar conta a pagar** ou **Liquidar conta a receber**, conforme a natureza do lançamento. - O [download de anexo](#tag/Anexos/paths/~1attachments~1{id}~1download/get) segue a consulta do registro dono dele, e o [envio de anexo](#tag/Anexos/paths/~1attachments/post) na venda e no lançamento de outro usuário pede o mesmo alcance. - [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch) que leva o lançamento de outro usuário para outra empresa passa a exigir, também na empresa de destino, o acesso aos lançamentos de outros usuários, como a venda exige "Editar vendas de outros vendedores" lá. O mesmo vale para [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch) que leva a tarefa de outro usuário para outra empresa: exige "Ver tarefas de outros usuários" no destino. - [Consultar logs](#tag/Logs/paths/~1logs/get) aplica o mesmo alcance: o log da venda, do lançamento e da tarefa de outro usuário só vem a quem alcança o registro (abrir as vendas de outros vendedores, acessar os lançamentos de outros usuários, ver as tarefas de outros usuários), como no Monde, em que o log fica na aba do registro. - A credencial gerada antes dessas permissões continua como antes: a própria ação (ler, editar, excluir, liquidar, anexar) alcança qualquer registro da empresa. - A tela da credencial passa a oferecer todas as permissões, com os nomes do Monde, e a credencial salva por ela vale pelas regras acima. Ao abrir uma credencial antiga, a tela já marca as permissões que dão o mesmo alcance que ela tinha, então salvar não tira acesso. A tela recusa a permissão que ela não oferece. - A conexão automática autorizada a partir de agora também vale pelas regras acima: o parceiro alcança só o que criou, e o acesso aos registros de outras origens é exceção concedida na homologação, mostrada em destaque no consentimento. ### Contas a Pagar e Receber - Em [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post), criar o lançamento já liquidado passou a exigir a permissão "Liquidar conta a pagar" ou "Liquidar conta a receber", como no Monde; sem ela, a resposta é 403. A credencial que já existia continua criando liquidado com "Editar". - Nova permissão "Ignorar bloqueios" em Contas a Pagar e Receber: a credencial que a tem na empresa do lançamento passa pelos bloqueios de vencimento, de data de movimentação e de acréscimo e desconto, como o usuário do Monde. Sem ela, os bloqueios continuam valendo como antes. - Novo endpoint [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post), para dar baixa num lançamento em aberto com as regras da liquidação do Monde: a data de liquidação e as movimentações, como na inserção já liquidada. Quando o pago não fecha com o valor final, `balance_resolution` diz o que fazer com a diferença: `category` a lança numa categoria de desconto ou acréscimo (a de `balance_category_id` ou a padrão da empresa), e `partial` liquida o que foi pago e cria um lançamento em aberto com o saldo, que vem em `generated_bills`. Liquida o lançamento avulso, as faturas de cliente e de fornecedor e a fatura de cartão com a edição liberada; o pagamento e o avulso da venda e a comissão respondem 409. Exige `Idempotency-Key`, a permissão "Editar" de contas a pagar e receber e a "Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza do lançamento, as mesmas da inserção já liquidada. - Novo endpoint [Desfazer a liquidação de conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete), como remover a liquidação no Monde: as movimentações saem das contas e o lançamento volta a ficar em aberto, com o acréscimo e o desconto lançados na liquidação. A fatura cujo saldo foi levado para outro lançamento responde 409, e o lançamento conciliado só é reaberto com `undo_bank_reconciliation` como `true`. Exige também a permissão **Editar lançamento liquidado**. Não exige `Idempotency-Key`. - Pela conexão automática, o parceiro só liquida e desfaz a liquidação do lançamento que ele mesmo criou, salvo a exceção concedida na homologação: o de outra origem responde 404, ou 403 quando o parceiro consegue lê-lo. ### Vendas - Em [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), o que o Monde protege com permissão própria passou a exigir essa permissão, na empresa da venda: alterar a data da venda, a empresa, o vendedor (em venda aberta e em venda fechada), o solicitante e os campos personalizados da venda fechada, tirar um produto da lista, enviar comissões e alterar a venda com recibo impresso. Sem a permissão, a resposta é 403 com o nome dela, e nada é alterado; o campo reenviado igual ao gravado não pede permissão, menos `commissions`, cuja lista sempre substitui as comissões manuais. As comissões passaram a exigir "Adicionar comissões" e "Excluir comissões", no lugar de "Fechar venda". [Excluir venda](#tag/Vendas/paths/~1sales~1{id}/delete) com recibo impresso passou a exigir também "Alterar vendas com recibo impresso". A credencial que já existia continua fazendo o que fazia: "Editar" vale também pelas permissões novas da alteração, "Fechar venda" pelas das comissões, e "Excluir" pela do recibo impresso. - Em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), a pessoa, o vendedor, o navio e a cabine que a venda cria junto passaram a exigir a permissão "Editar" em Pessoas, Vendedores, Navios e Cabines, como no Monde, em que cada um nasce na tela dele. Trocar a pessoa de um passageiro na venda com recibo impresso passou a exigir "Trocar passageiro em vendas fechadas ou com recibo impresso". - Em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get), comissão, over e receitas só vêm com "Visualizar comissão, over e receitas"; `payments` e `financial`, com "Ver aba financeiro"; e `commissions`, com "Ver aba comissões". Sem a permissão, o campo não vem. Na resposta da inserção e da alteração, sem "Ver aba financeiro", `payments` traz só o `id` e o `local_id` dos pagamentos enviados. - A credencial que já existia continua com o que fazia: "Editar" vale também para os cadastros que a venda cria junto e para trocar passageiro, e a leitura de vendas vale pelas colunas e abas. ### Logs - [Consultar logs](#tag/Logs/paths/~1logs/get) passou a recortar o histórico por cadastro, como no Monde: o log de cada cadastro vem a quem tem "Visualizar Log" dele ou, no cadastro sem essa permissão, a quem o lê; no log de venda, lançamento, nota fiscal e tarefa, a permissão vale na empresa do registro, e as exportações ficam de fora. A linha que a credencial não vê responde 404 em [Consultar logs por ID](#tag/Logs/paths/~1logs~1{id}/get). A credencial que já tinha a leitura de todo o log continua vendo tudo. ### Pessoas - Em [Inserir pessoa](#tag/Pessoas/paths/~1people/post) e [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch), informar ou trocar o vendedor (`seller`) passou a exigir a permissão "Alterar Vendedor", e o promotor (`promoter`), a "Alterar Promotor", como no Monde; sem ela, a resposta é 403. A credencial que já existia continua com o que fazia: "Editar" vale também por essas permissões. - [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) passou a recusar, com 403 e a mensagem do Monde, o que o Monde reserva aos administradores: alterar a pessoa que é uma empresa do sistema e trocar o e-mail de uma pessoa que é usuário ativo do Monde. Os demais campos do usuário continuam alteráveis, e o e-mail reenviado igual ao gravado não é recusado. ### Tarefas - Em [Criar tarefa](#tag/Tarefas/paths/~1tasks/post) e [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch), o responsável precisa ter acesso às tarefas da empresa da tarefa, como no Monde; sem ele, a resposta é 422 em `assignee_id`. A conferência vale em toda alteração, não só quando o responsável ou a empresa mudam. A tarefa sem empresa não confere. ### Conexão automática - A seção [Conexão automática](#tag/Conexao-automatica) abre com um resumo do fluxo em três passos e deixa claro que ele é OAuth 2.0 de autorização, e não login único (SSO) nem OpenID Connect: o token dá acesso à API da agência e não identifica quem autorizou. ### Contas a Pagar e Receber - A movimentação de [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) já liquidada, de [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post) e de [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch) ganha `card_rate`, a taxa de cartão, com as regras do Monde: só na conta a receber, em conta corrente e com a forma cartão de crédito ou de débito. `amount` é o que o cliente pagou, a conta recebe `amount` menos a taxa, e a soma das taxas vira a categoria de taxa de cartão configurada na empresa, que abate o valor final; sem essa categoria, a taxa responde `422`. Na alteração, mudar só a taxa mantém o que o cliente pagou. - As mesmas operações passam a aceitar a conta cartão de crédito na conta a receber, só com a forma cartão de crédito: é o estorno no cartão, que entra na fatura do cartão como no Monde. Antes, a conta cartão era recusada nas movimentações da conta a receber. ### Movimentações - [Consultar movimentação por ID](#tag/Movimentacoes/paths/~1account_movements~1{id}/get) passa a trazer `card_rate`, a taxa de cartão da movimentação. - Nova [Restaurar conta a pagar ou receber excluída](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1restoration/post) (`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](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete) ganha `recurrence_scope`, como a alteração e a exclusão: no lançamento de uma série, `this_and_following` desfaz também a liquidação dos seguintes que estão liquidados, com as mesmas recusas e a mesma permissão de cada um. Se um deles não pode reabrir, nenhuma liquidação é desfeita, e a resposta `409` diz qual barrou. O padrão continua sendo desfazer só o lançamento informado. ## 2026-10-20 ### Empresas, Vendedores e Marcadores - Novo recurso [Empresas](#tag/Empresas), com [Consultar empresas](#tag/Empresas/paths/~1companies/get) e [Consultar empresa por ID](#tag/Empresas/paths/~1companies~1{id}/get): as empresas ativas que a credencial alcança, com nome, razão social, CNPJ (o valor de `company_identifier` nas gravações) e se a empresa está somente leitura. Exige a nova permissão "Ler todas as empresas", concedida em cada empresa que deve aparecer. - [Vendedores](#tag/Vendedores) ganham [Cadastrar vendedor](#tag/Vendedores/paths/~1sellers/post), [Alterar vendedor](#tag/Vendedores/paths/~1sellers~1{id}/patch) e [Excluir vendedor](#tag/Vendedores/paths/~1sellers~1{id}/delete). Como no Monde, só uma pessoa física já cadastrada vira vendedor, a pessoa do vendedor não muda e o vendedor que está em alguma venda não se exclui (`409`): desative-o com `active: false`. Exigem as novas permissões de vendedores "Editar" e "Excluir". - [Marcadores](#tag/Marcadores) ganham [Criar marcador](#tag/Marcadores/paths/~1labels/post), [Alterar marcador](#tag/Marcadores/paths/~1labels~1{id}/patch) e [Excluir marcador](#tag/Marcadores/paths/~1labels~1{id}/delete). O nome tem até 38 caracteres e não repete o de outro marcador, e excluir retira o marcador de todas as pessoas. Exigem as novas permissões de marcadores "Editar" e "Excluir". ### Cidades - [Consultar cidades](#tag/Cidades/paths/~1cities/get) e [Consultar cidade por ID](#tag/Cidades/paths/~1cities~1{id}/get) passam a trazer também as cidades da lista de cidades do Monde que a agência ainda não usa, com os municípios do IBGE e as cidades do exterior. A cidade da lista entra no cadastro da agência, com o mesmo `id`, quando uma pessoa ou nota fiscal passa a usá-la. - Em [Inserir pessoa](#tag/Pessoas/paths/~1people/post), [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) e [Inserir venda](#tag/Vendas/paths/~1sales/post), o `city_ibge` e o nome da cidade do endereço e da naturalidade passam a achar também a cidade da lista. Quando o nome se repete, vem a cidade maior. Antes, a cidade do exterior que a agência não tinha era criada de novo, sem relação com a da lista. A cidade do exterior enviada com `state_code` continua sendo procurada como "Nome, UF" e, sem par, criada com esse nome. ### Campos Personalizados - Novos [Criar campo personalizado](#tag/Campos-Personalizados/paths/~1custom_fields/post) e [Alterar campo personalizado](#tag/Campos-Personalizados/paths/~1custom_fields~1{id}/patch), com as mesmas regras da tela de Campos Personalizados: nome único dentro do recurso, opções (`choices`) só no tipo lista, e recurso e tipo fixos depois de criados. Não há exclusão: o campo que não se usa mais é desativado com `active: false`. Exige a nova permissão **Criar e editar** de campos personalizados. ### Categorias de Tarefas - [Consultar categorias de tarefas](#tag/Categorias-de-Tarefas/paths/~1task_categories/get) e [Consultar categoria de tarefa por ID](#tag/Categorias-de-Tarefas/paths/~1task_categories~1{id}/get) passam a trazer `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). - Novos [Criar categoria de tarefa](#tag/Categorias-de-Tarefas/paths/~1task_categories/post), [Alterar categoria de tarefa](#tag/Categorias-de-Tarefas/paths/~1task_categories~1{id}/patch) e [Excluir categoria de tarefa](#tag/Categorias-de-Tarefas/paths/~1task_categories~1{id}/delete). A categoria nova entra no quadro como última coluna, e `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. ### Funções - Novo recurso [Funções](#tag/Funcoes), com [Consultar funções](#tag/Funcoes/paths/~1person_roles/get), [Consultar função por ID](#tag/Funcoes/paths/~1person_roles~1{id}/get), [Cadastrar função](#tag/Funcoes/paths/~1person_roles/post), [Alterar função](#tag/Funcoes/paths/~1person_roles~1{id}/patch) e [Excluir função](#tag/Funcoes/paths/~1person_roles~1{id}/delete): o cadastro de funções do módulo de comissões, com as empresas ou vendedores sobre cujas vendas a função é comissionada e as pessoas vinculadas a ela. Só na agência, e exige as novas permissões de **Funções** da credencial. A inclusão, a alteração e a exclusão da função, das pessoas vinculadas e das empresas e vendedores de `commissioned_over` ficam no log da função, em nome da credencial. ### Pessoas - [Cadastrar pessoa](#tag/Pessoas/paths/~1people/post) e [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) passam a gravar `credit_cards` (cartões de crédito), `cost_centers` (centros de custo do cliente corporativo) e `kandir_law` (retenções da Lei Kandir), no mesmo formato da consulta por ID. Na alteração, a lista enviada substitui a atual, como `contacts` e `labels`: o cartão que a pessoa já tem é citado pelo `id`, o centro de custo pelo nome e a retenção pelo produto. O número e o código de segurança do cartão são gravados cifrados e nunca voltam na resposta, que traz só os quatro últimos dígitos. Centros de custo e retenções só valem para pessoa jurídica, e a retenção só para Passagem Aérea, Seguro Viagem e Transporte Terrestre, com o total de cada grupo calculado pela soma de IR, CSLL, PIS e COFINS. Cada inclusão, alteração e exclusão entra no histórico da pessoa. - [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) passa a trazer o `id` de cada cartão em `credit_cards` e a lista `cost_centers`. ## 2026-10-19 ### Pessoas - [Consultar pessoas](#tag/Pessoas/paths/~1people/get) ganha o filtro de aniversário, que substitui a consulta Aniversariantes do Monde: `birthday_from` e `birthday_to` (YYYY-MM-DD, juntos, até 366 dias) trazem quem faz aniversário na janela, sem olhar o ano e atravessando a virada do ano. Ganha também o filtro `label_id`, para as pessoas de um marcador. - Nova [Converter pessoa física em jurídica, ou o contrário](#tag/Pessoas/paths/~1people~1{person_id}~1conversion/post) (`POST /people/{person_id}/conversion`), com as regras da conversão do Monde: apaga os dados que só o tipo de origem tem e recusa o usuário do sistema e a empresa do sistema. Exige a permissão de alterar pessoas. - Novas [Baixar foto da pessoa](#tag/Pessoas/paths/~1people~1{person_id}~1photo/get), [Enviar foto da pessoa](#tag/Pessoas/paths/~1people~1{person_id}~1photo/post) e [Remover foto da pessoa](#tag/Pessoas/paths/~1people~1{person_id}~1photo/delete). A foto (o logotipo, na pessoa jurídica) é JPEG de até 150 KB, como no Monde. - [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) ganha os campos `photo` (tipo e tamanho da foto, ou nulo) e `invoice_rules` (as regras de faturamento próprias da pessoa). ### Pessoas e Vendas - Em [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch), a pessoa que é usuário do Monde e recebe o `email` de outro usuário passa a responder 422 em `email`, e nada é gravado. Antes a resposta era 500. Vale também para a pessoa já cadastrada, citada em [Inserir venda](#tag/Vendas/paths/~1sales/post) ou em [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), 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](#tag/Pessoas/paths/~1people/post) não muda: a pessoa criada ainda não é usuário. ### Tarefas - [Consultar tarefas](#tag/Tarefas/paths/~1tasks/get) ganhou os filtros da consulta de Tarefas do Monde: `assignee_id` (responsável), `created_by_id` (quem cadastrou), `person_id`, `category_id` (ou `uncategorized`, para as tarefas sem categoria), `status` (`pending`, `completed` e `deleted`, separados por vírgula), `overdue` (vencidas), o período por `date_field` (`due`, `created_at` ou `completed_at`) com `date_from` e `date_to`, e o vínculo com venda, viagem e lançamento (`sale_id`, `travel_id`, `bill_id`). Sem `status`, a lista continua sem as tarefas excluídas. Filtro com valor inválido responde 400. - A tarefa pode ser vinculada a uma venda, uma viagem e um lançamento (conta a pagar ou receber): `sale_id`, `travel_id` e `bill_id` em [Criar tarefa](#tag/Tarefas/paths/~1tasks/post) e [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch), e `sale`, `travel` e `bill` em [Consultar tarefa por ID](#tag/Tarefas/paths/~1tasks~1{id}/get). Os vínculos não têm relação obrigatória com a pessoa da tarefa; quando vierem juntos, precisam combinar entre si: a venda tem de ser da viagem informada, e o lançamento, da venda informada. Na alteração, o vínculo enviado como nulo é desfeito, e a pessoa já preenchida da tarefa não é trocada enquanto ela tiver vínculo; preencher a pessoa da tarefa que está sem pessoa é permitido. ### Contas a Pagar e Receber - Em [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch) com `recurrence_scope` igual a `this_and_following`, cada lançamento seguinte da série só recebe a alteração quando a credencial poderia alterá-lo diretamente: com a permissão "Editar" na empresa dele, que não pode estar somente leitura; no de outro usuário, também o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, também a "Editar lançamento liquidado". O seguinte que não atende a isso fica como está, e a resposta continua 200. - No mesmo `this_and_following`, o lançamento seguinte excluído (`canceled` igual a `true`) fica como está e não recebe mais a alteração da série. - Em [Excluir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/delete) com `recurrence_scope` igual a `this_and_following`, cada lançamento seguinte da série só é apagado quando a credencial poderia excluí-lo diretamente: com a permissão "Excluir" na empresa dele, que não pode estar somente leitura; no de outro usuário, também o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento); e, no já liquidado, também a "Editar lançamento liquidado". O seguinte que não atende a isso continua lá, fora da série, e a resposta continua 204. ## 2026-10-17 ### Cidades - **Mudança no contrato:** [Consultar cidades](#tag/Cidades/paths/~1cities/get) e [Consultar cidade por ID](#tag/Cidades/paths/~1cities~1{id}/get) deixam de devolver o campo `setec`. O código SETEC não era usado pelo Monde em nenhuma emissão de nota e foi removido do cadastro de cidades. ### Contas a Pagar e Receber - [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) passa a aceitar `balance_resolution` e `balance_category_id` no lançamento criado já liquidado, como a [liquidação](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post): com `category`, a diferença entre o pago e o valor final vai para a categoria informada ou, sem ela, para a categoria padrão da empresa; com `partial`, o saldo vira um lançamento em aberto. O `partial_payment: true` continua aceito e equivale a `balance_resolution: partial`; o `partial_payment` que contradiz o `balance_resolution` é recusado com 422. O `balance_resolution` não se combina com parcelamento nem recorrência. ## 2026-10-16 ### Contas a Pagar e Receber - Novo endpoint [Liquidar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/post), para dar baixa num lançamento em aberto com as regras da liquidação do Monde: a data de liquidação e as movimentações, como na inserção já liquidada. Quando o pago não fecha com o valor final, `balance_resolution` diz o que fazer com a diferença: `category` a lança numa categoria de desconto ou acréscimo (a de `balance_category_id` ou a padrão da empresa), e `partial` liquida o que foi pago e cria um lançamento em aberto com o saldo, que vem em `generated_bills`. Liquida o lançamento avulso, as faturas de cliente e de fornecedor e a fatura de cartão com a edição liberada; o pagamento e o avulso da venda e a comissão respondem 409. Exige `Idempotency-Key` e a permissão de inserir e editar contas a pagar e receber, a mesma da inserção já liquidada. - Novo endpoint [Desfazer a liquidação de conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}~1settlement/delete), como remover a liquidação no Monde: as movimentações saem das contas e o lançamento volta a ficar em aberto, com o acréscimo e o desconto lançados na liquidação. A fatura cujo saldo foi levado para outro lançamento responde 409, e o lançamento conciliado só é reaberto com `undo_bank_reconciliation` como `true`. Exige também a permissão **Editar liquidadas**. Não exige `Idempotency-Key`. - Pela conexão automática, o parceiro só liquida e desfaz a liquidação do lançamento que ele mesmo criou: o de outra origem responde 403, ou 404 quando o parceiro não tem a permissão de ler contas a pagar e receber. - As movimentações das contas a pagar e receber passam a ficar no log do lançamento, em nome da credencial, quando são criadas, alteradas ou removidas pela API. ## 2026-10-15 ### Contas a Pagar e Receber - Novo endpoint [Excluir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/delete), com as regras do Monde. A exclusão é lógica: o lançamento fica com `canceled` igual a `true` e continua na consulta por ID. Exclui o lançamento avulso e a fatura de cliente e de fornecedor, cujos itens voltam a ser faturados; o gerado por venda, a fatura de cartão, o lançamento de comissão e a fatura gerada pelo Monde com itens respondem 409 com o motivo. O lançamento liquidado só é excluído com `remove_settlement` como `true`, que remove a liquidação, e o conciliado com `undo_bank_reconciliation` como `true`. Num parcelamento ou recorrência, `recurrence_scope` com `this_and_following` apaga também os lançamentos seguintes sem movimentação, como a opção "Excluir este e próximos" do Monde. Não exige `Idempotency-Key`. - Nova permissão **Excluir** em Contas a Pagar e Receber, oferecida na credencial da API; o lançamento liquidado exige também **Editar liquidadas**, e sem ela responde 403 antes de qualquer recusa com 409. Pela conexão automática, o parceiro recebe **Excluir as próprias contas** e só exclui o lançamento que ele mesmo criou: o de outra origem responde 403, ou 404 quando o parceiro não tem a permissão de ler contas a pagar e receber. ## 2026-10-14 ### Vendas - **Mudança no contrato:** em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), cada produto pago de `payments[].*.products[]` passou a apontar o produto por `sale_product_local_id` (um produto enviado na mesma requisição) ou por `sale_product_id` (um produto que a venda já tem, só na alteração), no lugar de `local_id`, `external_id` e `id`. O valor destinado ao produto passou a se chamar `amount`, no lugar de `payment_amount`, como na consulta da venda. Por enquanto, `local_id`, `external_id` e `payment_amount` seguem aceitos, para não quebrar quem já os envia: migre para os nomes novos. Como o `sale_product_local_id` aponta só o valor, dois produtos da venda não podem mais usar o mesmo valor como chave, nem um em `local_id` e o outro em `external_id`. - **Mudança no contrato:** cada item de `payments` passou a ter uma única forma de pagamento: `agency` ou `vendor`, com uma só forma dentro. Para pagar com duas formas, envie dois pagamentos. Assim cada pagamento enviado volta com um `id` só. - **Mudança no contrato:** em [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch), o `local_id` passou a ser obrigatório em cada pagamento novo de `payments` e único entre os pagamentos novos da requisição; o pagamento sem ele é recusado com 422. É ele que volta na resposta, dentro do pagamento, ao lado do `id` gerado, que você usa para manter o pagamento na próxima alteração. O pagamento mantido pelo `id` não precisa dele. ### Licença e permissão - A API deixou de exigir a licença de API: toda empresa com licença ativa do Monde pode ser usada, desde que a credencial tenha as permissões concedidas nela. A empresa sem licença ativa do Monde responde `403` com "A empresa não tem licença ativa do Monde. Contate o nosso time de suporte para mais informações.". - As gravações seguem a licença da própria empresa: na empresa com licença somente leitura, a consulta continua respondendo e a gravação responde `403`. - [Guias](#tag/Guias) passam a exigir a licença Monde Pro na empresa do guia. Sem ela, a resposta é `403` com "Este recurso exige a licença Monde Pro. Contate o nosso time de suporte para mais informações."; com a licença Monde Pro somente leitura, os guias são consultados, mas não gravados. O `public_url` fica nulo quando a empresa está somente leitura, não tem a licença Monde Pro ou tem a licença Monde Pro somente leitura. - A [Conexão automática](#tag/Conexao-automatica) deixou de exigir licença para qualquer permissão: o consentimento oferece todas as empresas ativas da agência, e nenhuma é recusada por licença. - A gravação em empresa somente leitura passa a responder `403` com mensagem própria, "A empresa está somente leitura: os registros dela podem ser consultados pela API, mas não gravados.", no lugar de "Sua licença não dá acesso a esta ação.". Vale para toda gravação: vendas, tarefas e o histórico delas, pessoas, contas a pagar e receber, anexos e guias, inclusive pela [Conexão automática](#tag/Conexao-automatica), e para a troca de empresa da tarefa ou do guia para uma empresa somente leitura. "Sua licença não dá acesso a esta ação." fica só para a licença Monde Pro somente leitura, nos guias. A consulta segue liberada. ### Contas a Pagar e Receber - [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post): a conta prevista (`account_id`) passa a aceitar qualquer conta ativa vinculada à empresa, inclusive conta cartão de crédito na conta a receber, como no Monde. A conta cartão continua fora das movimentações da conta a receber. - [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) passa a recusar operação própria (`operation_id`) inativa. - Novo endpoint [Alterar conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/patch), para todo tipo de lançamento, em aberto ou liquidado, com as regras do lançamento manual do Monde. Só os campos informados mudam: pessoa, descrição, documento, emissão, vencimento, conta prevista, operação própria, observações, campos personalizados, valor (`amount`), categorias, rateios por centro de custo e entre empresas e a empresa do lançamento (`company_identifier`). As categorias e cada rateio enviados substituem os atuais; o valor enviado sem as categorias segue a regra do Monde: com uma categoria só, ela acompanha o novo valor; com mais de uma, ele precisa ser igual à soma delas. Levar o lançamento para outra empresa exige a permissão de inserir e editar também nela, e o lançamento com boleto registrado ou emitido não muda de empresa. Num parcelamento ou recorrência, `recurrence_scope` com `this_and_following` leva a alteração também aos lançamentos seguintes da série, em segundo plano, como a opção "Atualizar este e próximos" do Monde. - Travas por tipo, como no Monde: no gerado por venda, pessoa, empresa e valor não mudam; na fatura de cliente e de fornecedor, pessoa, empresa e valor original não mudam; na fatura de cartão, vencimento, empresa e valor não mudam, e ela não aceita categorias nem rateios. A categoria gerada pelo sistema é reenviada como está. A operação própria só é aceita no lançamento avulso sem número de fatura. O lançamento excluído e a fatura inválida respondem 409, e a fatura de cartão também, enquanto a edição dela não estiver liberada para a agência. - No lançamento liquidado, mudam também a data de liquidação (`settlement_date`) e as movimentações que ele já tem (`movements`, cada uma pelo `id`), sem acrescentar nem retirar movimentação, sem liquidar e sem estornar. As movimentações precisam somar o valor final, e a empresa do lançamento liquidado não muda. Exige, além de **Inserir e editar**, a nova permissão **Editar liquidadas** em Contas a Pagar e Receber, oferecida na credencial da API. O lançamento com movimentação conciliada responde 409, com o aviso do Monde, até o pedido trazer `undo_bank_reconciliation` como `true`; com a confirmação, a conciliação da movimentação alterada é desfeita. - Pela conexão automática, o parceiro recebe **Inserir e editar as próprias contas** no lugar de **Inserir e editar** e só cria e altera o lançamento que ele mesmo criou: o de outra origem responde 403, ou 404 quando o parceiro não tem a permissão de ler contas a pagar e receber. Na alteração do lançamento que ele criou, a resposta traz o lançamento completo mesmo sem a permissão de leitura. ### Anexos - [Enviar anexo](#tag/Anexos/paths/~1attachments/post) passou a aceitar `bill` em `resource_type`: informe o `resource_id` da conta a pagar ou receber de destino e o anexo entra no lançamento, aparecendo na consulta da conta por ID e no download. Exige, em **Contas a Pagar e Receber**, a permissão **Adicionar anexos**, que passou a ser oferecida na credencial da API, concedida na empresa do lançamento, que não pode ser somente leitura. O restante do envio não muda: um arquivo por requisição, as mesmas extensões, o mesmo limite de 12 MB e o mesmo `Idempotency-Key`. - Pela conexão automática, o parceiro só [envia anexo](#tag/Anexos/paths/~1attachments/post) na venda e na conta a pagar ou receber que ele mesmo criou: a de outra origem responde 422 como registro não encontrado quando ele não tem a permissão de ler o recurso, e 403 quando tem. Em vendas, a de outra origem respondia sempre 403. Em compensação, ele [baixa o anexo](#tag/Anexos/paths/~1attachments~1{id}~1download/get) da venda e da conta que criou também só com **Adicionar anexos**, sem a permissão de leitura. ### Vendas - A documentação do `exchange_rate` dos produtos e do `payment_amount` dos pagamentos de [Criar venda](#tag/Vendas/paths/~1sales/post) passou a explicar como o câmbio é aplicado: cada valor é convertido e arredondado em 2 casas separadamente, e o total do produto é a soma desses valores. O cálculo não mudou; quem soma na moeda de origem e converte uma vez só pode chegar a centavos de diferença e ter o fechamento recusado por saldo pendente. ## 2026-10-13 ### Guias - Novo recurso [Guias](#tag/Guias), com [Consultar guias](#tag/Guias/paths/~1guides/get), [Consultar guia por ID](#tag/Guias/paths/~1guides~1{id}/get), [Criar guia](#tag/Guias/paths/~1guides/post), [Alterar guia](#tag/Guias/paths/~1guides~1{id}/patch) e [Excluir guia](#tag/Guias/paths/~1guides~1{id}/delete). O guia é um conteúdo em HTML com link público, sem pessoa vinculada e sem validade, e existe só nas empresas com a licença da API Monde. Exige as novas permissões de guias da credencial. ### Contas a Pagar e Receber - [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) passa a gerar mais de um lançamento a partir de uma só chamada: o parcelamento (`recurrence_kind: installment`, com `periodicity` e o total de `installments`), a recorrência (`recurrence_kind: recurrent`, pelos próximos 5 anos) e o pagamento parcial (`partial_payment: true`), em que o saldo vira um novo lançamento em aberto. A série é gerada em segundo plano, como no Monde: a resposta traz o `recurrence_group_id`, e os lançamentos da série se consultam pelo novo filtro `recurrence_group_id` de [Consultar contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get). O saldo do pagamento parcial vem na hora, em `generated_bills`. - [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) ganha o campo `recurrence_status`: `pending` enquanto a série do parcelamento ou da recorrência não foi gerada, `generated` quando já foi, e `retrying` quando a última tentativa falhou e o Monde vai tentar de novo. ### Especificação OpenAPI - Toda operação ganhou um `operationId` estável (por exemplo `listSales`, `createSale` e `getPerson`), que geradores de SDK e ferramentas de agentes de IA usam como nome da função. - A disponibilidade de cada endpoint fica só na etiqueta (**Beta** ou **Em desenvolvimento**, no `x-badges`): o aviso que se repetia no começo de toda descrição saiu. - Toda resposta em JSON, inclusive as de erro, traz um exemplo do corpo. - A especificação também está em `https://web.monde.com.br/api/v3/openapi.yaml`, com `Content-Type: application/yaml`. O endereço `/api/v3/documentation/file` continua valendo. ## 2026-10-12 ### Orçamentos - [Consultar orçamentos](#tag/Orcamentos/paths/~1quotes/get) e [Consultar orçamento por ID](#tag/Orcamentos/paths/~1quotes~1{id}/get) deixaram de trazer o campo `details_format`: todo orçamento tem os detalhes (`details`) em HTML, com as imagens em ``. ## 2026-10-09 ### Perguntas frequentes - Nova seção [Perguntas frequentes](#tag/Perguntas-frequentes), com as dúvidas que mais chegam sobre acesso, limites, consulta de vendas e gravação, cada uma com a resposta curta e o link para a seção que detalha o assunto. ### Consultas por ID, Marcadores e Categorias de Tarefas - As consultas por ID que ainda levavam a etiqueta **Em desenvolvimento** passaram a **Beta**: elas já respondiam e agora estão marcadas como disponíveis. São as de [Viagens](#tag/Viagens/paths/~1travels~1{id}/get), [Tarefas](#tag/Tarefas/paths/~1tasks~1{id}/get), [Produtos](#tag/Produtos/paths/~1products~1{id}/get), [Vendedores](#tag/Vendedores/paths/~1sellers~1{id}/get), [Orçamentos](#tag/Orcamentos/paths/~1quotes~1{id}/get), [Contas e Cartões](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get), [Formas de Pagamento](#tag/Formas-de-Pagamento/paths/~1payment_methods~1{id}/get), [Categorias](#tag/Categorias/paths/~1categories~1{id}/get), [Centros de Custo](#tag/Centros-de-Custo/paths/~1cost_centers~1{id}/get), [Cidades](#tag/Cidades/paths/~1cities~1{id}/get), [Moedas](#tag/Moedas/paths/~1currencies~1{code}/get), [Integrações](#tag/Integracoes/paths/~1integrations~1{id}/get), [Regras da Nota Fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules~1{id}/get) e [Regras de Faturamento](#tag/Regras-de-Faturamento/paths/~1invoice_rules~1{id}/get). - Pelo mesmo motivo, [Marcadores](#tag/Marcadores) e [Categorias de Tarefas](#tag/Categorias-de-Tarefas), na consulta em lista e na por ID, passaram a **Beta**. ### Contas a Pagar e Receber - Em [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post), a recusa feita pelo banco, como o caixa do dia fechado, passa a vir como o Monde a mostra: sem a marca `ValidationError:` e com a data formatada (`O caixa do dia "10/10/2026" da conta "Caixa" está fechado.` no lugar de `ValidationError: O caixa do dia "#Date(2026-10-10)#"…`). ## 2026-10-08 ### Vendas - **Mudança de comportamento:** [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a respeitar a configuração **Não permitir cadastrar vendas fora de viagens**, por empresa. Com ela ligada na empresa do `company_identifier`, a criação é recusada com 422 e a mensagem informa a empresa, como no Monde, que não deixa cadastrar venda fora de uma viagem nessa empresa. Antes a venda era criada solta. A API ainda não cria venda dentro de uma viagem; quem integra com essa empresa precisa desligar a configuração ou usar outra empresa. ### Categorias - [Consultar categorias](#tag/Categorias/paths/~1categories/get) e [Consultar categoria por ID](#tag/Categorias/paths/~1categories~1{id}/get) passaram a trazer o tipo da categoria (`kind`): `expense` (despesa) ou `revenue` (receita), herdado do grupo. Num lançamento financeiro, a categoria `revenue` soma ao valor do lançamento `credit` (a receber) e abate do lançamento `debit` (a pagar); a categoria `expense` faz o contrário. ### Contas a Pagar e Receber - Nova operação [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) (`POST /bills`), em aberto, com as regras do lançamento manual do Monde: a soma com sinal das categorias forma o valor final, o rateio por centro de custo fica entre 0 e 100%, o rateio entre empresas fecha 100%, e os bloqueios de vencimento e de acréscimo e desconto da empresa valem sempre. Exige a nova permissão de inserir e editar contas a pagar e receber e a chave de idempotência. - [Inserir conta a pagar ou receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/post) também cria o lançamento já liquidado, com `settlement_date` e as `movements`: a soma das movimentações fecha com o valor final, a forma de pagamento segue o tipo da conta, e o bloqueio da data de movimentação e o caixa fechado valem como no Monde. A liquidação parcial ainda não é aceita. Sem `issue_date`, a emissão passa a ser hoje ou o vencimento ou a liquidação, quando forem anteriores, em vez de recusar o vencimento já passado. O erro de um item de lista do lançamento traz a posição do item, a partir de 0, como em `'movements[1] account_id'`. ### Todas as gravações - A lista enviada como objeto de posições numeradas (como `"labels": { "0": { "id": "" } }` no lugar de `"labels": [{ "id": "" }]`) passa a responder 422, com o nome do campo, e nada é gravado. Antes ela podia responder 500. ### Vendas - **Mudança no contrato:** em [Inserir venda](#tag/Vendas/paths/~1sales/post), quem recebe cada comissão do array `commissions` passou a vir no objeto `person`, com os mesmos campos do intermediário, no lugar do `external_id`. Como nos passageiros, a pessoa é procurada pelo `external_id` e, sem vínculo, pelo CPF/CNPJ; não achando, é cadastrada. Antes o `external_id` precisava já estar vinculado a uma pessoa, e a comissão não cadastrava ninguém. Como no Monde, o `kind` não restringe quem recebe: a comissão de vendedor pode ir para qualquer pessoa. Sem `description`, `seller` e `intermediary` gravam "Comissão Vendedor" e "Comissão Intermediário". A comissão que ainda mandar só o `external_id` é recusada com 422. ## 2026-10-07 ### Vendas - **Operadora:** a venda passou a seguir as regras de cálculo da operadora, como no Monde. Na criação, a comissão, o over e a comissão do intermediário ficam na moeda de origem do produto, calculados sobre o total dos produtos nessa moeda, e a receita e o faturamento do produto seguem as fórmulas da operadora. O intermediário (`intermediary`) passou a ser obrigatório, com a venda aberta ou fechada, e é ele quem deve a fatura do cliente, pelo total do cliente já descontada a comissão do intermediário. Ao [excluir a venda](#tag/Vendas/paths/~1sales~1{id}/delete), o saldo que volta a ser devido também fica com o intermediário, e não com o pagante. O que se deve ao fornecedor fica na moeda de origem do produto. Os valores convertidos são arredondados em 2 casas. Pagamento ao fornecedor (`payments.vendor`) de produto com moeda de origem diferente de BRL é recusado com 422. Na agência nada muda. - **Mudança na consulta, na operadora:** em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get), `commission_amount`, `over_amount`, `intermediary_commission_amount` e `intermediary_over_amount` vinham na moeda de origem do produto, sem indicação. Passaram a vir na moeda final da venda, como os demais valores, e a receita da venda (`totals.revenue`) também. Na agência os valores não mudam. - Os produtos da venda passaram a trazer `commission_amount_origin_currency`, `over_amount_origin_currency`, `intermediary_commission_amount_origin_currency` e `intermediary_over_amount_origin_currency`, o valor na moeda de origem, como já acontecia com a taxa de serviço e o desconto. - **Operadora:** [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a aceitar a moeda de venda por produto, no novo campo `sale_currency` (padrão BRL). Como no Monde, `currency` é a moeda de origem, em que o fornecedor recebe, e `exchange_rate` converte a origem na moeda de venda: com moedas iguais o câmbio é 1, com moedas diferentes ele é obrigatório, inclusive quando a origem é BRL. A fatura do cliente e os pagamentos (`payments`) saem na moeda de venda, e cada pagamento só agrupa produtos com a mesma moeda de venda. O pagamento ao fornecedor (`payments.vendor`) passa a ser recusado com 422 quando a moeda de origem é diferente da moeda de venda, e não mais quando ela é diferente de BRL. Na consulta, `currency` devolve a moeda de venda do produto. Na agência, moeda de venda diferente de BRL é recusada com 422. - No pagamento à agência (`payments.agency`) com `settlement_date`, a conta bancária pode estar em outra moeda que a do pagamento, como no Monde. A liquidação converte pelo novo campo `settlement_exchange_rate`, da moeda do pagamento para a moeda da conta, ou, quando ele é omitido, pela razão entre as últimas cotações das duas moedas; sem a cotação de alguma delas, a resposta é 422. Antes o valor entrava na conta sem conversão. Com a conta na moeda do pagamento, `settlement_exchange_rate` deve ser 1 ou omitido. O boleto (`bank_slip`) passa a aceitar só produtos com moeda de venda BRL, com 422 nas demais. ## 2026-10-06 ### Vendas - Nova operação [Excluir venda](#tag/Vendas/paths/~1sales~1{id}/delete) (`DELETE /sales/{id}`). Como no Monde, a venda não é apagada: passa a ter `status` igual a `canceled`, e o Monde desfaz logo depois o que ela gerou no financeiro. As mesmas regras do Monde impedem a exclusão (venda fechada, produto cancelado, conta liquidada, item já faturado para o fornecedor, reembolso, fatura de cliente fechada), com resposta 409 e o motivo. A venda com recibo impresso é excluída. Exige a nova permissão de excluir vendas. Na conexão automática, o parceiro com a permissão de excluir as próprias vendas exclui só as vendas que a integração criou. - Nova operação [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) (`PATCH /sales/{id}`). Altera a venda aberta: o campo omitido permanece como está, e cada lista enviada substitui a atual (os produtos de cada tipo, os passageiros e trechos de cada produto enviado, `payments` e `commissions`). O campo enviado como `null` é retirado da venda (`intermediary`, `approver`, `requester`, `operation_id` e `operation`; a `operation_id` só sai junto do produto de operação própria que a sustenta), e o campo personalizado enviado em branco é limpo, menos o obrigatório. No produto alterado, o que o payload não traz, inclusive passageiros e trechos, permanece, e a lista de passageiros ou de trechos enviada vazia é recusada. No transporte terrestre e no bilhete de trem, cujos trechos ficam no texto dos serviços inclusos, os `segments` reenviados exigem o `included_services` junto, que grava como veio. A lista enviada como `null` equivale à lista vazia, com as mesmas travas; nos campos personalizados, que não são substituídos, ela não altera nada. Vale também para as listas de dentro de um item: os `seats` de um trecho enviado podem ir omitidos, vazios ou como `null`, e o pagamento novo com `products` vazio ou `null` é recusado. O produto que a venda já tem é apontado pelo `id` da consulta por ID; o produto sem `id` é incluído, e o que não vier na lista do seu tipo é excluído. Em `payments`, o pagamento enviado só com o `id` fica como está, o sem `id` é incluído e o que não vier é removido; no pagamento novo, o produto pago é apontado por `sale_product_local_id`, para um produto da mesma requisição, ou por `sale_product_id`, para um produto que a venda mantém. Os totais são recalculados, e o saldo do pagante e o valor a faturar ao fornecedor são ajustados pela diferença. O que já foi conciliado no financeiro não sai: a remoção de pagamento liquidado ou em fatura de cliente fechada responde 422, assim como valor do fornecedor em fatura fechada, liquidada ou avulsa e comissão paga. A venda excluída não pode ser alterada (409). Na venda fechada, como no Monde, só mudam o vendedor, o solicitante, o aprovador, os campos personalizados e as comissões, e o `status` só aceita `closed` (o resto responde 409). As comissões vêm no mesmo formato da criação, com quem recebe no objeto `person`. A venda pode ir para outra empresa em que a credencial também possa alterar venda, com as travas do Monde. Cada campo alterado vai para o log da venda. Exige a permissão "Criar e editar" na empresa da venda, ou "Criar e editar as próprias vendas" para a venda que a própria credencial criou. - [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passaram a trazer, em cada produto e pagamento enviado, o `local_id` com que ele veio ao lado do `id` gerado. A credencial sem permissão de leitura recebe só esses identificadores, no mesmo formato da venda, em vez de só o `id` da venda. Na consulta da venda, o pagamento ao fornecedor e os pagamentos à agência em `credit` e `legacy` passaram a trazer o `id`. - [Inserir venda](#tag/Vendas/paths/~1sales/post) e [Alterar venda](#tag/Vendas/paths/~1sales~1{id}/patch) passaram a gravar o vendedor da venda como vendedor responsável no cadastro do pagante, como a tela de vendas do Monde faz. ### Vendas, Contas a Pagar e Receber e Notas Fiscais - Em [Consultar vendas](#tag/Vendas/paths/~1sales/get), [Consultar contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get) e [Consultar notas fiscais](#tag/Notas-Fiscais/paths/~1nfs/get), o filtro `status` enviado como lista ou valor aninhado (como `?status[]=open`) continua respondendo 400, mas a mensagem passa a dizer que o parâmetro não aceita listas nem valores aninhados, como na paginação. Antes a mensagem dizia apenas que o valor não era válido. Em vendas e em contas a pagar e receber, para filtrar por mais de uma situação, envie os valores separados por vírgula (como `?status=open,overdue` em contas). ## 2026-10-05 ### Vendas - [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a aceitar o centro de custo do passageiro (`passengers[].cost_center`, até 50 caracteres), em todos os produtos com passageiros. Como no Monde, quando o pagante é pessoa jurídica o centro de custo precisa ser um dos cadastrados nele, sem diferenciar maiúsculas de minúsculas, e é gravado com o nome como está no cadastro; fora do cadastro, a resposta é 422 e nada é gravado. Com pagante pessoa física, ou com a configuração de vendas **Informar o centro de custo em texto livre** ligada, aceita qualquer texto. Antes o campo só vinha na consulta e era ignorado na criação. - [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a gravar o assento por trecho da passagem aérea, em `airline_tickets[].segments[].seats`. Cada assento aponta o passageiro pelo `ticket_number`, que precisa ser o bilhete de exatamente um dos passageiros do produto: o bilhete que não é de nenhum passageiro, ou que é de mais de um, responde 422 e nada é gravado. O mesmo passageiro não pode ter dois assentos no mesmo trecho. O `seat_number` aceita até 3 caracteres e é gravado em maiúsculas. Antes o campo era só documentado e ficava fora do que a API processava. - [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passou a trazer os assentos em cada trecho da passagem aérea (`segments[].seats`), no mesmo formato da criação. O assento informado no Monde para um passageiro ainda sem bilhete vem com o `ticket_number` nulo. O passageiro continua sem o `seat`. ### Idempotência - A chave de [idempotência](#tag/Idempotencia) passou a expirar: depois de pelo menos um dia da primeira requisição, ela é descartada na limpeza seguinte, que roda uma vez por dia, e reenviar a mesma chave é processado como uma requisição nova. Antes, a chave de uma requisição concluída devolvia a resposta em cache (`X-Idempotent-Replay: true`) para sempre. ### Vendas e Tarefas - Em [Inserir venda](#tag/Vendas/paths/~1sales/post), [Criar tarefa](#tag/Tarefas/paths/~1tasks/post) e [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch), o `company_identifier` de uma empresa em que a credencial não tem permissão nenhuma passou a ser respondido como CNPJ não encontrado (422, com erro no campo), igual ao CNPJ que não é empresa da agência. Antes a resposta era 403, o que deixava qualquer credencial descobrir quais CNPJs são empresas ativas da agência. Na empresa em que a credencial tem alguma permissão, mas não a da operação, a resposta continua 403. ## 2026-10-02 ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a aceitar o produto **Outros** no campo `others` (lista; a venda pode ter vários). O produto é informado por `product_id`, entre os produtos Outros do catálogo da agência (`GET /products?kind=others`). Conforme a configuração do produto, os valores vão por `passengers` ou por `quantity` × `unit_price` (com `unit_fee` e a taxa de serviço oculta `agency_fee`). O fornecedor (`supplier`) é obrigatório e o representante (`representative`) é opcional. Também aceita `destination` (`national` ou `international`). - Nos produtos sem passageiros (Outros e operação própria), `unit_fee` passou a ser em reais (BRL), como no Monde: o total de taxas é `quantity` × `unit_fee`, sem aplicar o câmbio do produto. Antes, a taxa unitária era multiplicada pelo câmbio. Em produto em BRL nada muda. - O produto Outros e a operação própria (`operation.product_id` e `operation_id`) precisam estar ativos no catálogo, como no Monde, que só oferece os produtos ativos na venda. O produto inativo, que aparece em `GET /products` com `active: false`, é recusado com 422. Antes a operação própria inativa era aceita. - Em Outros e na operação própria, `quantity` aceita no máximo 2147483647. Acima disso a resposta é 422, com o nome do campo, e nada é gravado. Antes essa quantidade dava 500. O total da linha que a quantidade gera ainda não é conferido, como nos demais valores calculados. - [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passou a trazer, em Outros, `agency_fee` e `agency_fee_origin_currency`, a taxa de serviço oculta da linha, como na operação própria. Vêm nulos no produto com passageiros, em que a taxa vem em cada passageiro. - [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a aceitar excursões no array `excursions`, uma ou mais por venda. A excursão é um produto do sistema, então não se informa qual produto está sendo vendido. São obrigatórios o `document` (até 40 caracteres), a data de partida (`departure_date`), a moeda, o fornecedor e ao menos um passageiro. A data de chegada (`arrival_date`) é opcional e não pode ser anterior à partida. Também entram as observações (`observations`), os serviços inclusos, o representante e os valores do produto (comissão, comissão do intermediário, taxa de serviço, desconto e câmbio). O passageiro recebe valor, taxas, taxa RAV e o desconto dela, taxa de serviço oculta e documento. Se o produto Excursão estiver inativo no Monde, ele é ativado ao criar a venda, como acontece ao vendê-lo pelo sistema. ## 2026-10-01 ### Vendas - [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a aceitar passagem aérea no array `airline_tickets`, com os trechos em `segments` e os passageiros. A companhia aérea é identificada pelo código IATA/ICAO em `airline_code` ou pelo CNPJ: quando já existe uma companhia com aquele código, ela é reaproveitada; senão, é criada. A taxa DU de cada passageiro (`du_fee`), menos o desconto dela (`du_fee_discount`), entra no total do passageiro e no do produto. O desconto de DU só pode ser informado quando o `du_fee` for maior que zero, como no Monde. As taxas CC DU e CC RAV (`cc_du_fee`, `cc_rav_fee`) ficam no produto e são descontadas da receita da agência. A origem e o destino de cada trecho precisam ser um aeroporto cadastrado; um código IATA desconhecido é recusado. Espaços antes ou depois dos códigos de companhia e de aeroporto são descartados, e o tamanho máximo vale para o código sem eles. O `flight_number` aceita só números, e o `emission_name` aceita até 50 caracteres. O assento por trecho (`segments[].seats`), que aponta o passageiro pelo `ticket_number`, e o `original_ticket_number` do passageiro estão apenas documentados, pois o sistema ainda não os processa. - Na consulta de vendas, o passageiro do aéreo deixou de trazer o `seat`. O assento é de cada trecho, e não do passageiro, e passará a vir nos trechos quando o sistema gravá-lo por trecho. - Na consulta de vendas, o `class` do trecho aéreo deixou de vir com espaço no final quando a classe tem uma letra só (`"A"` em vez de `"A "`). ## 2026-09-30 ### Vendas - [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a respeitar a configuração **Validar cadastro do pagante**: com ela ligada, o `payer` sem os campos que o Monde exige para salvar a venda (endereço completo, documento, contato e, conforme o tipo de pessoa, data de nascimento ou razão social) é recusado com 422, com um erro por campo faltante, e nada é gravado. Vale o cadastro como fica depois da requisição, inclusive o que ela cria ou completa. Antes a venda era criada mesmo com o cadastro incompleto. Com a configuração desligada, o padrão, nada muda. ### Tarefas - [Consultar tarefa por ID](#tag/Tarefas/paths/~1tasks~1{id}/get) passou a trazer `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](#tag/Tarefas/paths/~1tasks/post), [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch) e [Comentar na tarefa](#tag/Tarefas/paths/~1tasks~1{task_id}~1history/post) também trazem o campo quando devolvem a tarefa completa. ### Viagens - [Consultar viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get) passou a trazer `attachments`, com os anexos da viagem, no mesmo formato da venda. O anexo que também pertence a uma tarefa ou a uma venda não entra na lista, porque o download dele exige a permissão desse outro registro. ### Anexos - [Baixar anexo](#tag/Anexos/paths/~1attachments~1{id}~1download/get) passou a constar na documentação. É o endereço que vem em `download_url`. Ele exige a permissão de leitura do registro dono do anexo: "Ler todas as tarefas", "Ler todas as vendas", "Ler todas as viagens", "Ler todas as contas a pagar e receber" ou "Ler todas as pessoas". ### Pessoas e Vendas - Em [Inserir pessoa](#tag/Pessoas/paths/~1people/post), [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) e [Inserir venda](#tag/Vendas/paths/~1sales/post), o `city_ibge` do endereço e da naturalidade (`birthplace`) passa a definir a cidade, que precisa estar cadastrada. O código que não corresponde a nenhuma cidade responde 422 em `city_ibge`, mesmo com nome, estado e país informados, e nada é gravado. Antes a resposta era de sucesso: a pessoa ficava sem a naturalidade, ou a cidade era criada com o código inválido. Para cadastrar uma cidade nova, envie `city_name`, `state_code` e `country_code` sem o `city_ibge`: a cidade é criada sem código IBGE. - Com o `city_ibge`, o `state_code` enviado diferente do estado da cidade responde 422 em `state_code`, e o `country_code` enviado diferente de `BR` responde 422 em `country_code`. O `city_name` não é conferido. - Na venda, a recusa do endereço do pagante ou de outra pessoa recusa a venda inteira, como as demais validações da pessoa. ## 2026-09-29 ### Vendas - [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passou a trazer a moeda de origem de cada produto. `currency` é a moeda final da venda (BRL nas vendas criadas pela API), e os valores continuam nela, sem mudança. Entrou `origin_currency`, com a moeda em que o produto é originalmente comercializado, e `exchange_rate` passou a trazer o câmbio gravado no produto, no lugar do 1 fixo. - Cada valor que o Monde grava nas duas moedas ganhou um par com o sufixo `_origin_currency`, na moeda de origem: nos produtos (`agency_service_fee`, `deductions`, `discount_amount`), nos `totals` e nos passageiros (ex.: `amount` e `amount_origin_currency`). Comissão, over e os valores do intermediário não têm par. Isso corrige a regra da entrada de 2026-08-11, em que `currency` e `exchange_rate` devolviam sempre BRL e 1. - Na operação própria sem passageiros, `agency_fee` passa a vir na moeda final da venda, como os demais valores, e ganhou o par `agency_fee_origin_currency`. Antes vinha na moeda de origem. No envio nada muda: `agency_fee` continua sendo informado na moeda de origem. ## 2026-09-28 ### Conexão automática - A seção [Conexão automática](#tag/Conexao-automatica) passou a trazer os exemplos completos de requisição e resposta da homologação, da troca do code pelo token e da revogação, o que chega na `redirect_uri` quando a agência aprova ou recusa (com o `state`), e os erros de cada etapa. - A revogação pelo parceiro, em `POST /oauth/revoke`, passou a estar documentada: ela exclui a conexão com a agência na hora. ### Pessoas, Vendas, Tarefas e Cidades - Em [Inserir pessoa](#tag/Pessoas/paths/~1people/post), [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch), [Inserir venda](#tag/Vendas/paths/~1sales/post), [Criar tarefa](#tag/Tarefas/paths/~1tasks/post), [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch) e [Comentar na tarefa](#tag/Tarefas/paths/~1tasks~1{task_id}~1history/post), 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": [""]` no lugar de `"labels": [{ "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](#tag/Pessoas/paths/~1people/get) e [Consultar cidades](#tag/Cidades/paths/~1cities/get), o filtro enviado como lista ou valor aninhado (como `?name[]=Ana`) passa a responder 400, com o nome do parâmetro. Antes o filtro era ignorado e a consulta devolvia a lista sem ele. ## 2026-09-25 ### Cidades - [Consultar cidades](#tag/Cidades/paths/~1cities/get) passou a aceitar o filtro `name`, que busca pelo nome da cidade por trecho, sem diferenciar maiúsculas, acentos nem a posição do trecho no nome (ex.: `?name=sao paulo`). O filtro combina com a paginação e a ordenação por nome. ### Tarefas - [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch) 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](#tag/Tarefas/paths/~1tasks~1{id}/delete) passou a estar disponível: exclui a tarefa, que deixa de aparecer em [Consultar tarefas](#tag/Tarefas/paths/~1tasks/get) 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](#tag/Tarefas/paths/~1tasks~1{id}/patch) e [Comentar na tarefa](#tag/Tarefas/paths/~1tasks~1{task_id}~1history/post) respondem 409. - [Alterar tarefa](#tag/Tarefas/paths/~1tasks~1{id}/patch) e [Comentar na tarefa](#tag/Tarefas/paths/~1tasks~1{task_id}~1history/post) respondem apenas com o `id` da tarefa quando a credencial não tem a permissão **Ler todas as tarefas** na empresa da tarefa. A gravação acontece do mesmo jeito, com o mesmo status. Quem tem a permissão de ler continua recebendo a tarefa completa, no mesmo formato da consulta por ID. ### Pessoas - [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) passa a responder apenas com o `id` da pessoa quando a credencial não tem a permissão "Ler todas as pessoas". A alteração é gravada do mesmo jeito, com o mesmo status 200. Quem tem a permissão de ler continua recebendo a pessoa completa, no mesmo formato da consulta por ID. ## 2026-09-24 ### Tarefas - [Criar tarefa](#tag/Tarefas/paths/~1tasks/post) 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](#tag/Tarefas/paths/~1tasks~1{task_id}~1history/post) acrescenta um comentário ao histórico de uma tarefa existente e devolve a tarefa com o histórico atualizado. Quem participa da tarefa é avisado por e-mail. O histórico é só acréscimo: não há como alterar nem excluir um comentário já registrado. - As duas escritas exigem a permissão **Criar e editar** em Tarefas, que passou a ser oferecida na credencial. - Na consulta de tarefas, `due` e `completed_at` passaram a sair sem o fuso horário, no mesmo formato de `created_at` e dos demais campos de data e hora da API: `2026-04-01T09:00:00` no lugar de `2026-04-01T09:00:00-03:00`. O horário é o mesmo. ### Pessoas - Na consulta de pessoas, `last_contacts.last_task_update_at` passou a sair sem o fuso horário, no mesmo formato das demais datas de `last_contacts` e dos outros campos de data e hora da API: `2026-07-01T15:12:00` no lugar de `2026-07-01T15:12:00-03:00`. O horário é o mesmo. ### Conexão automática - A seção Credenciamento de fornecedores passou a se chamar [Conexão automática](#tag/Conexao-automatica) e vale para qualquer parceiro, não só para quem cria vendas. - As permissões do parceiro passam a ser definidas na homologação, e a agência vê essa lista no consentimento antes de autorizar. O parceiro homologado antes disso continua com a criação de vendas. - Criar vendas pela integração não exige licença de API. Permissões fora de Vendas exigem licença de API na empresa escolhida. - O parceiro com a criação de vendas não lê vendas: a venda criada volta completa na resposta do `POST /sales`. Anexos só entram na venda que o próprio parceiro criou. ## 2026-09-22 ### Pessoas - [Excluir pessoa](#tag/Pessoas/paths/~1people~1{id}/delete) passou a estar disponível: exclui em definitivo a pessoa que não tem registros vinculados (vendas, lançamentos financeiros, notas fiscais, orçamentos, tarefas, anexos, entre outros) e que não é usuário nem empresa do sistema. Nesses casos a resposta é 409, com o motivo, e nada é alterado. Responde 204 sem corpo e não exige `Idempotency-Key`. Exige a permissão "Excluir" em Pessoas, que passou a ser oferecida na credencial da API, concedida numa empresa com licença de API que grave. ### Logs - A descrição de todo log gravado por uma requisição da API passa a começar com a ação e o rótulo da credencial que a fez: `Inserido via API pela credencial "..."`, `Editado via API pela credencial "..."` ou `Excluído via API pela credencial "..."`. As linhas seguintes, com os campos alterados, não mudaram. Vale para tudo o que a requisição grava: o registro, os vínculos gravados junto com ele (como os marcadores e os contatos da pessoa) e os lançamentos que a venda gera no financeiro, inclusive os da fatura do fornecedor. Em [Consultar logs](#tag/Logs/paths/~1logs/get) o `person` desses logs continua nulo, porque a credencial não é uma pessoa. - O log separado com a descrição `Registro cadastrado via API`, que a API gravava junto de cada cadastro, deixou de existir: quem cadastrou passou a ser a primeira linha do log do próprio registro. Em [Consultar logs](#tag/Logs/paths/~1logs/get) o cadastro feito pela API passa a trazer um log a menos. ## 2026-09-21 ### Pessoas - [Alterar pessoa](#tag/Pessoas/paths/~1people~1{id}/patch) passou a estar disponível: altera uma pessoa já cadastrada com os mesmos campos de [Inserir pessoa](#tag/Pessoas/paths/~1people/post). Informe apenas o que deve mudar — o campo omitido, ou enviado como nulo ou como texto vazio, permanece como está, e um campo de texto não é esvaziado por esta operação. O tipo da pessoa não muda, o `external_id` passa a identificá-la desde que não esteja identificando outra, e o CPF/CNPJ e o código de companhia aérea não podem pertencer a outra pessoa. Marcadores e contatos funcionam por substituição: a lista enviada passa a ser a da pessoa, a lista vazia retira todos os itens e o campo omitido mantém os atuais. Os campos personalizados não substituem: cada um enviado é gravado por cima do atual e os demais permanecem. Exige a permissão "Inserir e editar" em Pessoas e o cabeçalho `Idempotency-Key`. ### Vendas - Os totais da venda passaram a considerar o desconto da taxa RAV e a segunda taxa do passageiro (`other_fees`, `tip`). Antes, o desconto informado no passageiro era gravado mas não abatia total nenhum, e a segunda taxa não entrava no total de taxas. Com isso o valor do produto, o total de descontos, as receitas, o faturamento e o saldo da venda passam a bater com o que o Monde calcula na tela. - `rav_fee_discount` só é aceito quando `rav_fee` for maior que zero. Enviar o desconto sem a taxa passa a responder 422, como o Monde já recusa na tela. ### Anexos - [Enviar anexo](#tag/Anexos/paths/~1attachments/post) recusado com 422 passa a liberar a `Idempotency-Key`: reenviar o mesmo anexo com a mesma chave volta a ser processado, em vez de responder 409 indefinidamente. ## 2026-09-18 ### Licença e permissão - As respostas 403 passaram a apontar a causa certa em toda a API. A licença de API é cobrada na empresa em que a credencial trabalha — a empresa do registro consultado, ou a empresa em que a permissão foi concedida —, e não em qualquer empresa da base. Quem tem a permissão numa empresa sem licença de API passa a receber "Você não possui licença de API", no lugar de "Você não tem permissão para executar essa ação". A falta de licença é sempre relatada antes da falta de permissão. ### Anexos - [Enviar anexo](#tag/Anexos/paths/~1attachments/post) 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](#tag/Anexos/paths/~1attachments/post) deixou de exigir a permissão de consultar o recurso de destino: anexar numa venda pede apenas a permissão de anexo em vendas. A resposta muda junto: a venda em que a credencial não pode anexar passa a responder 403, no lugar do 422 "Recurso não encontrado" que saía quando faltava a permissão de consultar vendas. O 422 fica para o `resource_id` que não existe. - O limite de 10 requisições a cada 3 segundos do envio de anexo passa a contar toda tentativa, inclusive a que é recusada por autenticação, por permissão, por licença, por arquivo grande ou por requisição malformada. Uma sequência de tentativas recusadas agora chega ao 429. ### Pessoas - [Inserir pessoa](#tag/Pessoas/paths/~1people/post) 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](#tag/Pessoas/paths/~1people~1{id}/get), 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](#tag/Campos-Personalizados/paths/~1custom_fields~1{id}/get). ### Vendas - Os campos `installments` (cartão de crédito e boleto) e `installment_period` (boleto) saíram dos pagamentos destinados à **agência** em [Criar venda](#tag/Vendas/paths/~1sales/post). 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](#tag/Pessoas/paths/~1people/post). ## 2026-09-15 ### Vendas - O campo que traz o documento do produto passou a se chamar `document` nos produtos em que o Monde escreve "Documento" na tela de cadastro: **locação de veículo** e **pacote de viagem** (antes `booking_number`), **seguro viagem** (antes `voucher_code`), **bilhete de trem**, **transporte terrestre** e **excursão** (antes `locator`). Em **pacote CVC** o mesmo campo passou a se chamar `receipt_number`, o "Recibo Nº" da tela. - Os produtos cujo rótulo na tela já era outro não mudaram: **bilhete aéreo** segue com `locator` ("Localizador"), **hospedagem** segue com `booking_number` ("Reserva"), **cruzeiro** segue com `booking_number` ("Booking"), e **outros** e **operação própria** já usavam `document`. - Na criação de vendas, o documento do passageiro passou a ser informado em `document`, no lugar de `ticket_number`, nos produtos em que o Monde tem esse campo: **seguro viagem**, **transporte terrestre**, **bilhete de trem**, **pacote de viagem** e **operação própria**. O `ticket_number` continua sendo o número do bilhete do passageiro do **aéreo**, na leitura e na criação, e o `ticket_number` de cada assento em `ground_transportations[].segments[].seats[]` não mudou. - O `document` do produto passou a aceitar 40 caracteres em todos os produtos, o mesmo tamanho que o Monde grava. Em **transporte terrestre** e **bilhete de trem** o limite era de 20. - Os nomes antigos seguem aceitos na criação de vendas e seguem saindo na leitura, mas saíram da documentação, que passa a descrever só o nome novo. Eles serão removidos em uma etapa seguinte, com tempo para as integrações existentes se ajustarem. ## 2026-09-14 ### Vendas - Em [Criar venda](#tag/Vendas/paths/~1sales/post), o campo `travel_agent` passou a se chamar `seller`, o mesmo nome que a consulta da venda já usa e o mesmo termo do Monde. - Na consulta de vendas, o passageiro de **Outros**, **Excursão** e **Operação Própria** passou a trazer o `document`, que já é preenchido no Monde mas não era devolvido. Nesses mesmos três produtos, o `other_fees` saiu da resposta, porque eles não têm uma segunda taxa por passageiro. Em **Operação Própria** também saíram `rav_fee`, `rav_fee_discount` e `agency_fee`, que o produto não cobra do passageiro. **Locação de Veículo** não mudou. ## 2026-09-11 ### Produtos - O `kind` dos produtos passou a trazer `excursion` (excursão) e `cvc_package` (pacote CVC). Os pacotes CVC vinham sem tipo na resposta. - O filtro `?kind=` passou a aceitar `cvc_package` e `excursion`, e é descrito como lista de valores: vários tipos separados por vírgula, como em `?kind=insurance,cruise`. A chamada não muda. - Em [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get), o campo `restitutes_lei_kandir` de cada fornecimento passou a se chamar `restitutes_kandir_law`. O valor não muda. - Os produtos de sistema passaram a aparecer nos exemplos com `system: true`, e a descrição do campo foi corrigida: produto de sistema não pode ser excluído, mas pode ser editado. ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post): o cargo da comissão no array `commissions` passou a ser informado pelo campo `kind` (`seller`, `intermediary` ou `person`), em vez de `job_title_id` (UUID). `seller` e `intermediary` gravam o cargo de sistema correspondente; `person` grava sem cargo. O `external_id` do destinatário continua obrigatório. - Na criação de vendas, o campo `ticket_number` do passageiro passou a ser aceito em operação própria, bilhete de trem e pacote de viagem, gravando o documento do passageiro — a mesma coluna que a consulta desses produtos devolve em `document`. - O filtro `?status=` passou a ser descrito como lista de valores: vários status separados por vírgula, como em `?status=opened,closed`. A chamada não muda. ### Contas a pagar e receber - O filtro `?status=` passou a ser descrito como lista de valores: vários status separados por vírgula, como em `?status=open,overdue`. A chamada não muda. ## 2026-09-10 ### Anexos - [Enviar anexo](#tag/Anexos/paths/~1attachments/post) passou a estar disponível: envie um arquivo por requisição em `multipart/form-data`, informando `resource_type` (por ora `sale`) e o `resource_id` da venda de destino, além de `file` e um `description` opcional. Valida a extensão (pdf, imagens, arquivos office, txt, csv), o tamanho máximo de 12 MB e o conteúdo real do arquivo. O anexo passa a aparecer na consulta da venda e no download. Aceita `Idempotency-Key` para reenvio seguro. ## 2026-09-09 ### Vendas - O campo `payer` de cada pagamento passou a aceitar um objeto de pessoa completo, o mesmo do pagante da venda, e cria a pessoa quando ela ainda não existe. Antes, só referenciava por `external_id` alguém já cadastrado. Repetir o `external_id` do pagante da venda resolve para a mesma pessoa. Quando omitido, o pagamento segue herdando o pagante da venda. ## 2026-09-08 ### Autenticação - A autenticação passou a usar o esquema `Bearer` no cabeçalho `Authorization`. A credencial é a mesma e não precisa ser reemitida, então as integrações em produção seguem funcionando. Use `Bearer` daqui em diante. ### Vendas - Em [Criar venda](#tag/Vendas/paths/~1sales/post), 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](#tag/Vendas/paths/~1sales/get) e [Obter venda por ID](#tag/Vendas/paths/~1sales~1{id}/get), os produtos deixaram de trazer o `external_id`. O identificador do produto na leitura é o `id`. ## 2026-09-03 ### Todas as consultas - As consultas de lista passaram a paginar por cursor. A resposta traz `next_cursor` no nó `pagination`, e para pedir a próxima página basta devolvê-lo no parâmetro `cursor`, enquanto `has_next_page` for verdadeiro. Veja a seção de [Paginação](#tag/Paginacao). O parâmetro `page` continua funcionando como antes para quem já integrou, mas não é mais a forma divulgada: pelo `page` o custo de cada página cresce com a profundidade da varredura, e pelo cursor não cresce. Quem pagina por cursor não recebe mais `page` no nó `pagination`. ## 2026-09-02 ### Credenciamento de fornecedores - O fornecedor passou a receber as credenciais numa página própria no Monde (o e-mail traz só o link para ela); o `client_secret` é exibido uma única vez e não é mais enviado por e-mail. A página também traz o snippet do botão "Conectar com o Monde". - O credenciamento ganhou um passo de homologação: confirme suas credenciais em `POST /oauth/homologation` (HTTP Basic com `client_id` e `client_secret`). Enquanto pendente, a autorização não funciona; ao responder `200`, passa a ativo. Veja a seção [Credenciamento de fornecedores](#tag/Conexao-automatica). ## 2026-09-01 ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a aceitar o campo `payer` em cada pagamento (cartão de crédito, boleto e depósito na agência; cartão, crédito e outros no fornecedor), referenciando por `external_id` a pessoa que efetivamente paga aquele pagamento — tipicamente o responsável financeiro informado na venda. Na agência, a Conta a Receber gerada usa esse pagante como Pessoa; no fornecedor, o pagante vai no lançamento da Conta a Pagar. Quando omitido, o pagamento herda o pagante da venda. Um `external_id` que não corresponde a nenhuma pessoa cadastrada devolve 422. ## 2026-08-31 ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a aceitar o `requester` (solicitante), para registrar quem pediu a venda junto da criação. É pessoa física, campo opcional, resolvido por `external_id` (find-or-create), como os demais papéis. ## 2026-08-28 ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a aceitar o array `commissions`, para gravar comissões manuais (vendedor, intermediário ou outra função) junto da venda. O destinatário é referenciado por `external_id`, o mesmo informado no vendedor/intermediário; o cargo vai em `job_title_id`. Só é aceito quando `status` é `closed`; comissão de cargo intermediário exige que a venda tenha intermediário. ## 2026-08-27 ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a devolver 422 quando o CPF/CNPJ de uma pessoa da venda (pagador, fornecedor, passageiro) já pertence a outra pessoa da base, com o erro no campo `cpf_cnpj`. Antes, o conflito de documento estourava erro interno (500). ## 2026-08-26 ### Credenciamento de fornecedores - Fornecedores homologados pelo Monde passaram a criar vendas na API v3 em nome da agência via OAuth 2.0 (Authorization Code + PKCE), sem a agência compartilhar senha de credencial. Veja o passo a passo (autorização na URL raiz, troca do code pelo token e uso do Bearer na URL fixa da v3) na seção [Credenciamento de fornecedores](#tag/Conexao-automatica). A agência revoga o acesso a qualquer momento e a revogação invalida o token na hora. ## 2026-08-24 ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a herdar os serviços inclusos cadastrados no produto. Quando o campo `included_services` do produto da venda não é enviado, o texto do cadastro do produto é gravado; quando é enviado, o texto informado é acrescentado ao do cadastro. Antes, o campo do produto da venda ficava com apenas o que a requisição enviava. ## 2026-08-21 ### Vendas - [Consultar vendas](#tag/Vendas/paths/~1sales/get) passou a filtrar por `number` (um por requisição): informe o número exibido no aplicativo e a consulta devolve a venda correspondente sem precisar traduzir número em UUID antes. Número não inteiro devolve 400. - [Consultar vendas](#tag/Vendas/paths/~1sales/get) passou a filtrar por `updated_since` (data ou data-hora ISO 8601, ex.: `2026-08-01` ou `2026-08-01T14:30:00`; sem fuso, considera Brasília): devolve as vendas atualizadas nesse instante ou depois, para reprocessar só o que mudou desde a última consulta, inclusive no mesmo dia. Um valor inválido devolve 400. ### Viagens - [Consultar viagens](#tag/Viagens/paths/~1travels/get) passou a filtrar por data com `date_field` + `date_from`/`date_to`: escolha a data em `date_field` (`start_date` ou `end_date`, o início e o fim da viagem calculados a partir das vendas vinculadas) e informe o intervalo fechado inclusivo em `date_from`/`date_to` (ISO `YYYY-MM-DD`, ambos opcionais). `date_field` é obrigatório quando há alguma data; data em formato inválido, intervalo invertido (`date_from` maior que `date_to`) ou `date_field` fora da lista devolvem 400. Viagem sem vendas vinculadas não tem datas calculadas e nunca aparece em um intervalo de datas. ### Contas a pagar e receber - [Consultar contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get) passou a filtrar por `number` (um por requisição): informe o número do lançamento exibido no aplicativo. Lançamentos parcelados têm sufixo de parcela (ex.: `362-1`), então informe o número exatamente como aparece. - [Consultar contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get) passou a filtrar por data com `date_field` + `date_from`/`date_to`: escolha a data em `date_field` (`issue_date` = emissão, `due_date` = vencimento, `settlement_date` = liquidação) e informe o intervalo fechado inclusivo em `date_from`/`date_to` (ISO `YYYY-MM-DD`, ambos opcionais). `date_field` é obrigatório quando há alguma data; data em formato inválido, intervalo invertido (`date_from` maior que `date_to`) ou `date_field` fora da lista devolvem 400. Filtrar por `settlement_date` traz só contas liquidadas (as não liquidadas não têm data de liquidação e ficam de fora do intervalo); como o status padrão (`open`, `overdue`) exclui liquidadas, inclua `settled` no parâmetro `status` ao usar `settlement_date`. ## 2026-08-20 ### Vendas - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a aceitar o campo `status`. O padrão continua `opened`; envie `closed` para já criar a venda fechada. O fechamento respeita todas as regras existentes (sem saldo pendente, e na base consolidadora o intermediário é obrigatório) e exige a permissão de fechar venda na credencial. Se a venda não puder ser fechada, a criação inteira é recusada com 422 e nada é gravado. ## 2026-08-17 ### Vendas - [Consultar vendas](#tag/Vendas/paths/~1sales/get) passou a filtrar por data com `date_field` + `date_from`/`date_to`: escolha a data em `date_field` (`sale_date`, `departure_date` ou `return_date`) e informe o intervalo fechado inclusivo em `date_from`/`date_to` (ISO `YYYY-MM-DD`, ambos opcionais). Substitui `period_start`/`period_end`, que foram removidos. `date_field` é obrigatório quando há alguma data; data em formato inválido, intervalo invertido (`date_from` maior que `date_to`) ou `date_field` fora da lista devolvem 400. - Na resposta da venda, `period_start` e `period_end` viraram `departure_date` e `return_date` — mesmos valores (início e fim da viagem, calculados pela menor e maior data dos produtos). ## 2026-08-14 ### Vendas - [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passou a trazer o array `excursions`. - Na criação de vendas, o campo de taxa do passageiro (`fees`) passou a ser aceito em todos os produtos com passageiros — seguro viagem, cruzeiro, hospedagem, transporte terrestre, aluguel de carro, trem, pacote de viagem e operação própria —, alinhado ao que a leitura já usa. `rav_fee`, `rav_fee_discount` e `agency_fee` passaram a ser aceitos nos mesmos produtos, exceto operação própria, cujo passageiro só tem valor e taxa; `other_fees` (hospedagem, aluguel de carro, pacote de viagem) e `tip` (cruzeiro) também passaram a ser aceitos. Nos produtos que tinham nome próprio para a taxa principal — `service_fee` (hospedagem e transporte terrestre) e `booking_fee` (trem) —, os nomes antigos continuam aceitos por enquanto, mas saem da documentação em favor de `fees`. - Corrigido `totals.balance`: vendas criadas pela [Criar venda](#tag/Vendas/paths/~1sales/post) vinham sempre com saldo `0` na leitura, mesmo tendo saldo em aberto real. Passa a refletir o saldo correto tanto na consulta em lista quanto na consulta por ID. ### Pessoas - [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) ganhou o nó `kandir_law`: a retenção de imposto por produto (valor, taxa de embarque, taxa DU/RAV e taxa de serviço, cada uma com o detalhamento por imposto — IR, CSLL, PIS e COFINS — e o total, nos regimes nacional e internacional), com a referência ao produto. Só existe para pessoa jurídica; vem `null` para pessoa física. - `city_inscription` e `tax_identification_number` voltaram para o nível raiz da pessoa. Estavam dentro de `additional_data`, que só existe para pessoa física, mas os dois são dados de pessoa jurídica. ### Regras de faturamento - Em `closing.period_kind`, o valor `separate` virou `standalone`. "Avulso" é o fechamento que deixa cada venda em uma fatura própria, e `standalone` é como a API já nomeia esse mesmo conceito no `kind` do lançamento financeiro. ### Contas a pagar e receber, e notas fiscais - Os dois campos que ainda vinham no formato antigo desde a entrada de 2026-08-13 acompanharam o código: em [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get), os itens deixaram de trazer `id`; em [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get), `credit_card_items[].id` deu lugar à referência `movement`. ### Nomenclatura - Os schemas de [Produtos](#tag/Produtos/paths/~1products/get) e de [Tarefas](#tag/Tarefas/paths/~1tasks/get) passaram a seguir a convenção do restante da API: o schema da consulta em lista ganhou o sufixo `_summary`, e o nome sem sufixo passou a ser o da consulta por ID. ### Nomenclatura - `registered_at` virou `created_at` em [vendas](#tag/Vendas/paths/~1sales/get), [contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get), [notas fiscais](#tag/Notas-Fiscais/paths/~1nfs/get), [regras da nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules/get), [tarefas](#tag/Tarefas/paths/~1tasks/get), [viagens](#tag/Viagens/paths/~1travels/get), [vendedores](#tag/Vendedores/paths/~1sellers/get), [pessoas](#tag/Pessoas/paths/~1people/get), [extrato CVC](#tag/Extrato-CVC/paths/~1cvc_statements/get) e [logs](#tag/Logs/paths/~1logs/get) — o nome mais comum para esse conceito no restante das APIs REST. - `registered_by` virou `created_by`, pelo mesmo motivo, em [vendas](#tag/Vendas/paths/~1sales/get), [contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get), [notas fiscais](#tag/Notas-Fiscais/paths/~1nfs/get), [regras da nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules/get), [tarefas](#tag/Tarefas/paths/~1tasks/get), [viagens](#tag/Viagens/paths/~1travels/get), [vendedores](#tag/Vendedores/paths/~1sellers/get), [pessoas](#tag/Pessoas/paths/~1people/get) e [extrato CVC](#tag/Extrato-CVC/paths/~1cvc_statements/get). ## 2026-08-13 Ajuste do padrão de leitura em vários endpoints, na mesma direção da entrada de 2026-08-11: a consulta em lista traz os campos do próprio registro, e as associações — referências e dados de outras entidades — ficam na consulta por ID. - O [limite de requisições](#tag/Limites-de-requisicao) mudou de 60 para **10 requisições a cada 3 segundos** por endereço IP de origem. ### Pessoas - [Consultar pessoas](#tag/Pessoas/paths/~1people/get) passou a trazer todos os campos da própria pessoa, que antes só existiam na consulta por ID: `rg_ie`, `passport_number`, `passport_expiration_date`, `foreigner`, `foreign_identity_document`, `business_phone`, `website`, `cvc_code`, `observations`, `charge_billet_fee`, `registered_at` e os nós `additional_data`, `last_contacts`, `tax_withholding` e `airline`. - Entraram `gender` e `birthdate`, nas duas leituras. - [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) ficou com o que é associação: `birthplace`, `seller`, `promoter`, `registered_by`, `contacts`, `labels`, `custom_fields`, `attachments` e `credit_cards`. - Os contatos e os cartões de crédito não trazem `id`: são dados que só existem dentro da pessoa. - Nos cartões de crédito, `masked_number` virou `last_digits` e passou a trazer só os quatro últimos dígitos, sem a máscara. ### Contas a pagar e receber - [Consultar contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get) passou a trazer `billet`, `check` e `card`, que antes só existiam na consulta por ID. São dados do próprio lançamento. - Em `credit_card_items`, o `id` — que era o identificador da movimentação, não da linha — deu lugar à referência `movement`, resolvida em [Consultar movimentação por ID](#tag/Movimentacoes/paths/~1account_movements~1{id}/get). ### Notas fiscais - Os itens em [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get) deixaram de trazer `id`. O item não tem consulta própria, e o identificador não resolvia nada. ### Cidades, categorias, contas e cartões - `state` e `country` saíram de [Consultar cidades](#tag/Cidades/paths/~1cities/get) e ficaram em [Consultar cidade por ID](#tag/Cidades/paths/~1cities~1{id}/get). - `group` saiu de [Consultar categorias](#tag/Categorias/paths/~1categories/get) e ficou em [Consultar categoria por ID](#tag/Categorias/paths/~1categories~1{id}/get). - `bank` saiu de [Consultar contas e cartões](#tag/Contas-e-Cartoes/paths/~1accounts/get) e ficou em [Consultar conta ou cartão por ID](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get). ### Logs - `kind` passou a declarar os valores possíveis: `insertion`, `edition`, `deletion`, `custom` e `export`. Não há outros. - A descrição de `person` passou a indicar [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get), o endpoint que resolve a referência. ### Vendas, produtos, tarefas e regras de nota fiscal - [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passou a trazer a referência `travel`, resolvida em [Consultar viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get). O vínculo existia só no sentido inverso. - [Produtos](#tag/Produtos/paths/~1products/get) passou a trazer `active`, e [Tarefas](#tag/Tarefas/paths/~1tasks/get), `deleted`. - Nas regras de nota fiscal, dentro de `payer_rule`, `supplier_rule` e `representative_rule`, o `recipient` passou a vir antes de `revenues` e `discounts`. ## 2026-08-12 - [Consultar vendas](#tag/Vendas/paths/~1sales/get) 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](#tag/Campos-Personalizados/paths/~1custom_fields/get) e [Consultar campo personalizado por ID](#tag/Campos-Personalizados/paths/~1custom_fields~1{id}/get). A consulta lista os campos personalizados por recurso (`sales`, `travels`, `people`, `bills` e `tasks`), com o identificador, o nome, o tipo, se é obrigatório, se está ativo e as opções cadastradas dos campos do tipo lista, e aceita o filtro `resource`; a consulta por ID resolve a definição de um campo a partir do id. As definições não são recortadas por empresa. O identificador de cada campo é numérico (não é um UUID como no resto da API). - O nó `pagination` deixou de trazer `total` e `total_pages`, e passou a trazer `has_next_page`. Para percorrer uma consulta inteira, peça a próxima página enquanto `has_next_page` for verdadeiro. O pedido não muda: `page` e `size` funcionam como antes. Contar o total exigia percorrer todos os registros que atendiam ao filtro a cada requisição, o que em bases grandes custava mais do que buscar a própria página. ## 2026-08-11 Toda leitura passou a ter duas formas: uma **consulta em lista**, enxuta, para extrair volume, e uma **consulta por ID**, com o registro completo. As associações não vêm mais embutidas: vêm como referência, só com o identificador. A descrição de cada referência indica o endpoint que a resolve, e referências e coleções aparecem apenas na consulta por ID. As mudanças estão agrupadas por endpoint. As consultas por ID novas estão documentadas antes de existirem: cada uma leva a etiqueta **Em desenvolvimento** até o código entrar. As consultas em lista que já existiam seguem em **Beta**, disponíveis para uso. ### Vendas - [Consultar vendas](#tag/Vendas/paths/~1sales/get) devolve só os campos escalares da venda e os totais. Os produtos, os pagamentos, as comissões, os anexos, os campos personalizados e o nó `financial` saíram da lista e continuam em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get), 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](#tag/Vendedores/paths/~1sellers~1{id}/get) — 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](#tag/Pessoas/paths/~1people~1{id}/get). - Saíram três campos: `company_identifier`, que era o CNPJ copiado da empresa e dá lugar à referência `company` (na criação continua obrigatório), `totals.payments` e o `role` das comissões. - Nas comissões, `value`, `retained_value` e `leftover` viraram `amount`, `retained_amount` e `balance`; nos totais, `final_value` virou `final_amount`; nos repasses ao fornecedor, `value` virou `amount`. - **Os pagamentos mudaram de forma.** `payments` deixou de ser lista e virou um objeto com `agency` e `vendor`. Em `agency`, `bills` e `refunds` são listas de referência, resolvidas em [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) e em [Consultar reembolso por ID](#tag/Reembolsos/paths/~1refunds~1{id}/get); `credit`, `retained_by_intermediary` e `legacy` vêm embutidos, porque não geram lançamento financeiro. Em `vendor`, há uma lista por forma: `credit_card`, `check`, `credit` e `others`. - Com isso saíram os nós por forma do lado da agência (`cash`, `check`, `credit_card`, `debit_card`, `bank_slip`, `bank_deposit`, `others`, `custom` e `invoice`). Todos eles geram um lançamento, e é o lançamento que traz a forma de pagamento, a conta, a liquidação, o boleto e os produtos cobertos. Um lançamento liquidado em várias formas aparece uma vez, e cada liquidação vem em `movements`, no próprio lançamento. - Cada item de `products` traz agora `amount` e a referência `sale_product`, no lugar de `external_id` e `payment_amount`. Todo pagamento embutido ganhou `payer`, que pode ser diferente do pagante da venda. - No nó `financial`, `vendor` virou `vendor_bills` e `bills` virou `standalone_bills` — as duas agora listas de referência aos lançamentos. Os itens e valores vêm do próprio lançamento. - O campo `operation` da venda é a referência à operação própria do cabeçalho, e o detalhe do produto de operação própria fica na coleção `operations`, junto dos demais produtos. Na entrada de 2026-08-07 esse campo passou a trazer o produto inteiro quando havia linha; agora ele é sempre referência. - Cada produto da venda passou a trazer o próprio `id`, o que torna resolvível a referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. Nos tipos `others`, `operation` e `cvc_package`, saíram `product_name` e `product_with_passengers` e entrou a referência `product`; nos outros oito tipos existe um único produto de sistema por tipo, e o nome do array já identifica qual é. - `currency` é um código ISO (texto) na criação e na consulta; o objeto `currency` completo ficou exclusivo de [Moedas](#tag/Moedas/paths/~1currencies/get). Nos produtos da venda, `currency` e `exchange_rate` são campos de criação: na consulta devolvem sempre BRL e 1, e os valores vêm convertidos para Real. - Em `custom_fields`, cada campo passou a trazer o `id` da definição e deixou de trazer o `name`. O nome, o tipo e as opções vêm da consulta de definições de campos personalizados. - A resposta de [Inserir venda](#tag/Vendas/paths/~1sales/post) passou a ser a mesma da consulta por ID. O corpo da requisição não muda. - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a aceitar o campo opcional `description` nos pagamentos de agência (cartão de crédito, boleto e depósito). Quando informado, o texto é gravado no lançamento financeiro; quando omitido, continua sendo usado "Pagamento venda". Máximo de 60 caracteres. ### Contas a pagar e receber - [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) ganhou os blocos `check` e `card`, com os dados de cheque e de cartão informados no cadastro. Antes eles só apareciam na venda, e ficavam inacessíveis enquanto o pagamento não fosse liquidado. - No `kind`, `sale_separate` e `vendor_separate` viraram `sale_standalone` e `vendor_standalone`. O filtro `kind` aceita os novos valores. - Em `custom_fields`, cada campo passou a trazer o `id` da definição e deixou de trazer o `name`, como na venda. ### Pessoas - Novo [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get), com os contatos, os marcadores, os campos personalizados, os anexos e os cartões de crédito. [Consultar pessoas](#tag/Pessoas/paths/~1people/get) ficou enxuta. - A cidade do endereço, a naturalidade, o vendedor, o promotor e quem cadastrou vêm como referência. - `external_id` passou a constar na consulta: a resposta já trazia o identificador que você atribuiu à pessoa, mas ele não estava documentado. Vem nulo quando a credencial que consulta não tem identificador externo para aquela pessoa. - [Listar pessoas](#tag/Pessoas/paths/~1people/get) passou a aceitar filtros por `name`, `cpf_cnpj`, `passport_number`, `phone`, `kind` (`individual` ou `company`), `code` e `email`. Todos são opcionais e combináveis (E lógico entre eles): `name`, `passport_number` e `email` casam por trecho, ignorando maiúsculas e acentos; `cpf_cnpj` e `phone` aceitam só os dígitos (a máscara é ignorada) e `code` é valor exato. Sem nenhum filtro, o comportamento é o mesmo de antes. ### Produtos - Novo [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get), com os fornecimentos em `supplies`: cada um traz o fornecedor, os dados de comissão e os representantes. - Nos fornecimentos, `commission_value` virou `commission_amount`, e `commission_type` passou a aceitar `amount` em vez de `value`. ### Tarefas - Novo [Consultar tarefa por ID](#tag/Tarefas/paths/~1tasks~1{id}/get), com o histórico em `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](#tag/Categorias-de-Tarefas/paths/~1task_categories~1{id}/get). ### Viagens - Novo [Consultar viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get), com as referências às vendas e aos passageiros vinculados. Os valores por passageiro pertencem a cada venda e saem pelo endpoint da venda. - `client` virou `customer`, e `seller` passou a apontar para o endpoint de vendedores. ### Extrato CVC - `seller` passou a apontar para [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get). ### Orçamentos - Novo [Consultar orçamento por ID](#tag/Orcamentos/paths/~1quotes~1{id}/get). Saiu `status`, que é derivável de `active` e `valid_until`, ambos ainda na resposta. ### Anexos - `attachment_id` virou `id`. ### Demais cadastros - Passaram a ter consulta em lista enxuta e consulta por ID: [vendedores](#tag/Vendedores/paths/~1sellers~1{id}/get), [contas e cartões](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get), [centros de custo](#tag/Centros-de-Custo/paths/~1cost_centers~1{id}/get), [cidades](#tag/Cidades/paths/~1cities~1{id}/get), [categorias](#tag/Categorias/paths/~1categories~1{id}/get), [formas de pagamento](#tag/Formas-de-Pagamento/paths/~1payment_methods~1{id}/get), [regras da nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules~1{id}/get), [regras de faturamento](#tag/Regras-de-Faturamento/paths/~1invoice_rules~1{id}/get), [integrações](#tag/Integracoes/paths/~1integrations~1{id}/get) e [moeda por código](#tag/Moedas/paths/~1currencies~1{code}/get). - Em vendedores, a pessoa correspondente passou a vir no campo `person`. - Continuam aninhados, com os dados completos, o estado e o país da cidade, o banco da conta e o grupo da categoria: não têm cadastro próprio na v3, então não há endpoint para resolvê-los. O estado ganhou `name`, e o país, `code` (ISO 3166-1 alfa-2) e `code_3` (alfa-3). ### Cadastros novos na leitura - [Marcadores](#tag/Marcadores/paths/~1labels/get) e [categorias de tarefas](#tag/Categorias-de-Tarefas/paths/~1task_categories/get), com consulta em lista e consulta por ID. São os alvos das referências `labels` da pessoa e `category` da tarefa. ## 2026-08-10 - [Criar venda](#tag/Vendas/paths/~1sales/post) passou a aceitar **campos personalizados** no campo `custom_fields` (array de `{id, value}`). O `id` é o mesmo retornado por [Consultar campos personalizados](#tag/Campos-Personalizados/paths/~1custom_fields/get); 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](#tag/Campos-Personalizados/paths/~1custom_fields~1{id}/get) ou em [Consultar campos personalizados](#tag/Campos-Personalizados/paths/~1custom_fields/get), para o consumidor sempre ler a referência e não um dado projetado que pode desatualizar. ## 2026-08-07 - [Criar venda](#tag/Vendas/paths/~1sales/post) 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](#tag/Vendas/paths/~1sales/get) e [Obter venda por ID](#tag/Vendas/paths/~1sales~1{id}/get)), 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](#tag/Logs/paths/~1logs/get) e [Consultar logs por ID](#tag/Logs/paths/~1logs~1{id}/get). A consulta traz a ação registrada, a origem, a descrição da alteração e o momento em que ela foi gravada, com filtros por autor, registro auditado, ação e origem; a consulta por ID acrescenta as referências para o autor e para o registro auditado. O histórico não é recortado por empresa. ## 2026-08-04 - Os itens de [Obter conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) 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](#tag/Vendas/paths/~1sales~1{id}/get). - 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](#tag/Movimentacoes/paths/~1account_movements~1{id}/get). - Cada linha de `commissions` ganhou a referência `person`, e o campo `leftover` passou a se chamar `balance`. - O lançamento perdeu `sale_number`, `balance`, `status`, `overdue_days` e `settled_late`, e ganhou `canceled`, `checked`, `invoice_closed`, `system_generated` e `recurrence_group_id`. A visualização por ID ganhou as referências `sale` e `invoice_rule`. No filtro `status`, o valor `paid` passou a `settled`. ## 2026-07-31 - Novos endpoints de leitura do extrato CVC: [Consultar extrato CVC](#tag/Extrato-CVC/paths/~1cvc_statements/get) e [Consultar extrato CVC por ID](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}/get). 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](#tag/Notas-Fiscais/paths/~1nfs/get) e [Consultar notas fiscais por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get). 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](#tag/Reembolsos/paths/~1refunds/get) e [Consultar reembolsos por ID](#tag/Reembolsos/paths/~1refunds~1{id}/get). Trazem o lado do reembolso (cliente ou fornecedor), o valor, a descrição, a emissão e o vencimento, e a visualização acrescenta as referências para venda, produto da venda, pessoa, empresa e conta a pagar ou a receber, com escopo por empresa. ## 2026-07-29 - Novos endpoints de leitura de movimentações: [Consultar movimentações](#tag/Movimentacoes/paths/~1account_movements/get) e [Consultar movimentação por ID](#tag/Movimentacoes/paths/~1account_movements~1{id}/get). A consulta traz data, valor, sentido (crédito ou débito), observação e os dados de cheque e de cartão; a consulta por ID acrescenta as referências para conta, forma de pagamento, conta a pagar/receber, fatura de cartão e conta do outro lado da transferência. Escopo por empresa. ## 2026-07-28 - Novos endpoints de leitura de contas a pagar e receber: [Consultar contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get) e [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get). Trazem identificação, valores, situação, boleto, recorrência, categorias, rateios, movimentações de liquidação, itens de fatura (cliente, fornecedor ou cartão), comissões, anexos e campos personalizados, com escopo por empresa. ## 2026-07-17 - Os endpoints [Consultar vendas](#tag/Vendas/paths/~1sales/get) e [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passaram a incluir os anexos da venda no campo `attachments`: cada anexo traz `id`, `description`, `extension`, `content_type` e `download_url`, com o conteúdo acessível por um link de download temporário. ## 2026-07-16 - Os endpoints [Consultar vendas](#tag/Vendas/paths/~1sales/get) e [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passaram a retornar a operação no campo `operation` (objeto com `id` e `name`); antes o identificador vinha em `operation_id`. ## 2026-07-15 - Os endpoints [Consultar vendas](#tag/Vendas/paths/~1sales/get) e [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passaram a incluir as comissões da venda no campo `commissions`: o rateio por pessoa e função (vendedor, intermediário e outros), com valor da comissão, valor retido e saldo. ## 2026-07-14 - Os endpoints [Consultar vendas](#tag/Vendas/paths/~1sales/get) e [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) passaram a incluir os dados financeiros da venda no campo `financial`: observações financeiras, os repasses aos fornecedores e os lançamentos de contas a pagar e a receber vinculados à venda. ## 2026-07-10 - Novos endpoints de leitura para os cadastros do sistema: [cabines](#tag/Cabines/paths/~1cabins/get), [categorias](#tag/Categorias/paths/~1categories/get), [centros de custo](#tag/Centros-de-Custo/paths/~1cost_centers/get), [cidades](#tag/Cidades/paths/~1cities/get), [contas e cartões](#tag/Contas-e-Cartoes/paths/~1accounts/get), [formas de pagamento](#tag/Formas-de-Pagamento/paths/~1payment_methods/get), [integrações](#tag/Integracoes/paths/~1integrations/get), [moedas](#tag/Moedas/paths/~1currencies/get), [navios](#tag/Navios/paths/~1ships/get), [orçamentos](#tag/Orcamentos/paths/~1quotes/get), [pessoas](#tag/Pessoas/paths/~1people/get), [regras de nota fiscal](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules/get), [regras de faturamento](#tag/Regras-de-Faturamento/paths/~1invoice_rules/get), [tarefas](#tag/Tarefas/paths/~1tasks/get), [vendedores](#tag/Vendedores/paths/~1sellers/get) e [viagens](#tag/Viagens/paths/~1travels/get). - name: Conexão automática description: " Além da credencial gerada pela agência, um parceiro aprovado pelo Monde pode acessar a API v3 em nome de uma agência de viagens, via OAuth 2.0 (Authorization Code + PKCE), sem que a agência compartilhe a senha de uma credencial. O que o parceiro pode fazer é definido pelo Monde na aprovação, e a agência vê e aprova essa lista ao autorizar.

Em resumo

  1. A agência clica em "Conectar com o Monde" no seu sistema, entra no Monde e autoriza o seu sistema.
  2. O Monde devolve a agência para a sua redirect_uri com um code.
  3. O seu backend troca o code por um token e usa o token para chamar a API em nome daquela agência.
O fluxo é OAuth 2.0 de autorização (Authorization Code + PKCE). Ele não é login único (SSO) nem OpenID Connect: o token dá acesso à API da agência e não identifica a pessoa que autorizou. O Monde não devolve id_token nem dados do usuário.

Todos os endpoints desta seção ficam em https://web.monde.com.br.

Cadastro e credenciais

  • Cadastre o parceiro em https://web.monde.com.br/partners/signup e confirme o e-mail. O Monde analisa o cadastro, define as permissões e aprova.
  • Na aprovação, o Monde envia por e-mail um link para a sua página de conexão automática. O client_id e o client_secret aparecem nessa página; o secret é exibido uma única vez, então guarde-o na hora. Se precisar vê-lo de novo, solicite a regeneração ao Monde.
  • Guarde o client_secret só no seu backend. Ele nunca vai para o navegador nem para o app do usuário.

1. Habilitar a conexão automática

Na área do parceiro (https://web.monde.com.br/partners/integration), informe a redirect_uri e a URL da política de privacidade, que a agência vê ao autorizar. A conexão fica habilitada assim que o cadastro está aprovado e as duas estão informadas, sem nenhum outro passo. Enquanto falta uma delas, a autorização não funciona.
  • A redirect_uri é uma só por parceiro e precisa usar https. Ela precisa ser idêntica, caractere por caractere, na autorização e na troca do token (uma barra no fim já é diferença). Endereços http, inclusive localhost e 127.0.0.1, não são aceitos.
  • Depois de habilitada, você pode trocar as duas URLs, mas não deixá-las em branco.

2. Autorização

A cada tentativa de conexão, gere no backend um state e um code_verifier novos e guarde os dois na sessão do usuário. O code_verifier é um texto aleatório de 43 a 128 caracteres; o code_challenge é BASE64URL(SHA256(code_verifier)), sem o = no fim. PKCE é obrigatório e só aceita S256: ele é o que impede outro sistema de trocar um code interceptado.
code_verifier=$(openssl rand -base64 64 | tr -d '=+/\\n' | cut -c1-64) code_challenge=$(printf
    '%s' "$code_verifier" | openssl dgst -sha256 -binary | openssl base64
    | tr '+/' '-_' | tr -d '=\\n')
Redirecione o usuário da agência para a URL de autorização, com os valores codificados para URL:
GET https://web.monde.com.br/oauth/authorize?response_type=code&client_id=SEU_CLIENT_ID&redirect_uri=SUA_REDIRECT_URI&state=STATE&code_challenge=CODE_CHALLENGE&code_challenge_method=S256
  • Não envie scope: o que o parceiro pode fazer são as permissões definidas na aprovação.
  • Se o client_id não é de um parceiro ativo e aprovado, se a conexão ainda não está habilitada (falta a redirect_uri ou a política de privacidade), se a redirect_uri não é a cadastrada, ou se falta o code_challenge ou o code_challenge_method não é S256, o Monde responde 400 numa página própria e não volta para a redirect_uri.
A agência faz login, escolhe a empresa e consente. Só um administrador da agência pode autorizar.

3. Retorno na redirect_uri

Quando a agência aprova, o navegador volta para a redirect_uri com o code e o mesmo state que você enviou:
SUA_REDIRECT_URI?code=agencia%7CujES3JCJylJRoM3j_kGeavaD2hFqz2oqw1Lazq_u0rs&state=STATE
Quando a agência recusa:
SUA_REDIRECT_URI?error=access_denied&error_description=O+dono+do+recurso+ou+o+servidor+de+autoriza%C3%A7%C3%A3o+negou+a+requisi%C3%A7%C3%A3o.&state=STATE
  • Compare o state com o da sessão. Se for diferente ou faltar, descarte a resposta.
  • O code é opaco. Use o valor decodificado da URL do jeito que veio, sem cortar nem trocar caracteres. Ele vale 10 minutos e só pode ser trocado uma vez.
  • Nada volta para a redirect_uri quando quem entrou não é administrador da agência. Nesse caso o usuário vê a explicação numa página do Monde. O consentimento oferece todas as empresas ativas da agência, e nenhuma é recusada por licença.

Botão "Conectar com o Monde"

Coloque na sua plataforma um botão no padrão de "Entrar com o Google", com o texto "Conectar com o Monde". O href aponta para a URL de autorização que você monta no seu backend a cada acesso, com um code_challenge PKCE novo (passo 2 acima), nunca um link estático. O símbolo do Monde é hospedado por nós: https://web.monde.com.br/logo-monde-conectar.svg (colorido, para fundo claro) e https://web.monde.com.br/logo-monde-conectar-branco.svg (branco, para fundo azul). Três variações:

1. Negativo (fundo azul)

Monde Conectar com o Monde
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0
    20px 0 14px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600
    14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar-branco.svg"
    alt="Monde" style="height:22px"> Conectar com o Monde</a>

2. Colorido (fundo branco)

Monde Conectar com o Monde
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0
    20px 0 14px;background:#fff;color:#344050;border:1px solid #d8e2ef;border-radius:6px;font:600
    14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar.svg"
    alt="Monde" style="height:22px"> Conectar com o Monde</a>

3. Só texto

Conectar com o Monde
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;height:40px;padding:0
    20px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600
    14px 'Open Sans',Arial,sans-serif;text-decoration:none">Conectar com o
    Monde</a>

4. Troca do code pelo token

Faça a troca no backend, nunca no navegador. O corpo vai em application/x-www-form-urlencoded; o mesmo corpo em JSON (application/json) também é aceito.
curl
    -X POST https://web.monde.com.br/oauth/token -H "Content-Type: application/x-www-form-urlencoded"
    --data-urlencode "grant_type=authorization_code" --data-urlencode "code=CODE"
    --data-urlencode "redirect_uri=SUA_REDIRECT_URI" --data-urlencode "client_id=SEU_CLIENT_ID"
    --data-urlencode "client_secret=SEU_CLIENT_SECRET" --data-urlencode
    "code_verifier=CODE_VERIFIER"
Resposta 200:
{
    "access_token": "YWdlbmNpYXw2ZjFj...", "token_type":
    "Bearer", "scope": "full_access", "created_at":
    1790602784 }
O access_token não expira e não vem refresh_token. Guarde-o no backend, um por agência conectada, e trate-o como senha.
  • 400 com {"error":"invalid_grant","error_description":"..."}: code vencido ou já trocado, code_verifier que não corresponde ao code_challenge, ou redirect_uri diferente da usada na autorização. Recomece pela autorização.
  • 400 com {"error":"invalid_request","error_description":"..."}: o code_verifier não foi enviado.
  • 401 com {"error":"invalid_client","error_description":"..."}: client_id ou client_secret errado.
  • 404 com corpo vazio: o code chegou alterado.

5. Uso na API v3

A URL da API v3 não muda: chame https://web.monde.com.br/api/v3 com o token no cabeçalho Authorization (o token já carrega a agência).
Authorization: Bearer SEU_ACCESS_TOKEN
Para confirmar que a conexão funciona sem criar dado, chame GET /api/v3/sales com o token:
curl
    https://web.monde.com.br/api/v3/sales -H "Authorization: Bearer SEU_ACCESS_TOKEN"
    -H "Content-Type: application/json"
  • 200 com a lista das vendas que o parceiro alcança (as que ele criou e, quando o Monde concedeu na aprovação o acesso a outras origens, também as demais; sem essa exceção, a lista vem vazia numa conexão nova): o token é válido e a integração está pronta.
  • 403 com {"errors":["Você não tem permissão para executar essa ação."]}: o token é válido, mas o parceiro não tem a permissão "Visualizar" de vendas na empresa.
  • 401 com {"errors":["Credenciais de acesso não são válidas."]}: o token é inválido ou a conexão foi excluída. Recomece pela autorização.
  • O parceiro só acessa a empresa que a agência escolheu, com as permissões que ela aprovou. Em vendas, contas a pagar e receber, tarefas e viagens, cada permissão alcança só o que o parceiro criou, e listar e consultar pedem a permissão "Visualizar" do recurso também no que ele criou; o acesso aos registros de outras origens é exceção concedida pelo Monde na aprovação, mostrada em destaque no consentimento. Também são exceção as permissões sobre o que vale para a agência inteira, porque quem grava alcança o que a agência cadastrou: criar e editar campos personalizados; criar, editar e excluir categorias de tarefa, marcadores, funções, regras de faturamento, regras da nota fiscal, produtos (com os fornecedores e os representantes deles), contas e cartões (e reabrir o caixa delas), categorias financeiras, centros de custo, formas de pagamento e informações das formas de pagamento; gravar, excluir, emitir e copiar notas fiscais e gerar notas fiscais, porque a nota é documento fiscal da agência; fechar e pagar comissões, que alcançam as de todos os vendedores; consultar, lançar, alterar, excluir e restaurar recibos do Extrato CVC; todo o Master - Extrato CVC, o Fechamento de Extrato CVC, o Master - Fechamento de Extrato CVC e a Conferência Depósito CVC, inclusive a consulta; e a importação de extratos CVC, que grava as vendas e os cadastros da empresa vindos da CVC, de qualquer origem.
  • A conexão não exige licença à parte para nenhuma permissão. As regras de cada recurso continuam valendo: a empresa somente leitura não recebe gravação, e os Guias exigem a licença Monde Pro.
  • A venda criada volta completa na resposta do POST /sales.
  • A agência pode excluir a conexão a qualquer momento; o acesso cai na hora e a API passa a responder 401.

6. Desconectar (revogação)

Quando o usuário desconectar na sua plataforma, ou se o token vazar, revogue o token no backend:
curl -X POST https://web.monde.com.br/oauth/revoke
    --data-urlencode "token=SEU_ACCESS_TOKEN" --data-urlencode "client_id=SEU_CLIENT_ID"
    --data-urlencode "client_secret=SEU_CLIENT_SECRET"
A resposta é 200 com {}. A conexão com a agência é excluída na hora e o token para de funcionar. Para conectar de novo, recomece pela autorização.
  • 403 com {"error":"unauthorized_client",...}: client_id ou client_secret errado, ou o token não pertence a este client_id. Nada é revogado.

7. Conexão iniciada pela agência

Opcional. O caminho padrão é o botão Conectar com o Monde (passos 2 a 4), que toda integração precisa ter. Implemente este passo só depois do botão, se quiser oferecer a conexão também pela tela de Integrações do Monde Web. Ele não substitui o botão. A agência também pode conectar com o parceiro sem sair do Monde: na tela de Integrações, um administrador escolhe o parceiro e a empresa, vê as permissões e confirma. Não é um fluxo OAuth e não passa pela redirect_uri: o seu backend consulta as conexões novas e recebe cada uma já com o token, sem ninguém copiar chave.
  • Para aparecer na tela de Integrações, marque Conexão iniciada pela agência na área do parceiro (https://web.monde.com.br/partners/integration), só depois que a consulta abaixo estiver implementada. A conexão automática precisa estar habilitada (passo 1).
  • O consentimento é dado pela agência dentro do Monde, com as mesmas permissões do passo 2. A conexão pela autorização (passos 2 a 4) continua valendo; as duas convivem.
Consulte as conexões novas no backend, de tempos em tempos (recomendamos a cada 1 a 5 minutos), com o client_id e o client_secret em HTTP Basic:
curl -X POST https://web.monde.com.br/oauth/connections
    -u "SEU_CLIENT_ID:SEU_CLIENT_SECRET"
O client_id e o client_secret também podem ir no corpo, como na troca do token, mas nunca na URL: na query string eles são ignorados e a resposta é 401. Resposta 200:
{ "data": [ { "id": "5b0f3c2e-8a51-4f6e-9a3d-2f4f1f0c9e11",
    "access_token": "YWdlbmNpYXw2ZjFj...", "token_type":
    "Bearer", "company": { "name": "Agência Exemplo",
    "cnpj": "12345678000190" }, "authorized_at": "2026-10-19T14:32:05.000-03:00"
    } ], "pagination": { "size": 50, "has_next_page":
    false, "next_cursor": null } }
  • Cada conexão é entregue uma única vez. Guarde o access_token no backend antes de qualquer outro passo: ele não volta numa próxima consulta. Se ele se perder, a agência exclui a integração e conecta de novo. Use o id para não processar a mesma conexão duas vezes do seu lado.
  • O access_token é igual ao do passo 4: não expira, não tem refresh_token, é usado na API v3 do mesmo jeito (passo 5) e revogado do mesmo jeito (passo 6).
  • A company é a empresa da agência que foi conectada. Use o CNPJ para ligar a conexão ao cliente certo na sua plataforma.
  • Cada consulta entrega até 50 conexões, da mais antiga para a mais nova, no nó data. O nó pagination tem o formato da paginação da API, mas a fila não usa cursor: com has_next_page igual a true, consulte de novo em seguida, sem parâmetro, e o next_cursor vem sempre nulo. Sem conexão nova, a lista vem vazia. Com duas consultas ao mesmo tempo, uma delas pode vir com a lista vazia e has_next_page igual a true: consulte de novo.
  • A conexão espera a sua consulta por 72 horas. Depois disso ela não é mais entregue, e a integração é excluída na conta da agência, que precisa conectar de novo. A conexão que a agência excluir antes da sua consulta também não é entregue.
  • A resposta vem com Cache-Control: no-store: não a guarde em cache nem em log, porque ela leva os tokens.
  • 401 com {"error":"invalid_client","error_description":"..."}: client_id ou client_secret errado, ou a conexão automática não está habilitada. Nada é entregue.
" components: parameters: authorization_header: name: Authorization in: header required: true description: Credencial de acesso fornecida pela agência de viagens, no esquema Bearer. schema: type: string example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz content_type_json: name: Content-Type in: header required: true description: Tipo de conteúdo da requisição. Deve ser application/json. schema: type: string enum: - application/json example: application/json content_type_multipart: name: Content-Type in: header required: true description: Tipo de conteúdo da requisição. Deve ser multipart/form-data. schema: type: string enum: - multipart/form-data example: multipart/form-data idempotency_key_header: name: Idempotency-Key in: header required: true description: Chave de idempotência (UUID v4) gerada pelo cliente. Veja a seção de [Idempotência](#tag/Idempotencia) para mais detalhes. schema: type: string format: uuid pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" example: 550e8400-e29b-41d4-a716-446655440000 cursor: name: cursor in: query required: false schema: type: string description: Cursor da próxima página, exatamente como veio em `next_cursor`. Sem ele, a consulta começa pela primeira página. example: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 size: name: size in: query required: false schema: type: integer minimum: 1 maximum: 50 default: 20 description: Número de registros por página. example: 10 schemas: entity_reference: type: object description: Referência a um registro relacionado. properties: id: type: string format: uuid description: Identificador do registro referenciado. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 required: - id numeric_entity_reference: type: object description: Referência a um registro relacionado. properties: id: type: integer description: Identificador do registro referenciado. example: 42 required: - id person: type: object properties: email: type: - string - 'null' description: 'Endereço de e-mail.

Exemplo: "contato@exemplo.com".' maxLength: 200 phone_number: type: - string - 'null' description: 'Número de telefone, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "1134567890", "+33170180123".' maxLength: 20 mobile_number: type: - string - 'null' description: 'Número de telefone celular, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "11934567890", "+447911123456".' maxLength: 20 address: type: - object - 'null' description: Endereço. properties: postal_code: type: - string - 'null' description: 'CEP ou código postal, sem traços.

Exemplo: "04078011".' maxLength: 8 street: type: - string - 'null' description: 'Logradouro.

Exemplo: "Avenida Divino Salvador".' maxLength: 50 street_number: type: - string - 'null' description: 'Número.

Exemplo: "5000".' maxLength: 10 neighborhood: type: - string - 'null' description: 'Bairro.

Exemplo: "Planalto Paulista".' maxLength: 30 additional_info: type: - string - 'null' description: 'Complemento.

Exemplo: "Casa 2".' maxLength: 20 city_ibge: type: - string - 'null' description: 'Código IBGE da cidade. Quando informado, define a cidade, que precisa estar entre as cidades que a agência pode usar ([Consultar cidades](#tag/Cidades/paths/~1cities/get)); o nome não é conferido e o estado e o país, se enviados, precisam ser os dela.

Exemplo: "3550308".' minLength: 7 maxLength: 7 city_name: type: - string - 'null' description: 'Nome da cidade. Sem o `city_ibge`, a cidade é procurada pelo nome, sem diferenciar acento nem maiúscula, entre as que a agência pode usar ([Consultar cidades](#tag/Cidades/paths/~1cities/get)): no Brasil, no estado do `state_code`; no exterior, no país do `country_code`. No exterior com `state_code`, a cidade é procurada primeiro como "Nome, subdivisão", a forma em que a API cadastrava as cidades antes. A cidade não é cadastrada: o nome que não corresponde a nenhuma é recusado (422).
  • **Obrigatório** quando o campo `country_code` estiver preenchido.
Exemplo: "São Paulo". ' maxLength: 50 state_code: type: - string - 'null' description: ' Código ou sigla do estado (ou outra subdivisão do país, como província, distrito, região, etc.).
  • **Obrigatório** quando o campo `country_code` for igual a "BR".
Exemplos: "SP", "RJ", "NY", "CA", "FL", "BAV", "VIC". ' maxLength: 3 country_code: type: - string - 'null' description: ' Código do país no padrão ISO-3166-1 alpha-2.
  • **Obrigatório** quando o campo `city_name` estiver preenchido.
Exemplos: "BR", "US", "GE", "AU". ' minLength: 2 maxLength: 2 city_inscription: type: - string - 'null' description: Inscrição municipal maxLength: 15 observations: type: - string - 'null' description: Observações da pessoa charge_billet_fee: type: boolean description: Indica se a taxa de boleto é cobrada da pessoa default: false person_references: type: object properties: seller: description: Vendedor responsável pela pessoa "$ref": "#/components/schemas/entity_reference" promoter: description: Promotor da pessoa (planos operadora) "$ref": "#/components/schemas/entity_reference" labels: type: array description: Marcadores atribuídos à pessoa. items: "$ref": "#/components/schemas/entity_reference" contacts: type: array description: Pessoas ligadas a este cadastro como contato. Cada pessoa informada precisa já estar cadastrada e não pode se repetir na lista. items: "$ref": "#/components/schemas/person_contact" custom_fields: type: array description: Campos personalizados de pessoas, definidos pela agência. Envie cada campo por `id` e `value`. Os campos ativos marcados como obrigatórios precisam vir preenchidos. items: "$ref": "#/components/schemas/person_custom_field" credit_cards: type: array description: 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. items: "$ref": "#/components/schemas/person_credit_card_write" cost_centers: type: array description: 'Centros de custo do cliente corporativo: os departamentos dele aceitos no centro de custo do passageiro e do item da fatura quando ele é o pagante. Não são os centros de custo da agência, de `/cost_centers`. Só pessoa jurídica tem centros de custo, e o nome não se repete na lista, sem diferenciar maiúsculas.' items: "$ref": "#/components/schemas/person_cost_center_write" kandir_law: type: array description: Retenções da Lei Kandir (Lei 9.430/1996, art. 64) da pessoa jurídica, uma por produto, no mesmo formato da consulta por ID. Só aceitam retenção os produtos ativos Passagem Aérea, Seguro Viagem e Transporte Terrestre. O percentual omitido é zero, e o negativo é recusado. O `total` de cada grupo é a soma de IR, CSLL, PIS e COFINS e não se informa. Exige a permissão "Ver aba financeiro" de pessoas. items: "$ref": "#/components/schemas/person_kandir_law_write" person_birthplace: type: - object - 'null' description: '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).' properties: city_ibge: type: - string - 'null' description: 'Código IBGE da cidade de nascimento. Quando informado, define a cidade, que precisa estar entre as cidades que a agência pode usar ([Consultar cidades](#tag/Cidades/paths/~1cities/get)); o nome não é conferido e o estado e o país, se enviados, precisam ser os dela.

Exemplo: "3550308".' minLength: 7 maxLength: 7 city_name: type: - string - 'null' description: |- Nome da cidade de nascimento.
  • **Obrigatório** quando o campo `country_code` estiver preenchido.
Exemplo: "São Paulo". maxLength: 50 state_code: type: - string - 'null' description: |- Código ou sigla do estado de nascimento (ou outra subdivisão do país).
  • **Obrigatório** quando o campo `country_code` for igual a "BR".
Exemplos: "SP", "RJ", "NY". maxLength: 3 country_code: type: - string - 'null' description: |- Código do país de nascimento no padrão ISO-3166-1 alpha-2.
  • **Obrigatório** quando o campo `city_name` estiver preenchido.
Exemplos: "BR", "US", "PT". minLength: 2 maxLength: 2 person_additional_data: type: - object - 'null' description: Dados adicionais da pessoa física. Ausente (null) para pessoa jurídica. properties: marital_status: type: - string - 'null' description: |- Estado civil (pessoa física).
  • single: solteiro(a).
  • married: casado(a).
  • separated: separado(a).
  • divorced: divorciado(a).
  • widowed: viúvo(a).
  • civil_union: união estável.
enum: - single - married - separated - divorced - widowed - civil_union - rg_emitter: type: - string - 'null' description: Órgão emissor do RG maxLength: 10 rg_issue_date: type: - string - 'null' format: date description: Data de emissão do RG birth_certificate: type: - string - 'null' description: Certidão de nascimento maxLength: 50 mother_name: type: - string - 'null' description: Filiação (mãe) maxLength: 50 person_tax_withholding: type: - object - 'null' description: Retenções de imposto da pessoa jurídica. Ausente (null) para pessoa física. properties: iss: type: boolean description: Indica retenção de ISS (pessoa jurídica) default: false ir: type: boolean description: Indica retenção de IR (pessoa jurídica) default: false pis_cofins_csll: type: boolean description: Indica retenção de PIS/COFINS/CSLL (pessoa jurídica) default: false person_airline: type: - object - 'null' description: Dados de companhia aérea da pessoa jurídica (fornecedores). Ausente (null) para pessoa física. properties: code: type: - string - 'null' description: Código da companhia aérea (fornecedores). É único entre as pessoas — no cadastro, um código já usado por outra pessoa é recusado. maxLength: 3 number: type: - string - 'null' description: Número da companhia aérea (fornecedores) maxLength: 3 person_contact: type: object required: - person properties: role: type: - string - 'null' description: Função registrada no vínculo, que descreve quem é o contato maxLength: 50 person: description: Pessoa que passa a ser contato deste cadastro. "$ref": "#/components/schemas/entity_reference" person_custom_field: type: object required: - id properties: id: type: integer description: Identificador da definição do campo personalizado. O nome, o tipo e as opções da definição saem da consulta de definições de campos personalizados. example: 123 value: type: - string - number - 'null' description: | Valor do campo personalizado. Deve corresponder ao kind do campo: - numeric: número inteiro. - currency: valor monetário (número). - text: texto livre. - date: data no formato ISO 8601 (AAAA-MM-DD). - choices: uma das opções cadastradas na definição. individual_person: allOf: - type: object required: - external_id - name properties: external_id: type: string description: 'Identificador **único** utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID.

Exemplo: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".' maxLength: 50 name: type: string description: 'Nome.

Exemplo: "Maria da Silva".' maxLength: 100 gender: type: - string - 'null' description: Gênero enum: - female - male - birthdate: type: - string - 'null' description: 'Data de nascimento no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "1990-02-12".' format: date cpf: type: - string - 'null' description: 'CPF, sem pontos, traços ou espaços.

Exemplo: "38107867807".' maxLength: 11 minLength: 11 rg: type: - string - 'null' description: 'RG, sem pontos, traços ou espaços.

Exemplo: "461196037".' maxLength: 20 passport_number: type: - string - 'null' description: 'Número do passaporte, sem pontos, traços ou espaços.

Exemplo: "FG225776".' maxLength: 20 passport_expiration_date: type: - string - 'null' format: date description: 'Data de expiração do passaporte no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2035-12-01".' foreigner: type: boolean description: Indica se a pessoa é estrangeira. Use `true` para pessoas que não têm nacionalidade brasileira. default: false foreign_identity_document: type: - string - 'null' description: ' Documento de identificação do estrangeiro, emitido em seu país de origem. Sem pontos, traços ou espaços.

Exemplo: "41234567". ' maxLength: 30 business_phone: type: - string - 'null' description: Telefone comercial maxLength: 20 birthplace: "$ref": "#/components/schemas/person_birthplace" additional_data: "$ref": "#/components/schemas/person_additional_data" - "$ref": "#/components/schemas/person" company_person: allOf: - type: object required: - external_id - name properties: external_id: type: string description: 'Identificador **único** utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID.

Exemplo: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".' maxLength: 50 name: type: string description: 'Nome fantasia.

Exemplo: "Epic Journey".' maxLength: 100 legal_name: type: - string - 'null' description: 'Razão social.

Exemplo: "Epic Journey S.A.".' maxLength: 100 cnpj: type: - string - 'null' description: 'CNPJ, sem pontos, barras, traços ou espaços.

Exemplo: "50559280000140".' minLength: 14 maxLength: 14 ie: type: - string - 'null' description: 'Inscrição Estadual, sem pontos, traços ou espaços.

Exemplo: "123456789012".' maxLength: 20 foreigner: type: boolean description: Indica se a empresa é estrangeira. Use `true` para empresas que não estão sediadas no Brasil. default: false website: type: - string - 'null' description: Website (pessoa jurídica) maxLength: 50 tax_identification_number: type: - string - 'null' description: Identificação fiscal (pessoa jurídica estrangeira) maxLength: 20 tax_withholding: "$ref": "#/components/schemas/person_tax_withholding" airline: "$ref": "#/components/schemas/person_airline" - "$ref": "#/components/schemas/person" person_union_fields: type: object properties: person_kind: type: string description: Define se é uma pessoa física (individual) ou jurídica (company). enum: - individual - company external_id: type: string description: 'Identificador **único** utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID.

Exemplo: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".' maxLength: 50 name: type: string description: 'Nome ou nome fantasia, de acordo com o tipo da pessoa.

Exemplo: "Maria da Silva" ou "Epic Journey".' maxLength: 100 legal_name: type: - string - 'null' description: 'Razão social.

Exemplo: "Epic Journey S.A.".' maxLength: 100 gender: type: - string - 'null' description: Gênero enum: - female - male - birthdate: type: - string - 'null' description: 'Data de nascimento no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "1990-02-12".' format: date cpf_cnpj: type: string description: 'CPF ou CNPJ, de acordo com o tipo da pessoa, sem pontos, barras, traços ou espaços.

Exemplo: "38107867807" ou "50559280000140".' minLength: 11 maxLength: 14 rg_ie: type: - string - 'null' description: 'RG ou Inscrição Estadual, de acordo com o tipo da pessoa, sem pontos, traços ou espaços.

Exemplo: "461196037" ou "123456789012".' maxLength: 20 passport_number: type: - string - 'null' description: 'Número do passaporte, sem pontos, traços ou espaços.

Exemplo: "FG225776".' maxLength: 20 passport_expiration_date: type: - string - 'null' format: date description: 'Data de expiração do passaporte no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2035-12-01".' foreigner: type: boolean description: Indica se a pessoa ou empresa é estrangeira. Use `true` para pessoas que não têm nacionalidade brasileira ou empresas que não estão sediadas no Brasil. default: false foreign_identity_document: type: - string - 'null' description: ' Documento de identificação do estrangeiro, emitido em seu país de origem. Sem pontos, traços ou espaços.

Exemplo: "41234567". ' maxLength: 30 business_phone: type: - string - 'null' description: Telefone comercial maxLength: 20 birthplace: "$ref": "#/components/schemas/person_birthplace" additional_data: "$ref": "#/components/schemas/person_additional_data" website: type: - string - 'null' description: Website (pessoa jurídica) maxLength: 50 tax_identification_number: type: - string - 'null' description: Identificação fiscal (pessoa jurídica estrangeira) maxLength: 20 tax_withholding: "$ref": "#/components/schemas/person_tax_withholding" airline: "$ref": "#/components/schemas/person_airline" individual_or_company: allOf: - type: object required: - person_kind - external_id - name - "$ref": "#/components/schemas/person_union_fields" - "$ref": "#/components/schemas/person" person_registration: allOf: - type: object required: - person_kind - name - "$ref": "#/components/schemas/person_union_fields" - "$ref": "#/components/schemas/person" - "$ref": "#/components/schemas/person_references" person_update: allOf: - "$ref": "#/components/schemas/person_union_fields" - "$ref": "#/components/schemas/person" - "$ref": "#/components/schemas/person_update_references" person_update_references: type: object properties: seller: description: Vendedor responsável pela pessoa oneOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' promoter: description: Promotor da pessoa (planos operadora) oneOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' labels: type: array nullable: true description: '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.' items: "$ref": "#/components/schemas/entity_reference" contacts: type: array nullable: true description: '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.' items: "$ref": "#/components/schemas/person_contact" custom_fields: type: array description: 'Campos personalizados de pessoas, definidos pela agência. Diferente das outras listas, não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão, então a lista vazia ou nula não muda nada. O campo enviado com `value` nulo ou vazio é limpo, menos o obrigatório, que é recusado. Envie cada campo por `id` e `value`.' items: "$ref": "#/components/schemas/person_custom_field" credit_cards: type: array nullable: true description: 'Cartões de crédito da pessoa. A lista enviada substitui a atual: como a leitura não devolve o número, o cartão que a pessoa já tem é citado pelo `id` (o mesmo da consulta por ID), com só os campos a alterar; o item sem `id` é um cartão novo, e o cartão que não vier na lista é excluído. Envie uma lista vazia ou nula para excluir todos; omita o campo para manter os atuais. O cartão já vencido pode ser alterado, mas não incluído. Exige a permissão "Ver aba financeiro" de pessoas e, conforme a operação, "Cadastrar Cartão de Crédito" (item sem `id`), "Visualizar dados do Cartão de Crédito" e "Editar Cartão de Crédito" (item com `id` que muda algum campo) e "Remover Cartão de Crédito" (cartão da pessoa deixado de fora da lista).' items: "$ref": "#/components/schemas/person_credit_card_write" cost_centers: type: array nullable: true description: 'Centros de custo do cliente corporativo (não os da agência, de `/cost_centers`). A lista enviada substitui a atual: o nome que a pessoa já tem, sem diferenciar maiúsculas, mantém o centro de custo; o nome novo inclui um; o que não vier na lista é excluído. Os passageiros e itens de fatura que já gravaram um nome não mudam. Envie uma lista vazia ou nula para excluir todos; omita o campo para manter os atuais. Só pessoa jurídica tem centros de custo.' items: "$ref": "#/components/schemas/person_cost_center_write" kandir_law: type: array nullable: true description: '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.' items: "$ref": "#/components/schemas/person_kandir_law_write" representative: allOf: - "$ref": "#/components/schemas/company_person" description: Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor. intermediary: allOf: - "$ref": "#/components/schemas/individual_or_company" description: 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. product_summary: type: object description: Representa um produto disponível no sistema. properties: id: type: string format: uuid description: Identificador único do produto example: f9d961b8-ea88-4346-8e52-afe94267417a name: type: string description: Nome do produto example: Seguro Viagem included_services: type: string nullable: true description: Serviços inclusos no produto example: Cobertura completa para viagens internacionais kind: type: string enum: - insurance - cruise - hotel - airline_ticket - train_ticket - ground_transportation - excursion - visa - car_rental - travel_package - cvc_package - operation - others description: " Tipo do produto.
  • insurance: seguro viagem.
  • cruise: cruzeiro.
  • hotel: diárias de hospedagem.
  • airline_ticket: passagem aérea.
  • train_ticket (others): bilhete de trem.
  • ground_transportation (others): transporte terrestre.
  • excursion (others): excursão.
  • visa (others): visto consular.
  • car_rental: locação de veículos.
  • travel_package: pacotes turísticos.
  • cvc_package: pacote CVC.
  • operation: operação própria.
  • others: outros produtos.
" example: insurance passengers: type: boolean description: Indica se o produto tem passageiros example: true system: type: boolean description: Indica se o produto é do sistema (não pode ser excluído) example: false active: type: boolean description: Indica se o produto está ativo example: true nbs_code: type: string nullable: true description: Código NBS do produto (Nomenclatura Brasileira de Serviços) example: '115022000' required: - id - name - kind - passengers - system - active - included_services product: type: object description: Representa um produto com seus fornecimentos e representantes. allOf: - "$ref": "#/components/schemas/product_summary" - type: object properties: supplies: type: array description: Fornecimentos do produto. Cada fornecimento traz o fornecedor, as condições comerciais e os representantes. items: "$ref": "#/components/schemas/supply" required: - supplies supply: type: object description: Fornecimento do produto, com o fornecedor e as condições comerciais negociadas com ele. properties: &853 id: type: string format: uuid description: Identificador único do fornecimento example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b description: type: string nullable: true description: Descrição do fornecimento (campo opcional). example: Fornecimento padrão commission_type: &4 type: string enum: - percentage - amount description: Tipo da comissão — percentage (percentual) ou amount (valor). example: percentage commission_percentage: &5 type: number format: double description: Percentual de comissão. example: 10.0 commission_amount: &6 type: number format: double description: Valor da comissão. example: 0.0 over_percentage: &7 type: number format: double description: Percentual de over. example: 0.0 over_value: &8 type: number format: double description: Percentual aplicado sobre o over. example: 100.0 du_percentage: &9 type: number format: double description: Percentual da taxa de cartão DU. example: 0.0 rav_percentage: &10 type: number format: double description: Percentual da taxa de cartão RAV. example: 0.0 restitutes_kandir_law: type: boolean description: Indica se o fornecimento restitui a Lei Kandir. example: true supplier: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Fornecedor do fornecimento.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representations: type: array description: Representantes vinculados ao fornecimento. items: "$ref": "#/components/schemas/representation" representation: type: object description: Representante vinculado a um fornecimento, com as condições comerciais próprias. properties: &852 id: type: string format: uuid description: Identificador único do representante no fornecimento example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a commission_type: *4 commission_percentage: *5 commission_amount: *6 over_percentage: *7 over_value: *8 du_percentage: *9 rav_percentage: *10 representative: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Representante do fornecimento.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
product_create: type: object writeOnly: true description: Dados para criar um produto. required: - name properties: &11 name: &858 type: string maxLength: 50 description: Nome do produto example: Passeio de Barco included_services: &859 type: string nullable: true description: Serviços inclusos no produto example: Passeio de escuna com almoço active: &860 type: boolean default: true description: Indica se o produto está ativo example: true nbs_code: &861 type: string nullable: true description: Código NBS do produto (Nomenclatura Brasileira de Serviços) example: 1.2501.11.00 kind: &862 type: string enum: - others - operation default: others description: " Tipo do produto. Na criação só são aceitos:
  • others (padrão): outros produtos.
  • operation: operação própria, só em base de agência.
Não muda depois do cadastro. " example: others passengers: &863 type: boolean default: true description: Indica se o produto tem passageiros. Padrão `true`. Não muda depois do cadastro. example: true product_update: type: object writeOnly: true description: Dados para alterar um produto. Todos os campos são opcionais. properties: *11 supply_create: type: object writeOnly: true description: Dados para adicionar um fornecedor ao produto. required: - supplier properties: &12 supplier: &854 allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do fornecimento.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
description: &855 type: string nullable: true maxLength: 50 description: Descrição do fornecimento (campo opcional). example: Tarifa net restitutes_kandir_law: &856 type: boolean description: Indica se o fornecimento restitui a Lei Kandir. example: true commission_type: &13 type: string enum: - percentage - amount description: Tipo da comissão — percentage (percentual) ou amount (valor). example: percentage commission_percentage: &14 type: number format: double description: Percentual de comissão. example: 10.0 commission_amount: &15 type: number format: double description: Valor da comissão. example: 0.0 over_percentage: &16 type: number format: double description: Percentual de over. example: 0.0 over_value: &17 type: number format: double description: Percentual aplicado sobre o over. example: 100.0 du_percentage: &18 type: number format: double description: Percentual da taxa de cartão DU. example: 0.0 rav_percentage: &19 type: number format: double description: Percentual da taxa de cartão RAV. example: 0.0 supply_update: type: object writeOnly: true description: Dados para alterar um fornecimento. Todos os campos são opcionais. properties: *12 representation_create: type: object writeOnly: true description: Dados para adicionar um representante ao fornecimento. required: - representative properties: &20 representative: &857 allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do fornecimento.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
commission_type: *13 commission_percentage: *14 commission_amount: *15 over_percentage: *16 over_value: *17 du_percentage: *18 rav_percentage: *19 representation_update: type: object writeOnly: true description: Dados para alterar um representante. Todos os campos são opcionais. properties: *20 company_identifier: type: string description: 'CNPJ da agência de viagens emissora da venda. Deve conter somente dígitos.

Exemplo: "86452403000197".' pattern: "^[0-9]{14}$" minLength: 14 maxLength: 14 sale_date: type: string format: date description: 'Data da venda no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2026-11-16".' operation_id: type: string writeOnly: true description: 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. seller_create: type: object description: Dados para cadastrar um vendedor. required: - name - external_id - person_id properties: external_id: type: string description: 'Identificador **único** utilizado para identificar o registro no Monde. Você deve fornecer essa informação e utilizá-la em futuras referências ao mesmo registro. Permitido qualquer string única, como um documento ou UUID.

Exemplo: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".' maxLength: 50 name: type: string description: 'Nome.

Exemplo: "Maria da Silva".' maxLength: 100 cpf: type: string description: 'CPF, sem pontos, traços ou espaços.

Exemplo: "38107867807".' maxLength: 11 minLength: 11 person_id: type: string format: uuid description: Identificador da pessoa física que passa a ser vendedor example: f9d961b8-ea88-4346-8e52-afe94267417a active: type: boolean default: true description: Indica se o vendedor nasce ativo. Omitido, o vendedor nasce ativo example: true writeOnly: true custom_field: type: object required: - id properties: id: type: integer description: Identificador da definição do campo personalizado (o mesmo retornado em Consultar campos personalizados). É por ele que o valor é enviado na criação da venda. O nome, o tipo e as opções da definição saem da consulta de definições de campos personalizados ou de Consultar campo personalizado por ID. example: 123 value: type: - string - number - 'null' description: | Valor do campo personalizado. Deve corresponder ao kind do campo: - numeric: número inteiro. - currency: valor monetário (número). - text: texto livre. - date: data no formato ISO 8601 (YYYY-MM-DD). - choices: uma das opções cadastradas para o campo, enviada como texto. Envie sempre um valor simples (número, texto ou data), nunca um objeto ou lista; um valor não simples é ignorado. commission_create: type: object writeOnly: true required: - person - kind - value properties: person: allOf: - "$ref": "#/components/schemas/individual_or_company" description: Pessoa que recebe a comissão. É procurada pelo `external_id` e, sem vínculo, pelo CPF/CNPJ; não achando, é cadastrada. Pessoa já cadastrada só tem preenchidos os campos que estão vazios. Pode repetir o `external_id` do vendedor, do intermediário ou de outra pessoa da venda. kind: type: string enum: - seller - intermediary - person description: 'Papel da comissão. `seller` e `intermediary` gravam o cargo de sistema correspondente; `person` grava sem cargo. O papel não restringe quem recebe: a comissão de vendedor pode ir para qualquer pessoa. `intermediary` exige que a venda tenha intermediário. Sem `description`, `seller` e `intermediary` gravam “Comissão Vendedor” e “Comissão Intermediário”.' value: type: number format: double multipleOf: 0.01 exclusiveMaximum: 100000000000 description: Valor da comissão.
  • Deve ser informado em reais (BRL).
description: type: - string - 'null' description: 'Descrição da comissão: texto livre informado manualmente ou a frase do plano de comissão que a originou.' retained_value: type: number format: double multipleOf: 0.01 exclusiveMaximum: 100000000000 description: Valor retido da comissão. Opcional, assume 0 quando omitido.
  • Deve ser informado em reais (BRL).
sale_totals: type: object readOnly: true properties: products: type: number format: double readOnly: true description: Total dos produtos.
  • Vem na moeda de venda dos produtos (`sale_currency`), BRL salvo na operadora. Com produtos em moedas de venda diferentes, os valores são somados como estão.
fees: type: number format: double readOnly: true description: Total de taxas.
  • Vem na moeda de venda dos produtos (`sale_currency`), BRL salvo na operadora. Com produtos em moedas de venda diferentes, os valores são somados como estão.
discount: type: number format: double readOnly: true description: Total de descontos.
  • Vem na moeda de venda dos produtos (`sale_currency`), BRL salvo na operadora. Com produtos em moedas de venda diferentes, os valores são somados como estão.
revenue: type: number format: double readOnly: true description: Receita total da venda.
  • Vem na moeda de venda dos produtos (`sale_currency`), BRL salvo na operadora. Com produtos em moedas de venda diferentes, os valores são somados como estão.
balance: type: number format: double readOnly: true description: Saldo a pagar da venda.
  • Vem na moeda de venda dos produtos (`sale_currency`), BRL salvo na operadora. Com produtos em moedas de venda diferentes, os valores são somados como estão.
final_amount: type: number format: double readOnly: true description: Valor final da venda.
  • Vem na moeda de venda dos produtos (`sale_currency`), BRL salvo na operadora. Com produtos em moedas de venda diferentes, os valores são somados como estão.
sale: type: object required: - company_identifier - sale_date - payer - seller - id - sale_number properties: company_identifier: "$ref": "#/components/schemas/company_identifier" id: type: string format: uuid readOnly: true description: Identificador único da venda (formato UUID). example: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_number: type: integer readOnly: true description: Número sequencial da venda gerado automaticamente pelo sistema. example: 987 sale_date: "$ref": "#/components/schemas/sale_date" departure_date: type: string format: date readOnly: true description: 'Data de início da viagem no formato ISO 8601 (AAAA-MM-DD), calculada considerando a menor data de início entre todos os produtos da venda (check-in de hotéis, início de seguros, partida de cruzeiros, etc.).

Exemplo: "2024-03-15".' example: '2024-03-15' return_date: type: string format: date readOnly: true description: 'Data de fim da viagem no formato ISO 8601 (AAAA-MM-DD), calculada considerando a maior data de fim entre todos os produtos da venda (check-out de hotéis, fim de seguros, chegada de cruzeiros, etc.).

Exemplo: "2024-03-22".' example: '2024-03-22' status: type: string default: opened enum: - opened - closed description: Situação da venda na criação. Padrão `opened`. Envie `closed` para já criar a venda fechada. Isso exige que ela atenda a todas as regras de fechamento (sem saldo pendente). Se não puder fechar, a criação inteira é recusada com 422. observations: type: string nullable: true description: Observações gerais da venda, em texto livre e sem limite de tamanho. printed_receipt: type: boolean readOnly: true description: Indica se o recibo da venda foi impresso. example: false created_at: type: string format: date-time readOnly: true description: Data e hora de cadastro da venda. example: '2024-03-15T10:30:00' created_by: type: object nullable: true readOnly: true description: Pessoa que cadastrou a venda. properties: id: type: string format: uuid description: Identificador único da pessoa que cadastrou a venda. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 name: type: string description: Nome da pessoa que cadastrou a venda. example: Maria da Silva required: - id - name operation_id: "$ref": "#/components/schemas/operation_id" custom_fields: type: array description: Campos personalizados da venda, definidos pela agência. Na criação, envie cada campo por `id` e `value`; os campos ativos e obrigatórios do módulo de vendas passam a ser exigidos. items: "$ref": "#/components/schemas/custom_field" seller: "$ref": "#/components/schemas/seller_create" payer: allOf: - "$ref": "#/components/schemas/individual_or_company" description: 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. intermediary: oneOf: - "$ref": "#/components/schemas/intermediary" - type: 'null' requester: description: Pessoa física que solicitou a venda. oneOf: - "$ref": "#/components/schemas/individual_person" - type: 'null' approver: description: 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. oneOf: - "$ref": "#/components/schemas/individual_or_company" - type: 'null' promoter: readOnly: true description: 'Promotor da venda, só na operadora (consolidadora). Não é enviado na criação nem na edição: é o promotor do cadastro do intermediário, copiado quando a venda é criada e a cada troca de intermediário. Sem intermediário com promotor, vem nulo.' oneOf: - "$ref": "#/components/schemas/individual_or_company" - type: 'null' insurances: type: array description: Seguro viagem. items: "$ref": "#/components/schemas/insurance" cruises: type: array description: Cruzeiro. items: "$ref": "#/components/schemas/cruise" hotels: type: array description: Diárias de hospedagem. items: "$ref": "#/components/schemas/hotel" airline_tickets: type: array description: Passagem aérea. items: "$ref": "#/components/schemas/airline_ticket" train_tickets: type: array description: " Bilhete de trem. " items: "$ref": "#/components/schemas/train_ticket" ground_transportations: type: array description: " Transporte terrestre. " items: "$ref": "#/components/schemas/ground_transportation" car_rentals: type: array description: Locação de veículos. items: "$ref": "#/components/schemas/car_rental" travel_packages: type: array description: Pacotes turísticos. items: "$ref": "#/components/schemas/travel_package" excursions: type: array description: " Passeios (excursões) da venda. A excursão é um produto do sistema: não é preciso informar qual produto está sendo vendido. " items: "$ref": "#/components/schemas/excursion" visas: type: array description: " Vistos consulares da venda, um por pedido de visto. O visto é um produto do sistema: não é preciso informar qual produto está sendo vendido. Cada passageiro é um solicitante do visto.

Não há campo próprio para a taxa consular nem para a taxa de serviço: a taxa consular de cada solicitante vai em passengers[].fees (e soma no total da venda), e a taxa de serviço da agência vai em agency_service_fee do produto. " items: "$ref": "#/components/schemas/visa" operation: allOf: - "$ref": "#/components/schemas/operation" nullable: true description: Produto de operação própria da venda. No máximo um por venda, e o produto informado precisa ser o mesmo de `operation_id` quando os dois vierem. Exclusivo da agência; na operadora (consolidadora), o campo é recusado com 422. others: type: array description: Outros produtos da venda, que podem ou não ter passageiros. items: "$ref": "#/components/schemas/others" cvc_packages: type: array readOnly: true description: Pacotes CVC da venda. Sempre sem passageiros. items: "$ref": "#/components/schemas/cvc_package" payments: type: array description: " Lista de pagamentos realizados na venda. Cada pagamento tem uma única forma e pode ser distribuído entre um ou mais produtos, apontados por `sale_product_local_id` ou `sale_product_id`, permitindo o controle detalhado de como os valores foram alocados por produto. " items: "$ref": "#/components/schemas/payment" commissions: type: array description: Comissões a gravar na venda. Só é aceito quando `status` é `closed`; o saldo de cada linha é o valor menos o valor retido. Na criação da venda, a lista com alguma comissão exige as permissões "Ver aba comissões" e "Adicionar comissões" de vendas. items: "$ref": "#/components/schemas/commission_create" attachments: type: array readOnly: true description: Lista de anexos do registro. items: "$ref": "#/components/schemas/attachment_summary" totals: allOf: - "$ref": "#/components/schemas/sale_totals" description: Totais consolidados da venda. financial: allOf: - "$ref": "#/components/schemas/financial" description: 'Financeiro da venda: observações financeiras, repasses a fornecedor e lançamentos avulsos de conta a pagar/receber.' sale_product_reference: type: object properties: id: type: string format: uuid description: 'Identificador de um produto que a venda já tem (o mesmo da consulta por ID). Com ele, o produto é alterado; sem ele, é incluído. Com o id, o local_id passa a ser opcional: um pagamento da mesma requisição aponta este produto por sale_product_id.' example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 sale_update: type: object description: 'Campos da alteração de venda. Todos são opcionais: o campo omitido permanece como está.' properties: company_identifier: type: string description: CNPJ da empresa da venda. Com outro CNPJ, a venda passa para essa empresa, se as regras da troca permitirem. example: '46598887000162' sale_date: "$ref": "#/components/schemas/sale_date" status: type: string enum: - opened - closed description: 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: "$ref": "#/components/schemas/operation_id" observations: type: string nullable: true description: 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. custom_fields: type: array description: '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.' items: "$ref": "#/components/schemas/custom_field" seller: "$ref": "#/components/schemas/seller_create" payer: allOf: - "$ref": "#/components/schemas/individual_or_company" description: 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. intermediary: "$ref": "#/components/schemas/intermediary" requester: allOf: - "$ref": "#/components/schemas/individual_person" description: Pessoa física que solicitou a venda. approver: allOf: - "$ref": "#/components/schemas/individual_or_company" description: 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. insurances: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/insurance" cruises: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/cruise" hotels: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/hotel" airline_tickets: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/airline_ticket" train_tickets: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/train_ticket" ground_transportations: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/ground_transportation" car_rentals: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/car_rental" travel_packages: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/travel_package" excursions: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/excursion" others: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/others" visas: type: array description: 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. items: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/visa" operation: allOf: - "$ref": "#/components/schemas/sale_product_reference" - "$ref": "#/components/schemas/operation" description: 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. payments: type: array description: 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. items: "$ref": "#/components/schemas/payment_update" commissions: type: array description: 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. items: "$ref": "#/components/schemas/commission_create" sale_product_passenger_person: type: object description: A pessoa do passageiro, pelo `id`. required: - id properties: id: type: string format: uuid description: O `id` da pessoa do passageiro, como em `passengers[].person.id` na consulta da venda. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 sale_product_cancellation: type: object description: O cancelamento do produto. Com passageiros, `passengers` é obrigatório e cada item traz `person` e `canceled_at`; o produto fica cancelado quando a lista cancela os que faltavam. No produto sem passageiros, envie só as opções, ou `{}`. `canceled_at` na raiz é recusado. Campo que não está na documentação é ignorado. properties: passengers: type: array description: '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.' items: type: object required: - person - canceled_at properties: person: "$ref": "#/components/schemas/sale_product_passenger_person" canceled_at: type: string format: date description: Data de cancelamento deste passageiro, no formato `AAAA-MM-DD`. Obrigatória. Não pode ser anterior à data da venda. example: '2026-10-15' calculate_commission: type: boolean default: false description: Mantém o produto cancelado no cálculo da meta dos planos de comissão (o mesmo `calculate_commission` da consulta do produto). Padrão `false`. Só vale quando o pedido deixa todos os passageiros cancelados. delete_customer_balance: type: boolean default: false description: Exclui o saldo pendente a receber do cliente neste produto, que passa a ser saldo excluído. delete_supplier_balance: type: boolean default: false description: 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: type: number format: double minimum: 0 default: 0 description: 'Multa cobrada pelo fornecedor, em valor positivo, na moeda em que o fornecedor é pago: a moeda final da venda na agência e a moeda de origem do produto na operadora. Na consulta, volta em `supplier_fine` na agência e em `supplier_fine_origin_currency` na operadora. Exige `delete_supplier_balance`.' example: 150.0 sale_product_reactivation: type: object description: A reativação do produto. Com passageiros, `passengers` é obrigatório e cada item traz `person`; o produto inteiro volta quando a lista traz todos os cancelados. No produto sem passageiros, envie `{}`. Campo que não está na documentação é ignorado; os campos do cancelamento são recusados. properties: passengers: type: array description: '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.' items: type: object required: - person properties: person: "$ref": "#/components/schemas/sale_product_passenger_person" sale_totals_read: type: object readOnly: true description: Agregado de totais da venda. properties: products: type: number format: double description: Soma do valor dos produtos da venda em BRL. fees: type: number format: double description: Soma das taxas da venda em BRL. discount: type: number format: double description: Soma dos descontos da venda em BRL. revenue: type: number format: double description: Receita apurada da venda em BRL. balance: type: number format: double description: Saldo remanescente da venda em BRL. final_amount: type: number format: double description: Valor final da venda em BRL. sale_summary: type: object readOnly: true description: Item da consulta de vendas. Traz os campos escalares da venda, as referências relacionadas no formato id/name e o agregado de totais, sem as entidades fracas (produtos, pagamentos, comissões, anexos, financeiro e campos personalizados), que ficam disponíveis apenas na consulta por ID. required: - id - sale_number properties: id: type: string format: uuid description: Identificador único da venda no formato UUID. example: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_number: type: integer description: Número sequencial da venda gerado automaticamente pelo sistema. example: 987 sale_date: type: string format: date description: Data da venda no formato ISO 8601 (AAAA-MM-DD). departure_date: type: string format: date nullable: true description: Data de início da viagem no formato ISO 8601 (AAAA-MM-DD), calculada pela menor data de início entre os produtos da venda. return_date: type: string format: date nullable: true description: Data de fim da viagem no formato ISO 8601 (AAAA-MM-DD), calculada pela maior data de fim entre os produtos da venda. status: type: string enum: - opened - closed - canceled description: Situação atual da venda. observations: type: string nullable: true description: Observações gerais da venda. printed_receipt: type: boolean description: Indica se o recibo da venda foi impresso. created_at: type: string format: date-time nullable: true description: Data e hora de cadastro da venda. totals: allOf: - "$ref": "#/components/schemas/sale_totals_read" description: Agregado de totais da venda. sale_detail: readOnly: true description: Consulta completa de uma venda. Além dos campos da consulta em lista, embute as entidades fracas da venda (arrays de produto por tipo, pagamentos, comissões, anexos, financeiro e campos personalizados). allOf: - "$ref": "#/components/schemas/sale_summary" - type: object required: - company properties: company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Empresa emissora da venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência à pessoa que efetuou o cadastro da venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
operation: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Operação própria à qual a venda pertence. Vem preenchida mesmo quando nenhum produto de operação própria consta na venda.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência ao vendedor responsável pela venda.
  • Chame o endpoint [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get) para os dados completos.
payer: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência ao contratante responsável pelo pagamento da venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
intermediary: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência ao intermediário da venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
requester: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência à pessoa que solicitou a venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
approver: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência à pessoa que aprovou a venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
promoter: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência ao promotor da venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
travel: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Referência à viagem à qual a venda pertence.
  • Chame o endpoint [Consultar viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get) para os dados completos.
custom_fields: type: array description: Campos personalizados preenchidos na venda. items: "$ref": "#/components/schemas/custom_field" insurances: type: array description: Seguros viagem da venda. items: "$ref": "#/components/schemas/insurance_read" cruises: type: array description: Cruzeiros da venda. items: "$ref": "#/components/schemas/cruise_read" hotels: type: array description: Diárias de hospedagem da venda. items: "$ref": "#/components/schemas/hotel_read" airline_tickets: type: array description: Passagens aéreas da venda. items: "$ref": "#/components/schemas/airline_ticket_read" train_tickets: type: array description: Bilhetes de trem da venda. items: "$ref": "#/components/schemas/train_ticket_read" ground_transportations: type: array description: Transportes terrestres da venda. items: "$ref": "#/components/schemas/ground_transportation_read" car_rentals: type: array description: Locações de veículo da venda. items: "$ref": "#/components/schemas/car_rental_read" travel_packages: type: array description: Pacotes de viagem da venda. items: "$ref": "#/components/schemas/travel_package_read" others: type: array description: Outros produtos da venda. items: "$ref": "#/components/schemas/others_read" excursions: type: array description: Passeios (excursões) da venda. items: "$ref": "#/components/schemas/excursion_read" visas: type: array description: Vistos consulares da venda. items: "$ref": "#/components/schemas/visa_read" cvc_packages: type: array description: Pacotes CVC da venda. items: "$ref": "#/components/schemas/cvc_package_read" operations: type: array description: Produtos de operação própria vendidos na venda, cada um com documento, valores e passageiros próprios. Todos pertencem à operação do campo `operation`; vendas antigas podem trazer mais de um. items: "$ref": "#/components/schemas/operation_read" payments: allOf: - "$ref": "#/components/schemas/payment_read" description: Pagamentos da venda, separados entre os destinados à agência e os destinados ao fornecedor. commissions: type: array description: Comissões da venda. items: "$ref": "#/components/schemas/commission" attachments: type: array description: Anexos da venda. items: "$ref": "#/components/schemas/attachment_summary" financial: allOf: - "$ref": "#/components/schemas/financial" description: Financeiro da venda. sales_response: type: object description: Resposta contendo uma lista paginada de vendas na forma de consulta. properties: data: type: array description: Array contendo as vendas da página atual. items: "$ref": "#/components/schemas/sale_summary" pagination: "$ref": "#/components/schemas/pagination" financial: type: object readOnly: true description: 'Financeiro da venda: observações financeiras, repasses a fornecedor por produto e lançamentos avulsos de conta a pagar/receber vinculados à venda.' properties: observations: type: - string - 'null' description: Observações financeiras da venda. vendor_bills: type: array description: |- Lançamentos que contêm os repasses a fornecedor desta venda. Um lançamento pode agregar repasses de várias vendas; use o `sale` de cada item para filtrar os desta.
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" standalone_bills: type: array description: |- Lançamentos avulsos de conta a pagar ou receber vinculados diretamente a esta venda.
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" vendor_items: type: array description: 'Os itens do fornecedor da venda, como na aba Financeiro do Monde: o que falta faturar, o que já está num lançamento e o que foi pago direto ao fornecedor, de todos os produtos, por vencimento. O item aguardando exclusão não vem. O vencimento e a descrição do item que ainda não está num lançamento nem foi pago direto mudam em [Alterar item do fornecedor da venda](#tag/Vendas/paths/~1sales~1{sale_id}~1vendor_items~1{id}/patch).' items: "$ref": "#/components/schemas/sale_vendor_item" sale_vendor_item: type: object readOnly: true description: 'Item do fornecedor da venda, uma linha da aba Financeiro do Monde: o que a agência acerta com o fornecedor ou o representante por um produto da venda.' properties: id: type: string format: uuid description: Identificador do item (UUID). É o `id` que [Alterar item do fornecedor da venda](#tag/Vendas/paths/~1sales~1{sale_id}~1vendor_items~1{id}/patch) recebe. example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 kind: type: string enum: - invoice - refund - signal - lei_kandir - reversal - leftover - retained - fine - cvc - generated_credit description: |- O que o item é: - `invoice`: o valor a faturar ao fornecedor pelo produto. - `refund`: reembolso do fornecedor. - `signal`: sinal. - `lei_kandir`: Lei Kandir. - `reversal`: estorno. - `leftover`: saldo. - `retained`: valor retido. - `fine`: multa do fornecedor no cancelamento do produto. - `cvc`: item do extrato CVC. - `generated_credit`: crédito gerado para o fornecedor, tratado no crédito da pessoa. example: invoice description: type: - string - 'null' maxLength: 100 description: Descrição do item. example: Faturar em dezembro due_date: type: - string - 'null' format: date description: Vencimento do item. No item que já está num lançamento (`bill`), é o vencimento do lançamento, como no Monde. example: '2026-12-15' amount: type: number format: double description: Valor do item, na moeda de `currency`. Negativo é o que a agência paga ao fornecedor; positivo, o que o fornecedor paga à agência. example: -650.95 currency: type: string minLength: 3 maxLength: 3 description: Moeda do item (código ISO 4217). example: BRL sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto da venda do item.
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor ou representante do item.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
bill: anyOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' description: |- Lançamento (fatura ou conta a pagar/receber) em que o item está. Nulo enquanto o item não foi faturado.
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
payment: anyOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' description: 'Pagamento feito direto ao fornecedor que quita o item: o `id` do pagamento em `payments.vendor`, na consulta da venda. Nulo quando o item não foi pago direto.' required: - id - kind - description - due_date - amount - currency - sale_product - person - bill - payment sale_vendor_item_update: type: object description: Os campos do item que mudam. O campo omitido fica como está. properties: due_date: type: string format: date description: 'Novo vencimento do item, no formato ISO 8601 (AAAA-MM-DD). O vencimento é obrigatório: `null` ou texto vazio responde `422`.' example: '2026-12-15' description: type: - string - 'null' maxLength: 100 description: Nova descrição do item, com até 100 caracteres. `null` deixa o item sem descrição. example: Faturar em dezembro sale_vendor_invoice_create: type: object writeOnly: true description: 'O pagamento avulso ou o sinal a gerar: o tipo e os itens do fornecedor, cada um com o valor.' properties: kind: type: string enum: - advance - deposit description: |- O que gerar, como no Monde: - `advance`: **Gerar Pagamento Avulso ou Sinal**, da aba Financeiro da venda. A fatura sai com a descrição "Pagamento Avulso". - `deposit`: **Sinal Fornecedor**, do menu do produto. A fatura sai com a descrição "Sinal", e o movimento de cada item é sempre o do saldo dele. example: advance product_id: type: string format: uuid description: 'Produto da venda (UUID, o `id` em `products` na consulta da venda), como o **Sinal Fornecedor** do menu do produto: todos os itens precisam ser desse produto. O produto que não é da venda responde `404`; o de operação própria ou excluído responde `422`.' example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 items: type: array minItems: 1 description: 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. items: type: object properties: id: type: string format: uuid description: Identificador do item do fornecedor (UUID), o `id` do item em `financial.vendor_items` na consulta da venda. Em aberto é o item sem lançamento (`bill` nulo) e sem pagamento direto (`payment` nulo); com a fatura automática do fornecedor, também o que está na fatura automática ainda não liquidada. example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 amount: type: number format: double exclusiveMinimum: 0 multipleOf: 0.01 description: 'Valor a gerar do item, maior que zero, na moeda do item. Não tem teto, como no Monde. O valor igual ao do item leva o item inteiro para a fatura; o valor diferente divide o item: a parte gerada vai para a fatura e a sobra fica em aberto.' example: 650.95 transaction_kind: type: string enum: - debit - credit description: |- O movimento do item, como a coluna Movimento do Monde: - `debit`: Pagar, a agência paga ao fornecedor. - `credit`: Receber, o fornecedor paga à agência. Omitido, vale o do saldo do item: `debit` no item negativo, `credit` no positivo. Em `deposit` o campo é ignorado, e vale sempre o do saldo. example: debit required: - id - amount required: - kind - items sale_to_invoice_product: type: object writeOnly: true properties: sale_product_id: type: string format: uuid description: Produto da venda (UUID, o `id` do produto na consulta da venda). example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 amount: type: number format: double multipleOf: 0.01 description: 'Valor do produto, diferente de zero, na moeda de venda, com o sinal do saldo do cliente do produto, como a tela do Monde mostra: negativo no produto de saldo negativo, positivo nos outros. O sinal trocado responde `422`.' example: 650.95 required: - sale_product_id - amount sale_to_invoice_products: type: array writeOnly: true minItems: 1 description: '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.' items: "$ref": "#/components/schemas/sale_to_invoice_product" sale_to_invoice_payer_id: type: string format: uuid writeOnly: true description: Pagante (UUID de pessoa, o `id` de [Consultar pessoas](#tag/Pessoas/paths/~1people/get)). Omitido, é o pagante da venda. A pessoa que não existe responde `422`. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 sale_to_invoice_create: type: object writeOnly: true description: 'O Faturar a incluir: o pagante, o centro de custo e o valor de cada produto.' properties: payer_id: "$ref": "#/components/schemas/sale_to_invoice_payer_id" cost_center: type: string maxLength: 50 description: 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. example: Diretoria products: "$ref": "#/components/schemas/sale_to_invoice_products" required: - products sale_to_invoice_return_create: type: object writeOnly: true description: 'A Devolução Faturar a incluir: o pagante, a descrição e o valor de cada produto.' properties: payer_id: "$ref": "#/components/schemas/sale_to_invoice_payer_id" description: type: string maxLength: 100 description: Descrição da Devolução Faturar, até 100 caracteres. example: Reembolso do seguro products: "$ref": "#/components/schemas/sale_to_invoice_products" required: - products sale_to_invoice_removal: type: object writeOnly: true description: A linha do Faturar a remover, apontada pela fatura de cliente e pelo centro de custo, e as confirmações que o Monde pergunta antes de excluir. properties: bill_id: type: string format: uuid description: Fatura de cliente da linha (UUID, o `bill.id` da linha em `payments.agency.to_invoice` na consulta da venda). example: 4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819 cost_center: type: string nullable: true description: Centro de custo da linha, o `cost_center` dela na consulta da venda. Nulo, vazio ou omitido aponta a linha sem centro de custo. example: reopen_sale: type: boolean default: false description: Confirma a reabertura da venda fechada, como o Monde pergunta antes de excluir. Com `true`, a venda fechada é reaberta e o Faturar é removido; exige também a permissão "Reabrir venda". Sem a confirmação, a venda fechada responde `409`. Na venda aberta, não tem efeito. example: false remove_settlement: type: boolean default: false description: Confirma desfazer a liquidação da fatura de cliente liquidada, como o Monde pergunta antes de excluir. Sem a confirmação, a fatura liquidada responde `409`. Na fatura em aberto, não tem efeito. example: false required: - bill_id commission: type: object readOnly: true description: 'Comissão da venda: uma linha do rateio de comissão para uma pessoa (vendedor, intermediário ou outra função).' properties: description: type: - string - 'null' description: 'Descrição da comissão: texto livre informado manualmente ou a frase do plano de comissão que a originou.' amount: type: number format: double multipleOf: 0.01 description: Valor da comissão. Pode ser negativo quando se trata de um ajuste.
  • Deve ser informado em reais (BRL).
retained_amount: type: number format: double multipleOf: 0.01 description: Valor retido da comissão.
  • Deve ser informado em reais (BRL).
balance: type: number format: double multipleOf: 0.01 description: Saldo da comissão (valor menos valor retido).
  • Deve ser informado em reais (BRL).
person: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Pessoa que recebe a comissão.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
required: - amount - retained_amount - balance - person attachment: type: object required: - resource_type - resource_id - file properties: resource_type: type: string enum: - sale - person - bill - travel - task description: 'Recurso que irá receber o anexo: "sale" para uma venda, "person" para uma pessoa, "bill" para uma conta a pagar ou receber, "travel" para uma viagem, "task" para uma tarefa.

Exemplo: "sale"' resource_id: type: string format: uuid description: 'ID do recurso que irá receber o anexo.

Exemplo: "cc36d5d7-b699-43f1-b081-24c15e2db5e8"' file: type: string format: binary description: 'Arquivo binário a ser anexado.
  • Apenas 1 arquivo por requisição.
  • Extensões permitidas: .pdf, .doc, .docx, .odt, .xls, .xlsx, .ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic, .heif, .txt, .csv.
  • Tamanho máximo por arquivo: 12 MB.
' description: type: string description: '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 (-).' maxLength: 255 attachment_summary: type: object readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador do anexo. description: type: string readOnly: true description: Descrição do anexo. extension: type: string readOnly: true description: 'Extensão do arquivo, em minúsculas e sem o ponto inicial.

Exemplo: "pdf"' content_type: type: string readOnly: true description: 'Tipo MIME derivado da extensão do arquivo. Quando a extensão for desconhecida, retorna "application/octet-stream".

Exemplo: "application/pdf"' download_url: type: string format: uri readOnly: true description: Endereço para baixar o conteúdo deste anexo. Basta segui-lo usando as mesmas credenciais da API; a resposta redireciona (302) para um link temporário do arquivo, que expira em poucos minutos. Um novo acesso a esta URL gera um novo link temporário.

O conteúdo é retornado compactado em gzip e sem o cabeçalho Content-Encoding, então deve ser descompactado explicitamente antes do uso. O tipo e a extensão reais do arquivo estão nos campos content_type e extension. attachments_response: type: object required: - id properties: id: type: string format: uuid description: Identificador do anexo. description: type: string description: Descrição do anexo. maxLength: 255 extension: type: string description: 'Extensão do arquivo, em minúsculas e sem o ponto inicial.

Exemplo: "pdf"' content_type: type: string description: 'Tipo MIME derivado da extensão do arquivo. Quando a extensão for desconhecida, retorna "application/octet-stream".

Exemplo: "application/pdf"' download_url: type: string format: uri description: Endereço para baixar o conteúdo deste anexo. Basta segui-lo usando as mesmas credenciais da API; a resposta redireciona (302) para um link temporário do arquivo, que expira em poucos minutos. Um novo acesso a esta URL gera um novo link temporário.

O conteúdo é retornado compactado em gzip e sem o cabeçalho Content-Encoding, então deve ser descompactado explicitamente antes do uso. O tipo e a extensão reais do arquivo estão nos campos content_type e extension. sale_product_id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. sale_product_local_id: type: string writeOnly: true description: 'Nome que você dá ao produto, **obrigatório** no produto novo e único entre os produtos da requisição. Ele liga o produto que você enviou ao `id` que o Monde gera: a resposta traz cada produto com o `id` ao lado deste `local_id`. Guarde o `id` e use-o para alterar o produto depois. Nesta mesma requisição, os pagamentos apontam o produto por ele (`sale_product_local_id`). Não é gravado, então não volta na consulta da venda. Aceita qualquer texto, como o código do produto no seu sistema.' maxLength: 50 product_status: type: string readOnly: true enum: - active - canceled - deleted description: Situação do produto na venda. product_issue_date: type: string format: date readOnly: true description: Data de emissão do produto. product_canceled_at: type: string format: date-time readOnly: true description: Data de cancelamento do produto. product_calculate_commission: type: boolean readOnly: true description: Se o produto entra no cálculo da meta dos planos de comissão. O produto ativo sempre entra; o cancelado só entra quando foi cancelado com `calculate_commission`. product_deleted_balance: type: number format: double readOnly: true description: Saldo do cliente excluído no cancelamento do produto ou de passageiros dele, com `delete_customer_balance`, na moeda final da venda. Reduz a receita da venda. Zero quando o cancelamento não excluiu saldo. product_delete_supplier_balance: type: boolean readOnly: true description: Se o cancelamento do produto excluiu o saldo em aberto do fornecedor, com `delete_supplier_balance`. product_supplier_fine: type: number format: double readOnly: true description: Multa cobrada pelo fornecedor no cancelamento do produto, em valor positivo, na moeda final da venda; o valor na moeda de origem vem em `supplier_fine_origin_currency`. Zero quando não há multa. product_supplier_fine_origin_currency: type: number format: double readOnly: true description: Valor de `supplier_fine` na moeda de origem do produto (`origin_currency`). product_observations: type: string readOnly: true description: Observações do produto. vendor_reservation_url: type: string description: URL da reserva no sistema de origem. Utilize esse campo para informar um link para a reserva que está originando esta venda. O link será utilizado para criar um atalho de acesso do Monde ao seu sistema, permitindo que os usuários naveguem rapidamente de um sistema para o outro. format: uri sale_product_external_number: type: - string - 'null' maxLength: 20 description: 'Campo adicional do produto, com o título que a agência deu a ele no Monde (por exemplo, "Nº Pedido"). Consulte o título de cada campo em [Consultar campos adicionais do produto](#tag/Vendas/paths/~1sale_product_additional_fields/get), que traz este campo como `external_number`. O campo sem título não aparece no Monde: a API ignora o valor enviado e não o devolve na consulta. Na edição, omitir mantém o valor gravado e enviar `null` o retira.' example: TT48499 sale_product_additional1: type: - string - 'null' maxLength: 20 description: 'Campo adicional do produto, com o título que a agência deu a ele no Monde (por exemplo, "Nº Pedido"). Consulte o título de cada campo em [Consultar campos adicionais do produto](#tag/Vendas/paths/~1sale_product_additional_fields/get), que traz este campo como `additional1`. O campo sem título não aparece no Monde: a API ignora o valor enviado e não o devolve na consulta. Na edição, omitir mantém o valor gravado e enviar `null` o retira.' example: TT48499 sale_product_additional2: type: - string - 'null' maxLength: 20 description: 'Campo adicional do produto, com o título que a agência deu a ele no Monde (por exemplo, "Nº Pedido"). Consulte o título de cada campo em [Consultar campos adicionais do produto](#tag/Vendas/paths/~1sale_product_additional_fields/get), que traz este campo como `additional2`. O campo sem título não aparece no Monde: a API ignora o valor enviado e não o devolve na consulta. Na edição, omitir mantém o valor gravado e enviar `null` o retira.' example: TT48499 reservation_due_date: type: - string - 'null' format: date description: 'Data de vencimento da reserva no formato ISO 8601 (AAAA-MM-DD). Exclusiva da operadora (consolidadora): na agência, o campo é recusado com 422 e vem nulo na consulta. Na edição, omitido mantém a data gravada e enviado como nulo a apaga.' currency_code: type: string description: ' Código da moeda, seguindo o padrão ISO 4217.

Na criação, é a moeda de origem: a moeda em que o produto é originalmente comercializado, e os valores do produto devem ser informados nela. Exemplo: "USD". A moeda em que o cliente paga vai em `sale_currency`.

Na consulta, é a moeda de venda do produto, em que vêm os valores dele. A moeda de origem vem em `origin_currency`. ' minLength: 3 maxLength: 3 origin_currency_code: type: string readOnly: true description: Código ISO 4217 da moeda em que o produto é originalmente comercializado. Os campos com o sufixo `_origin_currency` vêm nesta moeda. minLength: 3 maxLength: 3 sale_currency_code: type: string writeOnly: true default: BRL description: " Código ISO 4217 da moeda de venda: a moeda em que o cliente paga o produto e em que saem a fatura e os pagamentos dele. Padrão: BRL.
  • Na operadora, pode ser qualquer moeda cadastrada. Na agência, só BRL é aceito.
  • Quando é igual a `currency`, `exchange_rate` deve ser 1 ou ficar de fora. Quando é diferente, `exchange_rate` é **obrigatório**.
  • Cada pagamento (`payments`) tem uma moeda só: todos os produtos de um pagamento precisam ter a mesma moeda de venda.
Na consulta, vem no campo `currency` do produto. " minLength: 3 maxLength: 3 exchange_rate: type: object format: double exclusiveMinimum: 0 description: 'Uma cotação da moeda: quantos reais vale uma unidade dela, a partir da data e hora da cotação.' properties: id: type: string format: uuid description: ID da cotação example: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 currency: type: object description: A moeda da cotação, pelo código properties: code: type: string example: USD required: - code value: type: number description: Quantos reais vale uma unidade da moeda, com até 4 casas decimais example: 5.4321 quoted_at: type: string format: date-time description: Data e hora da cotação, no horário de Brasília example: '2026-10-14T09:30:00' required: - id - currency - value - quoted_at commission_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Valor da comissão que o fornecedor ou representante paga para a agência de viagens sobre o valor da venda do produto. Utilize o valor monetário, não a porcentagem. Na consulta, vem na moeda final da venda, e o valor na moeda de origem vem em `commission_amount_origin_currency`.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" commission_percentage: type: number format: double readOnly: true minimum: 0 description: Percentual de comissão do fornecedor. over_amount: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Valor de over do fornecedor, na moeda final da venda. O valor na moeda de origem vem em `over_amount_origin_currency`.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" over_percentage: type: number format: double readOnly: true minimum: 0 description: Percentual de over do fornecedor. over: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Base sobre a qual o over é calculado.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" intermediary_commission_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Valor da comissão que a agência de viagens paga ao intermediário sobre o valor da venda do produto. Utilize o valor monetário, não a porcentagem. Na consulta, vem na moeda final da venda, e o valor na moeda de origem vem em `intermediary_commission_amount_origin_currency`.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" intermediary_commission_percentage: type: number format: double readOnly: true minimum: 0 description: Percentual de comissão do intermediário. intermediary_over_amount: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Valor de over do intermediário, na moeda final da venda. O valor na moeda de origem vem em `intermediary_over_amount_origin_currency`.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" intermediary_over_percentage: type: number format: double readOnly: true minimum: 0 description: Percentual de over do intermediário. intermediary_over: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Base sobre a qual o over do intermediário é calculado.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" agency_service_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Taxa de serviço cobrada diretamente pela agência de viagens, sem vínculo direto com o fornecedor ou representante. O valor é somado ao total do produto e aparece detalhado para o cliente final.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" cc_rav_fee: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Taxa administrativa de cartão de crédito sobre a RAV.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" cc_du_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 description: " Taxa administrativa de cartão de crédito sobre a DU.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" agency_card_rate: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Taxa da operadora do cartão usado pela agência.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" deductions: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Abatimentos aplicados ao produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" discount_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Valor de desconto concedido sobre a receita total da agência de viagens no produto. Utilize o valor monetário, não a porcentagem.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" product_totals: type: object readOnly: true properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" fees_origin_currency: type: number format: double readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). rav_fee: type: number format: double readOnly: true description: " Total da RAV dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" rav_fee_origin_currency: type: number format: double readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: type: number format: double readOnly: true description: " Total de desconto sobre a RAV dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" rav_fee_discount_origin_currency: type: number format: double readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: type: number format: double readOnly: true description: " Total da taxa de serviço oculta dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" agency_fee_origin_currency: type: number format: double readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). discount: type: number format: double readOnly: true description: " Total de descontos do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" discount_origin_currency: type: number format: double readOnly: true description: Valor de `discount` na moeda de origem do produto (`origin_currency`). products: type: number format: double readOnly: true description: " Soma apenas dos valores dos produtos, sem taxas, descontos ou abatimentos.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" products_origin_currency: type: number format: double readOnly: true description: Valor de `products` na moeda de origem do produto (`origin_currency`). customer_amount: type: number format: double readOnly: true description: " Valor total para o cliente.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" customer_amount_origin_currency: type: number format: double readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). amount: type: number format: double readOnly: true description: " Valor total do produto, somando os produtos, as taxas e as remunerações e subtraindo descontos e abatimentos.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" amount_origin_currency: type: number format: double readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). product_name: type: string readOnly: true description: Nome do produto cadastrado. product_with_passengers: type: boolean readOnly: true description: Indica se o produto trabalha com passageiros. Quando verdadeiro, o detalhamento financeiro vem na lista de passageiros e os campos quantity, unit_price e unit_fee retornam nulos. Quando falso, a lista de passageiros retorna nula e os valores vêm dos campos unitários do produto. product_document: type: string readOnly: true description: Identificador geral do produto, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "localizador", "número da reserva", "código do voucher", "número do pedido", entre outros. maxLength: 40 quantity: type: integer readOnly: true minimum: 0 description: Quantidade de unidades do produto, em produtos sem passageiros. Em produtos com passageiros retorna nulo, pois a contagem corresponde à lista de passageiros. unit_price: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Valor unitário do produto, em produtos sem passageiros. O total corresponde ao valor unitário multiplicado pela quantidade. Vem na moeda de origem (`origin_currency`). Em produtos com passageiros retorna nulo.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" unit_fee: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: Taxas unitárias do produto, em produtos sem passageiros. O total de taxas corresponde à taxa unitária multiplicada pela quantidade, sem aplicar o câmbio do produto. Em produtos com passageiros retorna nulo.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
destination: type: string readOnly: true description: Destino do produto. departure_date: type: string readOnly: true description: 'Data e hora de início no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-21T00:00:44".' arrival_date: type: string readOnly: true description: 'Data e hora de término no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-24T00:00:44".' included_services: type: string readOnly: true description: 'Serviços inclusos no produto. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "Guia local incluso\nTraslado".' insurance: type: object description: Seguro viagem. required: - local_id - document - begin_date - end_date - destination - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &21 type: string description: Identificador geral do seguro, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "código do voucher", "número da apólice", "código da reserva", "código do pedido", entre outros. maxLength: 40 begin_date: &22 type: string description: 'Data e hora de início da cobertura do seguro no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas ao local da venda do seguro, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-11-21"; "2026-11-21T00:00:44"' end_date: &23 type: string description: 'Data e hora de término da cobertura do seguro no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas ao local da venda do seguro, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-12-06"; "2026-12-06T00:00:44"' destination: &24 type: string description: Tipo de destino da viagem. Utilize "national" para viagens dentro do Brasil, "international" para viagens para outros países, e "cruise" para seguros exclusivamente marítimos. enum: - national - international - cruise status: &25 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &26 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &27 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &28 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &29 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &30 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &31 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &32 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &33 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &34 type: string description: 'Informações adicionais sobre o que está incluso na contratação do seguro, como cobertura, nome do plano, etc. O caractere `\n` será interpretado como uma quebra de linha. Exemplo: "Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas\nCódigo: 1234"' vendor_reservation_url: &35 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &36 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &37 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &38 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &39 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &40 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &41 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &42 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &43 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &44 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &45 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &46 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &47 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &48 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &49 allOf: - "$ref": "#/components/schemas/over_percentage" over: &50 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &51 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &52 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &53 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &54 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &55 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &56 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &57 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &58 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &59 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &60 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &61 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &62 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &63 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &64 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &65 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Fornecedor do seguro. Empresa proprietária direta do produto, como uma seguradora, por exemplo. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/insurance_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. insurance_read: type: object description: Seguro viagem. required: - document - begin_date - end_date - destination - currency - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *21 begin_date: *22 end_date: *23 destination: *24 status: *25 issue_date: *26 canceled_at: *27 calculate_commission: *28 deleted_balance: *29 delete_supplier_balance: *30 supplier_fine: *31 supplier_fine_origin_currency: *32 observations: *33 included_services: *34 vendor_reservation_url: *35 external_number: *36 additional1: *37 additional2: *38 reservation_due_date: *39 currency: *40 exchange_rate: *41 sale_currency: *42 origin_currency: *43 commission_amount: *44 commission_amount_origin_currency: *45 commission_percentage: *46 over_amount: *47 over_amount_origin_currency: *48 over_percentage: *49 over: *50 intermediary_commission_amount: *51 intermediary_commission_amount_origin_currency: *52 intermediary_commission_percentage: *53 intermediary_over_amount: *54 intermediary_over_amount_origin_currency: *55 intermediary_over_percentage: *56 intermediary_over: *57 agency_service_fee: *58 agency_service_fee_origin_currency: *59 agency_card_rate: *60 deductions: *61 deductions_origin_currency: *62 discount_amount: *63 discount_amount_origin_currency: *64 cc_rav_fee: *65 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do seguro. Empresa proprietária direta do produto, como uma seguradora, por exemplo.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/insurance_passenger_read" cruise: type: object description: Cruzeiro. required: - local_id - booking_number - departure_date - arrival_date - ship_name - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" booking_number: &66 type: string description: Número da reserva. maxLength: 40 departure_date: &67 type: string description: 'Data e hora de partida do cruzeiro no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas ao local de partida do cruzeiro, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-11-22"; "2026-11-22T00:00:44"' arrival_date: &68 type: string description: 'Data e hora de chegada do cruzeiro no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas ao local de chegada do cruzeiro, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-12-06"; "2026-12-06T00:00:44"' ship_name: &69 type: string description: Nome do navio. maxLength: 30 cruise_destination: &70 type: string description: 'Destino do cruzeiro. Exemplo: "Bahamas".' maxLength: 30 accommodation_kind: &71 type: string description: ' Tipo de acomodação contratada pelo cliente.

Exemplos: "Single", "Duplo Casal". ' maxLength: 20 cabin_number: &72 type: string description: 'Número da cabine. Exemplo: "8074".' maxLength: 10 cabin_kind: &73 type: string description: 'Tipo da cabine. Exemplos: "Suíte", "Interna", "Externa", etc.' maxLength: 30 cabin_category: &74 type: string description: 'Categoria da cabine. Código utilizado para identificar a qual categoria a cabine pertence. Exemplos: "STD", "7A".' maxLength: 3 meal_plan: &75 type: string readOnly: true description: 'Regime de alimentação do cruzeiro. Exemplos: "All inclusive", "Pensão completa".' maxLength: 20 status: &76 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &77 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &78 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &79 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &80 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &81 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &82 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &83 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &84 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &85 type: string description: 'Informações adicionais sobre o que está incluso na contratação do cruzeiro, como o nome do pacote, itinerário, etc. O caractere `\n` será interpretado como uma quebra de linha. Exemplo: "Pacote: All Inclusive\nCódigo: 1234".' vendor_reservation_url: &86 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &87 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &88 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &89 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &90 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &91 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &92 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &93 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &94 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &95 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &96 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &97 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &98 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &99 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &100 allOf: - "$ref": "#/components/schemas/over_percentage" over: &101 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &102 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &103 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &104 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &105 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &106 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &107 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &108 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &109 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &110 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &111 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &112 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &113 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &114 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &115 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &116 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Fornecedor do cruzeiro. Empresa proprietária direta do produto, como uma companhia de cruzeiros marítimos, por exemplo. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/cruise_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e a gorjeta (tip) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. cruise_read: type: object description: Cruzeiro. required: - booking_number - departure_date - arrival_date - ship_name - currency - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 booking_number: *66 departure_date: *67 arrival_date: *68 ship_name: *69 cruise_destination: *70 accommodation_kind: *71 cabin_number: *72 cabin_kind: *73 cabin_category: *74 meal_plan: *75 status: *76 issue_date: *77 canceled_at: *78 calculate_commission: *79 deleted_balance: *80 delete_supplier_balance: *81 supplier_fine: *82 supplier_fine_origin_currency: *83 observations: *84 included_services: *85 vendor_reservation_url: *86 external_number: *87 additional1: *88 additional2: *89 reservation_due_date: *90 currency: *91 exchange_rate: *92 sale_currency: *93 origin_currency: *94 commission_amount: *95 commission_amount_origin_currency: *96 commission_percentage: *97 over_amount: *98 over_amount_origin_currency: *99 over_percentage: *100 over: *101 intermediary_commission_amount: *102 intermediary_commission_amount_origin_currency: *103 intermediary_commission_percentage: *104 intermediary_over_amount: *105 intermediary_over_amount_origin_currency: *106 intermediary_over_percentage: *107 intermediary_over: *108 agency_service_fee: *109 agency_service_fee_origin_currency: *110 agency_card_rate: *111 deductions: *112 deductions_origin_currency: *113 discount_amount: *114 discount_amount_origin_currency: *115 cc_rav_fee: *116 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e a gorjeta (tip) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do cruzeiro. Empresa proprietária direta do produto, como uma companhia de cruzeiros marítimos, por exemplo.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/cruise_passenger_read" hotel: type: object description: Diárias de hospedagem. required: - local_id - booking_number - check_in - check_out - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" booking_number: &117 type: string description: Número da reserva. maxLength: 40 check_in: &118 type: string description: 'Data e hora de check-in no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas à localização do hotel, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-12-09"; "2026-12-09T00:00:44"' check_out: &119 type: string description: 'Data e hora de check-out no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas à localização do hotel, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-12-16"; "2026-12-16T00:00:44"' destination: &120 type: string description: Tipo de destino da viagem. Utilize "national" para viagens dentro do Brasil e "international" para viagens para outros países. enum: - national - international accommodation_kind: &121 type: string description: ' Tipo de acomodação contratada pelo cliente.

Exemplos: "Single", "Duplo Casal". ' maxLength: 20 room_category: &122 type: string description: 'Categoria do quarto. Exemplos: "Suite", "Deluxe".' maxLength: 20 meal_plan: &123 type: string description: 'Regime de alimentação. Exemplos: "All inclusive", "Meia pensão".' maxLength: 20 nights: &124 type: integer readOnly: true minimum: 0 description: Quantidade de diárias (calculada entre check-in e check-out). status: &125 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &126 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &127 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &128 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &129 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &130 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &131 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &132 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &133 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &134 type: string description: 'Informações adicionais sobre o que está incluso na contratação da hospedagem, como endereço do hotel, detalhes do quarto, etc. O caractere `\n` será interpretado como uma quebra de linha. Exemplo: "Grand EX Hotel: 5th Ave, New York, NY, United States \nQuarto com vista para cidade".' vendor_reservation_url: &135 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &136 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &137 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &138 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &139 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &140 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &141 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &142 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &143 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &144 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &145 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &146 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &147 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &148 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &149 allOf: - "$ref": "#/components/schemas/over_percentage" over: &150 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &151 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &152 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &153 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &154 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &155 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &156 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &157 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &158 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &159 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &160 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &161 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &162 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &163 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &164 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &165 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Hotel que está fornecendo a hospedagem. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/hotel_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. hotel_read: type: object description: Diárias de hospedagem. required: - booking_number - check_in - check_out - currency - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 booking_number: *117 check_in: *118 check_out: *119 destination: *120 accommodation_kind: *121 room_category: *122 meal_plan: *123 nights: *124 status: *125 issue_date: *126 canceled_at: *127 calculate_commission: *128 deleted_balance: *129 delete_supplier_balance: *130 supplier_fine: *131 supplier_fine_origin_currency: *132 observations: *133 included_services: *134 vendor_reservation_url: *135 external_number: *136 additional1: *137 additional2: *138 reservation_due_date: *139 currency: *140 exchange_rate: *141 sale_currency: *142 origin_currency: *143 commission_amount: *144 commission_amount_origin_currency: *145 commission_percentage: *146 over_amount: *147 over_amount_origin_currency: *148 over_percentage: *149 over: *150 intermediary_commission_amount: *151 intermediary_commission_amount_origin_currency: *152 intermediary_commission_percentage: *153 intermediary_over_amount: *154 intermediary_over_amount_origin_currency: *155 intermediary_over_percentage: *156 intermediary_over: *157 agency_service_fee: *158 agency_service_fee_origin_currency: *159 agency_card_rate: *160 deductions: *161 deductions_origin_currency: *162 discount_amount: *163 discount_amount_origin_currency: *164 cc_rav_fee: *165 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Hotel que está fornecendo a hospedagem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/hotel_passenger_read" airline_ticket: type: object description: Passagem aérea. required: - local_id - locator - segments - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" locator: &166 type: string description: Código localizador da passagem. maxLength: 10 destination: &864 type: string description: Destino da passagem. Utilize "national" para voos dentro do Brasil e "international" para voos para outros países. enum: - national - international status: &167 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &168 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &169 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &170 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &171 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &172 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &173 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &174 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &175 type: string description: Observações do produto. included_services: &176 type: string description: ' Informações sobre os serviços inclusos na passagem aérea, como franquia de bagagem, refeições, escolha de assentos, entre outros benefícios oferecidos pela Cia. aérea. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "3 bagagens despachadas sem custo\nAssento com reclinação total\nAcesso ao Lounge". ' vendor_reservation_url: &177 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &178 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &179 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &180 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &181 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &182 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &183 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &184 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &185 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &186 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &187 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &188 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &189 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &190 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &191 allOf: - "$ref": "#/components/schemas/over_percentage" over: &192 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &193 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &194 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &195 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &196 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &197 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &198 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &199 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &200 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &201 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &202 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &203 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &204 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &205 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &206 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &207 type: number format: double default: 0 minimum: 0 multipleOf: 0.01 description: " Taxa administrativa de cartão de crédito sobre a RAV.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" cc_du_fee: &208 allOf: - "$ref": "#/components/schemas/cc_du_fee" supplier: description: Cia. Aérea que está fornecendo a passagem. allOf: - type: object required: - airline_code - name properties: airline_code: type: string description: 'Código IATA ou ICAO da Cia. Aérea.

Exemplo: "AA"' maxLength: 3 airline_number: type: string description: 'Código IATA de três dígitos da Cia. Aérea.

Exemplo: "001"' maxLength: 3 name: type: string description: 'Nome fantasia.

Exemplo: "American Airlines".' maxLength: 100 legal_name: type: string description: 'Razão Social.

Exemplo: "American Airlines Inc.".' maxLength: 100 cnpj: type: string description: 'CNPJ, sem pontos, barras, traços ou espaços.

Exemplo: "50559280000140".' minLength: 14 maxLength: 14 foreigner: type: boolean description: Indica se a empresa é estrangeira. Use `true` para empresas que não estão sediadas no Brasil. - "$ref": "#/components/schemas/person" representative: allOf: - "$ref": "#/components/schemas/representative" segments: type: array description: Lista de trechos que compõem o itinerário aéreo. items: type: object required: - airline_code - flight_number - origin - departure_date - destination - arrival_date properties: airline_code: type: string description: 'Código IATA ou ICAO da Cia. Aérea.

Exemplo: "AA"' maxLength: 3 flight_number: type: string description: Número do voo, só com dígitos. maxLength: 4 pattern: "^[0-9]+$" class: type: string description: Classe do voo. maxLength: 2 origin: type: string description: 'Código IATA do aeroporto de origem.

Exemplo: "NAS".' maxLength: 3 departure_date: type: string description: 'Data e hora de partida no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização do aeroporto, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T00:00:44".' destination: type: string description: 'Código IATA do aeroporto de destino.

Exemplo: "JFK".' maxLength: 3 arrival_date: type: string description: 'Data e hora de chegada no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização do aeroporto, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T03:12:44".' seats: type: array description: Assentos dos passageiros neste trecho, um por passageiro. Cada assento aponta o passageiro pelo `ticket_number`, que precisa ser o bilhete de um dos passageiros do produto. Por isso, o passageiro que tiver assento precisa ter o `ticket_number` informado. Na consulta, o assento informado no Monde para um passageiro ainda sem bilhete vem com o `ticket_number` nulo. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Número do assento. maxLength: 3 ticket_number: type: string description: Número do bilhete com o qual o assento está associado. maxLength: 30 passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/airline_ticket_passenger" totals: type: object readOnly: true description: Totais consolidados do produto. properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa de embarque (boarding_fee) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" rav_fee: type: number format: double readOnly: true description: " Total da RAV dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" rav_fee_discount: type: number format: double readOnly: true description: " Total de desconto sobre a RAV dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" agency_fee: type: number format: double readOnly: true description: " Total da taxa de serviço oculta dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" discount: type: number format: double readOnly: true description: " Total de descontos do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" products: type: number format: double readOnly: true description: " Soma apenas dos valores dos produtos, sem taxas, descontos ou abatimentos.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee: type: number format: double readOnly: true description: " Total da DU dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee_origin_currency: type: number format: double readOnly: true description: Valor de `du_fee` na moeda de origem do produto (`origin_currency`). du_fee_discount: type: number format: double readOnly: true description: " Total de desconto sobre a DU dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee_discount_origin_currency: type: number format: double readOnly: true description: Valor de `du_fee_discount` na moeda de origem do produto (`origin_currency`). customer_amount: type: number format: double readOnly: true description: " Valor total para o cliente.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" amount: type: number format: double readOnly: true description: " Valor total do produto, somando os produtos, as taxas e as remunerações e subtraindo descontos e abatimentos.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" airline_ticket_read: type: object description: Passagem aérea. required: - locator - segments - currency - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 locator: *166 destination: type: string description: 'Destino da passagem: "national" ou "international". A passagem gravada pela API antes desta regra pode vir como "cruise", valor que o Monde nunca aceitou na passagem aérea. Para alterar essa passagem, envie "national" ou "international": "cruise" é recusado com 422, também quando o destino é omitido.' enum: - national - international - cruise status: *167 issue_date: *168 canceled_at: *169 calculate_commission: *170 deleted_balance: *171 delete_supplier_balance: *172 supplier_fine: *173 supplier_fine_origin_currency: *174 observations: *175 included_services: *176 vendor_reservation_url: *177 external_number: *178 additional1: *179 additional2: *180 reservation_due_date: *181 currency: *182 exchange_rate: *183 sale_currency: *184 origin_currency: *185 commission_amount: *186 commission_amount_origin_currency: *187 commission_percentage: *188 over_amount: *189 over_amount_origin_currency: *190 over_percentage: *191 over: *192 intermediary_commission_amount: *193 intermediary_commission_amount_origin_currency: *194 intermediary_commission_percentage: *195 intermediary_over_amount: *196 intermediary_over_amount_origin_currency: *197 intermediary_over_percentage: *198 intermediary_over: *199 agency_service_fee: *200 agency_service_fee_origin_currency: *201 agency_card_rate: *202 deductions: *203 deductions_origin_currency: *204 discount_amount: *205 discount_amount_origin_currency: *206 cc_rav_fee: *207 cc_du_fee: *208 totals: type: object readOnly: true description: Totais consolidados do produto. properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa de embarque (boarding_fee) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" rav_fee: type: number format: double readOnly: true description: " Total da RAV dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" rav_fee_discount: type: number format: double readOnly: true description: " Total de desconto sobre a RAV dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" agency_fee: type: number format: double readOnly: true description: " Total da taxa de serviço oculta dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" discount: type: number format: double readOnly: true description: " Total de descontos do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" products: type: number format: double readOnly: true description: " Soma apenas dos valores dos produtos, sem taxas, descontos ou abatimentos.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee: type: number format: double readOnly: true description: " Total da DU dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee_origin_currency: type: number format: double readOnly: true description: Valor de `du_fee` na moeda de origem do produto (`origin_currency`). du_fee_discount: type: number format: double readOnly: true description: " Total de desconto sobre a DU dos passageiros do produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee_discount_origin_currency: type: number format: double readOnly: true description: Valor de `du_fee_discount` na moeda de origem do produto (`origin_currency`). customer_amount: type: number format: double readOnly: true description: " Valor total para o cliente.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" amount: type: number format: double readOnly: true description: " Valor total do produto, somando os produtos, as taxas e as remunerações e subtraindo descontos e abatimentos.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Cia. Aérea que está fornecendo a passagem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
segments: type: array description: Lista de trechos que compõem o itinerário aéreo. items: type: object required: - airline_code - flight_number - origin - departure_date - destination - arrival_date properties: airline_code: type: string description: 'Código IATA ou ICAO da Cia. Aérea.

Exemplo: "AA"' maxLength: 3 flight_number: type: string description: Número do voo, só com dígitos. maxLength: 4 class: type: string description: Classe do voo. maxLength: 2 origin: type: string description: 'Código IATA do aeroporto de origem.

Exemplo: "NAS".' maxLength: 3 departure_date: type: string description: 'Data e hora de partida no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização do aeroporto, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T00:00:44".' destination: type: string description: 'Código IATA do aeroporto de destino.

Exemplo: "JFK".' maxLength: 3 arrival_date: type: string description: 'Data e hora de chegada no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização do aeroporto, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T03:12:44".' seats: type: array description: Assentos dos passageiros neste trecho, um por passageiro. Cada assento aponta o passageiro pelo `ticket_number`, que precisa ser o bilhete de um dos passageiros do produto. Por isso, o passageiro que tiver assento precisa ter o `ticket_number` informado. Na consulta, o assento informado no Monde para um passageiro ainda sem bilhete vem com o `ticket_number` nulo. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Número do assento. maxLength: 3 ticket_number: type: string nullable: true description: Número do bilhete com o qual o assento está associado. maxLength: 30 passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/airline_ticket_passenger_read" train_ticket: type: object description: " Bilhete de trem. " required: - local_id - document - currency - segments - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &209 type: string description: Identificador geral do bilhete de trem, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "código localizador", "número do bilhete", "número da reserva", entre outros. maxLength: 40 departure_date: &210 type: string readOnly: true description: 'Data e hora de partida do bilhete no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-21T00:00:44".' arrival_date: &211 type: string readOnly: true description: 'Data e hora de chegada do bilhete no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-24T00:00:44".' status: &212 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &213 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &214 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &215 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &216 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &217 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &218 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &219 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &220 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &221 type: string description: ' Informações sobre os serviços inclusos no bilhete de trem, como refeições, serviços de bordo, Wi-Fi, entre outros benefícios oferecidos pela operadora ferroviária. O caractere `\n` será interpretado como uma quebra de linha. Na alteração de venda, é obrigatório quando os `segments` do produto são reenviados, porque o texto dos trechos fica aqui; omitido junto com os trechos, permanece como está.

Exemplo: "Refeição inclusa\nWi-Fi gratuito\nVagão silencioso". ' vendor_reservation_url: &222 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &223 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &224 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &225 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &226 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &227 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &228 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &229 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &230 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &231 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &232 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &233 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &234 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &235 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &236 allOf: - "$ref": "#/components/schemas/over_percentage" over: &237 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &238 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &239 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &240 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &241 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &242 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &243 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &244 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &245 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &246 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &247 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &248 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &249 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &250 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &251 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &252 allOf: - "$ref": "#/components/schemas/cc_rav_fee" segments: type: array writeOnly: true description: Lista de trechos que compõem o itinerário ferroviário. items: type: object required: - railway_operator - origin - departure_date - destination - arrival_date properties: railway_operator: type: string description: Operadora Ferroviária responsável pelo trecho. maxLength: 50 origin: type: string description: 'Estação de origem.

Exemplo: "Paris Gare de Lyon".' maxLength: 50 departure_date: type: string format: date-time description: 'Data e hora de saída no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização da estação, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T00:00:44".' destination: type: string description: 'Estação de destino.

Exemplo: "Nice-Ville".' maxLength: 50 arrival_date: type: string format: date-time description: 'Data e hora de chegada no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização da estação, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T03:12:44".' supplier: description: Operadora Ferroviária ou empresa distribuidora que está fornecendo o bilhete de trem. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/train_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. train_ticket_read: type: object description: " Bilhete de trem. " required: - document - currency - segments - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *209 departure_date: *210 arrival_date: *211 status: *212 issue_date: *213 canceled_at: *214 calculate_commission: *215 deleted_balance: *216 delete_supplier_balance: *217 supplier_fine: *218 supplier_fine_origin_currency: *219 observations: *220 included_services: *221 vendor_reservation_url: *222 external_number: *223 additional1: *224 additional2: *225 reservation_due_date: *226 currency: *227 exchange_rate: *228 sale_currency: *229 origin_currency: *230 commission_amount: *231 commission_amount_origin_currency: *232 commission_percentage: *233 over_amount: *234 over_amount_origin_currency: *235 over_percentage: *236 over: *237 intermediary_commission_amount: *238 intermediary_commission_amount_origin_currency: *239 intermediary_commission_percentage: *240 intermediary_over_amount: *241 intermediary_over_amount_origin_currency: *242 intermediary_over_percentage: *243 intermediary_over: *244 agency_service_fee: *245 agency_service_fee_origin_currency: *246 agency_card_rate: *247 deductions: *248 deductions_origin_currency: *249 discount_amount: *250 discount_amount_origin_currency: *251 cc_rav_fee: *252 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Operadora Ferroviária ou empresa distribuidora que está fornecendo o bilhete de trem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
segments: type: array writeOnly: true description: Lista de trechos que compõem o itinerário ferroviário. items: type: object required: - railway_operator - origin - departure_date - destination - arrival_date properties: railway_operator: type: string description: Operadora Ferroviária responsável pelo trecho. maxLength: 50 origin: type: string description: 'Estação de origem.

Exemplo: "Paris Gare de Lyon".' maxLength: 50 departure_date: type: string format: date-time description: 'Data e hora de saída no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização da estação, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T00:00:44".' destination: type: string description: 'Estação de destino.

Exemplo: "Nice-Ville".' maxLength: 50 arrival_date: type: string format: date-time description: 'Data e hora de chegada no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas à localização da estação, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T03:12:44".' passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/train_passenger_read" ground_transportation: type: object description: " Transporte terrestre. " required: - local_id - document - segments - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &253 type: string description: Identificador geral do transporte terrestre, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "localizador", "número do bilhete", "número da reserva", entre outros. maxLength: 40 departure_date: &254 type: string readOnly: true description: 'Data e hora de partida do transporte terrestre no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-21T00:00:44".' arrival_date: &255 type: string readOnly: true description: 'Data e hora de chegada do transporte terrestre no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-24T00:00:44".' status: &256 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &257 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &258 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &259 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &260 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &261 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &262 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &263 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &264 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &265 type: string description: ' Informações sobre os serviços inclusos no transporte terrestre, como refeições, Wi-Fi, entre outros benefícios oferecidos pela viação. O caractere `\n` será interpretado como uma quebra de linha. Na alteração de venda, é obrigatório quando os `segments` do produto são reenviados, porque o texto dos trechos fica aqui; omitido junto com os trechos, permanece como está.

Exemplo: "Refeição inclusa\nWi-Fi gratuito". ' vendor_reservation_url: &266 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &267 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &268 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &269 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &270 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &271 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &272 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &273 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &274 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &275 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &276 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &277 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &278 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &279 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &280 allOf: - "$ref": "#/components/schemas/over_percentage" over: &281 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &282 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &283 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &284 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &285 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &286 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &287 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &288 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &289 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &290 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &291 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &292 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &293 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &294 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &295 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &296 allOf: - "$ref": "#/components/schemas/cc_rav_fee" segments: type: array writeOnly: true description: Lista de trechos que compõem o itinerário terrestre. items: type: object required: - coach_company - origin - departure_date - destination - arrival_date properties: coach_company: type: string description: 'Nome da viação responsável pelo trecho.

Exemplo: "Viação UTIL"' maxLength: 100 service_class: type: string description: 'Classe da passagem.

Exemplos: "Leito, Convencional, Executivo".' maxLength: 20 origin: type: string description: 'Terminal ou estação de origem.

Exemplo: "Terminal Rodoviário Novo Rio".' maxLength: 100 departure_date: type: string format: date-time description: 'Data e hora de partida no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas ao local de embarque, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T00:00:44".' destination: type: string description: 'Terminal ou estação de destino.

Exemplo: "Terminal Rodoviário de Santos".' maxLength: 100 arrival_date: type: string format: date-time description: 'Data e hora de chegada no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas ao local de desembarque, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T04:00:44".' seats: type: array writeOnly: true description: Lista de assentos associados a este trecho. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Número do assento. maxLength: 3 ticket_number: type: string description: Número do bilhete com o qual o assento está associado. maxLength: 20 supplier: description: Viação ou empresa de transporte que está fornecendo a passagem. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/ground_transportation_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. ground_transportation_read: type: object description: " Transporte terrestre. " required: - document - segments - currency - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *253 departure_date: *254 arrival_date: *255 status: *256 issue_date: *257 canceled_at: *258 calculate_commission: *259 deleted_balance: *260 delete_supplier_balance: *261 supplier_fine: *262 supplier_fine_origin_currency: *263 observations: *264 included_services: *265 vendor_reservation_url: *266 external_number: *267 additional1: *268 additional2: *269 reservation_due_date: *270 currency: *271 exchange_rate: *272 sale_currency: *273 origin_currency: *274 commission_amount: *275 commission_amount_origin_currency: *276 commission_percentage: *277 over_amount: *278 over_amount_origin_currency: *279 over_percentage: *280 over: *281 intermediary_commission_amount: *282 intermediary_commission_amount_origin_currency: *283 intermediary_commission_percentage: *284 intermediary_over_amount: *285 intermediary_over_amount_origin_currency: *286 intermediary_over_percentage: *287 intermediary_over: *288 agency_service_fee: *289 agency_service_fee_origin_currency: *290 agency_card_rate: *291 deductions: *292 deductions_origin_currency: *293 discount_amount: *294 discount_amount_origin_currency: *295 cc_rav_fee: *296 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Viação ou empresa de transporte que está fornecendo a passagem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
segments: type: array writeOnly: true description: Lista de trechos que compõem o itinerário terrestre. items: type: object required: - coach_company - origin - departure_date - destination - arrival_date properties: coach_company: type: string description: 'Nome da viação responsável pelo trecho.

Exemplo: "Viação UTIL"' maxLength: 100 service_class: type: string description: 'Classe da passagem.

Exemplos: "Leito, Convencional, Executivo".' maxLength: 20 origin: type: string description: 'Terminal ou estação de origem.

Exemplo: "Terminal Rodoviário Novo Rio".' maxLength: 100 departure_date: type: string format: date-time description: 'Data e hora de partida no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas ao local de embarque, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T00:00:44".' destination: type: string description: 'Terminal ou estação de destino.

Exemplo: "Terminal Rodoviário de Santos".' maxLength: 100 arrival_date: type: string format: date-time description: 'Data e hora de chegada no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). A data e hora serão sempre relativas ao local de desembarque, portanto, não é necessário incluir informações de fuso horário.

Exemplo: "2026-11-21T04:00:44".' seats: type: array writeOnly: true description: Lista de assentos associados a este trecho. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Número do assento. maxLength: 3 ticket_number: type: string description: Número do bilhete com o qual o assento está associado. maxLength: 20 passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/ground_transportation_passenger_read" car_rental: type: object description: Locação de veículos. required: - local_id - document - pickup_date - dropoff_date - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &297 type: string description: Identificador geral da locação, utilizado para localizá-la junto ao fornecedor ou representante. Pode ser conhecido como "número da reserva", "código do voucher", "localizador", entre outros. maxLength: 40 pickup_date: &298 type: string description: ' Data e hora de retirada do veículo no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas à localização de retirada, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-11-21"; "2026-11-21T00:00:44" ' pickup_location: &299 type: string description: ' Local de retirada do veículo.

Exemplo: "Aeroporto de Congonhas" ' maxLength: 30 dropoff_date: &300 type: string description: ' Data e hora de devolução do veículo no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas à localização de devolução, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-11-28"; "2026-11-28T00:00:44" ' dropoff_location: &301 type: string description: 'Local de devolução do veículo.

Exemplo: "Aeroporto de Congonhas" ' maxLength: 30 destination: &302 type: string description: Tipo de destino da locação. Utilize "national" para locações dentro do Brasil e "international" para locações em outros países. enum: - national - international vehicle_category: &303 type: string description: ' Categoria do veículo.

Exemplos: "Econômico", "Intermediário", "Premium", "SUV". ' maxLength: 50 rental_days: &304 type: integer readOnly: true minimum: 0 description: Quantidade de diárias da locação (entre retirada e devolução). status: &305 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &306 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &307 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &308 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &309 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &310 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &311 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &312 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &313 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &314 type: string description: ' Informações adicionais sobre o que está incluso na locação do veículo, como quilometragem, seguro, extras, etc. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "Quilometragem livre\nSeguro básico incluso\nTanque cheio". ' vendor_reservation_url: &315 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &316 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &317 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &318 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &319 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &320 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &321 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &322 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &323 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &324 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &325 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &326 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &327 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &328 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &329 allOf: - "$ref": "#/components/schemas/over_percentage" over: &330 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &331 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &332 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &333 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &334 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &335 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &336 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &337 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &338 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &339 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &340 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &341 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &342 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &343 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &344 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &345 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Locadora de veículos que está fornecendo o serviço. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/default_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. car_rental_read: type: object description: Locação de veículos. required: - document - pickup_date - dropoff_date - currency - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *297 pickup_date: *298 pickup_location: *299 dropoff_date: *300 dropoff_location: *301 destination: *302 vehicle_category: *303 rental_days: *304 status: *305 issue_date: *306 canceled_at: *307 calculate_commission: *308 deleted_balance: *309 delete_supplier_balance: *310 supplier_fine: *311 supplier_fine_origin_currency: *312 observations: *313 included_services: *314 vendor_reservation_url: *315 external_number: *316 additional1: *317 additional2: *318 reservation_due_date: *319 currency: *320 exchange_rate: *321 sale_currency: *322 origin_currency: *323 commission_amount: *324 commission_amount_origin_currency: *325 commission_percentage: *326 over_amount: *327 over_amount_origin_currency: *328 over_percentage: *329 over: *330 intermediary_commission_amount: *331 intermediary_commission_amount_origin_currency: *332 intermediary_commission_percentage: *333 intermediary_over_amount: *334 intermediary_over_amount_origin_currency: *335 intermediary_over_percentage: *336 intermediary_over: *337 agency_service_fee: *338 agency_service_fee_origin_currency: *339 agency_card_rate: *340 deductions: *341 deductions_origin_currency: *342 discount_amount: *343 discount_amount_origin_currency: *344 cc_rav_fee: *345 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Locadora de veículos que está fornecendo o serviço.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/car_rental_passenger_read" travel_package: type: object description: Pacotes turísticos. required: - local_id - document - begin_date - destination - package_name - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &346 type: string description: Identificador geral do pacote, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "número da reserva", "código do voucher", "localizador", "número do pedido", entre outros. maxLength: 40 begin_date: &347 type: string description: 'Data e hora de início do pacote no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas ao destino do pacote, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-11-23"; "2026-11-23T00:00:44"' end_date: &348 type: string description: 'Data e hora de término do pacote no formato ISO 8601.
  • A data é obrigatória, enquanto a hora é opcional.
  • Se informar apenas a data, use o formato AAAA-MM-DD.
  • Se informar data e hora, use o formato AAAA-MM-DDTHH:MM:SS.
  • A data e hora serão sempre relativas ao destino do pacote, portanto, não é necessário incluir informações de fuso horário.
Exemplos: "2026-11-30"; "2026-11-30T00:00:44"' destination: &349 type: string description: Tipo de destino da viagem. Utilize "national" para viagens dentro do Brasil e "international" para viagens para outros países. enum: - national - international package_name: &350 type: string description: 'Nome do pacote turístico.

Exemplos: "Aracajú", "Surf Trip Trancoso".' maxLength: 50 transport: &351 type: string description: " Tipo de transporte incluído no pacote.

  • self_provided: transporte próprio.
  • road_transport: transporte rodoviário.
  • no_transport: sem transporte.
  • charter_flight: voo fretado.
  • scheduled_flight: voo regular.
" enum: - self_provided - road_transport - no_transport - charter_flight - scheduled_flight maxLength: 20 status: &352 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &353 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &354 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &355 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &356 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &357 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &358 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &359 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &360 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &361 type: string description: ' Informações adicionais sobre o que está incluso no pacote turístico, como detalhes de hospedagem, passeios, refeições, etc. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "Hospedagem: Hotel 5 estrelas\nRefeições: Café da manhã incluso\nPasseios: City tour e aulas de surf". ' vendor_reservation_url: &362 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &363 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &364 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &365 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &366 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &367 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &368 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &369 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &370 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &371 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &372 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &373 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &374 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &375 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &376 allOf: - "$ref": "#/components/schemas/over_percentage" over: &377 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &378 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &379 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &380 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &381 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &382 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &383 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &384 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &385 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &386 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &387 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &388 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &389 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &390 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &391 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &392 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Fornecedor responsável pelo pacote turístico. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/travel_package_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. travel_package_read: type: object description: Pacotes turísticos. required: - document - begin_date - destination - package_name - currency - supplier - passengers readOnly: true properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *346 begin_date: *347 end_date: *348 destination: *349 package_name: *350 transport: *351 status: *352 issue_date: *353 canceled_at: *354 calculate_commission: *355 deleted_balance: *356 delete_supplier_balance: *357 supplier_fine: *358 supplier_fine_origin_currency: *359 observations: *360 included_services: *361 vendor_reservation_url: *362 external_number: *363 additional1: *364 additional2: *365 reservation_due_date: *366 currency: *367 exchange_rate: *368 sale_currency: *369 origin_currency: *370 commission_amount: *371 commission_amount_origin_currency: *372 commission_percentage: *373 over_amount: *374 over_amount_origin_currency: *375 over_percentage: *376 over: *377 intermediary_commission_amount: *378 intermediary_commission_amount_origin_currency: *379 intermediary_commission_percentage: *380 intermediary_over_amount: *381 intermediary_over_amount_origin_currency: *382 intermediary_over_percentage: *383 intermediary_over: *384 agency_service_fee: *385 agency_service_fee_origin_currency: *386 agency_card_rate: *387 deductions: *388 deductions_origin_currency: *389 discount_amount: *390 discount_amount_origin_currency: *391 cc_rav_fee: *392 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total das taxas dos passageiros do produto, somando a taxa (fees) e as outras taxas (other_fees) de cada passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor responsável pelo pacote turístico.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/travel_package_passenger_read" others: type: object description: Outros produtos da venda, que podem ou não ter passageiros. required: - product_id - local_id - product_name - product_with_passengers - currency - supplier - departure_date properties: product_id: type: string format: uuid writeOnly: true description: Identificador (UUID) do produto escolhido no catálogo da agência. O produto precisa estar ativo. Consulte os produtos disponíveis em GET /products?kind=others. local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" product_name: allOf: - "$ref": "#/components/schemas/product_name" product_with_passengers: allOf: - "$ref": "#/components/schemas/product_with_passengers" document: type: string maxLength: 40 description: Identificador geral do produto, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "localizador", "número da reserva", "código do voucher", "número do pedido", entre outros. destination: type: string description: Tipo de destino do produto. Utilize "national" para produtos dentro do Brasil e "international" para produtos em outros países. enum: - national - international departure_date: type: string description: 'Data e hora de início no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-21T00:00:44".' arrival_date: type: string description: 'Data e hora de término no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-24T00:00:44".' status: allOf: - "$ref": "#/components/schemas/product_status" issue_date: allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: type: string description: Observações do produto. included_services: type: string description: 'Serviços inclusos no produto. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "Guia local incluso\nTraslado".' vendor_reservation_url: allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: allOf: - "$ref": "#/components/schemas/sale_currency_code" commission_amount: allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: allOf: - "$ref": "#/components/schemas/over_percentage" over: allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: allOf: - "$ref": "#/components/schemas/deductions" discount_amount: allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: description: Quantidade de unidades do produto, em produtos sem passageiros. Em produtos com passageiros retorna nulo, pois a contagem corresponde à lista de passageiros. oneOf: - type: integer minimum: 1 maximum: 2147483647 - type: 'null' unit_price: oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' unit_fee: description: Taxas unitárias do produto, em produtos sem passageiros. O total de taxas corresponde à taxa unitária multiplicada pela quantidade, sem aplicar o câmbio do produto. Em produtos com passageiros retorna nulo.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' agency_fee: description: Taxa de serviço oculta da linha, na moeda de origem. Valor único (não multiplicado pela quantidade). Só se aplica ao produto sem passageiros; com passageiros a taxa é informada por passageiro. oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' supplier: description: Fornecedor do produto. Empresa proprietária direta do produto, como uma casa de câmbio ou emissora de passes de trem, por exemplo. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: description: Lista de Passageiros. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/others_passenger" - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. others_read: type: object readOnly: true description: Outros produtos da venda, que podem ou não ter passageiros. required: - currency - supplier properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: &865 allOf: - "$ref": "#/components/schemas/product_document" destination: &866 allOf: - "$ref": "#/components/schemas/destination" departure_date: &867 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &868 allOf: - "$ref": "#/components/schemas/arrival_date" status: &869 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &870 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &871 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &872 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &873 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &874 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &875 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &876 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &877 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &878 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &879 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &880 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &881 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &882 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &883 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &884 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &885 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &886 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &887 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &888 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &889 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &890 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &891 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &892 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &893 allOf: - "$ref": "#/components/schemas/over_percentage" over: &894 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &895 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &896 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &897 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &898 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &899 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &900 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &901 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &902 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &903 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &904 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &905 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &906 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &907 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &908 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &909 allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: &910 oneOf: - "$ref": "#/components/schemas/quantity" - type: 'null' unit_price: &911 oneOf: - "$ref": "#/components/schemas/unit_price" - type: 'null' unit_fee: &912 oneOf: - "$ref": "#/components/schemas/unit_fee" - type: 'null' agency_fee: &913 description: Taxa de serviço oculta da linha, na moeda final da venda (`currency`). Valor único (não multiplicado pela quantidade). Vem nula no produto com passageiros, em que a taxa vem em cada passageiro. oneOf: - type: number format: double - type: 'null' agency_fee_origin_currency: &914 readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). oneOf: - type: number format: double - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto cadastrado que originou este item da venda.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do produto. Empresa proprietária direta do produto, como uma casa de câmbio ou emissora de passes de trem, por exemplo.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: description: Lista de Passageiros. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/default_passenger_read" - type: 'null' excursion: type: object description: " Passeios (excursões) da venda. A excursão é um produto do sistema: não é preciso informar qual produto está sendo vendido. " required: - local_id - document - departure_date - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &393 type: string description: Identificador geral do passeio, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "localizador", "número do voucher", "número da reserva", entre outros. maxLength: 40 status: &394 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &395 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &396 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &397 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &398 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &399 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &400 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &401 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" included_services: &402 type: string description: ' Informações sobre os serviços inclusos no passeio, como guia, transporte, alimentação, entre outros benefícios oferecidos pelo fornecedor. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "Guia local incluso\nTransporte incluso". ' vendor_reservation_url: &403 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &404 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &405 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &406 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &407 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &408 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &409 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &410 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &411 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &412 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &413 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &414 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &415 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &416 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &417 allOf: - "$ref": "#/components/schemas/over_percentage" over: &418 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &419 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &420 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &421 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &422 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &423 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &424 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &425 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &426 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &427 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &428 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &429 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &430 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &431 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &432 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &433 allOf: - "$ref": "#/components/schemas/cc_rav_fee" departure_date: type: string description: 'Data e hora de partida do passeio no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-21T00:00:44".' arrival_date: type: string description: 'Data e hora de chegada do passeio no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-22T00:00:44".' observations: type: string description: Observações do produto. supplier: description: Fornecedor do passeio. Empresa proprietária direta do produto. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/excursion_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. excursion_read: type: object readOnly: true description: " Passeios (excursões) da venda. A excursão é um produto do sistema: não é preciso informar qual produto está sendo vendido. " required: - document - currency - supplier - passengers properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *393 status: *394 issue_date: *395 canceled_at: *396 calculate_commission: *397 deleted_balance: *398 delete_supplier_balance: *399 supplier_fine: *400 supplier_fine_origin_currency: *401 included_services: *402 vendor_reservation_url: *403 external_number: *404 additional1: *405 additional2: *406 reservation_due_date: *407 currency: *408 exchange_rate: *409 sale_currency: *410 origin_currency: *411 commission_amount: *412 commission_amount_origin_currency: *413 commission_percentage: *414 over_amount: *415 over_amount_origin_currency: *416 over_percentage: *417 over: *418 intermediary_commission_amount: *419 intermediary_commission_amount_origin_currency: *420 intermediary_commission_percentage: *421 intermediary_over_amount: *422 intermediary_over_amount_origin_currency: *423 intermediary_over_percentage: *424 intermediary_over: *425 agency_service_fee: *426 agency_service_fee_origin_currency: *427 agency_card_rate: *428 deductions: *429 deductions_origin_currency: *430 discount_amount: *431 discount_amount_origin_currency: *432 cc_rav_fee: *433 departure_date: type: string readOnly: true description: 'Data e hora de partida do passeio no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-21T00:00:44".' arrival_date: type: string readOnly: true description: 'Data e hora de chegada do passeio no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-22T00:00:44".' observations: allOf: - "$ref": "#/components/schemas/product_observations" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do passeio. Empresa proprietária direta do produto.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: type: array description: Lista de Passageiros. items: allOf: - "$ref": "#/components/schemas/default_passenger_read" visa: type: object description: " Vistos consulares da venda, um por pedido de visto. O visto é um produto do sistema: não é preciso informar qual produto está sendo vendido. Cada passageiro é um solicitante do visto.

Não há campo próprio para a taxa consular nem para a taxa de serviço: a taxa consular de cada solicitante vai em passengers[].fees (e soma no total da venda), e a taxa de serviço da agência vai em agency_service_fee do produto. " required: - local_id - visa_type - destination_country - departure_date - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &434 type: string description: Identificador do pedido do visto, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "número do protocolo", "número da solicitação", entre outros. Opcional. maxLength: 40 visa_type: &435 type: string description: 'Tipo do visto, em texto livre de até 50 caracteres. Obrigatório.

Exemplos: "Turismo", "Negócios", "Estudo", "Trabalho".' maxLength: 50 example: Turismo destination_country: &915 type: string description: 'País do visto, pelo código ISO 3166-1 alpha-2 (duas letras), como "US" para os Estados Unidos. Obrigatório. O código precisa estar no cadastro de países do Monde: um código fora dele é recusado com 422.' minLength: 2 maxLength: 2 example: US destination: &436 type: string description: 'Classificação do destino usada no faturamento: "national" para viagem dentro do Brasil e "international" para viagem a outros países. Não é o país do visto, que vai em destination_country. Opcional.' enum: - national - international status: &437 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &438 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &439 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &440 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &441 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &442 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &443 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &444 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" included_services: &445 type: string description: ' Informações sobre os serviços inclusos no visto, como agendamento da entrevista, preenchimento de formulários e entrega do passaporte. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "Agendamento da entrevista\nPreenchimento do formulário DS-160". ' vendor_reservation_url: &446 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &447 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &448 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &449 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &450 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &451 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &452 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &453 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &454 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &455 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &456 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &457 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &458 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &459 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &460 allOf: - "$ref": "#/components/schemas/over_percentage" over: &461 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &462 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &463 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &464 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &465 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &466 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &467 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &468 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &469 allOf: - "$ref": "#/components/schemas/agency_service_fee" description: 'Taxa de serviço cobrada pela agência pela assessoria do visto, sem vínculo com o fornecedor ou representante. O valor é somado ao total do produto. A taxa consular não vai aqui: vai em passengers[].fees, por solicitante.' agency_service_fee_origin_currency: &470 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &471 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &472 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &473 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &474 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &475 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &476 allOf: - "$ref": "#/components/schemas/cc_rav_fee" departure_date: type: string description: 'Data e hora de início do visto, em geral a data prevista da viagem, no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). Obrigatória.

Exemplo: "2026-12-16T00:00:44".' arrival_date: type: string description: 'Data e hora de fim do visto, em geral a data prevista da volta, no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). Não pode ser anterior a departure_date. Opcional.

Exemplo: "2026-12-31T00:00:44".' observations: type: string description: Observações do produto. supplier: description: Fornecedor do visto. Empresa que presta o serviço do visto, como a assessoria ou o próprio consulado. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Solicitantes do visto. Cada um leva a sua taxa consular em fees. items: allOf: - "$ref": "#/components/schemas/visa_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. visa_read: type: object readOnly: true description: " Vistos consulares da venda, um por pedido de visto. O visto é um produto do sistema: não é preciso informar qual produto está sendo vendido. Cada passageiro é um solicitante do visto.

Não há campo próprio para a taxa consular nem para a taxa de serviço: a taxa consular de cada solicitante vai em passengers[].fees (e soma no total da venda), e a taxa de serviço da agência vai em agency_service_fee do produto. " required: - visa_type - destination_country - currency - supplier - passengers properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 3c9e1f47-2b8d-4a65-9f13-8e7d6c5b4a21 document: *434 visa_type: *435 destination_country: type: string readOnly: true nullable: true description: País do visto, pelo código ISO 3166-1 alpha-2 (duas letras), como "US" para os Estados Unidos. Nulo no visto lançado sem país. example: US destination: *436 status: *437 issue_date: *438 canceled_at: *439 calculate_commission: *440 deleted_balance: *441 delete_supplier_balance: *442 supplier_fine: *443 supplier_fine_origin_currency: *444 included_services: *445 vendor_reservation_url: *446 external_number: *447 additional1: *448 additional2: *449 reservation_due_date: *450 currency: *451 exchange_rate: *452 sale_currency: *453 origin_currency: *454 commission_amount: *455 commission_amount_origin_currency: *456 commission_percentage: *457 over_amount: *458 over_amount_origin_currency: *459 over_percentage: *460 over: *461 intermediary_commission_amount: *462 intermediary_commission_amount_origin_currency: *463 intermediary_commission_percentage: *464 intermediary_over_amount: *465 intermediary_over_amount_origin_currency: *466 intermediary_over_percentage: *467 intermediary_over: *468 agency_service_fee: *469 agency_service_fee_origin_currency: *470 agency_card_rate: *471 deductions: *472 deductions_origin_currency: *473 discount_amount: *474 discount_amount_origin_currency: *475 cc_rav_fee: *476 departure_date: type: string readOnly: true description: 'Data e hora de início do visto, em geral a data prevista da viagem, no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). Obrigatória.

Exemplo: "2026-12-16T00:00:44".' arrival_date: type: string readOnly: true description: 'Data e hora de fim do visto, em geral a data prevista da volta, no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS). Não pode ser anterior a departure_date. Opcional.

Exemplo: "2026-12-31T00:00:44".' observations: allOf: - "$ref": "#/components/schemas/product_observations" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do visto. Empresa que presta o serviço do visto, como a assessoria ou o próprio consulado.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: type: array description: Solicitantes do visto. Cada um leva a sua taxa consular em fees. items: allOf: - "$ref": "#/components/schemas/visa_passenger_read" operation: type: object description: Produtos de operação própria da venda (operados pela própria agência), com ou sem passageiros. required: - product_id - local_id - product_name - product_with_passengers - currency - supplier - departure_date properties: product_id: type: string format: uuid writeOnly: true description: Identificador (UUID) do produto de operação própria escolhido no catálogo da agência. O produto precisa estar ativo. Consulte os produtos disponíveis em GET /products?kind=operation. local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" product_name: allOf: - "$ref": "#/components/schemas/product_name" product_with_passengers: allOf: - "$ref": "#/components/schemas/product_with_passengers" document: type: string maxLength: 40 description: Identificador geral do produto, utilizado para localizá-lo junto ao fornecedor ou representante. Pode ser conhecido como "localizador", "número da reserva", "código do voucher", "número do pedido", entre outros. departure_date: type: string description: 'Data e hora de início no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-21T00:00:44".' arrival_date: type: string description: 'Data e hora de término no formato ISO 8601 (AAAA-MM-DDTHH:MM:SS).

Exemplo: "2026-11-24T00:00:44".' status: allOf: - "$ref": "#/components/schemas/product_status" issue_date: allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: allOf: - "$ref": "#/components/schemas/product_deleted_balance" observations: type: string description: Observações do produto. included_services: type: string description: 'Serviços inclusos no produto. O caractere `\n` será interpretado como uma quebra de linha.

Exemplo: "Guia local incluso\nTraslado".' vendor_reservation_url: allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: allOf: - "$ref": "#/components/schemas/sale_product_additional2" currency: allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: allOf: - "$ref": "#/components/schemas/origin_currency_code" intermediary_commission_amount: allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: allOf: - "$ref": "#/components/schemas/agency_card_rate" discount_amount: allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). quantity: description: Quantidade de unidades do produto, em produtos sem passageiros. Em produtos com passageiros retorna nulo, pois a contagem corresponde à lista de passageiros. oneOf: - type: integer minimum: 1 maximum: 2147483647 - type: 'null' unit_price: oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' unit_fee: description: Taxas unitárias do produto, em produtos sem passageiros. O total de taxas corresponde à taxa unitária multiplicada pela quantidade, sem aplicar o câmbio do produto. Em produtos com passageiros retorna nulo.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' agency_fee: description: Taxa de serviço oculta da linha, na moeda de origem. Valor único (não multiplicado pela quantidade). Só se aplica ao produto sem passageiros; com passageiros a taxa é informada por passageiro. oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' supplier: readOnly: true description: Fornecedor do produto de operação própria. Empresa proprietária direta do produto, como um operador local contratado para realizar o serviço, por exemplo. allOf: - "$ref": "#/components/schemas/company_person" passengers: description: Lista de Passageiros. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/operation_passenger" - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. operation_read: type: object readOnly: true description: Produtos de operação própria da venda (operados pela própria agência), com ou sem passageiros. required: - currency - supplier properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: &916 allOf: - "$ref": "#/components/schemas/product_document" departure_date: &917 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &918 allOf: - "$ref": "#/components/schemas/arrival_date" status: &919 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &920 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &921 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &922 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &923 allOf: - "$ref": "#/components/schemas/product_deleted_balance" observations: &924 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &925 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &926 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &927 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &928 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &929 allOf: - "$ref": "#/components/schemas/sale_product_additional2" currency: &930 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &931 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &932 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &933 allOf: - "$ref": "#/components/schemas/origin_currency_code" intermediary_commission_amount: &934 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &935 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &936 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &937 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &938 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &939 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &940 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &941 allOf: - "$ref": "#/components/schemas/agency_card_rate" discount_amount: &942 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &943 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). quantity: &944 oneOf: - "$ref": "#/components/schemas/quantity" - type: 'null' unit_price: &945 oneOf: - "$ref": "#/components/schemas/unit_price" - type: 'null' unit_fee: &946 oneOf: - "$ref": "#/components/schemas/unit_fee" - type: 'null' agency_fee: &947 description: Taxa de serviço oculta da linha, na moeda final da venda (`currency`). Valor único (não multiplicado pela quantidade). Vem nula no produto com passageiros. oneOf: - type: number format: double - type: 'null' agency_fee_origin_currency: &948 readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). oneOf: - type: number format: double - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto cadastrado que originou este item da venda.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do produto de operação própria. Empresa proprietária direta do produto, como um operador local contratado para realizar o serviço, por exemplo.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
passengers: description: Lista de Passageiros. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/operation_passenger_read" - type: 'null' cvc_package: type: object readOnly: true description: Pacotes CVC da venda. Sempre sem passageiros. required: - id - package_name - quantity - unit_price - currency - supplier properties: id: allOf: - "$ref": "#/components/schemas/sale_product_id" package_name: &477 type: string readOnly: true description: Nome do pacote CVC adquirido. receipt_number: &478 type: string readOnly: true description: Identificador geral do pacote CVC, utilizado para localizá-lo junto à CVC. É o número do recibo emitido para o pacote. maxLength: 40 departure_date: &479 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &480 allOf: - "$ref": "#/components/schemas/arrival_date" status: &481 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &482 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &483 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &484 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &485 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &486 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &487 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &488 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &489 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &490 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &491 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &492 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &493 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &494 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &495 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &496 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &497 allOf: - "$ref": "#/components/schemas/exchange_rate" origin_currency: &498 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &499 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &500 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Valor de `commission_amount` na moeda de origem do produto (`origin_currency`). commission_percentage: &501 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &502 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &503 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Valor de `over_amount` na moeda de origem do produto (`origin_currency`). over_percentage: &504 allOf: - "$ref": "#/components/schemas/over_percentage" over: &505 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &506 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &507 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Valor de `intermediary_commission_amount` na moeda de origem do produto (`origin_currency`). intermediary_commission_percentage: &508 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &509 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &510 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Valor de `intermediary_over_amount` na moeda de origem do produto (`origin_currency`). intermediary_over_percentage: &511 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &512 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &513 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &514 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Valor de `agency_service_fee` na moeda de origem do produto (`origin_currency`). agency_card_rate: &515 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &516 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &517 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Valor de `deductions` na moeda de origem do produto (`origin_currency`). discount_amount: &518 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &519 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Valor de `discount_amount` na moeda de origem do produto (`origin_currency`). cc_rav_fee: &520 allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: &521 allOf: - "$ref": "#/components/schemas/quantity" unit_price: &522 allOf: - "$ref": "#/components/schemas/unit_price" unit_fee: &523 allOf: - "$ref": "#/components/schemas/unit_fee" supplier: description: Fornecedor do pacote CVC. Empresa proprietária direta do produto, ou seja, a CVC. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. cvc_package_read: type: object readOnly: true description: Pacotes CVC da venda. Sempre sem passageiros. required: - package_name - quantity - unit_price - currency - supplier properties: id: type: string format: uuid readOnly: true description: Identificador único do produto da venda no formato UUID. É o alvo da referência `sale_product` do lançamento, da nota fiscal, do reembolso e do extrato CVC. example: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 package_name: *477 receipt_number: *478 departure_date: *479 arrival_date: *480 status: *481 issue_date: *482 canceled_at: *483 calculate_commission: *484 deleted_balance: *485 delete_supplier_balance: *486 supplier_fine: *487 supplier_fine_origin_currency: *488 observations: *489 included_services: *490 vendor_reservation_url: *491 external_number: *492 additional1: *493 additional2: *494 reservation_due_date: *495 currency: *496 exchange_rate: *497 origin_currency: *498 commission_amount: *499 commission_amount_origin_currency: *500 commission_percentage: *501 over_amount: *502 over_amount_origin_currency: *503 over_percentage: *504 over: *505 intermediary_commission_amount: *506 intermediary_commission_amount_origin_currency: *507 intermediary_commission_percentage: *508 intermediary_over_amount: *509 intermediary_over_amount_origin_currency: *510 intermediary_over_percentage: *511 intermediary_over: *512 agency_service_fee: *513 agency_service_fee_origin_currency: *514 agency_card_rate: *515 deductions: *516 deductions_origin_currency: *517 discount_amount: *518 discount_amount_origin_currency: *519 cc_rav_fee: *520 quantity: *521 unit_price: *522 unit_fee: *523 totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Totais consolidados do produto. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto cadastrado que originou este item da venda.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do pacote CVC. Empresa proprietária direta do produto, ou seja, a CVC.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Representante do produto. Empresa que representa o fornecedor na venda do produto, como uma operadora ou consolidadora, por exemplo. Deve ser informado quando a agência de viagens não adquiriu o produto diretamente do fornecedor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
payment_product: type: object required: - amount oneOf: - required: - sale_product_id - required: - sale_product_local_id properties: sale_product_id: type: string format: uuid description: 'Só na alteração da venda: `id` de um produto que a venda já tem (o da resposta que o criou ou o da consulta da venda). Informe este ou o `sale_product_local_id`, um dos dois.' sale_product_local_id: type: string maxLength: 50 description: "`local_id` de um produto enviado nesta mesma requisição. Informe este ou o `sale_product_id`, um dos dois." amount: type: number format: double exclusiveMinimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: 'Valor do pagamento destinado a este produto, na moeda de venda (`sale_currency`). Em produto com câmbio, calcule o total como a soma dos valores convertidos e arredondados um a um (ver `exchange_rate` do produto): para fechar a venda (`status: closed`), os pagamentos precisam somar exatamente esse total: um centavo a menos deixa saldo pendente e um centavo a mais é recusado como pagamento acima do valor.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
' payment_amount: type: number format: double readOnly: true multipleOf: 0.01 description: Valor do movimento de liquidação.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
bank_account: type: object required: - bank_code - agency_number - account_number description: 'Informações da conta bancária que receberá o pagamento. A conta é procurada pelo banco, agência e número entre as contas correntes ativas da empresa da venda (company_identifier): conta de outra empresa não é encontrada, mesmo com os dados conferindo.' properties: description: type: string readOnly: true description: Nome da conta bancária cadastrada na agência. bank_code: type: string description: 'Código do banco.

Exemplo: 001. (Código referente ao Banco do Brasil)' maxLength: 10 agency_number: type: string description: Número da agência bancária maxLength: 10 agency_digit: type: string description: Dígito verificador da agência maxLength: 2 account_number: type: string description: Número da conta bancária maxLength: 20 account_digit: type: string description: Dígito verificador da conta maxLength: 2 payment_card_last_digits: type: string description: Últimos 4 dígitos do cartão. minLength: 4 maxLength: 4 payment_authorization: type: string description: Código de autorização. maxLength: 20 payment_due_date: type: string format: date description: Data de vencimento do pagamento no formato ISO 8601 (AAAA-MM-DD). payment_settlement_date: type: string format: date description: Data de liquidação do pagamento no formato ISO 8601 (AAAA-MM-DD). payment_settlement_exchange_rate: type: number exclusiveMinimum: 0 description: 'Câmbio da liquidação, da moeda do pagamento para a moeda da conta bancária. Só vale com `settlement_date` e conta em outra moeda: quando omitido, é usada a razão entre as últimas cotações das duas moedas cadastradas no Monde, e sem a cotação de alguma delas a resposta é 422. Com a conta na moeda do pagamento, deve ser 1 ou omitido. A movimentação entra na conta já convertida.' payment_observations: type: string maxLength: 255 description: 'Observações sobre o pagamento. Pode ser usado para especificar o tipo de transferência utilizado.

Exemplos: "Pix", "TED", "DOC".' agency_others_product: type: object required: - amount oneOf: - required: - sale_product_id - required: - sale_product_local_id properties: sale_product_id: type: string format: uuid description: 'Só na alteração da venda: `id` de um produto que a venda já tem (o da resposta que o criou ou o da consulta da venda). Informe este ou o `sale_product_local_id`, um dos dois.' sale_product_local_id: type: string maxLength: 50 description: "`local_id` de um produto enviado nesta mesma requisição. Informe este ou o `sale_product_id`, um dos dois." amount: type: number format: double multipleOf: 0.01 exclusiveMinimum: -100000000000 exclusiveMaximum: 100000000000 description: |- Valor do pagamento destinado a este produto, na moeda de venda (`sale_currency`). Em produto com câmbio, calcule o total como a soma dos valores convertidos e arredondados um a um (ver `exchange_rate` do produto): para fechar a venda (`status: closed`), os pagamentos precisam somar exatamente esse total: um centavo a menos deixa saldo pendente e um centavo a mais é recusado como pagamento acima do valor. Na devolução (`overpayment_return`), vai com o sinal do saldo do cliente no produto: negativo no produto de saldo negativo, positivo nos outros. Fora dela, é sempre positivo.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
payment_description: type: string maxLength: 60 description: Descrição do pagamento gravada no lançamento financeiro. Quando omitida, é usado "Pagamento venda". Máximo de 60 caracteres. payment_products: type: array description: Lista de produtos vinculados a este pagamento, com seus respectivos valores. **Todos os produtos da lista devem ter o mesmo fornecedor ou representante**. items: "$ref": "#/components/schemas/payment_product" payment_installments: type: integer description: Número de parcelas. minimum: 1 default: 1 payment_vendor_due_date: type: string format: date readOnly: true description: Data de vencimento do pagamento ao fornecedor. payment_agency_due_date: type: string format: date readOnly: true description: Data de vencimento do pagamento no formato ISO 8601 (AAAA-MM-DD). agency_credit_card: type: object required: - card_last_digits - card_brand - due_date - bank_account - products - amount properties: due_date: &949 allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &950 allOf: - "$ref": "#/components/schemas/payment_settlement_date" settlement_exchange_rate: &951 allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: &952 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true card_last_digits: &953 allOf: - "$ref": "#/components/schemas/payment_card_last_digits" card_brand: &954 type: string description: Bandeira do cartão. enum: - amex - diners - hipercard - mastercard - visa - elo authorization: &955 allOf: - "$ref": "#/components/schemas/payment_authorization" card_rate_percentage: &956 type: number format: double minimum: 0 maximum: 100 writeOnly: true description: 'Só no pagamento à agência (`agency.credit_card`). Taxa do cartão da agência, em percentual do valor do pagamento, de 0 a 100. O Monde calcula o valor da taxa, arredondado em centavos.

Envie `card_rate_percentage` ou `card_rate`, um dos dois: os dois juntos são recusados com 422. Sem nenhum dos dois, vale a *Taxa cartão de crédito* das configurações de Vendas da empresa, como no Monde. `0` lança o pagamento sem taxa.

A taxa é rateada entre os produtos do pagamento como no Monde, soma no `agency_card_rate` de cada produto (o que diminui a receita dele) e abate o valor final do lançamento, na categoria de taxa de cartão configurada na empresa. Sem essa categoria, a taxa maior que zero é recusada com 422. Com `settlement_date`, a movimentação recebe o valor do pagamento menos a taxa.

Exemplo: pagamento de R$ 264,55 com `card_rate_percentage` 3 gera taxa de R$ 7,94, e o lançamento fica com valor final de R$ 256,61.' card_rate: &957 type: number format: double minimum: 0 multipleOf: 0.01 writeOnly: true description: Só no pagamento à agência (`agency.credit_card`). Taxa do cartão da agência em valor, de 0 até o valor do pagamento. O Monde calcula o percentual dela, e o valor maior que o pagamento é recusado com 422.

Envie `card_rate` ou `card_rate_percentage`, um dos dois. As regras de padrão, rateio e categoria estão em `card_rate_percentage`.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
payer: "$ref": "#/components/schemas/payment_payer_write" amount: allOf: - "$ref": "#/components/schemas/payment_amount" bank_account: "$ref": "#/components/schemas/bank_account" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true vendor_credit_card: type: object required: - card_last_digits - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" card_last_digits: allOf: - "$ref": "#/components/schemas/payment_card_last_digits" authorization: allOf: - "$ref": "#/components/schemas/payment_authorization" installments: allOf: - "$ref": "#/components/schemas/payment_installments" payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" agency_bank_slip: type: object required: - due_date - bank_account - products - amount properties: due_date: &958 allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &959 allOf: - "$ref": "#/components/schemas/payment_settlement_date" settlement_exchange_rate: &960 allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: &961 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true bank_slip_number: &962 type: integer readOnly: true description: Número do boleto. amount: &963 allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer_write" bank_account: "$ref": "#/components/schemas/bank_account" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true vendor_others: type: object required: - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" details: type: string maxLength: 255 description: 'Detalhes sobre o pagamento. Pode ser usado para especificar a forma de pagamento utilizada.

Exemplos: "Pix", "Boleto bancário", "Fatura", "Dinheiro".' payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" agency_bank_deposit: type: object required: - due_date - bank_account - products - amount properties: due_date: &964 description: Data prevista do depósito (vencimento) no formato ISO 8601 (AAAA-MM-DD). allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &965 allOf: - "$ref": "#/components/schemas/payment_settlement_date" settlement_exchange_rate: &966 allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: &967 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true observations: &968 allOf: - "$ref": "#/components/schemas/payment_observations" amount: &969 allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer_write" bank_account: "$ref": "#/components/schemas/bank_account" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true vendor_credit: type: object required: - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" document: type: string readOnly: true description: Identificação do crédito do fornecedor, como número de documento ou outra referência, quando aplicável. payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" agency_credit: type: object required: - products properties: payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true agency_retained_by_intermediary: type: object required: - products properties: products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true payment_check_number: type: integer minimum: 1 maximum: 2147483647 description: Número do cheque. payment_check_bank_code: type: string maxLength: 3 description: Código do banco emissor do cheque. payment_check_document: type: string description: 'CPF (11 dígitos) ou CNPJ (14 dígitos) de quem emitiu o cheque. Pode vir com ou sem pontuação: é gravado só com os dígitos.' agency_cash: type: object required: - due_date - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_exchange_rate: allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: allOf: - "$ref": "#/components/schemas/payment_description" payer: "$ref": "#/components/schemas/payment_payer_write" products: "$ref": "#/components/schemas/payment_products" agency_check: type: object required: - due_date - check_number - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_exchange_rate: allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" check_number: "$ref": "#/components/schemas/payment_check_number" bank_code: "$ref": "#/components/schemas/payment_check_bank_code" document: "$ref": "#/components/schemas/payment_check_document" description: allOf: - "$ref": "#/components/schemas/payment_description" payer: "$ref": "#/components/schemas/payment_payer_write" products: "$ref": "#/components/schemas/payment_products" agency_others: type: object required: - due_date - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" details: type: string maxLength: 255 description: 'Detalhes sobre o pagamento. Pode ser usado para especificar a forma de pagamento utilizada.

Exemplos: "Pix", "Boleto bancário", "Fatura", "Dinheiro".' description: allOf: - "$ref": "#/components/schemas/payment_description" payer: "$ref": "#/components/schemas/payment_payer_write" overpayment_return: type: boolean default: false writeOnly: true description: 'Com `true`, o pagamento é a Devolução › Gerar Conta a Pagar do Monde: devolve ao cliente o que ele pagou a mais. Só é aceita quando, antes dela, algum produto da venda tem saldo do cliente negativo (o que foi pago passa do que o produto vale), contando os produtos e os pagamentos que vêm antes na lista; sem isso, 422. O `amount` de cada produto vai com o sinal do saldo do cliente nele, como o Monde mostra: negativo no produto de saldo negativo e positivo nos outros; o sinal que não bate é recusado com 422, e a soma não pode ser zero (422). Não há teto de valor. O lançamento fica em aberto, sem conta e sem forma de pagamento: é de débito (conta a pagar) quando a soma é negativa, e de crédito quando é positiva. O valor negativo vai para a categoria de pagamento do cliente e o positivo para a de recebimento do cliente, das configurações da empresa; sem elas, 422. A devolução não tem `description` nem `details` (422 se enviados): o lançamento sai com a descrição padrão, que pode mudar depois na alteração do pagamento. Vale também na operadora. Depois de gravada, a devolução aparece em `payments.agency.bills` e se altera como o Outros; o `overpayment_return` não é aceito na alteração.' products: type: array description: Lista de produtos vinculados a este pagamento, com seus respectivos valores. **Todos os produtos da lista devem ter o mesmo fornecedor ou representante**. items: "$ref": "#/components/schemas/agency_others_product" vendor_check: type: object required: - due_date - check_number - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" check_number: "$ref": "#/components/schemas/payment_check_number" bank_code: "$ref": "#/components/schemas/payment_check_bank_code" document: "$ref": "#/components/schemas/payment_check_document" payer: "$ref": "#/components/schemas/payment_payer_write" products: "$ref": "#/components/schemas/payment_products" payment_agency: type: object description: 'Uma única forma de pagamento por item: para pagar com duas formas, envie dois pagamentos.' minProperties: 1 maxProperties: 1 properties: credit_card: description: Pagamento com cartão de crédito. "$ref": "#/components/schemas/agency_credit_card" bank_slip: description: 'Pagamento com boleto bancário. O boleto é emitido em reais: só aceita produtos com moeda de venda BRL.' "$ref": "#/components/schemas/agency_bank_slip" bank_deposit: description: Pagamento por depósito em conta, que pode representar diferentes meios de transferência, como Pix, TED ou DOC. Você pode usar o campo `observations` para especificar o tipo de transferência utilizado. "$ref": "#/components/schemas/agency_bank_deposit" credit: description: 'Pagamento com crédito que o pagante tem na agência (a empresa da venda). Não gera lançamento: grava o pagamento e um item por produto, com o vencimento na data da venda. Sem `payer`, o pagante é o da venda. Com o controle de crédito do Monde ativo, o valor é conferido contra o saldo do pagante na empresa, somando todos os créditos na agência da requisição, e consumido ao gravar a venda; sem saldo suficiente, a resposta é 422. Retirado da venda na alteração, o crédito usado volta ao pagante. Sem o controle de crédito, o pagamento é gravado sem conferir saldo. Não é aceito na operadora (422).' "$ref": "#/components/schemas/agency_credit" retained_by_intermediary: description: 'Valor retido pelo intermediário da venda, por produto. Só na agência, e só em venda com intermediário: na operadora, ou sem intermediário, a resposta é 422. Não gera lançamento: grava um item por produto, no nome do pagante da venda e com o vencimento na data da venda, como no Monde. Não aceita pagante nem vencimento próprios.' "$ref": "#/components/schemas/agency_retained_by_intermediary" cash: description: 'Pagamento em dinheiro. Gera um lançamento na conta de Dinheiro das configurações de Vendas da empresa, que não vem no payload: sem essa conta configurada, a resposta é 422. Com a liquidação automática do Dinheiro ligada nas configurações de Vendas, o lançamento já nasce liquidado no vencimento, como no Monde. Na liquidação em conta de outra moeda, vale o câmbio de `settlement_exchange_rate` ou, sem ele, o das últimas cotações. O vencimento não pode ser anterior à data da venda. Não é aceito na operadora (422).' "$ref": "#/components/schemas/agency_cash" check: description: 'Pagamento com cheque. Cada pagamento é um cheque: para vários cheques, envie vários pagamentos. Gera um lançamento com os dados do cheque na conta de Cheque das configurações de Vendas da empresa, que não vem no payload: sem essa conta configurada, a resposta é 422. Com a liquidação automática do Cheque ligada nas configurações de Vendas, o lançamento nasce liquidado na data da venda, com a movimentação no vencimento do cheque, como no Monde. Na liquidação em conta de outra moeda, vale o câmbio de `settlement_exchange_rate` ou, sem ele, o das últimas cotações. O vencimento não pode ser anterior à data da venda. Não é aceito na operadora (422).' "$ref": "#/components/schemas/agency_check" others: description: Pagamento com outra forma. Gera um lançamento em aberto, sem conta e sem forma de pagamento, com o texto de `details` nas observações, como no Monde. O vencimento não pode ser anterior à data da venda. Não é aceito na operadora (422), a não ser como devolução (`overpayment_return`). "$ref": "#/components/schemas/agency_others" payment_vendor: type: object description: 'Uma única forma de pagamento por item: para pagar com duas formas, envie dois pagamentos.' minProperties: 1 maxProperties: 1 properties: credit_card: description: Pagamento com cartão de crédito. "$ref": "#/components/schemas/vendor_credit_card" others: description: Pagamento com outras formas . Utilize o campo `details` para especificar a forma de pagamento utilizada. "$ref": "#/components/schemas/vendor_others" credit: description: 'Pagamento com crédito disponível no fornecedor ou representante. Com o controle de crédito do Monde ativo, o valor do pagamento é conferido contra o saldo do pagante com o fornecedor e o representante de um produto só, como no Monde: o primeiro produto do pagamento, por ordem alfabética do representante e, depois, do fornecedor. Os produtos de outro fornecedor pagos juntos usam esse mesmo saldo. O crédito sem representante é um saldo à parte. A conferência soma todos os pagamentos com crédito da requisição, e o valor é consumido ao gravar a venda; sem saldo suficiente, a resposta é 422. Retirado da venda na alteração, o crédito usado volta ao pagante. Sem o controle de crédito, e na operadora, o pagamento é gravado sem conferir saldo.' "$ref": "#/components/schemas/vendor_credit" check: description: 'Cheque direto ao fornecedor. Cada pagamento é um cheque: para vários cheques, envie vários pagamentos. Não gera lançamento: grava o pagamento ao fornecedor com o vencimento e os dados do cheque. O vencimento não pode ser anterior à data da venda. Não é aceito na operadora (422).' "$ref": "#/components/schemas/vendor_check" payment: type: object required: - local_id oneOf: - required: - agency - required: - vendor properties: local_id: type: string maxLength: 50 description: 'Nome que a integração dá ao pagamento, único entre os pagamentos novos da requisição. Obrigatório no pagamento novo. Não é gravado: volta na resposta, dentro do pagamento, ao lado do `id` gerado. É por ele que você sabe qual `id` é de qual pagamento, para mantê-lo ou removê-lo na alteração da venda.' example: pagamento-1 agency: description: Pagamentos destinados à agência. "$ref": "#/components/schemas/payment_agency" vendor: description: Pagamentos destinados ao fornecedor ou representante. "$ref": "#/components/schemas/payment_vendor" payment_product_read: type: object readOnly: true description: Produto da venda coberto pelo pagamento, com o valor destinado a ele. properties: amount: type: number format: double multipleOf: 0.01 description: Valor do pagamento destinado a este produto.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto da venda que recebeu o valor.
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
payment_products_read: type: array readOnly: true description: Produtos da venda cobertos por este pagamento, com o valor destinado a cada um. items: "$ref": "#/components/schemas/payment_product_read" grouped_payment_product_read: type: object readOnly: true description: Produto da venda coberto pelo pagamento, com o valor destinado a ele. properties: id: type: string format: uuid description: 'Identificador do item gravado para este produto. Mantém o pagamento na alteração da venda como o `id` dele: o `id` do pagamento pode mudar quando um pagamento igual incluído depois entra na mesma linha, e o do item não.' example: 9c2e4a71-5b3d-4f80-a6c1-7d9e0b2f4a35 amount: type: number format: double multipleOf: 0.01 description: Valor do pagamento destinado a este produto.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto da venda que recebeu o valor.
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
grouped_payment_products_read: type: array readOnly: true description: Produtos da venda cobertos por este pagamento, com o valor destinado a cada um. items: "$ref": "#/components/schemas/grouped_payment_product_read" payment_payer: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Pagante deste pagamento, que pode ser diferente do pagante da venda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
payment_payer_write: writeOnly: true allOf: - "$ref": "#/components/schemas/individual_or_company" description: 'Pagante deste pagamento, pessoa física ou jurídica, informada do mesmo jeito que o pagante da venda: quando não existir, é criada pelo external_id ou pelo documento. Quando omitido, o pagamento herda o pagante da venda.' payment_check: type: object readOnly: true nullable: true description: Dados do cheque; nulo quando o pagamento não foi em cheque. properties: number: type: integer nullable: true description: Número do cheque. bank: type: string nullable: true description: Código do banco emissor do cheque. document: type: string nullable: true description: CPF ou CNPJ do titular do cheque. payment_card: type: object readOnly: true nullable: true description: Dados do cartão; nulo quando o pagamento não foi em cartão. properties: brand: type: string nullable: true description: Bandeira do cartão. last_digits: type: string nullable: true description: Últimos 4 dígitos do cartão. authorization: type: string nullable: true description: Código de autorização. agency_credit_read: type: object readOnly: true description: Pagamentos com crédito disponível na agência. Não geram lançamento financeiro, por isso vêm embutidos. properties: id: type: string format: uuid description: Identificador do pagamento. É o que a alteração da venda usa para mantê-lo na lista `payments`. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_agency_due_date" document: type: string nullable: true readOnly: true description: Identificação do crédito da agência, como número de documento ou outra referência, quando aplicável. amount: allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer" origin_sale: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true nullable: true description: |- Venda que originou o crédito.
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
products: "$ref": "#/components/schemas/payment_products_read" agency_retained_by_intermediary_read: type: object readOnly: true description: 'Valores retidos pelo intermediário. Não geram lançamento financeiro, por isso vêm embutidos. Os itens com o mesmo vencimento, centro de custo e descrição formam uma linha só, como no Monde: um Retido incluído depois com os mesmos dados entra na linha e pode trocar o `id` dela; o `id` de cada item em `products` não muda, e qualquer um deles mantém a linha inteira na alteração.' properties: id: type: string format: uuid description: Identificador do pagamento. É o que a alteração da venda usa para mantê-lo na lista `payments`. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_agency_due_date" amount: description: Valor retido pelo intermediário. Sempre positivo.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/grouped_payment_products_read" agency_to_invoice_read: type: object readOnly: true description: 'Uma linha do Faturar, como a grade de pagamentos do Monde: o Faturar e a Devolução Faturar da venda que já entraram numa fatura de cliente, reunidos pela fatura e pelo centro de custo. A linha não tem `id`: é apontada pela fatura e pelo centro de custo, como na [remoção do Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice~1removal/post). O Faturar que ainda não entrou em fatura não aparece: são os segundos até a fatura automática levá-lo. O pagante e o vencimento são os da fatura, em [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get).' properties: bill: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fatura de cliente em que a linha está.
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
cost_center: type: string nullable: true description: Centro de custo da linha; nulo na linha sem centro de custo. example: Diretoria amount: type: number format: double multipleOf: 0.01 description: |- Valor da linha: a soma dos produtos, com o sinal. O valor negativo é Devolução Faturar.
  • Na moeda de venda do produto (`sale_currency`), BRL salvo na operadora.
example: 2350.0 products: type: array description: 'O que cada produto da venda soma na linha, com o sinal: o valor negativo é Devolução Faturar.' items: "$ref": "#/components/schemas/payment_product_read" agency_legacy_read: type: object readOnly: true description: Pagamentos à agência gravados sem lançamento financeiro em versões anteriores do sistema. Nenhum pagamento novo entra nesta lista, e a forma utilizada vem em payment_method. properties: id: type: string format: uuid description: Identificador do pagamento. É o que a alteração da venda usa para mantê-lo na lista `payments`. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_agency_due_date" amount: allOf: - "$ref": "#/components/schemas/payment_amount" check: "$ref": "#/components/schemas/payment_check" card: "$ref": "#/components/schemas/payment_card" payer: "$ref": "#/components/schemas/payment_payer" payment_method: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Forma de pagamento utilizada.
  • Chame o endpoint [Consultar forma de pagamento por ID](#tag/Formas-de-Pagamento/paths/~1payment_methods~1{id}/get) para os dados completos.
products: "$ref": "#/components/schemas/payment_products_read" vendor_credit_card_read: type: object readOnly: true properties: id: type: string format: uuid description: Identificador do pagamento. É o que a alteração da venda usa para mantê-lo na lista `payments`. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" card_last_digits: readOnly: true allOf: - "$ref": "#/components/schemas/payment_card_last_digits" authorization: readOnly: true allOf: - "$ref": "#/components/schemas/payment_authorization" installments: readOnly: true allOf: - "$ref": "#/components/schemas/payment_installments" payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" vendor_check_read: type: object readOnly: true properties: id: type: string format: uuid description: Identificador do pagamento. É o que a alteração da venda usa para mantê-lo na lista `payments`. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" bank_code: type: string readOnly: true description: Código do banco emissor do cheque. check_number: type: integer readOnly: true description: Número do cheque. payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" vendor_credit_read: type: object readOnly: true properties: id: type: string format: uuid description: Identificador do pagamento. É o que a alteração da venda usa para mantê-lo na lista `payments`. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" document: type: string nullable: true readOnly: true description: Identificação do crédito do fornecedor, como número de documento ou outra referência, quando aplicável. payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" vendor_others_read: type: object readOnly: true properties: id: type: string format: uuid description: Identificador do pagamento. É o que a alteração da venda usa para mantê-lo na lista `payments`. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" details: type: string maxLength: 255 readOnly: true description: 'Detalhes sobre o pagamento. Pode ser usado para especificar a forma de pagamento utilizada.

Exemplos: "Pix", "Boleto bancário", "Fatura", "Dinheiro".' payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" payment_agency_read: type: object readOnly: true description: Pagamentos destinados à agência. As listas `bills` e `refunds` são referências; as demais são pagamentos registrados sem lançamento financeiro e vêm embutidas. properties: bills: type: array description: |- Lançamentos gerados pelos pagamentos à agência e as faturas de cliente das devoluções. O Faturar e a Devolução Faturar saem em `to_invoice`, na linha da fatura de cliente em que entraram. A forma de pagamento, a conta, a liquidação e os produtos cobertos estão no lançamento.
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" refunds: type: array description: |- Reembolsos ao cliente registrados nesta venda.
  • Chame o endpoint [Consultar reembolso por ID](#tag/Reembolsos/paths/~1refunds~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" credit: type: array description: Pagamento com crédito disponível na agência. items: "$ref": "#/components/schemas/agency_credit_read" to_invoice: type: array description: 'Faturar e Devolução Faturar: o pagante paga, ou recebe de volta, pela fatura de cliente. Não geram lançamento próprio: cada linha é o que a venda já tem numa fatura de cliente, por centro de custo. Só leitura: inclua pelo [Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice/post) e pela [Devolução Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice_returns/post), e remova pela [remoção do Faturar](#tag/Vendas/paths/~1sales~1{sale_id}~1to_invoice~1removal/post).' items: "$ref": "#/components/schemas/agency_to_invoice_read" retained_by_intermediary: type: array description: Valor retido pelo intermediário. items: "$ref": "#/components/schemas/agency_retained_by_intermediary_read" legacy: type: array description: Pagamentos à agência gravados sem lançamento financeiro em versões anteriores do sistema. Nenhum pagamento novo entra nesta lista, e a forma utilizada vem em payment_method. items: "$ref": "#/components/schemas/agency_legacy_read" payment_vendor_read: type: object readOnly: true description: Pagamentos destinados ao fornecedor ou representante. Não geram lançamento financeiro, por isso vêm embutidos, com os produtos que cada pagamento cobre. properties: credit_card: type: array description: Pagamento com cartão de crédito. items: "$ref": "#/components/schemas/vendor_credit_card_read" check: type: array description: Pagamento com cheque. items: "$ref": "#/components/schemas/vendor_check_read" credit: type: array description: 'Pagamento com crédito disponível no fornecedor ou representante. Com o controle de crédito do Monde ativo, o valor do pagamento é conferido contra o saldo do pagante com o fornecedor e o representante de um produto só, como no Monde: o primeiro produto do pagamento, por ordem alfabética do representante e, depois, do fornecedor. Os produtos de outro fornecedor pagos juntos usam esse mesmo saldo. O crédito sem representante é um saldo à parte. A conferência soma todos os pagamentos com crédito da requisição, e o valor é consumido ao gravar a venda; sem saldo suficiente, a resposta é 422. Retirado da venda na alteração, o crédito usado volta ao pagante. Sem o controle de crédito, e na operadora, o pagamento é gravado sem conferir saldo.' items: "$ref": "#/components/schemas/vendor_credit_read" others: type: array description: Pagamento com outras formas . Utilize o campo `details` para especificar a forma de pagamento utilizada. items: "$ref": "#/components/schemas/vendor_others_read" payment_read: type: object readOnly: true description: Pagamentos da venda, separados entre os destinados à agência e os destinados ao fornecedor. properties: agency: allOf: - "$ref": "#/components/schemas/payment_agency_read" description: Pagamentos destinados à agência. As listas `bills` e `refunds` são referências; as demais são pagamentos registrados sem lançamento financeiro e vêm embutidas. vendor: allOf: - "$ref": "#/components/schemas/payment_vendor_read" description: Pagamentos destinados ao fornecedor ou representante. Não geram lançamento financeiro, por isso vêm embutidos, com os produtos que cada pagamento cobre. payment_update: type: object oneOf: - required: - id - required: - local_id - agency - required: - local_id - vendor description: 'Pagamento na alteração da venda. Sem `id`, inclui um pagamento novo, como na criação. Só com o `id`, mantém o pagamento que a venda já tem. Com o `id` e a forma com que ele foi incluído, altera o pagamento, como no Monde: mudam o pagante (`payer`), o vencimento (`due_date`), a descrição (`description`) e os dados da forma (cartão, cheque, `details`, `observations`), e só o que foi enviado. O valor e a forma não mudam: `products`, `bank_account`, `settlement_date`, `settlement_exchange_rate`, `card_rate` e `card_rate_percentage` 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 sem `id`. As travas são as do Monde: o pagamento liquidado ou faturado (em fatura de cliente ou de fornecedor) não se altera (422), e a venda fechada só se altera reaberta (409). O Retido pelo Intermediário e o pagamento antigo registrado só na venda não se alteram por aqui (422).' properties: id: type: string format: uuid description: 'Identificador de um pagamento que a venda já tem (o que voltou ao lado do `local_id` na resposta da criação ou da alteração, ou o da consulta da venda: `id` do pagamento ao fornecedor, ao crédito e do Retido pelo Intermediário ou o de qualquer item em `products` deles, ou o lançamento em `payments.agency.bills`). Só com o `id`, o pagamento fica como está. O Faturar e a Devolução Faturar não entram nesta lista: a alteração da venda não os mantém nem os remove. Com o `id` e a forma com que ele foi incluído, o pagamento é alterado: veja a alteração na descrição do pagamento.' example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 local_id: type: string maxLength: 50 description: 'Nome que a integração dá ao pagamento, único entre os pagamentos novos da requisição. Obrigatório no pagamento novo. Não é gravado: volta na resposta, dentro do pagamento, ao lado do `id` gerado. É por ele que você sabe qual `id` é de qual pagamento, para mantê-lo ou removê-lo na alteração da venda.' example: pagamento-1 agency: description: Pagamentos destinados à agência. "$ref": "#/components/schemas/payment_agency" vendor: description: Pagamentos destinados ao fornecedor ou representante. "$ref": "#/components/schemas/payment_vendor" written_item: type: object description: 'Produto ou pagamento enviado nesta requisição: o `id` gerado e o `local_id` que você deu a ele.' properties: id: type: string format: uuid example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 local_id: type: string nullable: true description: 'O `local_id` que você enviou neste item. Não é gravado: só vem na resposta da requisição que enviou o item. Nulo no produto alterado pelo `id` sem `local_id`.' example: seguro-1 sale_written: description: A venda no formato da consulta por ID. Cada produto e pagamento enviado nesta requisição traz o `local_id` ao lado do `id` gerado. allOf: - "$ref": "#/components/schemas/sale_detail" sale_written_reference: type: object description: 'Resposta à credencial que não pode consultar a venda alterada: o `id` da venda e, no mesmo formato da venda, o `id` e o `local_id` de cada produto e pagamento enviado nesta requisição. Nada além do que você enviou.' properties: id: type: string format: uuid example: 212b54b8-27df-4859-80a9-79ad855bcd09 insurances: type: array items: "$ref": "#/components/schemas/written_item" cruises: type: array items: "$ref": "#/components/schemas/written_item" hotels: type: array items: "$ref": "#/components/schemas/written_item" airline_tickets: type: array items: "$ref": "#/components/schemas/written_item" train_tickets: type: array items: "$ref": "#/components/schemas/written_item" ground_transportations: type: array items: "$ref": "#/components/schemas/written_item" car_rentals: type: array items: "$ref": "#/components/schemas/written_item" travel_packages: type: array items: "$ref": "#/components/schemas/written_item" others: type: array items: "$ref": "#/components/schemas/written_item" cvc_packages: type: array items: "$ref": "#/components/schemas/written_item" operations: type: array items: "$ref": "#/components/schemas/written_item" excursions: type: array items: "$ref": "#/components/schemas/written_item" visas: type: array items: "$ref": "#/components/schemas/written_item" payments: type: object properties: agency: type: object properties: bills: type: array items: "$ref": "#/components/schemas/written_item" credit: type: array items: "$ref": "#/components/schemas/written_item" retained_by_intermediary: type: array items: "$ref": "#/components/schemas/written_item" vendor: type: object properties: credit_card: type: array items: "$ref": "#/components/schemas/written_item" check: type: array items: "$ref": "#/components/schemas/written_item" credit: type: array items: "$ref": "#/components/schemas/written_item" others: type: array items: "$ref": "#/components/schemas/written_item" passenger_document: type: string description: Identificação do passageiro no produto, como número de bilhete ou outra referência de identificação, quando aplicável. maxLength: 30 passenger_cost_center: type: string maxLength: 50 description: Centro de custo do passageiro. Quando o pagante da venda é pessoa jurídica, precisa ser um dos centros de custo cadastrados nele (sem diferenciar maiúsculas de minúsculas) e é gravado com o nome como está no cadastro; fora do cadastro, a venda é recusada com 422. Com pagante pessoa física, ou com a configuração de vendas **Informar o centro de custo em texto livre** ligada, aceita qualquer texto. passenger_canceled_at: type: string format: date-time readOnly: true description: Data de cancelamento do passageiro. passenger_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Valor do produto cobrado do passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_fees: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: ' Taxas cobradas pelo fornecedor ou representante. Também pode ser conhecida como "taxa administrativa", "taxa de emissão", "taxa de embarque", entre outros.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
' passenger_other_fees: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Taxas diversas cobradas do passageiro, além das taxas específicas do produto. O que ela representa varia conforme o produto.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_tip: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Gorjeta cobrada do passageiro no cruzeiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_rav_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Remuneração do Agente de Viagens (RAV), receita gerada pela agência, especialmente em passagens aéreas.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_rav_fee_discount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Desconto aplicado sobre a RAV.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_agency_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Taxa cobrada diretamente pela agência de viagens, sem vínculo direto com o fornecedor ou representante. O valor é somado ao total do produto mas não aparece detalhado para o cliente final.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_customer_amount: type: number format: double readOnly: true minimum: 0 description: " Valor cobrado do cliente referente ao passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_total_amount: type: number format: double readOnly: true minimum: 0 description: " Valor total do passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" passenger_person: description: 'A pessoa do passageiro: os dados dela, para cadastrar ou atualizar pelo `external_id`, ou só o `id` da pessoa já cadastrada. É a pessoa que identifica o passageiro no produto: a mesma pessoa aparece uma vez só, e na alteração da venda a pessoa que já é passageiro tem o mesmo passageiro alterado.' oneOf: - "$ref": "#/components/schemas/individual_person" - "$ref": "#/components/schemas/passenger_person_reference" passenger_person_reference: type: object title: Pessoa já cadastrada description: Aponta a pessoa já cadastrada pelo `id`, como a consulta da venda devolve. Os dados da pessoa não são alterados por aqui, e os demais campos enviados junto do `id` são ignorados. Exige a permissão de ler pessoas; sem ela, ou com uma pessoa jurídica, a resposta é 422. required: - id properties: id: type: string format: uuid description: Identificador (UUID) da pessoa física já cadastrada. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 insurance_passenger: type: object required: - person properties: document: &524 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &525 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &526 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &527 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &528 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). rav_fee: &529 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &530 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: &531 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &532 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: &533 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &534 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). amount: &535 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &536 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &537 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &538 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &539 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &540 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: &541 allOf: - "$ref": "#/components/schemas/passenger_person" insurance_passenger_read: type: object readOnly: true required: - person properties: document: *524 cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: &559 allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Dados pessoais do passageiro.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
train_passenger: type: object required: - person properties: document: &542 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &543 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &544 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &545 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &546 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). rav_fee: &547 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &548 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: &549 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &550 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: &551 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &552 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). amount: &553 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &554 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &555 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &556 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &557 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &558 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: *541 train_passenger_read: type: object readOnly: true required: - person properties: document: *542 cost_center: *543 canceled_at: *544 fees: *545 fees_origin_currency: *546 rav_fee: *547 rav_fee_origin_currency: *548 rav_fee_discount: *549 rav_fee_discount_origin_currency: *550 agency_fee: *551 agency_fee_origin_currency: *552 amount: *553 amount_origin_currency: *554 customer_amount: *555 customer_amount_origin_currency: *556 total_amount: *557 total_amount_origin_currency: *558 person: *559 ground_transportation_passenger: type: object required: - person - document properties: document: &560 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &561 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &562 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &563 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &564 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). rav_fee: &565 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &566 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: &567 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &568 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: &569 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &570 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). amount: &571 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &572 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &573 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &574 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &575 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &576 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: *541 ground_transportation_passenger_read: type: object readOnly: true required: - person properties: document: *560 cost_center: *561 canceled_at: *562 fees: *563 fees_origin_currency: *564 rav_fee: *565 rav_fee_origin_currency: *566 rav_fee_discount: *567 rav_fee_discount_origin_currency: *568 agency_fee: *569 agency_fee_origin_currency: *570 amount: *571 amount_origin_currency: *572 customer_amount: *573 customer_amount_origin_currency: *574 total_amount: *575 total_amount_origin_currency: *576 person: *559 cruise_passenger: type: object required: - person properties: document: &577 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &578 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &579 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &580 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &581 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). tip: &582 allOf: - "$ref": "#/components/schemas/passenger_tip" tip_origin_currency: &583 allOf: - "$ref": "#/components/schemas/passenger_tip" readOnly: true description: Valor de `tip` na moeda de origem do produto (`origin_currency`). rav_fee: &584 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &585 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: &586 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &587 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: &588 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &589 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). amount: &590 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &591 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &592 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &593 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &594 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &595 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: *541 cruise_passenger_read: type: object readOnly: true required: - person properties: document: *577 cost_center: *578 canceled_at: *579 fees: *580 fees_origin_currency: *581 tip: *582 tip_origin_currency: *583 rav_fee: *584 rav_fee_origin_currency: *585 rav_fee_discount: *586 rav_fee_discount_origin_currency: *587 agency_fee: *588 agency_fee_origin_currency: *589 amount: *590 amount_origin_currency: *591 customer_amount: *592 customer_amount_origin_currency: *593 total_amount: *594 total_amount_origin_currency: *595 person: *559 operation_passenger: type: object required: - person properties: document: &616 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &617 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &618 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &619 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &620 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). amount: &621 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &622 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &623 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &624 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &625 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &626 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: *541 default_passenger: type: object required: - person properties: document: &597 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &598 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &599 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &600 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &601 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). other_fees: &602 allOf: - "$ref": "#/components/schemas/passenger_other_fees" other_fees_origin_currency: &603 allOf: - "$ref": "#/components/schemas/passenger_other_fees" readOnly: true description: Valor de `other_fees` na moeda de origem do produto (`origin_currency`). rav_fee: &604 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &605 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: &606 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &607 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: &608 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &609 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). amount: &610 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &611 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &612 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &613 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &614 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &615 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: *541 default_passenger_read: type: object readOnly: true required: - person properties: document: &596 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: *559 excursion_passenger: type: object required: - person properties: document: *596 cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: *541 visa_passenger: type: object description: Solicitante do visto. required: - person properties: document: *596 cost_center: *525 canceled_at: *526 fees: allOf: - "$ref": "#/components/schemas/passenger_fees" description: 'Taxa consular do solicitante, cobrada pelo consulado ou embaixada pelo pedido do visto. Soma no total do produto e da venda. A taxa de serviço da agência não vai aqui: vai em agency_service_fee do produto.' fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: *541 visa_passenger_read: type: object readOnly: true description: Solicitante do visto. required: - person properties: document: *596 cost_center: *525 canceled_at: *526 fees: allOf: - "$ref": "#/components/schemas/passenger_fees" description: 'Taxa consular do solicitante, cobrada pelo consulado ou embaixada pelo pedido do visto. Soma no total do produto e da venda. A taxa de serviço da agência não vai aqui: vai em agency_service_fee do produto.' fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: *559 others_passenger: type: object required: - person properties: document: &970 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: *541 car_rental_passenger_read: type: object readOnly: true required: - person properties: document: *597 cost_center: *598 canceled_at: *599 fees: *600 fees_origin_currency: *601 other_fees: *602 other_fees_origin_currency: *603 rav_fee: *604 rav_fee_origin_currency: *605 rav_fee_discount: *606 rav_fee_discount_origin_currency: *607 agency_fee: *608 agency_fee_origin_currency: *609 amount: *610 amount_origin_currency: *611 customer_amount: *612 customer_amount_origin_currency: *613 total_amount: *614 total_amount_origin_currency: *615 person: *559 operation_passenger_read: type: object readOnly: true required: - person properties: document: *616 cost_center: *617 canceled_at: *618 fees: *619 fees_origin_currency: *620 amount: *621 amount_origin_currency: *622 customer_amount: *623 customer_amount_origin_currency: *624 total_amount: *625 total_amount_origin_currency: *626 person: *559 travel_package_passenger: type: object required: - person properties: document: *597 cost_center: *598 canceled_at: *599 fees: *600 fees_origin_currency: *601 other_fees: *602 other_fees_origin_currency: *603 rav_fee: *604 rav_fee_origin_currency: *605 rav_fee_discount: *606 rav_fee_discount_origin_currency: *607 agency_fee: *608 agency_fee_origin_currency: *609 amount: *610 amount_origin_currency: *611 customer_amount: *612 customer_amount_origin_currency: *613 total_amount: *614 total_amount_origin_currency: *615 person: *541 travel_package_passenger_read: type: object readOnly: true required: - person properties: document: *597 cost_center: *598 canceled_at: *599 fees: *600 fees_origin_currency: *601 other_fees: *602 other_fees_origin_currency: *603 rav_fee: *604 rav_fee_origin_currency: *605 rav_fee_discount: *606 rav_fee_discount_origin_currency: *607 agency_fee: *608 agency_fee_origin_currency: *609 amount: *610 amount_origin_currency: *611 customer_amount: *612 customer_amount_origin_currency: *613 total_amount: *614 total_amount_origin_currency: *615 person: *559 hotel_passenger: type: object required: - person properties: document: &627 allOf: - "$ref": "#/components/schemas/passenger_document" emission_name: &628 type: string readOnly: true description: Nome de emissão do bilhete. maxLength: 30 cost_center: &629 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &630 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &631 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &632 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Valor de `fees` na moeda de origem do produto (`origin_currency`). other_fees: &633 allOf: - "$ref": "#/components/schemas/passenger_other_fees" other_fees_origin_currency: &634 allOf: - "$ref": "#/components/schemas/passenger_other_fees" readOnly: true description: Valor de `other_fees` na moeda de origem do produto (`origin_currency`). rav_fee: &635 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &636 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: &637 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &638 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: &639 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &640 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). amount: &641 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &642 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &643 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &644 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &645 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &646 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: *541 hotel_passenger_read: type: object readOnly: true required: - person properties: document: *627 emission_name: *628 cost_center: *629 canceled_at: *630 fees: *631 fees_origin_currency: *632 other_fees: *633 other_fees_origin_currency: *634 rav_fee: *635 rav_fee_origin_currency: *636 rav_fee_discount: *637 rav_fee_discount_origin_currency: *638 agency_fee: *639 agency_fee_origin_currency: *640 amount: *641 amount_origin_currency: *642 customer_amount: *643 customer_amount_origin_currency: *644 total_amount: *645 total_amount_origin_currency: *646 person: *559 airline_ticket_passenger: type: object required: - ticket_number properties: ticket_number: &647 type: string description: Número do bilhete do passageiro. maxLength: 30 original_ticket_number: &648 type: string writeOnly: true description: "⚠️ Esse campo ainda não está disponível — está documentado apenas como referência do que temos planejado.

Número do bilhete original do passageiro. Utilize esse campo para indicar que o bilhete foi reemitido, informando o número do bilhete que originou a reemissão." maxLength: 30 emission_name: &649 type: string description: Nome do passageiro conforme emitido no bilhete. maxLength: 50 cost_center: &650 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &651 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" boarding_fee: &652 type: number format: double minimum: 0 exclusiveMaximum: 100000000000 description: " Valor da taxa de embarque cobrada do passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" boarding_fee_origin_currency: &653 type: number format: double readOnly: true description: Valor de `boarding_fee` na moeda de origem do produto (`origin_currency`). other_fees: &654 allOf: - "$ref": "#/components/schemas/passenger_other_fees" other_fees_origin_currency: &655 allOf: - "$ref": "#/components/schemas/passenger_other_fees" readOnly: true description: Valor de `other_fees` na moeda de origem do produto (`origin_currency`). rav_fee: &656 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &657 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Valor de `rav_fee` na moeda de origem do produto (`origin_currency`). rav_fee_discount: &658 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &659 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Valor de `rav_fee_discount` na moeda de origem do produto (`origin_currency`). du_fee: &660 type: number format: double minimum: 0 description: " Remuneração adicional que algumas companhias aéreas oferecem às agências (DU).
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee_origin_currency: &661 type: number format: double readOnly: true description: Valor de `du_fee` na moeda de origem do produto (`origin_currency`). du_fee_discount: &662 type: number format: double readOnly: true minimum: 0 description: " Desconto aplicado sobre a DU.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" du_fee_discount_origin_currency: &663 type: number format: double readOnly: true description: Valor de `du_fee_discount` na moeda de origem do produto (`origin_currency`). agency_fee: &664 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &665 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Valor de `agency_fee` na moeda de origem do produto (`origin_currency`). amount: &666 type: number format: double default: 0 minimum: 0 description: " Valor do produto cobrado do passageiro.
  • Deve ser informado na mesma moeda especificada no campo `currency`.
" amount_origin_currency: &667 type: number format: double readOnly: true description: Valor de `amount` na moeda de origem do produto (`origin_currency`). customer_amount: &668 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &669 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Valor de `customer_amount` na moeda de origem do produto (`origin_currency`). total_amount: &670 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &671 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Valor de `total_amount` na moeda de origem do produto (`origin_currency`). person: description: Dados pessoais do passageiro. allOf: - "$ref": "#/components/schemas/individual_person" airline_ticket_passenger_read: type: object readOnly: true required: - ticket_number properties: ticket_number: *647 original_ticket_number: *648 emission_name: *649 cost_center: *650 canceled_at: *651 boarding_fee: *652 boarding_fee_origin_currency: *653 other_fees: *654 other_fees_origin_currency: *655 rav_fee: *656 rav_fee_origin_currency: *657 rav_fee_discount: *658 rav_fee_discount_origin_currency: *659 du_fee: *660 du_fee_origin_currency: *661 du_fee_discount: *662 du_fee_discount_origin_currency: *663 agency_fee: *664 agency_fee_origin_currency: *665 amount: *666 amount_origin_currency: *667 customer_amount: *668 customer_amount_origin_currency: *669 total_amount: *670 total_amount_origin_currency: *671 person: *559 pagination: type: object description: Informações de paginação da resposta. properties: size: type: integer minimum: 1 maximum: 50 description: Número de registros por página. example: 10 has_next_page: type: boolean description: Indica se existe uma próxima página. Para percorrer a consulta inteira, peça a próxima página com o `next_cursor` enquanto for verdadeiro. example: true next_cursor: type: - string - 'null' description: Cursor para pedir a próxima página. Nulo quando não existe próxima página. example: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 cabin: type: object description: Representa um tipo de cabine cadastrado no sistema. properties: name: type: string maxLength: 30 description: Nome da cabine (identificador único) example: Varanda required: - name cabin_write: type: object description: Dados para cadastrar ou alterar uma cabine. Na alteração, todos os campos são opcionais. additionalProperties: false properties: name: type: string minLength: 1 maxLength: 30 description: 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. example: Varanda ship: type: object description: Representa um navio cadastrado no sistema. properties: name: type: string maxLength: 30 description: Nome do navio (identificador único) example: MSC Preziosa required: - name ship_write: type: object description: Dados para cadastrar ou alterar um navio. Na alteração, todos os campos são opcionais. additionalProperties: false properties: name: type: string minLength: 1 maxLength: 30 description: Nome do navio, até 30 caracteres e sem repetir outro navio. Quebras de linha são removidas. Obrigatório no cadastro; na alteração, um nome novo renomeia o navio. example: MSC Preziosa package: type: object description: Representa um pacote cadastrado no sistema. properties: name: type: string maxLength: 50 description: Nome do pacote (identificador único) example: Disney 7 noites services_included: type: - string - 'null' description: Serviços inclusos no pacote, que o Monde copia para a descrição do produto de pacote turístico quando o pacote é escolhido na venda example: Aéreo, hotel e ingressos para os parques required: - name package_write: type: object description: Dados para cadastrar ou alterar um pacote. Na alteração, todos os campos são opcionais. additionalProperties: false properties: name: type: string minLength: 1 maxLength: 50 description: 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. example: Disney 7 noites services_included: type: - string - 'null' description: Serviços inclusos no pacote. Na alteração, nulo deixa o campo em branco. example: Aéreo, hotel e ingressos para os parques cost_center: type: object description: Representa um centro de custo cadastrado no sistema. properties: id: type: string format: uuid description: Identificador único do centro de custo example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Descrição do centro de custo example: Marketing required: - id - description cost_center_create: type: object writeOnly: true description: Dados para cadastrar um centro de custo. required: - description properties: description: type: string maxLength: 50 description: Descrição do centro de custo, até 50 caracteres. Obrigatória na inclusão. example: Marketing cost_center_update: type: object writeOnly: true description: Dados para alterar um centro de custo. properties: description: type: string maxLength: 50 description: Descrição do centro de custo, até 50 caracteres. Obrigatória na inclusão. example: Marketing currency: type: object description: Representa uma moeda cadastrada no sistema. properties: code: type: string minLength: 3 maxLength: 3 description: Código da moeda no padrão ISO 4217 (identificador único) example: BRL description: type: string description: Descrição da moeda example: Real symbol: type: string nullable: true description: Símbolo da moeda example: R$ active: type: boolean description: Indica se a moeda está ativa example: true required: - code - description - active currency_update: type: object description: Dados para alterar a moeda. Todos os campos são opcionais. additionalProperties: false properties: code: type: string minLength: 3 maxLength: 3 description: 'Código da moeda. É fixo: um valor diferente do atual é recusado (422)' example: USD description: type: string maxLength: 100 description: 'Descrição da moeda. É fixa: um valor diferente do atual é recusado (422)' example: Dólar Americano symbol: type: - string - 'null' maxLength: 5 description: 'Símbolo da moeda. É fixo: um valor diferente do atual é recusado (422)' example: US$ active: type: boolean description: Indica se a moeda está ativa example: true exchange_rate_create: type: object description: Dados para gravar a cotação nova da moeda. additionalProperties: false properties: value: type: number exclusiveMinimum: 0 maximum: 99999999999.9999 description: Quantos reais vale uma unidade da moeda, maior que zero. É gravado com 4 casas decimais example: 5.4321 required: - value exchange_rate_update: type: object description: As cotações novas de várias moedas. additionalProperties: false properties: exchange_rates: type: array minItems: 1 description: As cotações novas, uma por moeda items: type: object properties: currency_code: type: string minLength: 3 maxLength: 3 description: Código da moeda, ativa e diferente de BRL example: USD value: type: number exclusiveMinimum: 0 maximum: 99999999999.9999 description: Quantos reais vale uma unidade da moeda, maior que zero. É gravado com 4 casas decimais example: 5.4321 required: - currency_code - value required: - exchange_rates exchange_rate_update_response: type: object description: As cotações gravadas pela atualização. properties: exchange_rates: type: array description: As cotações gravadas. A moeda cujo valor não mudou fica de fora items: "$ref": "#/components/schemas/exchange_rate" required: - exchange_rates category_summary: type: object description: Representa uma categoria financeira cadastrada no sistema, com os campos da própria categoria. properties: id: type: string format: uuid description: Identificador único da categoria example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Descrição da categoria example: Aluguel kind: type: string enum: - expense - revenue description: 'Tipo da categoria, herdado do grupo: `expense` (despesa) ou `revenue` (receita). 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.' example: expense pass_through: type: boolean description: Indica se a categoria é de repasse. Repasses são valores que apenas transitam pela agência e não devem ser considerados receita ou despesa real. example: false required: - id - description - kind - pass_through category: description: Representa uma categoria financeira cadastrada no sistema, com o grupo. allOf: - "$ref": "#/components/schemas/category_summary" - type: object required: - group properties: group: type: object description: Grupo ao qual a categoria pertence properties: id: type: string format: uuid description: Identificador único do grupo da categoria no formato UUID example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: type: string description: Nome do grupo da categoria example: Despesas Administrativas required: - id - name category_create: type: object writeOnly: true description: Dados para cadastrar uma categoria financeira. required: - description - group_id properties: description: type: string maxLength: 50 description: Descrição da categoria, até 50 caracteres. Obrigatória na inclusão. example: Aluguel group_id: type: string format: uuid description: ID do grupo da categoria (consulte em `GET /category_groups`). Obrigatório na inclusão. Na alteração, só um grupo do mesmo tipo. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 pass_through: type: boolean description: 'Indica se a categoria é de repasse: valores que só transitam pela agência e ficam fora do resultado. Na inclusão, o padrão é `false`.' example: false category_update: type: object writeOnly: true description: Dados para alterar uma categoria financeira. Envie só os campos que mudam. properties: description: type: string maxLength: 50 description: Descrição da categoria, até 50 caracteres. Obrigatória na inclusão. example: Aluguel group_id: type: string format: uuid description: ID do grupo da categoria (consulte em `GET /category_groups`). Obrigatório na inclusão. Na alteração, só um grupo do mesmo tipo. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 pass_through: type: boolean description: 'Indica se a categoria é de repasse: valores que só transitam pela agência e ficam fora do resultado. Na inclusão, o padrão é `false`.' example: false city_summary: type: object description: Representa uma cidade cadastrada no sistema, com os campos da própria cidade. properties: id: type: string format: uuid description: Identificador único da cidade example: f9d961b8-ea88-4346-8e52-afe94267417a name: type: string description: Nome da cidade example: São Paulo ibge: type: string nullable: true description: Código IBGE da cidade (apenas cidades brasileiras) example: '3550308' siafi: type: string nullable: true description: Código SIAFI da cidade (apenas cidades brasileiras) example: '7107' required: - id - name city: description: Representa uma cidade cadastrada no sistema, com o estado e o país. allOf: - "$ref": "#/components/schemas/city_summary" - type: object properties: state: type: object nullable: true description: Estado da cidade (nulo para cidades estrangeiras) properties: id: type: string format: uuid description: Identificador único do estado example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 acronym: type: string description: Sigla do estado (UF) example: SP name: type: string description: Nome do estado example: São Paulo required: - id - acronym - name country: type: object nullable: true description: País da cidade properties: id: type: string format: uuid description: Identificador único do país example: c3b7e8eb-1199-4457-9170-923c3fe56c92 name: type: string description: Nome do país example: Brasil code: type: string nullable: true description: Código do país com duas letras (ISO 3166-1 alfa-2) example: BR code_3: type: string nullable: true description: Código do país com três letras (ISO 3166-1 alfa-3) example: BRA sisbacen: type: integer nullable: true description: Código SISBACEN do país example: 1058 required: - id - name person_role_summary: type: object description: Representa uma função na consulta em lista, com os campos próprios do cadastro. properties: id: type: string format: uuid description: Identificador único da função example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e description: type: string description: Nome da função example: Gerente seller: type: boolean description: Indica a função de vendedor do sistema, que comissiona o vendedor da venda example: false intermediary: type: boolean description: Indica a função de intermediário do sistema, que comissiona o intermediário da venda example: false system: type: boolean description: Indica a função do sistema (Vendedor e Intermediário), que não muda de nome nem é excluída example: false required: - id - description - seller - intermediary - system person_role: description: Representa uma função cadastrada, com as empresas ou vendedores sobre cujas vendas ela é comissionada e as pessoas vinculadas. allOf: - "$ref": "#/components/schemas/person_role_summary" - type: object properties: commissioned_over: type: array description: Empresas e vendedores sobre cujas vendas a função é comissionada (o grupo "Comissionado sobre" do Monde), pelo `id` da pessoa. Vazio na função do sistema. items: "$ref": "#/components/schemas/entity_reference" people: type: array description: Pessoas vinculadas à função. items: "$ref": "#/components/schemas/person_role_person" person_role_person: type: object description: Pessoa vinculada à função. properties: id: type: string format: uuid description: Identificador do vínculo da pessoa com a função, usado para mantê-lo na alteração example: 0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b person: allOf: - "$ref": "#/components/schemas/entity_reference" description: Pessoa vinculada commission_plan: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Plano de comissão da pessoa na função start_date: type: string format: date nullable: true description: Data a partir da qual a pessoa é comissionada na função example: '2026-01-01' not_commissioned: type: boolean description: Indica que a pessoa não é comissionada na função example: false goals: type: array description: Metas da pessoa na função, por ano (o "Plano e Metas" do Monde). items: "$ref": "#/components/schemas/person_role_goal" required: - id - person - commission_plan - start_date - not_commissioned - goals person_role_goal: type: object description: Meta da pessoa na função num ano, com o valor de cada mês, como em [Metas](#tag/Metas). properties: id: type: string format: uuid readOnly: true description: Identificador da meta, o mesmo de [Metas](#tag/Metas), usado para mantê-la na alteração example: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a year: type: integer description: Ano da meta example: 2026 months: "$ref": "#/components/schemas/goal_months" required: - id - year - months person_role_write: type: object description: Dados para cadastrar uma função. properties: &672 description: type: string maxLength: 30 description: Nome da função, até 30 caracteres. example: Gerente commissioned_over: type: array description: Empresas e vendedores ativos sobre cujas vendas a função é comissionada, pelo `id` obtido em [Consultar empresas](#tag/Empresas/paths/~1companies/get) ou em [Consultar vendedores](#tag/Vendedores/paths/~1sellers/get), que é o da pessoa. Obrigatório no cadastro, com ao menos um item. Na alteração, a lista enviada substitui a da função. items: "$ref": "#/components/schemas/entity_reference" people: type: array description: Pessoas vinculadas à função. Na alteração, a lista enviada é a final. items: "$ref": "#/components/schemas/person_role_person_write" required: - description person_role_update: type: object description: Dados para alterar uma função. Todos os campos são opcionais. properties: *672 person_role_person_write: type: object description: Pessoa vinculada à função. Sem `id`, vincula uma pessoa nova; com `id`, mantém aquele vínculo e altera só os campos enviados. properties: id: type: string format: uuid description: Identificador de um vínculo que a função já tem, obtido na consulta da função. Omitido, o item vincula uma pessoa nova. example: 0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b person: allOf: - "$ref": "#/components/schemas/entity_reference" description: 'Pessoa a vincular, pelo `id` obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). Obrigatória no item sem `id`. O vínculo existente não troca de pessoa: para vincular outra, envie um item novo.' commission_plan: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Plano de comissão da pessoa na função, pelo `id` do plano. Nulo tira o plano do vínculo. start_date: type: string format: date nullable: true description: Data a partir da qual a pessoa é comissionada, no formato AAAA-MM-DD. Obrigatória, a menos que `not_commissioned` seja `true`. example: '2026-01-01' not_commissioned: type: boolean description: "`true` quando a pessoa não é comissionada na função, o que dispensa a data de início. Omitido no item novo, vale `false`." example: false goals: type: array nullable: true description: 'Metas da pessoa na função. A lista enviada é a final: a meta com `id` fica, a sem `id` entra e a que ficou de fora é excluída. Omitida, as metas ficam como estão; nula, todas são excluídas. Um ano por pessoa na função.' items: "$ref": "#/components/schemas/person_role_goal_write" person_role_goal_write: type: object description: Meta da pessoa na função. Sem `id`, cadastra uma meta; com `id`, mantém aquela meta e altera só os campos enviados. properties: id: type: string format: uuid description: Identificador de uma meta que a pessoa já tem na função, obtido na consulta da função. Omitido, o item cadastra uma meta nova. example: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a year: type: integer description: Ano da meta, obrigatório na meta nova. Na meta nova ou quando muda, vai do ano anterior ao atual até cinco anos à frente; a meta já gravada com outro ano é aceita enquanto o ano não muda. Um ano por pessoa na função. example: 2026 months: allOf: - "$ref": "#/components/schemas/goal_months" description: Valor de cada mês, sem negativos. Na meta nova, `months` e `january` são obrigatórios, e o mês omitido recebe o valor de janeiro. Na meta existente, só os meses enviados mudam. seller_summary: type: object description: Representa um vendedor na consulta em lista, com os campos próprios do cadastro. properties: id: type: string format: uuid description: Identificador único do vendedor (o mesmo da pessoa correspondente) example: f9d961b8-ea88-4346-8e52-afe94267417a active: type: boolean description: Indica se o vendedor está ativo example: true created_at: type: string format: date-time description: Data e hora de cadastro do vendedor example: '2024-03-15T10:30:00' required: - id - created_at seller: description: Representa um vendedor cadastrado no sistema. O identificador do vendedor é o mesmo da pessoa correspondente. allOf: - "$ref": "#/components/schemas/seller_summary" - type: object required: - person properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Pessoa correspondente ao vendedor
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que cadastrou o vendedor
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
seller_update: type: object writeOnly: true description: 'Dados para alterar um vendedor. Todos os campos são opcionais: o campo omitido permanece como está. Nenhum deles pode ser retirado: enviado como nulo, é recusado.' properties: person_id: type: string format: uuid description: Identificador da pessoa do vendedor. Opcional; se enviado, precisa ser o da própria pessoa do vendedor, que não muda example: f9d961b8-ea88-4346-8e52-afe94267417a active: type: boolean description: Indica se o vendedor fica ativo. O inativo deixa de ser oferecido nas vendas novas example: false payment_method: type: object description: Representa uma forma de pagamento cadastrada no sistema. properties: id: type: string format: uuid description: Identificador único da forma de pagamento example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 name: type: string description: Descrição da forma de pagamento example: Dinheiro system: type: boolean description: Indica se a forma de pagamento é padrão do sistema (não pode ser editada nem excluída) example: true required: - id - name - system payment_method_create: type: object writeOnly: true description: Dados para cadastrar uma forma de pagamento. required: - name properties: name: type: string maxLength: 30 description: Nome da forma de pagamento, até 30 caracteres. Obrigatório na inclusão. example: Vale-viagem payment_method_update: type: object writeOnly: true description: Dados para alterar uma forma de pagamento. properties: name: type: string maxLength: 30 description: Nome da forma de pagamento, até 30 caracteres. Obrigatório na inclusão. example: Vale-viagem account_summary: type: object description: Representa uma conta ou cartão na consulta em lista, com os campos próprios do cadastro. properties: id: type: string format: uuid description: Identificador único da conta example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Descrição da conta example: Banco do Brasil - Matriz kind: type: string enum: - checking_account - card_account - check_account - cashier_account description: " Tipo da conta.
  • checking_account: conta corrente.
  • card_account: cartão de crédito.
  • check_account: cheques.
  • cashier_account: caixa.
" example: checking_account active: type: boolean description: Indica se a conta está ativa example: true currency: type: string minLength: 3 maxLength: 3 description: Código da moeda da conta no padrão ISO 4217 example: BRL initial_balance: type: number format: double description: Saldo inicial da conta example: 1500.0 bank_operation: type: string nullable: true description: Código da operação bancária. Relevante apenas para contas correntes da Caixa Econômica Federal; nulo nos demais casos. example: '001' agency: type: string nullable: true description: Número da agência bancária example: '1412' agency_digit: type: string nullable: true description: Dígito da agência bancária example: '5' number: type: string nullable: true description: Número da conta bancária example: '04640' digit: type: string nullable: true description: Dígito da conta bancária example: '2' pix_key: type: string nullable: true description: Chave Pix da conta example: financeiro@agencia.com.br bill_expiration: type: integer nullable: true minimum: 1 maximum: 31 description: Dia de vencimento da fatura (1 a 31). Aplica-se apenas a contas de cartão de crédito; nulo nos demais casos. example: 10 bill_closing: type: integer nullable: true minimum: 1 maximum: 31 description: Dia de fechamento da fatura (1 a 31). Aplica-se apenas a contas de cartão de crédito; nulo nos demais casos. example: 1 required: - id - description - kind - active - currency - initial_balance account: description: Representa uma conta ou cartão cadastrado no sistema. Os campos bancários são preenchidos para contas correntes; os campos de cartão, para cartões de crédito. allOf: - "$ref": "#/components/schemas/account_summary" - type: object required: - companies properties: bank: type: object nullable: true description: Banco da conta (apenas contas correntes) properties: id: type: string format: uuid description: Identificador único do banco example: c3b7e8eb-1199-4457-9170-923c3fe56c92 number: type: string description: Número do banco example: '001' name: type: string description: Nome do banco example: Banco do Brasil required: - id - name owner: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Titular da conta
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
card_operator: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Operadora do cartão (apenas cartões de crédito)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
companies: type: array description: |- Empresas em que a conta está disponível
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" invoice_company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Empresa em que a fatura do cartão de crédito é gerada; nula nas demais contas. user_groups: type: array description: Grupos de usuários a que a conta está liberada. Lista vazia é conta sem restrição de grupo. items: "$ref": "#/components/schemas/entity_reference" next_bank_slip_number: type: integer nullable: true description: Número do próximo boleto que a conta corrente emitir. Nulo nas demais contas. example: 1520 billing_accounts: type: array description: Cobranças dos boletos da conta corrente (Monde Bancos e CobreBem). items: "$ref": "#/components/schemas/billing_account" billing_account: type: object description: Cobrança dos boletos da conta corrente, pelo Monde Bancos ou pelo CobreBem. A cobrança PJBank tem cadastro próprio e não aparece aqui. properties: id: type: string format: uuid description: Identificador único da cobrança kind: type: string enum: - monde_bancos - cobre_bem description: 'Quem emite o boleto: `monde_bancos` ou `cobre_bem`.' registered: type: boolean description: Indica se a cobrança é registrada. No CobreBem, é informado na gravação, como na tela; no Monde Bancos, sai da carteira escolhida, e o valor enviado é ignorado. active: type: boolean description: Indica se a cobrança está ativa bank_issues_billet: type: boolean description: O banco emite o boleto bank_generates_number: type: boolean description: O banco gera o nosso número allows_unregistered_issue: type: boolean description: Permite emitir o boleto antes do registro (só na cobrança registrada) portfolio: type: string nullable: true description: Carteira, uma das oferecidas pelo banco da conta (Monde Bancos) document_kind: type: string nullable: true description: Espécie do documento, como `DM` (duplicata mercantil) ou `DS` (duplicata de serviço) return_layout: type: string nullable: true description: Layout do arquivo de retorno, um dos oferecidos pelo banco da conta (Monde Bancos) remittance_layout: type: string nullable: true description: Layout do arquivo de remessa, um dos oferecidos pelo banco da conta (Monde Bancos) agreement_code: type: string nullable: true description: Convênio variation: type: string nullable: true description: Variação da carteira accept: type: string nullable: true description: Aceite (uma letra) ceb_code: type: string nullable: true description: Código CEB billet_instructions: type: string nullable: true description: Instruções do boleto. Somadas às linhas de juros, protesto e taxa, o boleto tem até 6 linhas. local_of_payment: type: string nullable: true description: Local de pagamento assignor_format: type: string nullable: true description: Formato do código do cedente our_number_format: type: string nullable: true description: Formato do nosso número other_settings: type: string nullable: true description: Configurações particulares do banco, uma por linha, no formato chave=valor late_fine: type: number format: double nullable: true description: Multa por atraso (%) late_interest: type: number format: double nullable: true description: Juros por atraso (%) bank_fee: type: number format: double nullable: true description: Tarifa do banco billet_rate: type: number format: double nullable: true description: Taxa do boleto last_remittance: type: integer nullable: true description: Número da última remessa days_protest: type: integer nullable: true description: Dias para protesto guarantor: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sacador avalista
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
cobre_bem: type: object nullable: true description: Configuração do CobreBem; nula na cobrança do Monde Bancos. properties: license_loaded: type: boolean description: Indica se o arquivo de licença do CobreBem está carregado skip_detail2: type: boolean description: Não gerar o detalhe 2 da remessa skip_detail3: type: boolean description: Não gerar o detalhe 3 da remessa config1: type: string nullable: true description: Configuração 1 da licença config2: type: string nullable: true description: Configuração 2 da licença config3: type: string nullable: true description: Configuração 3 da licença config4: type: string nullable: true description: Configuração 4 da licença config5: type: string nullable: true description: Configuração 5 da licença remittance_layout: type: string nullable: true description: Layout da remessa return_layout: type: string nullable: true description: Layout do retorno document_kind: type: string nullable: true description: Tipo de documento remittance_accept: type: string nullable: true description: Aceite da remessa (uma letra) instruction1: type: string nullable: true description: Instrução de cobrança 1 instruction2: type: string nullable: true description: Instrução de cobrança 2 instruction3: type: string nullable: true description: Instrução de cobrança 3 title_properties: type: string nullable: true description: Propriedades especiais do título, uma por linha, no formato PROPRIEDADE=VALOR account_properties: type: string nullable: true description: Propriedades especiais da conta, uma por linha, no formato PROPRIEDADE=VALOR instruction1_value: type: integer nullable: true description: Valor da instrução de cobrança 1 instruction2_value: type: integer nullable: true description: Valor da instrução de cobrança 2 instruction3_value: type: integer nullable: true description: Valor da instrução de cobrança 3 billing_account_write: type: object description: Cobrança dos boletos da conta corrente. Com `id`, altera a cobrança existente; sem `id`, cadastra uma nova. properties: id: type: string format: uuid description: Identificador da cobrança a alterar. Sem ele, a cobrança é cadastrada. kind: type: string enum: - monde_bancos - cobre_bem default: monde_bancos description: 'Quem emite o boleto: `monde_bancos` ou `cobre_bem`.' registered: type: boolean description: Indica se a cobrança é registrada. No CobreBem, é informado na gravação, como na tela; no Monde Bancos, sai da carteira escolhida, e o valor enviado é ignorado. active: type: boolean description: Indica se a cobrança está ativa bank_issues_billet: type: boolean description: O banco emite o boleto bank_generates_number: type: boolean description: O banco gera o nosso número allows_unregistered_issue: type: boolean description: Permite emitir o boleto antes do registro (só na cobrança registrada) portfolio: type: string nullable: true description: Carteira, uma das oferecidas pelo banco da conta (Monde Bancos) document_kind: type: string nullable: true description: Espécie do documento, como `DM` (duplicata mercantil) ou `DS` (duplicata de serviço) return_layout: type: string nullable: true description: Layout do arquivo de retorno, um dos oferecidos pelo banco da conta (Monde Bancos) remittance_layout: type: string nullable: true description: Layout do arquivo de remessa, um dos oferecidos pelo banco da conta (Monde Bancos) agreement_code: type: string nullable: true description: Convênio variation: type: string nullable: true description: Variação da carteira accept: type: string nullable: true description: Aceite (uma letra) ceb_code: type: string nullable: true description: Código CEB billet_instructions: type: string nullable: true description: Instruções do boleto. Somadas às linhas de juros, protesto e taxa, o boleto tem até 6 linhas. local_of_payment: type: string nullable: true description: Local de pagamento assignor_format: type: string nullable: true description: Formato do código do cedente our_number_format: type: string nullable: true description: Formato do nosso número other_settings: type: string nullable: true description: Configurações particulares do banco, uma por linha, no formato chave=valor late_fine: type: number format: double nullable: true description: Multa por atraso (%) late_interest: type: number format: double nullable: true description: Juros por atraso (%) bank_fee: type: number format: double nullable: true description: Tarifa do banco billet_rate: type: number format: double nullable: true description: Taxa do boleto last_remittance: type: integer nullable: true description: Número da última remessa days_protest: type: integer nullable: true description: Dias para protesto guarantor: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sacador avalista
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
cobre_bem: type: object nullable: true description: Configuração do CobreBem; nula na cobrança do Monde Bancos. properties: license: type: string nullable: true writeOnly: true description: 'Conteúdo do arquivo de licença do CobreBem. Só é aceito na gravação: a consulta diz apenas se ele está carregado.' skip_detail2: type: boolean description: Não gerar o detalhe 2 da remessa skip_detail3: type: boolean description: Não gerar o detalhe 3 da remessa config1: type: string nullable: true description: Configuração 1 da licença config2: type: string nullable: true description: Configuração 2 da licença config3: type: string nullable: true description: Configuração 3 da licença config4: type: string nullable: true description: Configuração 4 da licença config5: type: string nullable: true description: Configuração 5 da licença remittance_layout: type: string nullable: true description: Layout da remessa return_layout: type: string nullable: true description: Layout do retorno document_kind: type: string nullable: true description: Tipo de documento remittance_accept: type: string nullable: true description: Aceite da remessa (uma letra) instruction1: type: string nullable: true description: Instrução de cobrança 1 instruction2: type: string nullable: true description: Instrução de cobrança 2 instruction3: type: string nullable: true description: Instrução de cobrança 3 title_properties: type: string nullable: true description: Propriedades especiais do título, uma por linha, no formato PROPRIEDADE=VALOR account_properties: type: string nullable: true description: Propriedades especiais da conta, uma por linha, no formato PROPRIEDADE=VALOR instruction1_value: type: integer nullable: true description: Valor da instrução de cobrança 1 instruction2_value: type: integer nullable: true description: Valor da instrução de cobrança 2 instruction3_value: type: integer nullable: true description: Valor da instrução de cobrança 3 account_update: description: Dados para alterar uma conta ou cartão. Todos os campos são opcionais. allOf: - "$ref": "#/components/schemas/account_write" - type: object properties: next_bank_slip_number: type: integer minimum: 1 maximum: 2147483647 description: '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.' account_write: type: object description: Campos da conta ou cartão aceitos na inclusão e na alteração. properties: description: type: string maxLength: 50 description: Descrição da conta currency: type: string description: Código da moeda (ISO 4217), uma das moedas cadastradas. Não pode ser trocado depois que a conta tem movimentação. active: type: boolean description: Indica se a conta está ativa. A conta do recebimento padrão não pode ser desativada. initial_balance: type: number format: double description: 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**. owner: "$ref": "#/components/schemas/entity_reference" bank: allOf: - "$ref": "#/components/schemas/entity_reference" description: Banco da conta corrente, pelo `id` de [Consultar bancos](#tag/Bancos/paths/~1banks/get). Não pode ser trocado depois que a conta tem cobrança. agency: type: string description: 'Agência da conta corrente: 4 dígitos, só números.' agency_digit: type: string maxLength: 1 description: Dígito da agência bancária bank_operation: type: string description: Operação da conta, só na Caixa Econômica Federal (banco 104), com 3 ou 4 dígitos. number: type: string maxLength: 10 description: Número da conta bancária digit: type: string maxLength: 1 description: Dígito da conta bancária pix_key: type: string maxLength: 100 description: Chave Pix da conta card_operator: allOf: - "$ref": "#/components/schemas/entity_reference" description: Operadora do cartão de crédito (pessoa), obrigatória no cartão. bill_expiration: type: integer minimum: 1 maximum: 31 description: Dia de vencimento da fatura do cartão (1 a 31), obrigatório no cartão. bill_closing: type: integer minimum: 1 maximum: 31 description: Dia de fechamento da fatura do cartão (1 a 31), obrigatório no cartão. invoice_company: allOf: - "$ref": "#/components/schemas/entity_reference" description: Empresa em que a fatura do cartão é gerada, uma das empresas de `companies`. Com uma empresa só, é ela. companies: type: array minItems: 1 description: Empresas em que a conta fica disponível, pelo `id` (o mesmo que a consulta devolve). Precisa ter ao menos uma; na alteração, é a lista final. items: "$ref": "#/components/schemas/entity_reference" user_groups: type: array description: 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. items: "$ref": "#/components/schemas/entity_reference" billing_accounts: type: array description: '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.' items: "$ref": "#/components/schemas/billing_account_write" account_create: description: Dados para cadastrar uma conta ou cartão. allOf: - "$ref": "#/components/schemas/account_write" - type: object required: - kind - description - currency - companies properties: kind: type: string enum: - cashier_account - checking_account - card_account description: 'Tipo da conta: `cashier_account` (caixa), `checking_account` (conta corrente) ou `card_account` (cartão de crédito). Não muda depois de cadastrada.' nf_rule_summary: type: object description: Representa uma regra da nota fiscal na consulta em lista, com os campos próprios do cadastro. properties: id: &674 type: string format: uuid description: Identificador único da regra example: f9d961b8-ea88-4346-8e52-afe94267417a description: &675 type: string description: Descrição da regra example: Regra padrão de pacotes representative_scope: &676 type: string enum: - any - none - specific description: " Indica a quais representantes a regra se aplica.
  • none: aplica-se apenas a vendas sem representante.
  • specific: aplica-se apenas ao representante indicado em representative.
  • any: aplica-se a qualquer representante.
" example: any created_at: &677 type: string format: date-time description: Data e hora de cadastro da regra example: '2024-03-15T10:30:00' payer_rule: &678 type: object properties: &673 recipient: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa para quem a nota fiscal é emitida (nulo = a própria pessoa da venda)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
revenues: type: array description: Parcelas que somam ao valor da nota fiscal (taxas próprias, comissão e over da agência) items: type: string enum: - du_fee - rav_fee - agency_service_fee - agency_fee - commission_amount - over_amount discounts: type: array description: Parcelas que reduzem o valor da nota fiscal (taxas de cartão, comissão e over de intermediário e o desconto total) items: type: string enum: - cc_du_fee - cc_rav_fee - discount - intermediary_commission_amount - intermediary_over_amount required: - recipient - revenues - discounts description: Emissão para o pagante supplier_rule: &679 type: object properties: *673 required: - recipient - revenues - discounts description: Emissão para o fornecedor representative_rule: &680 type: object properties: *673 required: - recipient - revenues - discounts description: Emissão para o representante required: - id - representative_scope - payer_rule - supplier_rule - representative_rule - created_at nf_rule: type: object description: Representa uma regra de emissão de nota fiscal, com as parcelas de valor (receitas e descontos) que compõem cada emissão. properties: id: *674 description: *675 representative_scope: *676 created_at: *677 product: &971 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Produto ao qual a regra se aplica (nulo = todos os produtos)
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
supplier: &972 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Fornecedor ao qual a regra se aplica (nulo = todos os fornecedores)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: &973 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Representante ao qual a regra se aplica (preenchido quando representative_scope = specific)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
payer: &974 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pagante ao qual a regra se aplica (nulo = todos os pagantes)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
created_by: &975 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que cadastrou a regra
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
payer_rule: *678 supplier_rule: *679 representative_rule: *680 required: - id - representative_scope - payer_rule - supplier_rule - representative_rule - created_at task_summary: type: object description: Representa uma tarefa cadastrada no sistema. properties: id: type: string format: uuid description: Identificador único da tarefa example: f9d961b8-ea88-4346-8e52-afe94267417a number: type: integer description: Número sequencial da tarefa example: 1042 title: type: string description: Título da tarefa example: Enviar voucher para o cliente description: type: string nullable: true description: Descrição da tarefa example: Confirmar os dados do embarque antes do envio. due: type: string format: date-time nullable: true description: Data e hora de vencimento (nulo quando a tarefa não tem vencimento, e então nunca fica atrasada) example: '2024-04-01T09:00:00' completed_at: type: string format: date-time nullable: true description: Data e hora de conclusão (nulo quando não concluída) example: visualized: type: boolean description: Indica se a tarefa foi visualizada pelo responsável example: true deleted: type: boolean description: Indica se a tarefa foi excluída example: false created_at: type: string format: date-time description: Data e hora de cadastro da tarefa example: '2024-03-15T10:30:00' required: - id - number - title - visualized - deleted - created_at task_historic: type: object readOnly: true description: Entrada do histórico da tarefa — um comentário ou um registro de alteração. properties: created_at: type: string format: date-time description: Data e hora do registro no histórico example: '2024-04-01T09:30:00' text: type: string nullable: true description: Comentário registrado no histórico (nulo quando a entrada é apenas um registro de alteração) example: Cliente confirmou os dados do embarque. historic: type: string nullable: true description: Registro de alteração da tarefa (nulo quando a entrada é apenas um comentário) example: "'Título' alterado de 'A' para 'B'" person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que registrou a entrada do histórico (nulo quando a entrada não tem uma pessoa como autor, como a registrada pelo próprio Monde ou por uma credencial da API)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
attachments: type: array description: Anexos enviados com o comentário, com o link de download. Também aparecem nos anexos da tarefa. items: "$ref": "#/components/schemas/attachment_summary" task: description: Representa uma tarefa com o histórico e os campos personalizados. allOf: - "$ref": "#/components/schemas/task_summary" - type: object required: - assignee - history - custom_fields properties: category: allOf: - "$ref": "#/components/schemas/numeric_entity_reference" nullable: true description: |- Categoria da tarefa (nulo quando a tarefa não tem categoria)
  • Chame o endpoint [Consultar categoria de tarefa por ID](#tag/Categorias-de-Tarefas/paths/~1task_categories~1{id}/get) para os dados completos.
assignee: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Responsável pela tarefa
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa vinculada à tarefa
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Venda vinculada à tarefa (nulo quando não há)
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
travel: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Viagem vinculada à tarefa (nulo quando não há)
  • Chame o endpoint [Consultar viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get) para os dados completos.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Lançamento (conta a pagar ou receber) vinculado à tarefa (nulo quando não há)
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa da tarefa (nulo quando a tarefa vale para todas as empresas)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que cadastrou a tarefa
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
history: type: array readOnly: true description: Histórico da tarefa (comentários e registros de alteração) items: "$ref": "#/components/schemas/task_historic" custom_fields: type: array readOnly: true description: Campos personalizados preenchidos na tarefa, definidos pela agência items: "$ref": "#/components/schemas/custom_field" attachments: type: array readOnly: true description: Anexos da tarefa, inclusive os enviados nos comentários, com o link de download. O download segue a consulta da tarefa, com a mesma permissão. items: "$ref": "#/components/schemas/attachment_summary" task_historic_create: type: object writeOnly: true description: Comentário a acrescentar ao histórico da tarefa. required: - text properties: text: type: string description: Texto do comentário example: Cliente confirmou os dados do embarque. task_comment_create: type: object writeOnly: true description: Comentário a acrescentar ao histórico da tarefa, com texto, anexos ou os dois. Sem anexos, o texto é obrigatório. properties: text: type: string description: Texto do comentário example: Cliente confirmou os dados do embarque. attachment_ids: type: array description: Identificadores dos anexos a ligar ao comentário, devolvidos por [Enviar anexo](#tag/Anexos/paths/~1attachments/post). Cada um precisa ser anexo desta tarefa, não excluído e ainda sem comentário; os demais respondem 422 como não encontrados. items: type: string format: uuid example: - 5f1c2a8e-9b4d-4c6a-8e2f-1a3b5c7d9e0f task_create: type: object writeOnly: true description: Dados para criar uma tarefa. required: - company_identifier - title - assignee_id properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" nullable: true description: 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: type: string maxLength: 100 description: Título da tarefa example: Enviar voucher para o cliente description: type: string description: Descrição da tarefa example: Confirmar os dados do embarque antes do envio. due: type: string format: date-time description: Data e hora de vencimento (nulo quando a tarefa não tem vencimento, e então nunca fica atrasada) example: '2024-04-01T09:00:00' category_id: type: integer description: Identificador da categoria da tarefa, obtido em [Consultar categorias de tarefa](#tag/Categorias-de-Tarefas/paths/~1task_categories/get). example: 11 assignee_id: type: string format: uuid description: Identificador da pessoa responsável pela tarefa, obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). 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. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 person_id: type: string format: uuid description: Identificador da pessoa vinculada à tarefa, obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). example: c3b7e8eb-1199-4457-9170-923c3fe56c92 sale_id: type: string format: uuid description: Identificador da venda a vincular, obtido em [Consultar vendas](#tag/Vendas/paths/~1sales/get). Com `travel_id`, a venda precisa ser dessa viagem. example: 8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 travel_id: type: string format: uuid description: Identificador da viagem a vincular, obtido em [Consultar viagens](#tag/Viagens/paths/~1travels/get). example: 1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 bill_id: type: string format: uuid description: Identificador do lançamento (conta a pagar ou receber) a vincular, obtido em [Consultar contas a pagar e receber](#tag/Contas-a-Pagar-e-Receber/paths/~1bills/get). Com `sale_id`, o lançamento precisa ser dessa venda. example: 5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 history: type: array description: Comentários com que a tarefa nasce items: "$ref": "#/components/schemas/task_historic_create" custom_fields: type: array description: Campos personalizados a preencher na tarefa, definidos pela agência items: "$ref": "#/components/schemas/custom_field" task_update: type: object writeOnly: true description: Dados para alterar uma tarefa. Todos os campos são opcionais. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" nullable: true description: 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: type: string maxLength: 100 description: Título da tarefa example: Enviar voucher atualizado para o cliente description: type: string nullable: true description: Descrição da tarefa example: Voucher reemitido com o novo horário do embarque. due: type: string format: date-time nullable: true description: Data e hora de vencimento. Nulo tira o vencimento, e a tarefa deixa de ficar atrasada; omitido, mantém o vencimento atual example: '2024-04-02T09:00:00' category_id: type: integer nullable: true description: Identificador da categoria da tarefa, obtido em [Consultar categorias de tarefa](#tag/Categorias-de-Tarefas/paths/~1task_categories/get). Nulo tira a categoria; omitido, mantém a categoria atual. example: 11 assignee_id: type: string format: uuid description: Identificador da pessoa responsável pela tarefa, obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). 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. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 person_id: type: string format: uuid nullable: true description: Identificador da pessoa vinculada à tarefa, obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). example: c3b7e8eb-1199-4457-9170-923c3fe56c92 sale_id: type: string format: uuid nullable: true description: Identificador da venda a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual. example: 8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 travel_id: type: string format: uuid nullable: true description: Identificador da viagem a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual. example: 1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 bill_id: type: string format: uuid nullable: true description: Identificador do lançamento a vincular, com as regras da criação. Nulo desfaz o vínculo; omitido, mantém o atual. example: 5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 completed: type: boolean description: "`true` conclui a tarefa, com a data e hora da alteração; `false` a reabre. Concluir uma tarefa já concluída mantém a data da conclusão original." example: true custom_fields: type: array description: 'Campos personalizados da tarefa, definidos pela agência. Não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão, então a lista vazia não muda nada e não é possível esvaziar um campo por esta operação. Envie cada campo por `id` e `value`.' items: "$ref": "#/components/schemas/custom_field" task_category: type: object description: Representa uma categoria de tarefa cadastrada no sistema. properties: id: type: integer description: Identificador único da categoria de tarefa example: 42 name: type: string description: Nome da categoria de tarefa example: Emissão kanban: type: boolean description: Indica se a categoria é uma coluna do quadro de tarefas (kanban). example: true kanban_position: type: integer nullable: true minimum: 1 description: Posição da coluna no quadro de tarefas, a partir de 1, da esquerda para a direita. Nula quando a categoria não está no quadro. A coluna das tarefas sem categoria não é uma categoria e não entra nesta contagem. example: 2 required: - id - name - kanban - kanban_position task_category_create: type: object writeOnly: true description: Dados para criar uma categoria de tarefa. required: - name properties: name: type: string maxLength: 30 description: Nome da categoria de tarefa, com até 30 caracteres. É único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado. example: Emissão kanban: type: boolean default: true description: Indica se a categoria é uma coluna do quadro de tarefas (kanban). Omitido, a categoria entra no quadro. example: true kanban_position: type: integer minimum: 1 description: 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. example: 2 task_category_update: type: object writeOnly: true description: Dados para alterar uma categoria de tarefa. Todos os campos são opcionais. properties: name: type: string maxLength: 30 description: Nome da categoria de tarefa, com até 30 caracteres. É único, sem diferenciar maiúsculas de minúsculas, e o espaço nas pontas é descartado. example: Emissão de bilhetes kanban: type: boolean description: Indica se a categoria é uma coluna do quadro de tarefas (kanban). Ao voltar para o quadro sem `kanban_position`, a coluna retoma a posição que tinha. example: false kanban_position: type: integer nullable: true minimum: 1 description: 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. example: 1 travel_summary: type: object description: Representa uma viagem na listagem, com campos escalares e referências. properties: id: type: string format: uuid description: Identificador único da viagem example: f9d961b8-ea88-4346-8e52-afe94267417a number: type: string description: Número sequencial da viagem example: '000042' description: type: string nullable: true description: Descrição da viagem example: Lua de mel - Cancún situation: type: string nullable: true enum: - upcoming - ongoing - finished description: " Situação da viagem, calculada a partir do período.
  • upcoming: a iniciar.
  • ongoing: em viagem.
  • finished: finalizada.
Nula quando a viagem não tem vendas vinculadas com produtos ativos. " example: upcoming start_date: type: string format: date nullable: true description: Menor data de início entre os produtos das vendas vinculadas example: '2024-05-10' end_date: type: string format: date nullable: true description: Maior data de fim entre os produtos das vendas vinculadas example: '2024-05-24' observations: type: string nullable: true description: Observações da viagem example: Cliente prefere assentos na janela. created_at: type: string format: date-time nullable: true description: Data e hora de cadastro da viagem example: '2024-03-15T10:30:00' required: - id - number travel: type: object description: Representa uma viagem com seus campos escalares e as referências às vendas e aos passageiros vinculados. allOf: - "$ref": "#/components/schemas/travel_summary" - type: object properties: customer: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Cliente da viagem
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Vendedor da viagem
  • Chame o endpoint [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa da viagem
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que cadastrou a viagem
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
sales: type: array description: |- Referências às vendas vinculadas à viagem
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" passengers: type: array description: |- Referências aos passageiros da viagem, deduplicados por pessoa
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" attachments: type: array description: Anexos da viagem, com o link de download. O download segue a consulta da viagem, com a mesma permissão. items: "$ref": "#/components/schemas/attachment_summary" custom_fields: type: array readOnly: true description: Campos personalizados preenchidos na viagem, definidos pela agência items: "$ref": "#/components/schemas/custom_field" travel_create: type: object writeOnly: true description: Dados para cadastrar uma viagem. required: - company_identifier - description - customer_id - seller_id properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 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: type: string maxLength: 60 description: Descrição da viagem, com até 60 caracteres example: Lua de mel - Cancún customer_id: type: string format: uuid description: 'ID da pessoa cliente da viagem, a mesma de `GET /people`. Informar o cliente exige a permissão "Ler todas as pessoas": sem ela, ele é recusado (422) como o que não existe.' example: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 seller_id: type: string format: uuid description: ID do vendedor da viagem, o mesmo de `GET /sellers`. Precisa ser um vendedor ativo; na alteração, o vendedor atual da viagem reenviado é aceito mesmo inativo example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 observations: type: string description: Observações da viagem example: Cliente prefere assentos na janela. custom_fields: type: array description: Campos personalizados a preencher na viagem, definidos pela agência. Os obrigatórios precisam vir na criação items: "$ref": "#/components/schemas/custom_field" travel_update: type: object writeOnly: true description: Campos da viagem a alterar. O campo omitido permanece como está. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: '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: type: string maxLength: 60 description: Descrição da viagem, com até 60 caracteres example: Lua de mel - Cancún e Tulum customer_id: type: string format: uuid description: 'ID da pessoa cliente da viagem, a mesma de `GET /people`. Informar o cliente exige a permissão "Ler todas as pessoas": sem ela, ele é recusado (422) como o que não existe.' example: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 seller_id: type: string format: uuid description: ID do vendedor da viagem, o mesmo de `GET /sellers`. Precisa ser um vendedor ativo; na alteração, o vendedor atual da viagem reenviado é aceito mesmo inativo example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 observations: type: string nullable: true description: Observações da viagem. Enviadas como nulo, ficam em branco; o texto vazio é gravado como está example: Incluir o passeio a Tulum. custom_fields: type: array description: 'Campos personalizados da viagem, definidos pela agência. Não substitui: cada campo enviado é gravado por cima do valor atual e os que não vierem permanecem como estão. O campo obrigatório não pode ser enviado vazio. Envie cada campo por `id` e `value`.' items: "$ref": "#/components/schemas/custom_field" quote_summary: type: object description: Representa um orçamento na consulta em lista, com os campos próprios do cadastro. properties: id: type: integer description: Identificador único do orçamento example: 42 title: type: string description: Título do orçamento example: Cancún subtitle: type: string description: Subtítulo do orçamento. Opcional. example: Lua de mel - 14 noites details: type: string description: Detalhes do orçamento, em HTML. As imagens vêm como <img data-quote-image>, só com a referência da imagem. example: "

Pacote com aéreo, hospedagem all inclusive e traslados.

" valid_until: type: string format: date description: Data de validade do orçamento example: '2024-05-31' active: type: boolean description: Indica se o orçamento está ativo example: true public_url: type: string format: uri nullable: true description: Link público de visualização do orçamento (acessível apenas enquanto ativo e dentro da validade) example: https://suaviagem.app/a1B2c3-cancun internal_observations: type: string nullable: true description: Observações internas (não aparecem no link público) example: Cliente pediu retorno até sexta. cover_kind: type: string enum: - color - image - none description: 'Cabeçalho do link público: `color` (uma cor de fundo), `image` (uma imagem) ou `none` (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, `image` vale só no orçamento que já tem uma. Trocar para outra opção apaga a imagem. Mandar só `cover_color` já escolhe `color`, e `color` sem `cover_color` vem com a cor principal das Configurações de Orçamentos da empresa.' example: color cover_color: type: string nullable: true description: 'Cor de fundo do cabeçalho, em hexadecimal (`#1f4e79`). Só vale com o cabeçalho `color`; nos outros, fica nula. A cor fica gravada no orçamento: mudar a cor principal das Configurações de Orçamentos depois não muda o cabeçalho. O título fica preto no fundo claro e branco no escuro.' example: "#1f4e79" cover_show_title: type: boolean description: Exibe o título no cabeçalho. No cabeçalho `color` é sempre `true`. example: true cover_show_subtitle: type: boolean description: Exibe o subtítulo no cabeçalho. No cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`, a imagem aparece inteira, sem recorte e sem texto por cima. example: true cover_image_url: type: string format: uri nullable: true description: Endereço temporário da imagem do cabeçalho. Nulo quando o cabeçalho não é `image`. example: created_at: type: string format: date-time description: Data e hora de criação example: '2024-03-15T10:30:00' updated_at: type: string format: date-time description: Data e hora da última alteração example: '2024-03-16T08:15:00' required: - id - title - subtitle - details - valid_until - active - cover_kind - cover_color - cover_show_title - cover_show_subtitle - cover_image_url - created_at - updated_at quote: description: Representa um orçamento cadastrado no sistema. allOf: - "$ref": "#/components/schemas/quote_summary" - type: object required: - company - user properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa vinculada ao orçamento
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Empresa do orçamento
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
user: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Usuário dono do orçamento
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
quote_create: type: object writeOnly: true description: Dados para criar um orçamento. required: - company_identifier - user_id - title - valid_until properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 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: type: string format: uuid description: Identificador do usuário dono do orçamento, o mesmo `id` da pessoa obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do orçamento. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 person_id: type: string format: uuid description: 'Identificador da pessoa (cliente) do orçamento, obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). Opcional. Informar a pessoa exige a permissão "Ler todas as pessoas": sem ela, a pessoa é recusada (422) como a que não existe.' example: 212b54b8-27df-4859-80a9-79ad855bcd09 title: type: string description: Título do orçamento example: Cancún subtitle: type: string description: Subtítulo do orçamento. Opcional. example: Lua de mel - 14 noites valid_until: type: string format: date description: Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado. example: '2035-05-31' details: type: string description: 'Conteúdo do orçamento, em HTML. O HTML é limpo antes de gravar, com as mesmas regras do conteúdo dos [guias](#tag/Guias/paths/~1guides/post). 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.' example: "

Pacote com aéreo, hospedagem all inclusive e traslados.

" active: type: boolean default: true description: Indica se o orçamento está ativo example: true internal_observations: type: string description: Observações internas (não aparecem no link público) example: Cliente pediu retorno até sexta. cover_kind: type: string enum: - color - image - none description: 'Cabeçalho do link público: `color` (uma cor de fundo), `image` (uma imagem) ou `none` (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, `image` vale só no orçamento que já tem uma. Trocar para outra opção apaga a imagem. Mandar só `cover_color` já escolhe `color`, e `color` sem `cover_color` vem com a cor principal das Configurações de Orçamentos da empresa.' example: color cover_color: type: string description: 'Cor de fundo do cabeçalho, em hexadecimal (`#1f4e79`). Só vale com o cabeçalho `color`; nos outros, fica nula. A cor fica gravada no orçamento: mudar a cor principal das Configurações de Orçamentos depois não muda o cabeçalho. O título fica preto no fundo claro e branco no escuro.' example: "#1f4e79" cover_show_title: type: boolean description: Exibe o título no cabeçalho. No cabeçalho `color` é sempre `true`. example: true cover_show_subtitle: type: boolean description: Exibe o subtítulo no cabeçalho. No cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`, a imagem aparece inteira, sem recorte e sem texto por cima. example: false quote_update: type: object writeOnly: true description: Dados para alterar um orçamento. Todos os campos são opcionais. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 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: type: string format: uuid description: Identificador do usuário dono do orçamento, o mesmo `id` da pessoa obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do orçamento. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 person_id: type: string format: uuid nullable: true description: 'Identificador da pessoa (cliente) do orçamento, obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). 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.' example: 212b54b8-27df-4859-80a9-79ad855bcd09 title: type: string description: Título do orçamento example: Cancún subtitle: type: string nullable: true description: Subtítulo do orçamento. Opcional. example: Lua de mel - 10 noites valid_until: type: string format: date description: Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado. example: '2035-06-15' details: type: string nullable: true description: 'Conteúdo do orçamento, em HTML. O HTML é limpo antes de gravar, com as mesmas regras do conteúdo dos [guias](#tag/Guias/paths/~1guides/post). 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.' example: "

Pacote com aéreo, hospedagem e traslados.

" active: type: boolean description: Indica se o orçamento está ativo example: false internal_observations: type: string nullable: true description: 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. example: Cliente aceitou a proposta. cover_kind: type: string enum: - color - image - none description: 'Cabeçalho do link público: `color` (uma cor de fundo), `image` (uma imagem) ou `none` (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, `image` vale só no orçamento que já tem uma. Trocar para outra opção apaga a imagem. Mandar só `cover_color` já escolhe `color`, e `color` sem `cover_color` vem com a cor principal das Configurações de Orçamentos da empresa.' example: none cover_color: type: string nullable: true description: 'Cor de fundo do cabeçalho, em hexadecimal (`#1f4e79`). Só vale com o cabeçalho `color`; nos outros, fica nula. A cor fica gravada no orçamento: mudar a cor principal das Configurações de Orçamentos depois não muda o cabeçalho. O título fica preto no fundo claro e branco no escuro.' example: "#1f4e79" cover_show_title: type: boolean description: Exibe o título no cabeçalho. No cabeçalho `color` é sempre `true`. example: true cover_show_subtitle: type: boolean description: Exibe o subtítulo no cabeçalho. No cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`, a imagem aparece inteira, sem recorte e sem texto por cima. example: true quote_duplication: type: object writeOnly: true description: Dados que a cópia do orçamento não herda do original. required: - user_id - valid_until properties: user_id: type: string format: uuid description: Identificador do usuário dono da cópia, o mesmo `id` da pessoa obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do orçamento. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 valid_until: type: string format: date description: Data de validade do orçamento (AAAA-MM-DD). Não pode estar no passado. example: '2035-07-31' person_id: type: string format: uuid description: 'Identificador da pessoa (cliente) da cópia, obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). 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.' example: 7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f guide_summary: type: object description: Representa um guia na consulta em lista, com os campos próprios do cadastro. properties: id: type: integer description: Identificador único do guia example: 42 title: type: string description: Título do guia example: Lisboa subtitle: type: string nullable: true description: Subtítulo do guia. Opcional. example: Roteiro de 5 dias details: type: string description: Conteúdo do guia, em HTML. As imagens vêm como ``, só com a referência da imagem. example: "

Dia 1

Chegada e passeio pela Baixa.

" active: type: boolean description: 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. example: true public_url: type: string format: uri nullable: true description: Link público de visualização do guia. Nulo quando a empresa do guia está somente leitura ou não tem a licença Monde Pro, ou quando a licença Monde Pro dela é somente leitura. example: https://suaviagem.app/guia/a1B2c3-lisboa internal_observations: type: string nullable: true description: Observações internas (não aparecem no link público) example: Enviar junto com o voucher. cover_kind: type: string enum: - color - image - none description: 'Cabeçalho do link público: `color` (uma cor de fundo), `image` (uma imagem) ou `none` (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, `image` vale só no guia que já tem uma. Trocar para outra opção apaga a imagem. Mandar só `cover_color` já escolhe `color`, e `color` sem `cover_color` vem com o tom `#5f6777`. O antigo cabeçalho `default` ainda é aceito na escrita e vale como `color` no tom `#5f6777`.' example: color cover_color: type: string nullable: true description: Cor de fundo do cabeçalho, em hexadecimal (`#1f4e79`). Só vale com o cabeçalho `color`; nos outros, fica nula. O título fica preto no fundo claro e branco no escuro. example: "#1f4e79" cover_show_title: type: boolean description: Exibe o título no cabeçalho. No cabeçalho `color` é sempre `true`. example: true cover_show_subtitle: type: boolean description: Exibe o subtítulo no cabeçalho. No cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`, a imagem aparece inteira, sem recorte e sem texto por cima. example: true hide_cover_text: type: boolean description: 'Mantido para quem já usa a API: `true` é o cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`. Na escrita, `true` desmarca os dois no cabeçalho `image` e é ignorado nos outros, e `false` marca os dois; `cover_show_title` e `cover_show_subtitle` enviados junto valem mais que ele.' example: false cover_image_url: type: string format: uri nullable: true description: Endereço temporário da imagem do cabeçalho. Nulo quando o cabeçalho não é `image`. example: created_at: type: string format: date-time description: Data e hora de criação example: '2024-03-15T10:30:00' updated_at: type: string format: date-time description: Data e hora da última alteração example: '2024-03-16T08:15:00' required: - id - title - subtitle - details - active - cover_kind - cover_color - cover_show_title - cover_show_subtitle - hide_cover_text - cover_image_url - created_at - updated_at guide: description: Representa um guia cadastrado no sistema. allOf: - "$ref": "#/components/schemas/guide_summary" - type: object required: - company - user properties: company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Empresa do guia
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
user: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Usuário dono do guia
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
guide_create: type: object writeOnly: true description: Dados para criar um guia. required: - company_identifier - user_id - title properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 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: type: string format: uuid description: Identificador do usuário dono do guia, o mesmo `id` da pessoa obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do guia. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 title: type: string description: Título do guia example: Lisboa subtitle: type: string description: Subtítulo do guia. Opcional. example: Roteiro de 5 dias details: type: string description: '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, `

` e `

`: `

` e `

` viram `

`, e `

` e `
` viram `

`. Do estilo, só passa o alinhamento centralizado ou à direita de parágrafos e títulos. Também passam três blocos, que não vão um dentro do outro: a caixa de destaque (`
`), só de texto (parágrafos, títulos e listas), em que a imagem vai para um parágrafo logo depois da caixa e o resto vai para depois dela; a seção com imagem de fundo (`
`), em que a primeira imagem vira o fundo e as outras são descartadas; e as colunas (`
` com dois ou três `
`). Fora desse formato, a `div` sai e o conteúdo dela fica. As imagens seguidas no mesmo parágrafo viram carrossel; com `data-carousel="thumbnails"` no parágrafo, o carrossel mostra miniaturas embaixo, no lugar das bolinhas. Outro valor de `data-carousel` é descartado. Imagem sem `data-quote-image` é descartada. Opcional: enviado vazio, ou só com o que a limpeza descarta, o guia fica sem conteúdo.' example: "

Dia 1

Chegada e passeio pela Baixa.

" active: type: boolean default: true description: 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. example: true cover_kind: type: string enum: - color - image - none - default description: 'Cabeçalho do link público: `color` (uma cor de fundo), `image` (uma imagem) ou `none` (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, `image` vale só no guia que já tem uma. Trocar para outra opção apaga a imagem. Mandar só `cover_color` já escolhe `color`, e `color` sem `cover_color` vem com o tom `#5f6777`. O antigo cabeçalho `default` ainda é aceito na escrita e vale como `color` no tom `#5f6777`.' example: color cover_color: type: string description: Cor de fundo do cabeçalho, em hexadecimal (`#1f4e79`). Só vale com o cabeçalho `color`; nos outros, fica nula. O título fica preto no fundo claro e branco no escuro. example: "#1f4e79" cover_show_title: type: boolean description: Exibe o título no cabeçalho. No cabeçalho `color` é sempre `true`. example: true cover_show_subtitle: type: boolean description: Exibe o subtítulo no cabeçalho. No cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`, a imagem aparece inteira, sem recorte e sem texto por cima. example: true hide_cover_text: type: boolean description: 'Mantido para quem já usa a API: `true` é o cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`. Na escrita, `true` desmarca os dois no cabeçalho `image` e é ignorado nos outros, e `false` marca os dois; `cover_show_title` e `cover_show_subtitle` enviados junto valem mais que ele.' example: false internal_observations: type: string description: Observações internas (não aparecem no link público) example: Enviar junto com o voucher. guide_update: type: object writeOnly: true description: Dados para alterar um guia. Todos os campos são opcionais. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 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: type: string format: uuid description: Identificador do usuário dono do guia, o mesmo `id` da pessoa obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do guia. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 title: type: string description: Título do guia example: Lisboa e Sintra subtitle: type: string nullable: true description: Subtítulo do guia. Opcional. example: Roteiro de 6 dias details: type: string description: '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, `

` e `

`: `

` e `

` viram `

`, e `

` e `
` viram `

`. Do estilo, só passa o alinhamento centralizado ou à direita de parágrafos e títulos. Também passam três blocos, que não vão um dentro do outro: a caixa de destaque (`
`), só de texto (parágrafos, títulos e listas), em que a imagem vai para um parágrafo logo depois da caixa e o resto vai para depois dela; a seção com imagem de fundo (`
`), em que a primeira imagem vira o fundo e as outras são descartadas; e as colunas (`
` com dois ou três `
`). Fora desse formato, a `div` sai e o conteúdo dela fica. As imagens seguidas no mesmo parágrafo viram carrossel; com `data-carousel="thumbnails"` no parágrafo, o carrossel mostra miniaturas embaixo, no lugar das bolinhas. Outro valor de `data-carousel` é descartado. Imagem sem `data-quote-image` é descartada. Opcional: enviado vazio, ou só com o que a limpeza descarta, o guia fica sem conteúdo.' example: "

Dia 6

Bate-volta a Sintra.

" active: type: boolean description: 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. example: false cover_kind: type: string enum: - color - image - none - default description: 'Cabeçalho do link público: `color` (uma cor de fundo), `image` (uma imagem) ou `none` (sem cabeçalho). A imagem só se escolhe pelo Monde Web: pela API, `image` vale só no guia que já tem uma. Trocar para outra opção apaga a imagem. Mandar só `cover_color` já escolhe `color`, e `color` sem `cover_color` vem com o tom `#5f6777`. O antigo cabeçalho `default` ainda é aceito na escrita e vale como `color` no tom `#5f6777`.' example: none cover_color: type: string nullable: true description: Cor de fundo do cabeçalho, em hexadecimal (`#1f4e79`). Só vale com o cabeçalho `color`; nos outros, fica nula. O título fica preto no fundo claro e branco no escuro. example: "#1f4e79" cover_show_title: type: boolean description: Exibe o título no cabeçalho. No cabeçalho `color` é sempre `true`. example: false cover_show_subtitle: type: boolean description: Exibe o subtítulo no cabeçalho. No cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`, a imagem aparece inteira, sem recorte e sem texto por cima. example: false hide_cover_text: type: boolean description: 'Mantido para quem já usa a API: `true` é o cabeçalho `image` com `cover_show_title` e `cover_show_subtitle` em `false`. Na escrita, `true` desmarca os dois no cabeçalho `image` e é ignorado nos outros, e `false` marca os dois; `cover_show_title` e `cover_show_subtitle` enviados junto valem mais que ele.' example: true internal_observations: type: string nullable: true description: 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. example: Atualizado com o passeio a Sintra. guide_duplication: type: object writeOnly: true description: Dados que a cópia do guia não herda do original. required: - user_id properties: user_id: type: string format: uuid description: Identificador do usuário dono da cópia, o mesmo `id` da pessoa obtido em [Consultar pessoas](#tag/Pessoas/paths/~1people/get). A pessoa precisa ser um usuário ativo do Monde, com acesso à empresa do guia. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 invoice_rule_summary: type: object description: Representa uma regra de faturamento na consulta em lista, com os campos próprios do cadastro. properties: id: type: string format: uuid description: Identificador único da regra example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Descrição da regra (copiada para as faturas geradas) example: Faturamento semanal aéreo person_kind: type: string enum: - customer - supplier - representative description: " Tipo da pessoa dona da regra.
  • customer: cliente.
  • supplier: fornecedor.
  • representative: representante.
" example: supplier destination: type: string enum: - every - national - international - cruise description: " Destino ao qual a regra se aplica.
  • every: todos.
  • national: nacional.
  • international: internacional.
  • cruise: navio (disponível apenas para o produto Seguro Viagem).
" example: every movement: type: string enum: - every_movement - to_pay - to_receive description: " Movimento ao qual a regra se aplica. Só se aplica a regras de fornecedor e representante; em regras de cliente é sempre every_movement e não tem efeito.
  • every_movement: todos.
  • to_pay: a pagar para o fornecedor.
  • to_receive: a receber do fornecedor.
" example: every_movement cost_center: type: string nullable: true description: Centro de custo ao qual a regra se aplica (apenas regras de cliente; nulo = todos) example: Comercial closing: type: object description: Configuração de fechamento do período que agrupa as vendas em uma fatura. properties: period_kind: type: string enum: - standalone - daily - weekly - weekly_iata - weekly_inside_month - decendial - fortnightly - monthly - custom description: " Cadência de fechamento que agrupa as vendas em uma fatura.
  • standalone: avulso — cada venda em uma fatura própria (item a item).
  • daily: diário — um período por dia.
  • weekly: semanal — de segunda a domingo.
  • weekly_iata: semanal no padrão IATA — vencimento contado em dias úteis (ver days_to_skip).
  • weekly_inside_month: semanal respeitando o mês — de segunda a domingo, mas a semana não atravessa a virada do mês; a última semana do mês é cortada no dia 1.
  • decendial: decendial — faixas de 1 a 10, 11 a 20 e 21 a 31.
  • fortnightly: quinzenal — faixas de 1 a 15 e 16 a 31.
  • monthly: mensal — do dia 1 ao último dia do mês.
  • custom: customizado — faixas de dias definidas manualmente em custom_period.
" example: weekly week_start: type: string nullable: true enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday description: Dia em que a semana começa; usado apenas quando period_kind é weekly ou weekly_inside_month, nulo nos demais casos. example: monday custom_period: type: string nullable: true description: Faixas de dias do mês que definem cada período de fechamento customizado (usado quando period_kind = custom). Cada faixa é 'dia_inicial-dia_final', em dias do mês, separadas por ';'. Exemplo '1-8;9-15;16-23;24-31' significa do dia 1 ao dia 8, do dia 9 ao dia 15, do dia 16 ao dia 23 e do dia 24 ao dia 31. example: 1-8;9-15;16-23;24-31 custom_period_due_date: type: string nullable: true description: Dia do mês em que vence cada faixa de custom_period, na mesma ordem, separados por ';'. O N-ésimo valor é o dia de vencimento da N-ésima faixa. Exemplo para '1-8;9-15;16-23;24-31', o valor '10;17;25;5' vence a primeira faixa no dia 10, a segunda no dia 17, a terceira no dia 25 e a quarta no dia 5. example: 10;17;25;5 date_to_use: type: string enum: - after_sale_date - before_checkin - after_checkin - before_checkout - after_checkout description: " Data de referência da venda usada para enquadrar o item no período de fechamento.
  • after_sale_date: depois da venda.
  • before_checkin: antes do início.
  • after_checkin: depois do início.
  • before_checkout: antes do fim.
  • after_checkout: depois do fim.
" example: after_sale_date required: - period_kind - date_to_use due_date: type: object description: Configuração de vencimento da fatura gerada. properties: days_to_skip: type: integer description: Quantidade de dias após o fechamento do período para calcular o vencimento (dias úteis quando period_kind = weekly_iata). example: 5 on_weekend: type: string enum: - stay - next - previous description: " Ajuste do vencimento quando cai em sábado, domingo ou feriado.
  • stay: mantém a data.
  • next: move para o próximo dia útil.
  • previous: move para o dia útil anterior.
" example: stay required: - days_to_skip - on_weekend required: - id - description - person_kind - destination - movement - closing - due_date invoice_rule: description: Representa uma regra de faturamento cadastrada no sistema. allOf: - "$ref": "#/components/schemas/invoice_rule_summary" - type: object properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa dona da regra (nula = vale para todas as pessoas do tipo)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Produto ao qual a regra se aplica (nulo = todos os produtos)
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Fornecedor ao qual a regra se aplica (apenas regras de representante; nulo = todos)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
requester: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Solicitante ao qual a regra se aplica (apenas regras de cliente; nulo = todos)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
integration_summary: type: object description: Representa uma integração na consulta em lista, com os campos próprios do cadastro. properties: id: type: string format: uuid description: Identificador único da integração example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Descrição da integração example: Assist Card Matriz active: type: boolean description: Indica se a integração está ativa example: true vendor_id: type: string format: uuid description: Identificador do fornecedor da integração example: b2359357-cff7-4d43-b6d2-99adf2ff373b vendor_name: type: string nullable: true description: Nome do provedor da integração example: Assist Card required: - id - description - active - vendor_id - vendor_name integration: description: Representa uma integração com fornecedor cadastrada no sistema, com os campos adicionais e sem os dados de acesso ao fornecedor. allOf: - "$ref": "#/components/schemas/integration_summary" - type: object required: - additional_fields properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa vinculada como fornecedor ou representante nos produtos importados
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa da integração (nula quando vale para todas as empresas)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
additional_fields: type: array description: Campos adicionais que o fornecedor declara, na ordem do cadastro. items: "$ref": "#/components/schemas/integration_additional_field" integration_additional_field: type: object description: Um campo adicional que o fornecedor declara para a integração. required: - name - type - value - filled properties: name: type: string description: Nome do campo adicional, a chave usada em `additional_fields` na gravação example: agency_code type: type: string enum: - text - password - token description: 'Tipo do campo: `text`, `password` (senha) ou `token`' example: text value: type: string nullable: true description: 'Valor do campo. Sempre nulo nos campos secretos (`secret` no fornecedor): só o endereço do serviço e a identificação da agência são retornados; usuário, senha, token, chaves de API e PIN, nunca.' example: '1000' filled: type: boolean description: Indica se o campo está preenchido example: true person_summary: type: object description: Representa uma pessoa na consulta (lista), com escalares próprios e referências das entidades fortes, sem entidades fracas. properties: id: type: string format: uuid description: Identificador único da pessoa example: f9d961b8-ea88-4346-8e52-afe94267417a external_id: type: - string - 'null' maxLength: 50 description: Identificador que você atribuiu a esta pessoa ao cadastrá-la. Nulo quando a credencial que consulta não tem identificador externo para ela. code: type: integer nullable: true description: Código sequencial da pessoa example: 1042 person_kind: type: string enum: - individual - company description: Define se é uma pessoa física (individual) ou jurídica (company). example: individual name: type: string description: 'Nome ou nome fantasia, de acordo com o tipo da pessoa.

Exemplo: "Maria da Silva" ou "Epic Journey".' maxLength: 100 legal_name: type: - string - 'null' description: 'Razão social.

Exemplo: "Epic Journey S.A.".' maxLength: 100 cpf_cnpj: type: - string - 'null' description: 'CPF ou CNPJ, de acordo com o tipo da pessoa, sem pontos, barras, traços ou espaços.

Exemplo: "38107867807" ou "50559280000140".' minLength: 11 maxLength: 14 gender: type: - string - 'null' enum: - female - male - description: Gênero birthdate: type: - string - 'null' format: date description: 'Data de nascimento no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "1990-02-12".' rg_ie: type: - string - 'null' description: 'RG ou Inscrição Estadual, de acordo com o tipo da pessoa, sem pontos, traços ou espaços.

Exemplo: "461196037" ou "123456789012".' maxLength: 20 city_inscription: type: - string - 'null' description: Inscrição municipal tax_identification_number: type: - string - 'null' description: Identificação fiscal (pessoa jurídica estrangeira) passport_number: type: - string - 'null' description: 'Número do passaporte, sem pontos, traços ou espaços.

Exemplo: "FG225776".' maxLength: 20 passport_expiration_date: type: - string - 'null' format: date description: 'Data de expiração do passaporte no formato ISO 8601 (AAAA-MM-DD).

Exemplo: "2035-12-01".' foreigner: type: boolean description: Indica se a pessoa ou empresa é estrangeira. Use `true` para pessoas que não têm nacionalidade brasileira ou empresas que não estão sediadas no Brasil. default: false foreign_identity_document: type: - string - 'null' description: ' Documento de identificação do estrangeiro, emitido em seu país de origem. Sem pontos, traços ou espaços.

Exemplo: "41234567". ' maxLength: 30 email: type: - string - 'null' description: 'Endereço de e-mail.

Exemplo: "contato@exemplo.com".' maxLength: 200 phone_number: type: - string - 'null' description: 'Número de telefone, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "1134567890", "+33170180123".' maxLength: 20 mobile_number: type: - string - 'null' description: 'Número de telefone celular, sem traço ou espaços. Para números internacionais, utilize + e o código do país.

Exemplos: "11934567890", "+447911123456".' maxLength: 20 business_phone: type: - string - 'null' description: Telefone comercial example: '4133334444' website: type: - string - 'null' description: Website (pessoa jurídica) example: https://www.agencia.com.br cvc_code: type: - integer - 'null' description: Código CVC da pessoa observations: type: - string - 'null' description: Observações da pessoa charge_billet_fee: type: boolean description: Indica se a taxa de boleto é cobrada da pessoa example: false created_at: type: - string - 'null' format: date-time description: Data e hora de cadastro da pessoa address: type: - object - 'null' description: Endereço. properties: postal_code: type: - string - 'null' description: 'CEP ou código postal, sem traços.

Exemplo: "04078011".' maxLength: 8 street: type: - string - 'null' description: 'Logradouro.

Exemplo: "Avenida Divino Salvador".' maxLength: 50 street_number: type: - string - 'null' description: 'Número.

Exemplo: "5000".' maxLength: 10 neighborhood: type: - string - 'null' description: 'Bairro.

Exemplo: "Planalto Paulista".' maxLength: 30 additional_info: type: - string - 'null' description: 'Complemento.

Exemplo: "Casa 2".' maxLength: 20 city: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Cidade do endereço. Estado e país saem na consulta da cidade por ID.
  • Chame o endpoint [Consultar cidade por ID](#tag/Cidades/paths/~1cities~1{id}/get) para os dados completos.
additional_data: type: - object - 'null' description: Dados adicionais da pessoa física. Ausente (null) para pessoa jurídica. properties: marital_status: type: - string - 'null' enum: - single - married - separated - divorced - widowed - civil_union - description: |- Estado civil (pessoa física).
  • single: solteiro(a).
  • married: casado(a).
  • separated: separado(a).
  • divorced: divorciado(a).
  • widowed: viúvo(a).
  • civil_union: união estável.
example: married rg_emitter: type: - string - 'null' description: Órgão emissor do RG example: SSP/SP rg_issue_date: type: - string - 'null' format: date description: Data de emissão do RG birth_certificate: type: - string - 'null' description: Certidão de nascimento mother_name: type: - string - 'null' description: Filiação (mãe) last_contacts: type: object description: Datas dos últimos contatos e movimentações da pessoa. properties: first_sale_date: type: - string - 'null' format: date description: Data da primeira venda da pessoa last_sale_date: type: - string - 'null' format: date description: Data da última venda da pessoa last_departure_date: type: - string - 'null' format: date description: Data do último embarque da pessoa last_return_date: type: - string - 'null' format: date description: Data do último retorno da pessoa last_task_update_at: type: - string - 'null' format: date-time description: Data e hora da última atualização de tarefa da pessoa tax_withholding: type: - object - 'null' description: Retenções de imposto da pessoa jurídica. Ausente (null) para pessoa física. properties: iss: type: boolean description: Indica retenção de ISS (pessoa jurídica) ir: type: boolean description: Indica retenção de IR (pessoa jurídica) pis_cofins_csll: type: boolean description: Indica retenção de PIS/COFINS/CSLL (pessoa jurídica) airline: type: - object - 'null' description: Dados de companhia aérea da pessoa jurídica (fornecedores). Ausente (null) para pessoa física. properties: code: type: - string - 'null' description: Código da companhia aérea (fornecedores). É único entre as pessoas — no cadastro, um código já usado por outra pessoa é recusado. example: '957' number: type: - string - 'null' description: Número da companhia aérea (fornecedores) person_detail: description: Representa a consulta completa de uma pessoa, com os campos da consulta acrescidos dos blocos agrupados e das entidades fracas. allOf: - "$ref": "#/components/schemas/person_summary" - type: object properties: birthplace: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Naturalidade, cidade de nascimento da pessoa física
  • Chame o endpoint [Consultar cidade por ID](#tag/Cidades/paths/~1cities~1{id}/get) para os dados completos.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Vendedor responsável pela pessoa
  • Chame o endpoint [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get) para os dados completos.
promoter: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Promotor da pessoa (planos operadora)
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que efetuou o cadastro, como referência com id e name
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
contacts: type: array description: Vínculos de contato da pessoa, nos dois sentidos — quem é contato dela e de quem ela é contato. items: type: object properties: role: type: - string - 'null' description: Função registrada no vínculo, que descreve quem é o contato person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- A outra pessoa do vínculo: quem é o contato da pessoa consultada, ou a pessoa de quem ela é o contato
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
labels: type: array description: |- Marcadores atribuídos à pessoa.
  • Chame o endpoint [Consultar marcador por ID](#tag/Marcadores/paths/~1labels~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" custom_fields: type: array description: Campos personalizados preenchidos da pessoa, como pares de definição e valor. items: type: object properties: id: type: integer description: Identificador da definição do campo personalizado. O nome, o tipo e as opções da definição saem da consulta de definições de campos personalizados. example: 123 value: type: - string - number - 'null' description: Valor preenchido do campo personalizado attachments: type: array description: Anexos da pessoa. O download é feito pela URL assinada em download_url. items: "$ref": "#/components/schemas/attachment_summary" credit_cards: type: array description: Cartões de crédito da pessoa. O número completo nunca é devolvido. Só vem com as permissões "Ver aba financeiro" e "Visualizar dados do Cartão de Crédito" de pessoas; sem elas, o campo é omitido. items: type: object properties: id: type: string format: uuid description: Identificador único (UUID) do cartão, com o qual a edição da pessoa altera o cartão sem reenviar o número. name: type: - string - 'null' description: Nome/apelido do cartão last_digits: type: - string - 'null' description: Quatro últimos dígitos do cartão maxLength: 4 example: '1111' expiration_date: type: - string - 'null' format: date description: Data de validade do cartão issuer: type: - string - 'null' description: Operadora/bandeira do cartão ticket_card: type: - string - 'null' description: Identificação do cartão passagem cost_centers: type: - array - 'null' description: 'Centros de custo do cliente corporativo, em ordem de nome: os departamentos dele aceitos no centro de custo do passageiro e do item da fatura quando ele é o pagante. Não são os centros de custo da agência, de `/cost_centers`. Ausente (null) para pessoa física.' items: type: object properties: name: type: string description: Nome do centro de custo example: Diretoria kandir_law: type: - array - 'null' description: Retenção de impostos por produto, prevista pela Lei 9.430/1996 (art. 64), aplicável a pessoa jurídica. Ausente (null) para pessoa física. Só vem com a permissão "Ver aba financeiro" de pessoas; sem ela, o campo é omitido. items: type: object properties: amount: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Retenção incidente sobre o valor do produto. boarding_fee: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Retenção incidente sobre a taxa de embarque. du_rav_fee: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Retenção incidente sobre a taxa de DU/RAV. service_fee: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Retenção incidente sobre a taxa de serviço. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto ao qual os percentuais de retenção se aplicam.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
invoice_rules: type: array description: Regras de faturamento próprias da pessoa, como cliente, fornecedor ou representante (o detalhe de cada uma está em [Consultar regra de faturamento por ID](#tag/Regras-de-Faturamento)). A regra que vale para todas as pessoas não aparece aqui. As regras são gravadas no cadastro de regras de faturamento, e não no da pessoa. items: "$ref": "#/components/schemas/entity_reference" photo: type: - object - 'null' description: Foto da pessoa física, ou logotipo da pessoa jurídica. Traz só o tipo e o tamanho; a imagem é baixada em [Baixar foto da pessoa](#tag/Pessoas/paths/~1people~1{person_id}~1photo/get). Nulo quando não há foto. properties: content_type: type: string description: Tipo da imagem gravada. example: image/jpeg size: type: integer description: Tamanho da imagem, em bytes. example: 48213 kandir_law_tax_group: type: object properties: national: allOf: - "$ref": "#/components/schemas/kandir_law_tax_breakdown" description: Percentuais de retenção para produto nacional. international: allOf: - "$ref": "#/components/schemas/kandir_law_tax_breakdown" description: Percentuais de retenção para produto internacional. kandir_law_tax_breakdown: type: object properties: ir: type: number format: float description: Percentual de retenção de Imposto de Renda (IR). csll: type: number format: float description: Percentual de retenção de CSLL. pis: type: number format: float description: Percentual de retenção de PIS. cofins: type: number format: float description: Percentual de retenção de COFINS. total: type: number format: float description: Percentual total de retenção, soma de IR, CSLL, PIS e COFINS. person_credit_card_write: type: object writeOnly: true description: 'Cartão de crédito. Sem `id`, inclui um cartão e exige número, nome, operadora e validade. Com `id`, altera o cartão: número, nome, operadora e validade omitidos ficam como estão e, enviados nulos, são recusados; o código de segurança e o cartão passagem enviados nulos ficam em branco. O código de segurança vazio também deixa o cartão sem ele; o cartão passagem e a validade vazios são recusados (422), porque não são uma das opções nem número.' properties: id: type: string format: uuid description: Identificador único (UUID) de um cartão que a pessoa já tem, para alterá-lo. Omita para incluir um cartão. example: 6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c number: type: string pattern: "^[0-9]{1,30}$" description: Número do cartão, só dígitos, até 30. É gravado cifrado e nunca é devolvido. example: '4111111111111111' cvv: type: - string - 'null' pattern: "^[0-9]{0,4}$" description: Código de segurança, opcional, só dígitos, até 4. É gravado cifrado e nunca é devolvido. Por segurança, não é recomendável armazená-lo. example: '123' name: type: string maxLength: 30 description: Nome impresso no cartão, até 30 caracteres. example: ALINE NAKID issuer: type: string maxLength: 20 description: Operadora do cartão, até 20 caracteres. O Monde oferece Amex, Diners, Hipercard, MasterCard, Visa e Elo. example: Visa ticket_card: type: - string - 'null' enum: - CPB - Cielo - CTA - EBTA - description: 'Cartão passagem usado na exportação de cartões: `CPB`, `Cielo`, `CTA` ou `EBTA`.' example: CTA expiration_month: type: integer minimum: 1 maximum: 12 description: Mês da validade, de 1 a 12. example: 11 expiration_year: type: integer description: Ano da validade, com quatro dígitos. example: 2030 person_cost_center_write: type: object writeOnly: true description: Centro de custo do cliente corporativo. required: - name properties: name: type: string maxLength: 50 description: Nome do centro de custo, até 50 caracteres. example: Diretoria person_kandir_law_write: type: object writeOnly: true description: Retenção da Lei Kandir sobre um produto. required: - product properties: product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto da retenção: Passagem Aérea, Seguro Viagem ou Transporte Terrestre. Não se repete na lista
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
amount: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Retenção incidente sobre o valor do produto. boarding_fee: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Retenção incidente sobre a taxa de embarque. du_rav_fee: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Retenção incidente sobre a taxa de DU/RAV. service_fee: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Retenção incidente sobre a taxa de serviço. person_kandir_law_group_write: type: object writeOnly: true description: Percentuais de um grupo, por abrangência. properties: national: allOf: - "$ref": "#/components/schemas/person_kandir_law_breakdown_write" description: Percentuais de retenção para produto nacional. international: allOf: - "$ref": "#/components/schemas/person_kandir_law_breakdown_write" description: Percentuais de retenção para produto internacional. person_kandir_law_breakdown_write: type: object writeOnly: true description: 'Percentuais de IR, CSLL, PIS e COFINS, de zero em diante. O total não se informa: é a soma dos quatro.' properties: ir: type: - number - 'null' minimum: 0 description: Percentual de retenção de Imposto de Renda (IR). example: 1.5 csll: type: - number - 'null' minimum: 0 description: Percentual de retenção de CSLL. example: 1.5 pis: type: - number - 'null' minimum: 0 description: Percentual de retenção de PIS. example: 1.5 cofins: type: - number - 'null' minimum: 0 description: Percentual de retenção de COFINS. example: 1.5 label: type: object description: Representa um marcador usado para classificar pessoas. properties: id: type: string format: uuid description: Identificador único do marcador no formato UUID example: f9d961b8-ea88-4346-8e52-afe94267417a name: type: string maxLength: 38 description: Nome do marcador example: VIP required: - id - name label_create: type: object writeOnly: true description: Dados para criar um marcador. required: - name properties: name: type: string maxLength: 38 description: Nome do marcador, com até 38 caracteres e diferente do nome dos demais marcadores example: Lua de mel label_update: type: object writeOnly: true description: 'Dados para alterar um marcador. Todos os campos são opcionais: o campo omitido permanece como está. O nome não pode ser retirado, e enviado como nulo é recusado.' properties: name: type: string maxLength: 38 description: Nome do marcador, com até 38 caracteres e diferente do nome dos demais marcadores example: Cliente VIP company: type: object description: Representa uma empresa do sistema, com os dados da pessoa jurídica dela. properties: id: type: string format: uuid description: Identificador único da empresa (o mesmo da pessoa jurídica dela). É o `id` que as demais consultas trazem em `company` example: 8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10 name: type: string description: Nome da empresa example: Monde Viagens legal_name: type: string description: Razão social da empresa; sem ela, o nome example: Monde Viagens e Turismo Ltda cnpj: type: string nullable: true description: CNPJ da empresa, só com os números. É o valor a enviar em `company_identifier` nas gravações example: '46598887000162' read_only: type: boolean description: 'Indica se a empresa está somente leitura no cadastro de Empresas: ela é consultada, mas recusa as gravações com `403`' example: false person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Pessoa jurídica da empresa
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
required: - id - name - legal_name - cnpj - read_only - person bill_billet: type: object nullable: true properties: status: type: string enum: - unregistered - pending_registration - waiting_return - registered - rejected - bank_settled - pending_cleared - cleared - pending_update description: Situação da cobrança do boleto. example: registered number: type: integer nullable: true description: Número do boleto. example: 12345 our_number: type: string nullable: true description: Nosso número do boleto. example: '000000012345' amount: type: number format: double description: Valor do boleto. example: 1500.0 demonstrative: type: string nullable: true description: Demonstrativo do boleto. example: Pagável em qualquer banco até o vencimento. rejection_reason: type: string nullable: true description: Motivo da rejeição do registro do boleto, quando houver. example: account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Conta de cobrança do boleto.
  • Chame o endpoint [Consultar conta ou cartão por ID](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get) para os dados completos.
bill_check: type: object nullable: true description: Dados do cheque informados no lançamento; nulo quando o pagamento não foi em cheque. properties: number: type: integer nullable: true description: Número do cheque. example: 123456 bank: type: string nullable: true description: Código do banco emissor do cheque. example: '237' document: type: string nullable: true description: CPF ou CNPJ do titular do cheque. example: '03832060901' bill_card: type: object nullable: true description: Dados do cartão informados no lançamento; nulo quando o pagamento não foi em cartão. properties: brand: type: string nullable: true description: Bandeira do cartão. example: MasterCard last_digits: type: string nullable: true description: Últimos dígitos do cartão. example: '4117' authorization: type: string nullable: true description: Código de autorização da transação do cartão. example: '600551159' bill_category: type: object properties: amount: type: number format: double description: Valor da categoria, sempre positivo. O grupo da categoria define se é receita ou despesa. example: 1500.0 category: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Categoria financeira do rateio.
  • Chame o endpoint [Consultar categoria por ID](#tag/Categorias/paths/~1categories~1{id}/get) para os dados completos.
bill_apportionment: type: object properties: percentage: type: number format: double description: Percentual da empresa no rateio, calculado a partir do valor. example: 50.0 amount: type: number format: double description: Valor rateado para a empresa. example: 750.0 company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa do rateio.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
bill_cost_center: type: object properties: percentage: type: number format: double description: Percentual do centro de custo no rateio, calculado a partir do valor. example: 100.0 amount: type: number format: double description: Valor rateado para o centro de custo. example: 1500.0 cost_center: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Centro de custo.
  • Chame o endpoint [Consultar centro de custo por ID](#tag/Centros-de-Custo/paths/~1cost_centers~1{id}/get) para os dados completos.
bill_commission: type: object properties: description: type: string nullable: true description: Descrição da comissão. example: Comissão pacote amount: type: number format: double description: Valor da comissão. example: 150.0 retained_amount: type: number format: double description: Valor retido da comissão. example: 0.0 balance: type: number format: double description: 'Saldo da comissão: o valor menos o valor retido.' example: 150.0 person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que recebe a comissão.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
bill_item: type: object properties: id: type: string format: uuid description: Identificador do item, usado nas ações sobre os itens da fatura. example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 description: type: string nullable: true description: Descrição do item. example: Diárias de Hospedagem cost_center: type: string nullable: true description: Centro de custo anotado no item, em texto livre. Não tem relação com o cadastro de centros de custo nem com o rateio de centro de custo do lançamento, que sai em apportionments.per_cost_center. example: Alteração de pax checked: type: boolean description: Indica se o item foi conferido. example: false amount: type: number format: double description: Valor do item, com sinal próprio indicando a direção do fluxo daquele item. Como o amount do lançamento é sempre a magnitude, sem sinal, a soma dos itens equivale a +amount quando transaction_kind é credit e a -amount quando é debit. example: -4.0 side: type: string enum: - vendor - customer description: |- Lado do item na fatura.
  • customer: valor do cliente, como o que ele pagou direto ao fornecedor ou o saldo da venda.
  • vendor: valor do fornecedor, como o custo do produto a pagar.
example: vendor kind: type: string enum: - invoice - refund - signal - lei_kandir - reversal - leftover - retained - fine - cvc - generated_credit description: |- Tipo do item.
  • invoice: faturar.
  • refund: reembolso.
  • signal: sinal.
  • lei_kandir: Lei Kandir.
  • reversal: estorno.
  • leftover: saldo da venda.
  • retained: retido pelo intermediário.
  • fine: multa.
  • cvc: CVC.
  • generated_credit: crédito gerado.
example: invoice document: type: string nullable: true description: Documento do produto da venda que originou o item, como o número do bilhete ou da reserva. Nulo quando o item não veio de um produto de venda. example: '9572345678901' issue_date: type: string format: date nullable: true description: Data de emissão do item. example: '2026-10-03' person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Pessoa do item: o cliente nos itens customer e o fornecedor nos itens vendor.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Venda a que o item pertence.
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Produto da venda que originou o item. O identificador aparece no produto correspondente dentro da venda.
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
cvc_statement: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Linha do extrato CVC conciliada com o item. Pode vir preenchida junto com sale_product, quando a conciliação recai sobre um item que já tem produto de venda, ou sozinha, quando o item veio só do extrato.
  • Chame o endpoint [Consultar extrato CVC por ID](#tag/Extrato-CVC/paths/~1cvc_statements~1{id}/get) para os dados completos.
bill_credit_card_item: type: object properties: date: type: string format: date nullable: true description: Data da cobrança. example: '2026-04-08' amount: type: number format: double description: Valor da cobrança, com o sinal cru do movimento (negativo para despesas). example: -717.91 checked: type: boolean description: Indica se a cobrança foi conferida. example: false movement: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Movimentação que originou essa linha da fatura.
  • Chame o endpoint [Consultar movimentação por ID](#tag/Movimentacoes/paths/~1account_movements~1{id}/get) para os dados completos.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Lançamento liquidado por essa linha da fatura.
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
bill_custom_field: type: object properties: id: type: integer description: Identificador da definição do campo personalizado. O nome, o tipo e as opções da definição saem da consulta de definições de campos personalizados ou de Consultar campo personalizado por ID. example: 123 value: type: - string - 'null' description: Valor do campo personalizado. example: Matriz bill_summary: type: object description: Resumo de uma conta a pagar ou receber, como retornado na consulta. properties: id: type: string format: uuid description: Identificador único do lançamento. example: 212b54b8-27df-4859-80a9-79ad855bcd09 number: type: string nullable: true description: Número sequencial do lançamento. Lançamentos parcelados recebem um sufixo com o número da parcela, como 362-1, por isso o campo é texto e não número. example: '12345' transaction_kind: type: string enum: - credit - debit description: 'Natureza do lançamento.
  • credit: conta a receber.
  • debit: conta a pagar.
' example: credit kind: type: string enum: - normal - sale_payment - sale_standalone - vendor_standalone - vendor_invoice - customer_invoice - credit_card_invoice - commission description: 'Origem do lançamento.
  • normal: lançamento avulso.
  • sale_payment: pagamento de venda.
  • sale_standalone: avulso de venda.
  • vendor_standalone: avulso de fornecedor.
  • vendor_invoice: fatura de fornecedor.
  • customer_invoice: fatura de cliente.
  • credit_card_invoice: fatura de cartão de crédito.
  • commission: comissão.
' example: customer_invoice description: type: string nullable: true description: Descrição do lançamento. example: Fatura cliente - Janeiro/2026 document: type: string nullable: true description: Documento associado ao lançamento. example: NF 1001 invoice_number: type: integer nullable: true description: Número da fatura, quando o lançamento é uma fatura. example: 42 currency: type: string minLength: 3 maxLength: 3 description: Código da moeda do lançamento no padrão ISO 4217. O valor, o valor final e as movimentações estão nela. example: BRL amount: type: number format: double description: Valor original do lançamento. example: 1500.0 final_amount: type: number format: double description: Valor final do lançamento (após ajustes de categoria). example: 1500.0 issue_date: type: string format: date nullable: true description: Data de emissão. example: '2026-01-10' due_date: type: string format: date nullable: true description: Data de vencimento. example: '2026-02-10' settlement_date: type: string format: date nullable: true description: Data de liquidação; nulo quando o lançamento ainda não foi liquidado. example: created_at: type: string format: date-time nullable: true description: Data e hora de cadastro do lançamento. example: '2026-01-10T13:45:36' canceled: type: boolean description: Indica se o lançamento foi cancelado. example: false checked: type: boolean description: Indica se o lançamento foi conferido. example: false invoice_closed: type: boolean description: Indica se a fatura do lançamento foi fechada. Fatura fechada não recebe mais itens. example: false system_generated: type: boolean description: Indica se o lançamento foi gerado pelo sistema, em vez de cadastrado manualmente. example: true generates_credit: type: boolean description: Indica se o lançamento gera crédito. example: false periodicity: type: string enum: - without_periodicity - weekly - biweekly - monthly - bimonthly - quarterly - semiannual - annual description: Periodicidade da recorrência (without_periodicity, weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual). example: monthly recurrence_kind: type: string enum: - non_recurrent - recurrent - installment - recurrency_excluded description: Tipo de recorrência (non_recurrent, recurrent, installment, recurrency_excluded). example: installment recurrence_group_id: type: string format: uuid nullable: true description: 'Identificador da série de lançamentos gerada por um parcelamento ou por uma recorrência: todos os lançamentos da mesma série compartilham o valor. Na resposta da criação ele já vem preenchido, mas a consulta por ID só o traz depois que a série é gerada em segundo plano. Nulo quando o lançamento não pertence a nenhuma série. Não é uma entidade consultável, apenas uma chave de agrupamento.' example: 5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f recurrence_status: type: string nullable: true enum: - pending - generated - retrying description: 'Situação da série de parcelamento ou recorrência, que é gerada em segundo plano: pending enquanto ainda não foi gerada, generated quando já foi, e retrying quando a última tentativa falhou. O Monde tenta de novo sozinho, então retrying ainda pode virar generated. Nulo quando o lançamento não é parcelamento nem recorrência.' example: generated observations: type: string nullable: true description: Observações do lançamento. example: billet: allOf: - "$ref": "#/components/schemas/bill_billet" description: Dados do boleto; nulo quando o lançamento não tem número de boleto nem conta de cobrança. check: allOf: - "$ref": "#/components/schemas/bill_check" description: Dados do cheque informados no lançamento; nulo quando o pagamento não foi em cheque. card: allOf: - "$ref": "#/components/schemas/bill_card" description: Dados do cartão informados no lançamento; nulo quando o pagamento não foi em cartão. required: - id - transaction_kind - kind - amount - final_amount - canceled bill: type: object description: Detalhe completo de uma conta a pagar ou receber. properties: id: type: string format: uuid description: Identificador único do lançamento. example: 212b54b8-27df-4859-80a9-79ad855bcd09 number: type: string nullable: true description: Número sequencial do lançamento. Lançamentos parcelados recebem um sufixo com o número da parcela, como 362-1, por isso o campo é texto e não número. example: '12345' transaction_kind: type: string enum: - credit - debit description: 'Natureza do lançamento.
  • credit: conta a receber.
  • debit: conta a pagar.
' example: credit kind: type: string enum: - normal - sale_payment - sale_standalone - vendor_standalone - vendor_invoice - customer_invoice - credit_card_invoice - commission description: 'Origem do lançamento.
  • normal: lançamento avulso.
  • sale_payment: pagamento de venda.
  • sale_standalone: avulso de venda.
  • vendor_standalone: avulso de fornecedor.
  • vendor_invoice: fatura de fornecedor.
  • customer_invoice: fatura de cliente.
  • credit_card_invoice: fatura de cartão de crédito.
  • commission: comissão.
' example: customer_invoice description: type: string nullable: true description: Descrição do lançamento. example: Fatura cliente - Janeiro/2026 document: type: string nullable: true description: Documento associado ao lançamento. example: NF 1001 invoice_number: type: integer nullable: true description: Número da fatura, quando o lançamento é uma fatura. example: 42 currency: type: string minLength: 3 maxLength: 3 description: Código da moeda do lançamento no padrão ISO 4217. O valor, o valor final e as movimentações estão nela. example: BRL amount: type: number format: double description: Valor original do lançamento. example: 1500.0 final_amount: type: number format: double description: Valor final do lançamento (após ajustes de categoria). example: 1500.0 issue_date: type: string format: date nullable: true description: Data de emissão. example: '2026-01-10' due_date: type: string format: date nullable: true description: Data de vencimento. example: '2026-02-10' settlement_date: type: string format: date nullable: true description: Data de liquidação; nulo quando o lançamento ainda não foi liquidado. example: created_at: type: string format: date-time nullable: true description: Data e hora de cadastro do lançamento. example: '2026-01-10T13:45:36' canceled: type: boolean description: Indica se o lançamento foi cancelado. example: false checked: type: boolean description: Indica se o lançamento foi conferido. example: false invoice_closed: type: boolean description: Indica se a fatura do lançamento foi fechada. Fatura fechada não recebe mais itens. example: false system_generated: type: boolean description: Indica se o lançamento foi gerado pelo sistema, em vez de cadastrado manualmente. example: true generates_credit: type: boolean description: Indica se o lançamento gera crédito. example: false periodicity: type: string enum: - without_periodicity - weekly - biweekly - monthly - bimonthly - quarterly - semiannual - annual description: Periodicidade da recorrência (without_periodicity, weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual). example: monthly recurrence_kind: type: string enum: - non_recurrent - recurrent - installment - recurrency_excluded description: Tipo de recorrência (non_recurrent, recurrent, installment, recurrency_excluded). example: installment recurrence_group_id: type: string format: uuid nullable: true description: 'Identificador da série de lançamentos gerada por um parcelamento ou por uma recorrência: todos os lançamentos da mesma série compartilham o valor. Na resposta da criação ele já vem preenchido, mas a consulta por ID só o traz depois que a série é gerada em segundo plano. Nulo quando o lançamento não pertence a nenhuma série. Não é uma entidade consultável, apenas uma chave de agrupamento.' example: 5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f observations: type: string nullable: true description: Observações do lançamento. example: billet: allOf: - "$ref": "#/components/schemas/bill_billet" description: Dados do boleto; nulo quando o lançamento não tem número de boleto nem conta de cobrança. check: allOf: - "$ref": "#/components/schemas/bill_check" description: Dados do cheque informados no lançamento; nulo quando o pagamento não foi em cheque. card: allOf: - "$ref": "#/components/schemas/bill_card" description: Dados do cartão informados no lançamento; nulo quando o pagamento não foi em cartão. sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Venda que originou o lançamento.
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa vinculada ao lançamento (cliente ou fornecedor).
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa dona do lançamento.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Conta de previsão (bancária) vinculada ao lançamento.
  • Chame o endpoint [Consultar conta ou cartão por ID](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get) para os dados completos.
payment_method: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Forma de pagamento efetiva: a da liquidação tem precedência sobre a planejada. Nulo quando não há forma.
  • Chame o endpoint [Consultar forma de pagamento por ID](#tag/Formas-de-Pagamento/paths/~1payment_methods~1{id}/get) para os dados completos.
operation: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Operação própria vinculada ao lançamento.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
invoice_rule: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Regra de faturamento que originou o lançamento.
  • Chame o endpoint [Consultar regra de faturamento por ID](#tag/Regras-de-Faturamento/paths/~1invoice_rules~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Usuário que cadastrou o lançamento.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
movements: type: array description: |- Movimentações de liquidação do lançamento.
  • Chame o endpoint [Consultar movimentação por ID](#tag/Movimentacoes/paths/~1account_movements~1{id}/get) para os dados completos.
items: "$ref": "#/components/schemas/entity_reference" apportionments: type: object description: Rateio do valor do lançamento, decomposto por empresa e por centro de custo. properties: per_company: type: array description: Rateio entre empresas. items: "$ref": "#/components/schemas/bill_apportionment" per_cost_center: type: array description: Rateio entre centros de custo. items: "$ref": "#/components/schemas/bill_cost_center" custom_fields: type: array description: Campos personalizados preenchidos no lançamento. items: "$ref": "#/components/schemas/bill_custom_field" attachments: type: array description: Anexos do lançamento, com link temporário de download. items: "$ref": "#/components/schemas/attachment_summary" categories: type: array description: Rateio do lançamento por categoria financeira. items: "$ref": "#/components/schemas/bill_category" commissions: type: array description: Comissões vinculadas ao lançamento. items: "$ref": "#/components/schemas/bill_commission" items: type: array description: Itens que compõem o lançamento. items: "$ref": "#/components/schemas/bill_item" credit_card_items: type: array description: Itens da fatura de cartão (cobranças consolidadas); preenchido quando kind = credit_card_invoice, array vazio caso contrário. items: "$ref": "#/components/schemas/bill_credit_card_item" required: - id - transaction_kind - kind - amount - final_amount - canceled bill_create: type: object writeOnly: true description: Dados para inserir uma conta a pagar ou receber, em aberto ou já liquidada. required: - transaction_kind - person_id - description - amount - due_date - categories properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 'CNPJ da empresa do lançamento. A credencial precisa poder inserir lançamentos nela. Obrigatório, exceto no lançamento da venda (com sale_id), que fica na empresa da venda: nele pode ser omitido e, enviado, precisa ser o CNPJ dela.' sale_id: type: string format: uuid description: Venda em que a conta a pagar ou a receber é lançada, pelo id de GET /sales, como o botão da aba Financeiro da venda no Monde. O lançamento nasce como avulso da venda (sale_standalone), na empresa dela. Não se combina com operation_id nem com parcelamento ou recorrência. example: 5b1d2c3e-6f7a-4b8c-9d0e-1f2a3b4c5d6e transaction_kind: type: string enum: - credit - debit description: 'Natureza do lançamento: credit (conta a receber) ou debit (conta a pagar).' example: debit person_id: type: string format: uuid description: Pessoa do lançamento (cliente ou fornecedor), pelo id de GET /people. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: type: string maxLength: 50 description: 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. example: Aluguel escritório - Outubro/2026 document: type: string maxLength: 50 description: Documento de referência, como o número da nota, com até 50 caracteres. example: NF 1001 amount: type: number format: double multipleOf: 0.01 exclusiveMinimum: 0 description: Valor do lançamento, maior que zero, com até 2 casas decimais. example: 1500.0 currency: type: string minLength: 3 maxLength: 3 description: 'Código da moeda do lançamento no padrão ISO 4217, entre as moedas ativas. Omitido, o lançamento é em real (BRL). Outra moeda só é aceita quando o Monde trabalha com mais de uma: na operadora ou com multimoedas. O valor, as categorias e as movimentações vêm nela; a movimentação em conta de outra moeda é convertida pelo exchange_rate.' example: USD issue_date: type: string format: date description: 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. example: '2026-10-07' due_date: type: string format: date description: Data de vencimento no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio de vencimento da empresa. example: '2026-10-15' account_id: type: string format: uuid description: Conta prevista para a liquidação, pelo id de GET /accounts. Precisa estar ativa e vinculada à empresa do lançamento, de qualquer tipo, inclusive conta cartão de crédito na conta a receber. Quando omitida, vale a conta de previsão padrão da empresa. example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01 operation_id: type: string format: uuid description: Operação própria, pelo id do produto de operação própria. Precisa estar ativa. Só em agência. example: 1f0e2d3c-4b5a-4978-8a9b-0c1d2e3f4a5b observations: type: string description: Observações do lançamento. example: Contrato 2026/10 billing_account_id: type: string format: uuid description: Conta de cobrança do boleto, pelo id de billing_accounts em GET /accounts/{id}. Só na conta a receber. Precisa ser ativa e de conta corrente ativa da empresa do lançamento. O lançamento passa a prever a entrada na conta corrente da cobrança, e o boleto é numerado; na conta de cobrança registrada, como a do PJBank, o boleto fica pendente de registro e o Monde o envia ao banco. example: 6b7c2d1e-3f4a-4b5c-8d9e-0f1a2b3c4d5e billet_demonstrative: type: string description: Demonstrativo do boleto, o texto que sai impresso nele. Só na conta a receber. example: Não receber após 30 dias do vencimento. categories: type: array minItems: 1 description: Categorias do lançamento, ao menos uma. A soma com sinal delas é o valor final. items: "$ref": "#/components/schemas/bill_category_create" apportionments: type: object description: Rateios do lançamento. Só em agência. properties: per_cost_center: type: array description: Rateio por centro de custo, em percentual do valor final. O total pode ficar entre 0 e 100%, e o mesmo centro de custo não pode se repetir. items: "$ref": "#/components/schemas/bill_cost_center_create" per_company: type: array description: Rateio entre empresas, em percentual do valor final. Quando informado, o total precisa ser exatamente 100%, e a mesma empresa não pode se repetir. items: "$ref": "#/components/schemas/bill_company_apportionment_create" custom_fields: type: array description: Campos personalizados do financeiro, pelo id de GET /custom_fields. Os obrigatórios precisam ser informados. items: "$ref": "#/components/schemas/custom_field" settlement_date: type: string format: date description: Data de liquidação no formato ISO 8601 (AAAA-MM-DD), enviada junto com movements para criar o lançamento já liquidado. Não pode ser maior que a data da última movimentação. example: '2026-10-10' movements: type: array description: Movimentações da liquidação, enviadas junto com settlement_date. Sem balance_resolution, a soma delas precisa ser igual ao valor final. items: "$ref": "#/components/schemas/bill_movement_create" partial_payment: type: boolean description: 'Pagamento parcial, o mesmo que balance_resolution igual a partial: com true e movimentações somando menos que o valor final, o lançamento é liquidado com o que foi pago e o saldo vira um novo lançamento em aberto, referenciado em generated_bills. Não se combina com parcelamento nem recorrência. Enviado junto com balance_resolution, precisa dizer o mesmo que ele.' example: true balance_resolution: type: string enum: - category - partial description: 'O que fazer com a diferença entre o que foi pago e o valor final, no lançamento criado já liquidado: category lança a diferença numa categoria de desconto ou acréscimo; partial liquida o que foi pago e cria um lançamento em aberto com o saldo, só quando foi pago menos. Não se combina com parcelamento nem recorrência.' example: category balance_category_id: type: string format: uuid description: 'Só com balance_resolution igual a category: a categoria da diferença, pelo id de GET /categories. Sem ela, vale a categoria padrão da empresa.' example: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e recurrence_kind: type: string enum: - installment - recurrent description: 'Gera a série a partir do lançamento, em segundo plano: installment (parcelamento) ou recurrent (recorrência, pelos próximos 5 anos). Exige periodicity. Os lançamentos da série se consultam pelo recurrence_group_id da resposta.' example: installment periodicity: type: string enum: - weekly - biweekly - monthly - bimonthly - quarterly - semiannual - annual description: 'Intervalo entre os lançamentos da série: weekly, biweekly (15 dias), monthly, bimonthly, quarterly, semiannual ou annual.' example: monthly installments: type: integer minimum: 2 maximum: 200 description: Total de parcelas do parcelamento, de 2 a 200, contando a do próprio lançamento. Cada parcela repete o valor cheio. example: 3 bill_update: type: object writeOnly: true description: Campos de uma conta a pagar ou receber que podem ser alterados. Só os informados mudam. properties: person_id: type: string format: uuid description: Pessoa do lançamento (cliente ou fornecedor), pelo id de GET /people. Não pode ser vazia. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: type: string maxLength: 50 description: Descrição do lançamento, com até 50 caracteres. Não pode ser vazia. example: Aluguel escritório - Novembro/2026 document: type: string nullable: true maxLength: 50 description: Documento de referência, como o número da nota, com até 50 caracteres. Nulo limpa; o texto vazio é gravado. example: NF 1002 issue_date: type: string format: date description: Data de emissão no formato ISO 8601 (AAAA-MM-DD). Não pode ser maior que o vencimento. example: '2026-10-07' due_date: type: string format: date description: Data de vencimento no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio de vencimento da empresa. example: '2026-11-15' account_id: type: string format: uuid description: Conta prevista para a liquidação, pelo id de GET /accounts. Precisa estar ativa e vinculada à empresa do lançamento. example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01 operation_id: type: string nullable: true format: uuid description: 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. example: 1f0e2d3c-4b5a-4978-8a9b-0c1d2e3f4a5b observations: type: string nullable: true description: Observações do lançamento. Nulo limpa; o texto vazio é gravado. example: Vencimento renegociado com o locador billing_account_id: type: string format: uuid nullable: true description: 'Conta de cobrança do boleto, pelo id de billing_accounts em GET /accounts/{id}. Só na conta a receber, com as regras da inclusão. Só troca enquanto não há boleto vivo no banco: o boleto já emitido, e o registrado ou a caminho do banco, prendem a conta. Na fatura de cliente, só entra com a fatura fechada: veja close_invoice. Nulo tira a conta de cobrança.' example: 6b7c2d1e-3f4a-4b5c-8d9e-0f1a2b3c4d5e billet_demonstrative: type: string nullable: true description: '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.' example: Não receber após 30 dias do vencimento. close_invoice: type: boolean description: 'Confirma o fechamento da fatura de cliente aberta junto com a conta de cobrança: true fecha a fatura e grava a conta de cobrança na mesma chamada, com as regras e a permissão Fechar Fatura de Fechar fatura de cliente. Sem ela, a conta de cobrança na fatura de cliente aberta responde 409.' example: true company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 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: type: number format: double multipleOf: 0.01 exclusiveMinimum: 0 description: Valor do lançamento, maior que zero, com até 2 casas decimais. Sem categories, a única categoria acompanha o novo valor; com mais de uma, ele precisa ser igual à soma delas. example: 1500.0 categories: type: array minItems: 1 description: Categorias do lançamento, ao menos uma. Substituem as atuais, e a soma com sinal delas é o valor final. items: "$ref": "#/components/schemas/bill_category_create" apportionments: type: object nullable: true description: Rateios do lançamento. Só em agência. Cada um enviado substitui o atual; o que não veio fica como está. properties: per_cost_center: type: array nullable: true description: Rateio por centro de custo, em percentual do valor final, entre 0 e 100%. A lista vazia retira o rateio. items: "$ref": "#/components/schemas/bill_cost_center_create" per_company: type: array nullable: true description: Rateio entre empresas, em percentual do valor final. Quando informado, o total precisa ser exatamente 100%. A lista vazia retira o rateio. items: "$ref": "#/components/schemas/bill_company_apportionment_create" recurrence_scope: type: string enum: - only_this - this_and_following description: 'Só para lançamento de parcelamento ou recorrência: only_this (padrão) altera só este; this_and_following altera este e os lançamentos seguintes da série, em segundo plano; cada seguinte só muda quando a credencial poderia alterá-lo diretamente.' example: this_and_following custom_fields: type: array description: Campos personalizados do financeiro, pelo id de GET /custom_fields. Cada um enviado é gravado por cima do atual; os demais permanecem. items: "$ref": "#/components/schemas/custom_field" settlement_date: type: string format: date description: 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. example: '2026-10-12' movements: type: array description: 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. items: "$ref": "#/components/schemas/bill_movement_update" undo_bank_reconciliation: type: boolean description: 'Confirma a alteração que desfaz a conciliação bancária: true grava, e a conciliação da movimentação cujo valor, data ou conta mudou é desfeita. Sem ela, essa alteração responde 409; a que não mexe nas movimentações conciliadas grava sem ela.' example: true bill_movement_update: type: object writeOnly: true properties: id: type: string format: uuid description: Id da movimentação do lançamento, de movements na consulta por ID. Sem ele, a movimentação é nova, e account_id, payment_method_id, date e amount são obrigatórios. example: 6b1d0c2e-8f3a-4d5b-9e7c-1a2b3c4d5e6f account_id: type: string format: uuid description: Conta em que o dinheiro entrou ou saiu, pelo id de GET /accounts. Precisa estar ativa e vinculada à empresa do lançamento. example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01 payment_method_id: type: string format: uuid description: Forma de pagamento, pelo id de GET /payment_methods. Conta caixa e conta de cheques aceitam dinheiro ou cheque; conta cartão de crédito aceita só cartão de crédito. example: fc9f5c65-71b2-4bab-ba56-aee44fe6d998 date: type: string format: date description: Data da movimentação no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio da data de movimentação da empresa. example: '2026-10-12' amount: type: number format: double multipleOf: 0.01 exclusiveMinimum: 0 description: 'Valor da movimentação, na moeda do lançamento, maior que zero. Com taxa de cartão, é o que o cliente pagou, e a conta recebe o valor menos a taxa: na consulta da movimentação, é amount mais card_rate. As movimentações, já sem as taxas, precisam somar o valor final.' example: 1600.0 card_rate: type: number format: double multipleOf: 0.01 minimum: 0 description: Taxa de cartão da movimentação, maior ou igual a zero. Só na conta a receber, em conta corrente e com a forma cartão de crédito ou de débito. Enviada sozinha, mantém o que o cliente pagou e muda o que entrou na conta. Nula é zero. example: 32.0 installments: type: integer minimum: 1 maximum: 99 description: 'Só na movimentação nova, sem id: 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. As parcelas da movimentação gravada não mudam.' example: 1 check: type: object description: Dados do cheque, só com a forma de pagamento cheque. properties: number: type: string maxLength: 9 example: '123456' bank: type: string maxLength: 3 example: '341' document: type: string maxLength: 15 example: '12345678000190' card: type: object description: Dados do cartão, só com as formas de pagamento cartão de crédito ou de débito. properties: brand: type: string maxLength: 20 example: Visa last_digits: type: string maxLength: 4 example: '1234' authorization: type: string maxLength: 20 example: A1B2C3 bill_created: description: Conta a pagar ou receber criada com sucesso. allOf: - "$ref": "#/components/schemas/bill" - type: object required: - generated_bills properties: generated_bills: type: array description: 'Lançamento gerado na mesma chamada: o saldo do pagamento parcial. Vazio quando não há. Se consulta por GET /bills/{id}. As parcelas e recorrências não vêm aqui: elas são geradas em segundo plano e se consultam pelo recurrence_group_id.' items: "$ref": "#/components/schemas/entity_reference" bill_settlement: type: object writeOnly: true description: Dados para liquidar uma conta a pagar ou receber em aberto. required: - settlement_date - movements properties: settlement_date: type: string format: date description: 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. example: '2026-10-14' movements: type: array minItems: 1 description: 'Movimentações da liquidação, ao menos uma: uma por conta em que o dinheiro entrou ou saiu. Sem balance_resolution, precisam somar o valor final.' items: "$ref": "#/components/schemas/bill_movement_create" balance_resolution: type: string enum: - category - partial description: 'O que fazer com a diferença entre o que foi pago e o valor final: category lança a diferença numa categoria de desconto ou acréscimo; partial liquida o que foi pago e cria um lançamento em aberto com o saldo, só quando foi pago menos.' example: category balance_category_id: type: string format: uuid description: 'Só com balance_resolution igual a category: a categoria da diferença, pelo id de GET /categories. Sem ela, vale a categoria padrão da empresa.' example: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e bill_settled: description: Conta a pagar ou receber liquidada com sucesso. allOf: - "$ref": "#/components/schemas/bill" - type: object required: - generated_bills properties: generated_bills: type: array description: O lançamento em aberto com o saldo do pagamento parcial, criado na mesma chamada. Vazio nos demais casos. items: "$ref": "#/components/schemas/entity_reference" bill_batch_settlement: type: object writeOnly: true description: Dados para liquidar vários lançamentos em aberto de uma vez, cada um pelo valor final inteiro. required: - bill_ids - settlement_date - account_id properties: bill_ids: type: array minItems: 1 maxItems: 100 uniqueItems: true description: Ids (UUID) dos lançamentos a liquidar, de 1 a 100, sem repetir. Todos precisam estar na mesma moeda. items: type: string format: uuid example: - 212b54b8-27df-4859-80a9-79ad855bcd09 - 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f settlement_date: type: string format: date description: 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. example: '2026-10-14' account_id: type: string format: uuid description: 'Conta em que o dinheiro entrou ou saiu, a mesma para todos os lançamentos: ativa e vinculada às empresas de todos eles.' example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01 use_sale_data: type: boolean default: false description: Com true, cada pagamento da venda é liquidado com a forma e os dados de cheque ou cartão da própria venda, como o "Liquidar usando dados da venda" do Monde. Só vale quando todos os lançamentos são pagamento da venda, e aí payment_method_id, check e card não são aceitos. example: false payment_method_id: type: string format: uuid description: Forma de pagamento, a mesma para todos os lançamentos, que segue o tipo da conta. Omitida, cada lançamento fica sem forma na movimentação. Não é aceita com use_sale_data igual a true. example: fc9f5c65-71b2-4bab-ba56-aee44fe6d998 installments: type: integer minimum: 1 maximum: 99 description: 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. example: 1 check: type: object description: Dados do cheque, só com a forma cheque, que exige o número. Não é aceito com use_sale_data igual a true. properties: number: type: string maxLength: 9 example: '123456' bank: type: string maxLength: 3 example: '341' document: type: string maxLength: 15 example: '12345678000190' card: type: object description: Dados do cartão, só com as formas de cartão de crédito ou de débito. Não é aceito com use_sale_data igual a true. properties: brand: type: string maxLength: 20 example: Visa last_digits: type: string maxLength: 4 example: '1234' authorization: type: string maxLength: 20 example: A1B2C3 exchange_rate: type: number format: double exclusiveMinimum: 0 description: 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. example: 5.4321 bill_movement_create: type: object writeOnly: true required: - account_id - payment_method_id - date - amount properties: account_id: type: string format: uuid description: Conta em que o dinheiro entrou ou saiu, pelo id de GET /accounts. Precisa estar ativa e vinculada à empresa do lançamento. Na conta a receber, a conta cartão de crédito é o estorno, que entra na fatura do cartão. example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01 payment_method_id: type: string format: uuid description: 'Forma de pagamento, pelo id de GET /payment_methods. Conta caixa e conta de cheques aceitam dinheiro ou cheque; conta cartão de crédito aceita só cartão de crédito; conta corrente aceita as demais. Na liquidação do pagamento da venda (sale_payment) é opcional: ausente, vale a forma de pagamento da venda.' example: fc9f5c65-71b2-4bab-ba56-aee44fe6d998 date: type: string format: date description: Data da movimentação no formato ISO 8601 (AAAA-MM-DD). Em contas a receber, está sujeita ao bloqueio da data de movimentação da empresa, e o caixa do dia não pode estar fechado. example: '2026-10-10' amount: type: number format: double multipleOf: 0.01 exclusiveMinimum: 0 description: Valor da movimentação na moeda do lançamento, maior que zero, com até 2 casas decimais. Com taxa de cartão, é o que o cliente pagou, e a conta recebe o valor menos a taxa. Numa conta em outra moeda, entra convertido pela última cotação (ou, na liquidação, pelo exchange_rate informado); sem cotação cadastrada nem câmbio informado, a movimentação é recusada. example: 420.0 card_rate: type: number format: double multipleOf: 0.01 minimum: 0 description: Taxa de cartão da operadora, maior ou igual a zero e menor que amount. Só na conta a receber, em conta corrente e com a forma cartão de crédito ou de débito. A soma das taxas vira a categoria de taxa de cartão configurada na empresa. example: 0 installments: type: integer minimum: 1 maximum: 99 description: 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. example: 1 check: type: object description: 'Dados do cheque, só com a forma cheque: number (obrigatório, só números), bank e document.' properties: number: type: string maxLength: 9 example: '123456' bank: type: string maxLength: 3 example: '341' document: type: string maxLength: 15 example: '12345678000190' card: type: object description: 'Dados do cartão, só com as formas cartão de crédito ou de débito: brand, last_digits e authorization.' properties: brand: type: string maxLength: 20 example: Visa last_digits: type: string maxLength: 4 example: '1234' authorization: type: string maxLength: 20 example: A1B2C3 exchange_rate: type: number format: double exclusiveMinimum: 0 description: 'Câmbio que converte a moeda do lançamento na moeda da conta: quanto vale, na moeda da conta, uma unidade da moeda do lançamento. Maior que zero; gravado com 6 casas decimais, e o que passar delas é arredondado. Só vale quando a conta está em outra moeda, e a conta recebe amount vezes o câmbio. Omitido, vale a última cotação, como o Monde sugere ao liquidar; informe o câmbio usado pelo banco para gravar o valor que entrou de fato. Com ele, a falta de cotação cadastrada não recusa a movimentação. Na conta na moeda do lançamento, é ignorado.' example: 5.4321 reference_exchange_rate: type: number format: double exclusiveMinimum: 0 description: 'Câmbio de referência, que converte a moeda da conta para o real: quanto vale, em reais, uma unidade da moeda da conta. Maior que zero; gravado com 6 casas decimais, e o que passar delas é arredondado. Só vale na conta fora do real. Omitido, vale a última cotação da moeda da conta, como o Monde sugere ao liquidar. Na conta em real, é ignorado.' example: 5.4321 bill_category_create: type: object writeOnly: true required: - category_id - amount properties: category_id: type: string format: uuid description: Categoria, pelo id de GET /categories. example: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d amount: type: number format: double multipleOf: 0.01 exclusiveMinimum: 0 description: Valor da categoria, maior que zero, com até 2 casas decimais. example: 1200.0 description: type: string maxLength: 50 description: Descrição da linha, com até 50 caracteres. example: Aluguel bill_cost_center_create: type: object writeOnly: true required: - cost_center_id - percentage properties: cost_center_id: type: string format: uuid description: Centro de custo, pelo id de GET /cost_centers. example: 0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d percentage: type: number format: double minimum: 0 maximum: 100 description: Percentual, de 0 a 100. example: 60.0 bill_company_apportionment_create: type: object writeOnly: true required: - company_identifier - percentage properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ da empresa do rateio. A credencial precisa poder inserir lançamentos nela. percentage: type: number format: double minimum: 0 maximum: 100 description: Percentual, de 0 a 100. example: 100.0 bills_response: type: object description: Resposta contendo a lista de contas a pagar e receber com informações de paginação. properties: data: type: array description: Array contendo as contas a pagar e receber da página atual. items: "$ref": "#/components/schemas/bill_summary" pagination: "$ref": "#/components/schemas/pagination" account_movement_check: type: object nullable: true properties: number: type: integer nullable: true description: Número do cheque example: 4567 bank: type: string nullable: true description: Código de compensação do banco do cheque example: '341' document: type: string nullable: true description: CPF ou CNPJ do emitente do cheque, apenas dígitos example: '03832060901' account_movement_card: type: object nullable: true properties: brand: type: string nullable: true description: Operadora do cartão example: MasterCard last_digits: type: string nullable: true description: Últimos dígitos do cartão example: '4117' authorization: type: string nullable: true description: Código de autorização da operadora example: '600551159' account_movement_summary: type: object description: Resumo de uma movimentação de conta, como retornado na consulta. properties: id: type: string format: uuid description: Identificador único da movimentação example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 date: type: string format: date nullable: true description: Data do movimento na conta example: '2026-01-26' amount: type: number format: double description: Valor do movimento, negativo quando é saída da conta example: -9112.17 transaction_kind: type: string enum: - credit - debit description: |- Sentido do movimento, derivado do sinal do valor.
  • credit: entrada de dinheiro na conta.
  • debit: saída de dinheiro da conta.
example: debit description: type: string nullable: true description: 'Observação da própria movimentação: o texto informado na transferência entre contas ou a identificação da parcela, quando o pagamento em cartão de crédito foi parcelado. Não é a descrição da conta a pagar ou a receber liquidada, que vem no recurso referenciado em bill' example: Repasse diário check: allOf: - "$ref": "#/components/schemas/account_movement_check" description: Dados do cheque, nulo quando o movimento não foi feito em cheque card: allOf: - "$ref": "#/components/schemas/account_movement_card" description: Dados do cartão, nulo quando o movimento não foi feito em cartão. Número completo, código de segurança, validade e nome do portador nunca são retornados required: - id - amount - transaction_kind account_movement: type: object description: Detalhe completo de uma movimentação de conta. properties: id: type: string format: uuid description: Identificador único da movimentação example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 date: type: string format: date nullable: true description: Data do movimento na conta example: '2026-01-26' amount: type: number format: double description: Valor do movimento, negativo quando é saída da conta example: -9112.17 transaction_kind: type: string enum: - credit - debit description: |- Sentido do movimento, derivado do sinal do valor.
  • credit: entrada de dinheiro na conta.
  • debit: saída de dinheiro da conta.
example: debit description: type: string nullable: true description: 'Observação da própria movimentação: o texto informado na transferência entre contas ou a identificação da parcela, quando o pagamento em cartão de crédito foi parcelado. Não é a descrição da conta a pagar ou a receber liquidada, que vem no recurso referenciado em bill' example: Repasse diário check: allOf: - "$ref": "#/components/schemas/account_movement_check" description: Dados do cheque, nulo quando o movimento não foi feito em cheque card: allOf: - "$ref": "#/components/schemas/account_movement_card" description: Dados do cartão, nulo quando o movimento não foi feito em cartão. Número completo, código de segurança, validade e nome do portador nunca são retornados card_rate: type: number format: double description: 'Taxa de cartão da movimentação. Só abate na conta a receber paga em cartão de crédito ou de débito numa conta corrente: o cliente pagou amount mais a taxa. Zero quando não há taxa.' example: 0 account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Conta em que o movimento foi lançado
  • Chame o endpoint [Consultar conta ou cartão por ID](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get) para os dados completos.
payment_method: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Forma de pagamento do movimento
  • Chame o endpoint [Consultar forma de pagamento por ID](#tag/Formas-de-Pagamento/paths/~1payment_methods~1{id}/get) para os dados completos.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Conta a pagar ou a receber liquidada pelo movimento
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
credit_card_invoice: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Fatura de cartão de crédito que o movimento compõe
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
counterpart_account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Conta do outro lado da transferência entre contas: a de destino quando esta movimentação é a saída, a de origem quando é a entrada. Nula quando a movimentação não é transferência
  • Chame o endpoint [Consultar conta ou cartão por ID](#tag/Contas-e-Cartoes/paths/~1accounts~1{id}/get) para os dados completos.
required: - id - amount - transaction_kind - account account_movements_response: type: object description: Resposta contendo a lista de movimentações com informações de paginação. properties: data: type: array description: Array contendo as movimentações da página atual. items: "$ref": "#/components/schemas/account_movement_summary" pagination: "$ref": "#/components/schemas/pagination" refund_summary: type: object description: 'Representa um reembolso de venda na consulta: apenas os campos do próprio reembolso.' properties: id: &681 type: string format: uuid description: Identificador único do reembolso example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 refund_type: &682 type: string enum: - customer - vendor description: |- Lado do reembolso.
  • customer: reembolso do cliente.
  • vendor: reembolso do fornecedor ou do representante.
example: vendor amount: &683 type: number format: double description: Valor do reembolso example: -91.36 description: &684 type: string nullable: true description: Descrição do reembolso example: Reembolso Incentivo issue_date: &685 type: string format: date nullable: true description: Data de emissão do reembolso example: '2021-06-16' due_date: &686 type: string format: date nullable: true description: Vencimento do reembolso example: '2021-06-17' required: - id - refund_type - amount refund: type: object description: Representa um reembolso de venda com as referências para as entidades relacionadas. properties: id: *681 refund_type: *682 amount: *683 description: *684 issue_date: *685 due_date: *686 sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Venda reembolsada
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Produto da venda que originou o reembolso. O identificador aparece no produto correspondente dentro da venda
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Cliente ou fornecedor/representante do reembolso
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa do reembolso
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Conta a pagar ou a receber do reembolso, nula enquanto ele não está faturado
  • Chame o endpoint [Consultar conta a pagar ou receber por ID](#tag/Contas-a-Pagar-e-Receber/paths/~1bills~1{id}/get) para os dados completos.
required: - id - refund_type - amount - sale - sale_product - person - company refund_create: type: object description: Corpo do lançamento de um reembolso na venda. properties: sale_product_id: type: string format: uuid description: Identificador do produto da venda reembolsado, como aparece no produto dentro da venda. example: e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148 refund_type: type: string enum: - customer - vendor description: |- Lado do reembolso.
  • customer: a agência devolve o valor ao cliente.
  • vendor: reembolso com o fornecedor ou o representante do produto.
example: customer amount: type: number format: double minimum: 0 exclusiveMinimum: true description: Valor do reembolso, positivo. O sinal sai de `transaction_kind`. example: 1208.89 transaction_kind: type: string enum: - credit - debit description: |- Direção do dinheiro para a agência.
  • credit: a agência recebe. Só no reembolso do fornecedor, e é o padrão dele.
  • debit: a agência paga. É o único aceito no reembolso ao cliente, e o padrão dele.
example: debit billing: type: string enum: - invoice - bill description: |- Como o reembolso é cobrado.
  • invoice: vai para a fatura pelas regras de faturamento (Faturar).
  • bill: gera na hora uma fatura avulsa só com ele (Gerar conta a pagar/receber).
example: invoice issue_date: type: string format: date description: Data de emissão do reembolso. Quando omitida, é a data do dia. example: '2022-04-09' description: type: string maxLength: 100 description: Descrição do reembolso, com até 100 caracteres. example: Reembolso devido ao cancelamento da viagem person_id: type: string format: uuid description: '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.' example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 cost_center: type: string maxLength: 50 description: Centro de custo do reembolso ao cliente, só com `billing` igual a `invoice`. Para pessoa jurídica com centros de custo cadastrados, precisa ser um deles, salvo quando a agência informa o centro de custo em texto livre. example: Diretoria required: - sale_product_id - refund_type - amount - billing refunds_response: type: object description: Resposta contendo a lista de reembolsos com informações de paginação. properties: data: type: array description: Array contendo os reembolsos da página atual. items: "$ref": "#/components/schemas/refund_summary" pagination: "$ref": "#/components/schemas/pagination" passenger_list_named_reference: type: object description: Referência a um registro relacionado, com o nome dele. properties: id: type: string format: uuid description: Identificador do registro referenciado. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: type: string description: Nome do registro referenciado. example: Maria Silva required: - id - name passenger_list_airline_segment: type: object description: Trecho aéreo do produto, com o assento do passageiro. properties: airline_code: type: string description: Código da companhia aérea. example: TP flight_number: type: string nullable: true description: Número do voo. example: '88' class: type: string nullable: true description: Classe tarifária. example: Y origin: type: string description: Aeroporto de origem (IATA). example: GRU departure_date: type: string description: Partida do trecho (ISO 8601). example: '2026-11-10T23:55:00' destination: type: string description: Aeroporto de destino (IATA). example: LIS arrival_date: type: string nullable: true description: Chegada do trecho (ISO 8601). example: '2026-11-11T13:40:00' seat_number: type: string nullable: true description: Assento do passageiro no trecho. Nulo quando ele não tem assento marcado. example: 12A required: - airline_code - origin - departure_date - destination passenger_list_row: type: object description: Passageiro de um produto vendido. properties: id: type: string format: uuid description: Identificador do passageiro no produto da venda. example: 2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35 person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Cadastro do passageiro.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
name: type: string description: Nome do passageiro no cadastro. example: Ana Souza emission_name: type: string nullable: true description: Nome de emissão do passageiro no produto. gender: type: string nullable: true description: 'Sexo do passageiro: `M` ou `F`.' birthplace: type: string nullable: true description: Cidade de nascimento do passageiro. cpf: type: string nullable: true description: CPF do passageiro. rg: type: string nullable: true description: RG do passageiro. rg_issuing_agency: type: string nullable: true description: Órgão emissor do RG do passageiro. birth_certificate: type: string nullable: true description: Certidão de nascimento do passageiro. passport_number: type: string nullable: true description: Número do passaporte do passageiro. email: type: string nullable: true description: E-mail do passageiro. phone_number: type: string nullable: true description: Telefone. mobile_number: type: string nullable: true description: Celular do passageiro. birthdate: type: string format: date nullable: true description: Data de nascimento do passageiro. rg_issue_date: type: string format: date nullable: true description: Data de emissão do RG do passageiro. passport_expiration_date: type: string format: date nullable: true description: Validade do passaporte do passageiro. address: type: object description: Endereço do passageiro, o do cadastro dele. properties: postal_code: type: string nullable: true description: CEP. street: type: string nullable: true description: Logradouro. street_number: type: string nullable: true description: Número. additional_info: type: string nullable: true description: Complemento. neighborhood: type: string nullable: true description: Bairro. city_name: type: string nullable: true description: Nome da cidade. state_code: type: string nullable: true description: Sigla do estado. ticket_number: type: string nullable: true description: Documento do passageiro no produto, como o número do bilhete. cost_center: type: string nullable: true description: Centro de custo do passageiro no produto. canceled_at: type: string format: date nullable: true description: Data de cancelamento do passageiro no produto. Nulo quando ele não foi cancelado. sale: type: object description: |- Venda do produto, com o número, a data e a situação dela.
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. number: type: integer description: Número da venda. example: 1024 date: type: string format: date description: Data da venda. example: '2026-10-01' status: type: string enum: - opened - closed - canceled description: Situação da venda. example: closed required: - id - number - date - status sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto da venda em que o passageiro está.
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
product: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" description: |- Produto do cadastro, com o nome.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
supplier: type: object description: |- Fornecedor do produto, com o nome e a cidade.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. name: type: string description: Nome do registro referenciado. city_name: type: string nullable: true description: Nome da cidade. representative: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Representante do fornecedor no produto, com o nome. Nulo quando o produto não tem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
departure_date: type: string nullable: true description: Embarque ou início do produto (ISO 8601). Traz a hora quando o produto a tem. example: '2026-11-10T08:30:00' arrival_date: type: string nullable: true description: Chegada ou fim do produto (ISO 8601). Traz a hora quando o produto a tem. example: '2026-11-20' destination: type: string nullable: true enum: - national - international - cruise description: 'Destino do produto: `national`, `international` ou `cruise`.' example: international document: type: string nullable: true description: Documento do produto, como o localizador ou o número da reserva. product_details: type: object description: 'Os detalhes do produto que o Monde mostra conforme o tipo dele: hospedagem, cruzeiro, locação de veículo e pacote. O que não é do tipo do produto vem nulo.' properties: nights: type: integer nullable: true description: Diárias. accommodation_kind: type: string nullable: true description: Tipo de acomodação. room_category: type: string nullable: true description: Categoria do quarto. meal_plan: type: string nullable: true description: Regime de alimentação. cabin_kind: type: string nullable: true description: Tipo da cabine. cabin_number: type: string nullable: true description: Número da cabine. cabin_category: type: string nullable: true description: Categoria da cabine. ship_name: type: string nullable: true description: Nome do navio. cruise_destination: type: string nullable: true description: Destino do navio. vehicle_category: type: string nullable: true description: Categoria do veículo. pickup_location: type: string nullable: true description: Local de retirada do veículo. dropoff_location: type: string nullable: true description: Local de devolução do veículo. package_name: type: string nullable: true description: Nome do pacote. transport: type: string nullable: true description: Transporte do pacote. airline_segments: type: array description: Trechos aéreos do produto, em ordem de voo, cada um com o assento do passageiro. Lista vazia quando o produto não tem trechos. items: "$ref": "#/components/schemas/passenger_list_airline_segment" amounts: type: object description: Valores do passageiro no produto, na moeda de venda do produto, como as colunas de valores do relatório. properties: currency: type: string nullable: true description: Moeda de venda do produto. amount: type: number format: double description: Valor do produto. fees: type: number format: double description: Taxas. other_fees: type: number format: double description: Outras taxas. total_fees: type: number format: double description: Total das taxas. du_fee: type: number format: double description: Taxa DU. du_fee_discount: type: number format: double description: Desconto da taxa DU. rav_fee: type: number format: double description: Taxa RAV. rav_fee_discount: type: number format: double description: Desconto da taxa RAV. agency_fee: type: number format: double description: Taxa de serviço oculta. customer_amount: type: number format: double description: 'Valor cliente: o valor do produto mais a taxa de serviço oculta.' total_amount: type: number format: double description: Valor total. external_number: type: string nullable: true description: Número externo do produto. O nome com que o campo aparece no Monde é o das Configurações da agência. additional1: type: string nullable: true description: Adicional 1 do produto. O nome com que o campo aparece no Monde é o das Configurações da agência. additional2: type: string nullable: true description: Adicional 2 do produto. O nome com que o campo aparece no Monde é o das Configurações da agência. company: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" description: Empresa da venda, com o nome. seller: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" description: |- Vendedor da venda, com o nome.
  • Chame o endpoint [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get) para os dados completos.
payer: type: object description: |- Pagante da venda, com o nome e o telefone.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. name: type: string description: Nome do registro referenciado. phone_number: type: string nullable: true description: Telefone. intermediary: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Intermediário da venda, com o nome. Nulo quando a venda não tem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
requester: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Solicitante da venda, com o nome. Nulo quando a venda não tem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
approver: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Aprovador da venda, com o nome. Nulo quando a venda não tem. Só vem na agência.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
promoter: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Promotor da venda, com o nome. Nulo quando a venda não tem. Só vem na operadora.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
own_operation: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Operação própria da venda, com o nome. Nula quando a venda não tem. Só vem na agência.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
travel: type: object nullable: true description: |- Viagem da venda, com o número e a descrição. Nula quando a venda não está numa viagem.
  • Chame o endpoint [Consultar viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. number: type: string nullable: true description: Número da viagem. example: '000001' description: type: string nullable: true description: Descrição da viagem. example: Lua de mel custom_fields: type: object description: Campos personalizados preenchidos do passageiro, da venda e da viagem. properties: person: type: array description: Campos personalizados do cadastro do passageiro. items: "$ref": "#/components/schemas/custom_field" sale: type: array description: Campos personalizados da venda. items: "$ref": "#/components/schemas/custom_field" travel: type: array description: Campos personalizados da viagem. items: "$ref": "#/components/schemas/custom_field" required: - id - person - name - sale - sale_product - product - supplier - airline_segments - amounts - company - seller - payer - custom_fields passenger_list_response: type: object description: Lista de passageiros paginada. properties: data: type: array description: Passageiros da página. items: "$ref": "#/components/schemas/passenger_list_row" pagination: "$ref": "#/components/schemas/pagination" sales_by_product_named_reference: type: object description: Referência a um registro relacionado, com o nome dele. properties: id: type: string format: uuid description: Identificador do registro referenciado. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: type: string description: Nome do registro referenciado. example: Maria Silva required: - id - name sales_by_product_airline_segment: type: object description: Trecho aéreo do produto. properties: airline_code: type: string description: Código da companhia aérea. example: TP flight_number: type: string nullable: true description: Número do voo. example: '88' class: type: string nullable: true description: Classe tarifária. example: Y origin: type: string description: Aeroporto de origem (IATA). example: GRU departure_date: type: string description: Partida do trecho (ISO 8601). example: '2026-11-10T23:55:00' destination: type: string description: Aeroporto de destino (IATA). example: LIS arrival_date: type: string nullable: true description: Chegada do trecho (ISO 8601). example: '2026-11-11T13:40:00' required: - airline_code - origin - departure_date - destination sales_by_product_row: type: object description: Produto vendido. properties: id: type: string format: uuid description: |- Identificador do produto na venda.
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
example: 2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35 sale: type: object description: |- Venda do produto, com o número, a data e a situação dela.
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. number: type: integer description: Número da venda. example: 1024 date: type: string format: date description: Data da venda. example: '2026-10-01' status: type: string enum: - opened - closed - canceled description: Situação da venda. example: closed required: - id - number - date - status company: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: Empresa da venda, com o nome. seller: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: |- Vendedor da venda, com o nome.
  • Chame o endpoint [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get) para os dados completos.
payer: type: object description: |- Pagante da venda, com o nome, o tipo, o documento e o contato.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. name: type: string description: Nome do registro referenciado. person_kind: type: string enum: - individual - company description: 'Tipo do pagante: `individual` (pessoa física) ou `company` (pessoa jurídica).' example: individual cpf_cnpj: type: string nullable: true description: CPF ou CNPJ do pagante. email: type: string nullable: true description: E-mail do pagante. phone_number: type: string nullable: true description: Telefone do pagante. mobile_number: type: string nullable: true description: Celular do pagante. own_operation: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Operação própria da venda, com o nome. Nula quando a venda não tem.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
requester: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Solicitante da venda, com o nome. Nulo quando a venda não tem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
intermediary: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Intermediário da venda, com o nome. Nulo quando a venda não tem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
approver: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Aprovador da venda, com o nome. Nulo quando a venda não tem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
promoter: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Promotor da venda, com o nome. Nulo quando a venda não tem. Só vem com mais de uma moeda.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
travel: type: object nullable: true description: |- Viagem da venda, com o número e a descrição. Nula quando a venda não está numa viagem.
  • Chame o endpoint [Consultar viagem por ID](#tag/Viagens/paths/~1travels~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. number: type: string nullable: true description: Número da viagem. example: '000001' description: type: string nullable: true description: Descrição da viagem. example: Lua de mel product: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: |- Produto do cadastro, com o nome.
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
supplier: type: object description: |- Fornecedor do produto, com o nome, a cidade, o estado e o país.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
properties: id: type: string format: uuid description: Identificador do registro referenciado. name: type: string description: Nome do registro referenciado. city_name: type: string nullable: true description: Cidade do fornecedor. state_code: type: string nullable: true description: Sigla do estado do fornecedor. country_name: type: string nullable: true description: País do fornecedor. representative: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Representante do fornecedor no produto, com o nome. Nulo quando o produto não tem.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
status: type: string enum: - active - canceled description: 'Situação do produto: `active` ou `canceled`.' example: active departure_date: type: string nullable: true description: Embarque ou início do produto (ISO 8601). Traz a hora quando o produto a tem. example: '2026-11-10T08:30:00' arrival_date: type: string nullable: true description: Chegada ou fim do produto (ISO 8601). Traz a hora quando o produto a tem. example: '2026-11-20' canceled_at: type: string format: date nullable: true description: Data de cancelamento do produto. Nula quando ele não foi cancelado. quantity: type: integer nullable: true description: Quantidade. example: 1 destination: type: string nullable: true enum: - national - international - cruise description: 'Destino do produto: `national`, `international` ou `cruise`.' example: international document: type: string nullable: true description: Documento do produto, como o localizador ou o número da reserva. external_number: type: string nullable: true description: Número externo do produto. O nome com que o campo aparece no Monde é o das Configurações da agência. additional1: type: string nullable: true description: Adicional 1 do produto. O nome com que o campo aparece no Monde é o das Configurações da agência. additional2: type: string nullable: true description: Adicional 2 do produto. O nome com que o campo aparece no Monde é o das Configurações da agência. product_details: type: object description: 'Os detalhes do produto que o Monde mostra conforme o tipo dele: hospedagem, cruzeiro, locação de veículo e pacote. O que não é do tipo do produto vem nulo.' properties: nights: type: integer nullable: true description: Diárias. accommodation_kind: type: string nullable: true description: Tipo de acomodação. room_category: type: string nullable: true description: Categoria do quarto. meal_plan: type: string nullable: true description: Regime de alimentação. cabin_kind: type: string nullable: true description: Tipo da cabine. cabin_number: type: string nullable: true description: Número da cabine. cabin_category: type: string nullable: true description: Categoria da cabine. ship_name: type: string nullable: true description: Nome do navio. cruise_destination: type: string nullable: true description: Destino do navio. vehicle_category: type: string nullable: true description: Categoria do veículo. pickup_location: type: string nullable: true description: Local de retirada do veículo. dropoff_location: type: string nullable: true description: Local de devolução do veículo. package_name: type: string nullable: true description: Nome do pacote. transport: type: string nullable: true description: Transporte do pacote. passengers: type: array description: Passageiros do produto. Lista vazia quando o produto não tem passageiros. items: type: object properties: id: type: string format: uuid nullable: true description: |- Cadastro do passageiro.
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
name: type: string nullable: true description: Nome do passageiro. nfs: type: array description: Notas fiscais do produto que não foram canceladas. Lista vazia quando o produto não tem. items: type: object properties: id: type: string format: uuid description: |- Nota fiscal.
  • Chame o endpoint [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get) para os dados completos.
nfse_number: type: string nullable: true description: Número da NFS-e. airline_segments: type: array description: Trechos aéreos do produto, em ordem de voo. Lista vazia quando o produto não tem trechos. items: "$ref": "#/components/schemas/sales_by_product_airline_segment" amounts: type: object description: Valores do produto na moeda de venda dele, como as colunas de valores do relatório. properties: currency: type: string nullable: true description: Moeda de venda do produto. unit_amount: type: number format: double description: Valor unitário. unit_fees: type: number format: double description: Taxas unitárias. total_products: type: number format: double description: Total dos produtos. fees: type: number format: double description: 'Taxas: a soma das taxas dos passageiros.' other_fees: type: number format: double description: 'Outras taxas: a soma das outras taxas dos passageiros.' total_fees: type: number format: double description: Total das taxas. du_fee: type: number format: double description: Taxa DU. cc_du_fee: type: number format: double description: Taxa de cartão de crédito sobre a taxa DU. cc_du_fee_percentage: type: number format: double description: Taxa de cartão sobre a taxa DU, em percentual da taxa DU. du_fee_discount: type: number format: double description: Desconto da taxa DU. rav_fee: type: number format: double description: Taxa RAV. cc_rav_fee: type: number format: double description: Taxa de cartão de crédito sobre a taxa RAV. cc_rav_fee_percentage: type: number format: double description: Taxa de cartão sobre a taxa RAV, em percentual da taxa RAV. rav_fee_discount: type: number format: double description: Desconto da taxa RAV. agency_fee: type: number format: double description: Taxa de serviço oculta. agency_service_fee: type: number format: double description: Taxa de serviço destacada. discount: type: number format: double description: Desconto. total_discount: type: number format: double description: Total do desconto. deductions: type: number format: double description: Abatimentos. Não vem com mais de uma moeda. billing: type: number format: double description: Faturamento. total_amount: type: number format: double description: Valor total. customer_refund: type: number format: double description: Reembolso ao cliente. supplier_refund: type: number format: double description: Reembolso do fornecedor. agency_card_rate: type: number format: double description: Taxa de cartão da agência. supplier_fine: type: number format: double description: Multa do fornecedor. deleted_balance: type: number format: double description: Saldo excluído. kandir_retention: type: number format: double description: 'Retenção da Lei Kandir: a soma das retenções sobre o valor, a taxa de serviço, as taxas DU e RAV e a taxa de embarque.' origin_amounts: type: object description: Valores do produto na moeda de origem, com o câmbio da operadora. properties: currency: type: string nullable: true description: Moeda de origem do produto. exchange_rate: type: number format: double description: Câmbio da operadora. total_products: type: number format: double description: Total dos produtos. Na moeda de origem. total_fees: type: number format: double description: Total das taxas. Na moeda de origem. agency_fee: type: number format: double description: Taxa de serviço oculta. Na moeda de origem. du_fee: type: number format: double description: Taxa DU. Na moeda de origem. deductions: type: number format: double description: Abatimentos. Não vem com mais de uma moeda. Na moeda de origem. agency_service_fee: type: number format: double description: Taxa de serviço destacada. Na moeda de origem. discount: type: number format: double description: Desconto. Na moeda de origem. du_fee_discount: type: number format: double description: Desconto da taxa DU. Na moeda de origem. rav_fee_discount: type: number format: double description: Desconto da taxa RAV. Na moeda de origem. total_amount: type: number format: double description: Valor total. Na moeda de origem. commission: type: object description: Comissão, over e receitas do produto. Só vem nas empresas em que a credencial tem a permissão Visualizar comissão, over e receitas. properties: commission_amount: type: number format: double description: Comissão. commission_percentage: type: number format: double description: Comissão, em percentual. over: type: number format: double description: 'Over sobre: a base sobre a qual o over é calculado. Não vem com mais de uma moeda.' over_amount: type: number format: double description: Over. over_percentage: type: number format: double description: Over, em percentual. intermediary_commission_amount: type: number format: double description: Comissão do intermediário. intermediary_commission_percentage: type: number format: double description: Comissão do intermediário, em percentual. intermediary_over_amount: type: number format: double description: Over do intermediário. intermediary_over_percentage: type: number format: double description: Over do intermediário, em percentual. revenue: type: number format: double description: Receitas. revenue_percentage: type: number format: double description: Receitas, em percentual do faturamento. custom_fields: type: object description: Campos personalizados preenchidos do pagante, da venda e da viagem. properties: person: type: array description: Campos personalizados do cadastro do pagante. items: "$ref": "#/components/schemas/custom_field" sale: type: array description: Campos personalizados da venda. items: "$ref": "#/components/schemas/custom_field" travel: type: array description: Campos personalizados da viagem. items: "$ref": "#/components/schemas/custom_field" required: - id - sale - company - seller - payer - product - supplier - status - product_details - passengers - airline_segments - amounts - origin_amounts - custom_fields sales_by_product_response: type: object description: Vendas por produto paginadas. properties: data: type: array description: Produtos da página. items: "$ref": "#/components/schemas/sales_by_product_row" pagination: "$ref": "#/components/schemas/pagination" sales_by_seller_row: type: object description: Vendas de um vendedor numa empresa, somadas. properties: seller: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: |- Vendedor, com o nome.
  • Chame o endpoint [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: Empresa das vendas somadas na linha, com o nome. sales_count: type: integer description: 'Total Vendas: quantas vendas do vendedor entram na soma.' example: 12 products_count: type: integer description: 'Total Produtos: quantos produtos vendidos entram na soma.' example: 18 amounts: type: object description: Valores somados dos produtos, como as colunas de valores do relatório. properties: total_amount: type: number format: double description: 'Valor Total de Vendas: (Total Produto + Taxa de Serviço Oculta - Abatimentos) + Total Taxas + (Taxa DU - Desconto Taxa DU) + (Taxa RAV - Desconto Taxa RAV) + Taxa Serviço Destacada - Desconto.' billing: type: number format: double description: 'Faturamento: (Produtos - Abatimentos - Desconto) + Taxa DU + Taxa RAV + Taxa Serviço Destacada + Taxa de Serviço Oculta.' total_products: type: number format: double description: Valor Total Produtos. total_fees: type: number format: double description: 'Total Taxas: Taxas + Outras Taxas.' du_fee: type: number format: double description: Taxa DU. cc_du_fee: type: number format: double description: 'Taxa CC DU: taxa de cartão de crédito sobre a taxa DU.' du_fee_discount: type: number format: double description: Desconto Taxa DU. rav_fee: type: number format: double description: Taxa RAV. cc_rav_fee: type: number format: double description: 'Taxa CC RAV: taxa de cartão de crédito sobre a taxa RAV.' rav_fee_discount: type: number format: double description: Desconto Taxa RAV. agency_fee: type: number format: double description: Taxa de Serviço Oculta. agency_service_fee: type: number format: double description: Taxa Serviço Destacada. discount: type: number format: double description: Desconto. deductions: type: number format: double description: Abatimentos. required: - total_amount - billing - total_products - total_fees - du_fee - cc_du_fee - du_fee_discount - rav_fee - cc_rav_fee - rav_fee_discount - agency_fee - agency_service_fee - discount - deductions commission: type: object description: Comissão, over e receitas somados dos produtos. properties: commission_amount: type: number format: double description: Comissão. over_amount: type: number format: double description: Over. intermediary_commission_amount: type: number format: double description: Comissão Intermediário. intermediary_over_amount: type: number format: double description: Over Intermediário. revenue: type: number format: double description: 'Receitas: (Taxa DU + Taxa RAV + Taxa Serviço Destacada + Taxa de Serviço Oculta + Comissão + Over + Reembolso Fornecedor) - (Desconto + Desconto Taxa DU + Desconto Taxa RAV + Taxa CC DU + Taxa CC RAV + Taxa Cartão Agência + Comissão Intermediário + Over Intermediário + Reembolso Cliente + Multa Fornecedor + Saldo Excluído).' required: - commission_amount - over_amount - intermediary_commission_amount - intermediary_over_amount - revenue required: - seller - company - sales_count - products_count - amounts - commission sales_by_seller_response: type: object description: Vendas por vendedor paginadas. properties: data: type: array description: Vendedores da página. items: "$ref": "#/components/schemas/sales_by_seller_row" pagination: "$ref": "#/components/schemas/pagination" cvc_statement_summary: type: object description: 'Representa um recibo do extrato CVC na consulta: apenas os campos do próprio recibo.' properties: id: &687 type: string format: uuid description: Identificador único do recibo do extrato CVC example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 receipt_number: &688 type: string nullable: true description: Número do recibo, nulo no movimento que não se refere a um recibo example: '89930000112199' movement_date: &689 type: string format: date description: Data da movimentação example: '2019-12-26' sale_date: &690 type: string format: date-time nullable: true description: Data da venda registrada no recibo example: '2019-12-26T18:00:00' cancellation_date: &691 type: string format: date-time nullable: true description: Data de cancelamento registrada no recibo example: boarding_date: &692 type: string format: date nullable: true description: Data de embarque registrada no recibo example: '2020-09-01' return_date: &693 type: string format: date nullable: true description: Data de retorno registrada no recibo example: '2020-09-09' product_name: &694 type: string nullable: true description: 'Nome do produto como veio no extrato da CVC, em texto livre. Não é o produto cadastrado no sistema: para chegar ao produto da venda, use a referência sale_product' example: Excursões Internacionais package_name: &695 type: string nullable: true description: Nome do pacote como veio no extrato da CVC, em texto livre example: SANTIAGO total_payments: &696 type: number format: double description: Total dos lançamentos do movimento example: 347.89 total_taxes: &697 type: number format: double description: Total das taxas do movimento example: 0.0 total_discounts: &698 type: number format: double description: Total dos descontos do movimento example: 0.0 total_abatement: &699 type: number format: double description: Total dos abatimentos do movimento example: 0.0 calculated_commission: &700 type: number format: double description: Comissão calculada do movimento example: 111.33 retained_commission: &701 type: number format: double description: Comissão retida do movimento example: 0.0 intermediary_commission: &702 type: number format: double description: Comissão do intermediário no movimento example: 0.0 deposit: &703 type: number format: double description: Valor do depósito do movimento example: 34.78 opfax: &704 type: number format: double description: Valor do movimento em OPFAX example: 0.0 opfax_balance: &705 type: number format: double description: Saldo consolidado do par de recibos gerado quando o lançamento é em OPFAX parcial, gravado igual nas duas linhas. Não é o valor do movimento em OPFAX, que vem em opfax example: 0.0 balance: &706 type: number format: double description: Saldo do movimento example: 76.55 imported: &707 type: boolean description: Indica que o registro veio da importação do extrato example: true edited: &708 type: boolean description: Indica que o registro foi alterado manualmente depois de importado example: false checked: &709 type: boolean description: Marca de conferência do recibo example: false deleted: &710 type: boolean description: Indica que o recibo foi excluído. Sempre falso na consulta, que não retorna recibo excluído; na consulta por ID, é verdadeiro quando o recibo foi excluído example: false created_at: &711 type: string format: date-time nullable: true description: Data e hora em que o registro foi cadastrado example: '2019-12-30T08:45:48' required: - id - movement_date - balance - deleted cvc_statement: type: object description: Representa um recibo do extrato CVC com o tipo do movimento e as referências para as entidades relacionadas. properties: id: *687 receipt_number: *688 movement_date: *689 sale_date: *690 cancellation_date: *691 boarding_date: *692 return_date: *693 product_name: *694 package_name: *695 total_payments: *696 total_taxes: *697 total_discounts: *698 total_abatement: *699 calculated_commission: *700 retained_commission: *701 intermediary_commission: *702 deposit: *703 opfax: *704 opfax_balance: *705 balance: *706 imported: *707 edited: *708 checked: *709 deleted: *710 created_at: *711 movement_kind: type: object description: Tipo do movimento, com o nome como a CVC o classifica no extrato properties: code: type: integer description: Código do tipo do movimento na CVC, como vem no extrato (por exemplo, 0 baixa de recibo, 3 baixa de OPFAX, 11 ajuste manual) example: 0 name: type: string description: Nome do tipo do movimento example: BAIXA DE RECIBO required: - code - name company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa do recibo
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
contractor: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que consta como contratante no recibo
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que consta como vendedor no recibo, que não é necessariamente uma pessoa cadastrada como vendedor
  • Chame o endpoint [Consultar vendedor por ID](#tag/Vendedores/paths/~1sellers~1{id}/get) para os dados completos.
intermediary: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que consta como intermediário no recibo
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Venda vinculada ao recibo, nula quando o movimento não tem venda
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Produto da venda vinculado ao recibo. O identificador aparece no produto correspondente dentro da venda
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
nf: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Nota fiscal emitida para o recibo
  • Chame o endpoint [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que cadastrou o registro
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
required: - id - movement_date - balance - deleted - movement_kind - company cvc_statements_response: type: object description: Resposta contendo a lista de recibos do extrato CVC com informações de paginação. properties: data: type: array description: Array contendo os recibos da página atual. items: "$ref": "#/components/schemas/cvc_statement_summary" pagination: "$ref": "#/components/schemas/pagination" nf_item: type: object description: Representa um item da nota fiscal. properties: id: type: string format: uuid description: Identificador único do item da nota fiscal example: 2b7f0c94-6e1a-4d38-a5c2-9f4e1b7d3a60 local_id: type: string description: Identificador que o item trouxe na requisição, devolvido só na resposta da escrita para correlacionar o item enviado ao gravado. Não é gravado example: linha-1 description: type: string description: Descrição do item da nota fiscal example: Prestação de serviço de intermediação de venda de Passagem Aérea amount: type: number format: double description: Valor total do item example: 113.48 service_amount: type: number format: double description: Valor dos serviços do item example: 2613.82 approximate_taxes_amount: type: number format: double description: Valor aproximado dos tributos do item example: 0.0 required: - id - description - amount nf_summary: type: object description: 'Representa uma nota fiscal na consulta: apenas os campos da própria nota.' properties: id: &712 type: string format: uuid description: Identificador único da nota fiscal example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 number: &713 type: integer nullable: true description: Número da nota fiscal, nulo enquanto ela não recebeu numeração example: 982677 series: &714 type: string nullable: true description: Série da nota fiscal example: '1' issue_date: &715 type: string format: date description: Data de emissão da nota fiscal example: '2023-01-13' status: &716 type: string enum: - unissued - issued - processing - processing_cancellation - awaiting_processing - canceled - awaiting_issue - awaiting_cancellation description: |- Situação da nota fiscal.
  • unissued: não emitida.
  • issued: emitida.
  • processing: nota transmitida, aguardando o retorno.
  • processing_cancellation: cancelamento transmitido, aguardando o retorno.
  • awaiting_processing: nota ainda não transmitida, na fila de emissão.
  • canceled: cancelada.
  • awaiting_issue: aguardando emissão.
  • awaiting_cancellation: aguardando cancelamento.
example: issued operation_nature: &717 type: string description: Natureza da operação declarada na nota fiscal example: Prestação de Serviço cfop: &718 type: string nullable: true description: Código Fiscal de Operações e Prestações (CFOP) da nota fiscal example: '5933' nbs_code: &719 type: string nullable: true description: Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal example: 1.2004.10.00 document: &720 type: string nullable: true description: Documento gravado na nota fiscal, usado para conciliá-la com o documento de origem example: '9572810403321' manual_emission: &721 type: boolean description: Indica que a nota foi emitida manualmente, com o número da NFS-e informado por quem a emitiu example: false amount: &722 type: number format: double description: Valor total da nota fiscal, base de cálculo dos tributos example: 113.48 service_amount: &723 type: number format: double description: Valor total dos serviços da nota fiscal example: 2613.82 net_amount: &724 type: number format: double description: 'Valor líquido da nota fiscal: o valor total menos as retenções de PIS, COFINS, IR, CSLL e do ISS retido na fonte' example: 113.48 approximate_taxes_percentage: &725 type: number format: double description: Percentual aproximado dos tributos da nota fiscal example: 0.0 approximate_taxes_amount: &726 type: number format: double description: Valor aproximado dos tributos da nota fiscal example: 0.0 observations: &727 type: string nullable: true description: Observações da nota fiscal example: Nota emitida conforme contrato 4471. cvc_original_data: &728 type: string nullable: true description: Dados originais da nota importada do arquivo da CVC, como o Monde mostra na aba CVC da nota fiscal ("Dados importados do arquivo"). Só leitura. Nulo quando a nota não veio desse arquivo example: |- Série: Emissão: 03/08/2010 Tomador: Esferatur Passagens e Turismo Ltda Valor Total: 65,69 Documento: 009500220079 Produto: MIAMI - 2 dias e 1 noites printed_at: &729 type: string format: date-time nullable: true description: Data e hora em que a nota fiscal foi impressa ou gerada example: '2023-02-09T17:26:29' canceled_at: &730 type: string format: date-time nullable: true description: Data e hora do cancelamento da nota fiscal example: '2023-03-02T09:14:52' created_at: &731 type: string format: date-time nullable: true description: Data e hora do cadastro da nota fiscal example: '2023-02-09T17:16:14' recipient: &732 type: object description: Dados do tomador gravados na nota fiscal properties: kind: &976 type: string enum: - payer - supplier - representative description: |- Papel do tomador na venda que originou a nota.
  • payer: pagante.
  • supplier: fornecedor.
  • representative: representante.
example: payer name: &977 type: string description: Nome ou razão social do tomador example: Esferatur Passagens e Turismo Ltda cpf_cnpj: &978 type: string nullable: true description: CPF ou CNPJ do tomador, apenas dígitos example: '76530260000130' state_inscription: &979 type: string nullable: true description: Inscrição estadual do tomador example: '2536987410' city_inscription: &980 type: string nullable: true description: Inscrição municipal do tomador example: '1023456' postal_code: &981 type: string nullable: true description: CEP do tomador, apenas dígitos example: '89010300' street: &982 type: string nullable: true description: Logradouro do tomador example: Alameda Rio Branco street_number: &983 type: string nullable: true description: Número do endereço do tomador example: '238' neighborhood: &984 type: string nullable: true description: Bairro do tomador example: Jardim Blumenau additional_info: &985 type: string nullable: true description: Complemento do endereço do tomador example: 1º andar phone: &986 type: string nullable: true description: Telefone do tomador example: "(47) 3221-0100" email: &987 type: string nullable: true description: E-mail do tomador; pode conter vários endereços separados por ponto e vírgula example: financeiro@esferatur.com.br foreign: &988 type: boolean description: Indica que o tomador é estrangeiro example: false foreign_document: &989 type: string nullable: true description: Documento do tomador estrangeiro example: AB1234567 city: &990 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Cidade do tomador
  • Chame o endpoint [Consultar cidade por ID](#tag/Cidades/paths/~1cities~1{id}/get) para os dados completos.
taxes: &733 type: object description: Retenções e tributos da nota fiscal properties: retain_iss: &991 type: boolean description: Indica retenção de ISS na nota fiscal example: false retain_ir: &992 type: boolean description: Indica retenção de IR na nota fiscal example: false retain_pis_cofins_csll: &993 type: boolean description: Indica retenção de PIS, COFINS e CSLL na nota fiscal example: false iss_percentage: &994 type: number format: double description: Percentual de ISS aplicado na nota fiscal example: 5.0 iss_amount: &995 type: number format: double description: Valor de ISS da nota fiscal example: 5.67 pis_percentage: &996 type: number format: double description: Percentual de PIS aplicado na nota fiscal example: 0.0 pis_amount: &997 type: number format: double description: Valor de PIS da nota fiscal example: 0.0 cofins_percentage: &998 type: number format: double description: Percentual de COFINS aplicado na nota fiscal example: 0.0 cofins_amount: &999 type: number format: double description: Valor de COFINS da nota fiscal example: 0.0 ir_percentage: &1000 type: number format: double description: Percentual de IR aplicado na nota fiscal example: 0.0 ir_amount: &1001 type: number format: double description: Valor de IR da nota fiscal example: 0.0 csll_percentage: &1002 type: number format: double description: Percentual de CSLL aplicado na nota fiscal example: 0.0 csll_amount: &1003 type: number format: double description: Valor de CSLL da nota fiscal example: 0.0 nfse: &734 type: object description: Dados da NFS-e correspondente à nota fiscal properties: number: &1004 type: string nullable: true description: Número da NFS-e example: '13299' batch: &1005 type: string nullable: true description: Lote em que a NFS-e foi transmitida example: '8471' protocol: &1006 type: string nullable: true description: Protocolo devolvido na transmissão da NFS-e example: '202302091716140001' verification_code: &1007 type: string nullable: true description: Código de verificação da NFS-e example: BFLXB50A processed_at: &1008 type: string format: date-time nullable: true description: Data e hora do processamento da NFS-e example: '2023-02-09T17:26:29' errors: &1009 type: string nullable: true description: Erro devolvido no processamento da NFS-e, nulo quando não houve erro example: Inscricao municipal do prestador nao encontrada. required: - id - issue_date - status - operation_nature - recipient nf: type: object description: Representa uma nota fiscal com os itens e as referências para as entidades relacionadas. properties: id: *712 number: *713 series: *714 issue_date: *715 status: *716 operation_nature: *717 cfop: *718 nbs_code: *719 document: *720 manual_emission: *721 amount: *722 service_amount: *723 net_amount: *724 approximate_taxes_percentage: *725 approximate_taxes_amount: *726 observations: *727 cvc_original_data: *728 printed_at: *729 canceled_at: *730 created_at: *731 recipient: *732 taxes: *733 nfse: *734 person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa cadastrada a que a nota foi emitida. Os dados do tomador são os do bloco recipient, gravados na nota; o cadastro pode ter mudado desde a emissão. Nula quando o tomador foi informado apenas na nota
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Empresa emitente da nota fiscal
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Produto da venda que originou a nota fiscal. O identificador aparece no produto correspondente dentro da venda
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Venda que originou a nota fiscal
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que cadastrou a nota fiscal. Nula na nota inserida ou copiada pela API: quem a gravou é a credencial, registrada no log
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
canceled_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa que cancelou a nota fiscal, nula enquanto a nota não foi cancelada e quando o cancelamento veio da API, registrado no log com a credencial
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
items: type: array description: Itens da nota fiscal items: "$ref": "#/components/schemas/nf_item" required: - id - issue_date - status - operation_nature - recipient - company - items nf_create: type: object writeOnly: true description: Dados para inserir uma nota fiscal avulsa. Informe o tomador por person_id ou por recipient, nunca pelos dois. required: - company_identifier - items properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: '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: type: string format: date description: Data de emissão da nota fiscal example: '2026-10-16' operation_nature: type: string maxLength: 30 description: Natureza da operação declarada na nota fiscal example: Prestação de Serviço cfop: type: string maxLength: 10 description: Código Fiscal de Operações e Prestações (CFOP) da nota fiscal example: '5933' nbs_code: type: string description: Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal example: '109051200' observations: type: string maxLength: 2000 description: Observações da nota fiscal example: Referente à viagem de outubro person_id: type: string format: uuid nullable: true description: Identificador da pessoa do cadastro que é o tomador. Os dados do tomador e as retenções vêm do cadastro dela example: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 recipient: "$ref": "#/components/schemas/nf_recipient_write" taxes: "$ref": "#/components/schemas/nf_taxes_write" items: type: array description: Itens da nota fiscal items: "$ref": "#/components/schemas/nf_item_write" nf_update: type: object writeOnly: true description: Dados para editar a nota fiscal não emitida. O campo omitido permanece como está. properties: issue_date: type: string format: date description: Data de emissão da nota fiscal example: '2026-10-16' operation_nature: type: string maxLength: 30 description: Natureza da operação declarada na nota fiscal example: Prestação de Serviço cfop: type: string maxLength: 10 description: Código Fiscal de Operações e Prestações (CFOP) da nota fiscal example: '5933' nbs_code: type: string description: Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal example: '109051200' observations: type: string maxLength: 2000 description: Observações da nota fiscal example: Referente à viagem de outubro person_id: type: string format: uuid nullable: true description: Identificador da pessoa do cadastro que é o tomador. Os dados do tomador e as retenções vêm do cadastro dela example: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 recipient: "$ref": "#/components/schemas/nf_recipient_write" taxes: "$ref": "#/components/schemas/nf_taxes_write" items: type: array description: Itens da nota fiscal items: "$ref": "#/components/schemas/nf_item_write" nf_recipient_write: type: object writeOnly: true description: 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á. properties: name: type: string description: Nome ou razão social do tomador example: Esferatur Passagens e Turismo Ltda cpf_cnpj: type: string description: CPF ou CNPJ do tomador, apenas dígitos example: '76530260000130' state_inscription: type: string description: Inscrição estadual do tomador example: '254174250' city_inscription: type: string description: Inscrição municipal do tomador example: '4471' postal_code: type: string description: CEP do tomador, apenas dígitos example: '89010300' street: type: string description: Logradouro do tomador example: Alameda Rio Branco street_number: type: string description: Número do endereço do tomador example: '238' neighborhood: type: string description: Bairro do tomador example: Jardim Blumenau additional_info: type: string description: Complemento do endereço do tomador example: 1º andar phone: type: string description: Telefone do tomador example: "(47) 3221-0100" email: type: string description: E-mail do tomador; pode conter vários endereços separados por ponto e vírgula example: financeiro@esferatur.com.br foreign: type: boolean description: Indica que o tomador é estrangeiro example: false foreign_document: type: string description: Documento do tomador estrangeiro example: X1234567 city_id: type: string format: uuid description: Identificador da cidade do tomador example: 0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92 nf_taxes_write: type: object writeOnly: true description: '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.' properties: retain_iss: type: boolean description: Indica retenção de ISS na nota fiscal example: false retain_ir: type: boolean description: Indica retenção de IR na nota fiscal example: false retain_pis_cofins_csll: type: boolean description: Indica retenção de PIS, COFINS e CSLL na nota fiscal example: false nf_item_write: type: object writeOnly: true description: Item da nota. Com id, é um item existente que permanece, mudando só o que veio; sem id, é um item novo, e descrição e valor são obrigatórios. properties: id: type: string format: uuid description: Identificador único do item da nota fiscal example: f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13 local_id: type: string description: Identificador que o item trouxe na requisição, devolvido só na resposta da escrita para correlacionar o item enviado ao gravado. Não é gravado example: linha-1 description: type: string maxLength: 250 description: Descrição do item da nota fiscal example: Intermediação de hospedagem amount: type: number format: double description: Valor total do item example: 1500.0 service_amount: type: number format: double nullable: true description: Valor dos serviços do item example: 1500.0 nf_manual_issuance: type: object writeOnly: true description: Número da NFS-e emitida na prefeitura. required: - nfse_number properties: nfse_number: type: string maxLength: 20 description: Número da NFS-e gerado pela prefeitura, com até 20 caracteres example: '4521' nf_amount_adjustment: type: object writeOnly: true description: Percentual do ajuste de valor. required: - percentage properties: percentage: type: number format: double description: 'Percentual do ajuste, diferente de zero: positivo aumenta o valor, negativo reduz (ex.: -10 reduz 10%)' example: -10 nf_written_reference: type: object description: 'Resposta da escrita para quem não pode ler notas fiscais na empresa: o identificador da nota e, de cada item enviado, o identificador e o local_id.' properties: id: type: string format: uuid description: Identificador único da nota fiscal example: a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35 items: type: array description: Itens da nota fiscal items: type: object properties: id: type: string format: uuid description: Identificador único do item da nota fiscal local_id: type: string description: Identificador que o item trouxe na requisição, devolvido só na resposta da escrita para correlacionar o item enviado ao gravado. Não é gravado required: - id nfs_response: type: object description: Resposta contendo a lista de notas fiscais com informações de paginação. properties: data: type: array description: Array contendo as notas fiscais da página atual. items: "$ref": "#/components/schemas/nf_summary" pagination: "$ref": "#/components/schemas/pagination" nf_generation_draft: type: object description: Uma nota fiscal que a geração gravaria, montada pela regra de nota fiscal, ainda sem número. properties: recipient: type: object description: Tomador da nota. Os demais dados do tomador seguem os de [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get) properties: kind: type: string enum: - payer - supplier - representative description: |- Papel do tomador na regra de nota fiscal.
  • payer: pagante.
  • supplier: fornecedor.
  • representative: representante.
example: payer name: type: string description: Nome ou razão social do tomador example: Maria Souza cpf_cnpj: type: string nullable: true description: CPF ou CNPJ do tomador, apenas dígitos example: '52998224725' person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Pessoa do tomador
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
issue_date: type: string format: date description: Data de emissão que a nota terá, conforme a configuração da empresa de referência (data da venda, do embarque ou o dia da geração) example: '2026-10-16' operation_nature: type: string nullable: true description: Natureza da operação declarada na nota fiscal example: Prestação de Serviço cfop: type: string nullable: true description: Código Fiscal de Operações e Prestações (CFOP) da nota fiscal example: nbs_code: type: string nullable: true description: Código da Nomenclatura Brasileira de Serviços (NBS) da nota fiscal example: amount: type: number format: double description: 'Valor da nota: o resultado da fórmula menos o que as notas anteriores do mesmo produto e tomador já cobriram' example: 120.0 service_amount: type: number format: double description: Valor total dos serviços da nota fiscal example: 1500.0 net_amount: type: number format: double description: 'Valor líquido da nota fiscal: o valor total menos as retenções de PIS, COFINS, IR, CSLL e do ISS retido na fonte' example: 120.0 taxes: type: object description: Retenções e impostos calculados como a nota sairia, no mesmo formato de `taxes` em [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get) nf_rule: allOf: - "$ref": "#/components/schemas/entity_reference" description: Regra de nota fiscal que montou a nota. Consulte a regra em [Consultar regra da nota fiscal por ID](#tag/Regras-da-Nota-Fiscal/paths/~1nf_rules~1{id}/get) nf_rule_description: type: string description: Descrição da regra de nota fiscal example: Regra do pagante formula: type: string description: Fórmula da regra que definiu o valor do serviço example: Taxa de Serviço complementary: type: boolean description: Indica se a nota complementa outra já gerada para o mesmo produto e tomador example: false generatable: type: boolean description: Indica se a nota pode ser gerada. Só a nota com `true` entra no pedido de geração example: true error: type: string nullable: true description: O motivo de a nota não poder ser gerada, como o valor negativo; nulo quando pode example: nf_generation: type: object description: Um produto vendido com as notas fiscais que já tem e as que a geração gravaria. properties: sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto da venda
  • Chame o endpoint o `id` do produto na venda, em [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Venda do produto
  • Chame o endpoint [Consultar venda por ID](#tag/Vendas/paths/~1sales~1{id}/get) para os dados completos.
company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Empresa da venda, que é a empresa das notas
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
sale_number: type: integer description: Número da venda example: 1532 sale_date: type: string format: date description: Data da venda example: '2026-10-05' product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Produto do cadastro
  • Chame o endpoint [Consultar produto por ID](#tag/Produtos/paths/~1products~1{id}/get) para os dados completos.
payer: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Pagante da venda
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Fornecedor do produto
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Representante do produto, nulo quando não há
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
start_date: type: string format: date nullable: true description: Data de início do produto example: '2026-11-10' end_date: type: string format: date nullable: true description: Data de fim do produto example: '2026-11-20' total_amount: type: number format: double description: Valor total do produto example: 1500.0 revenues: type: number format: double description: Receita do produto que as notas podem cobrir, já sem os reembolsos example: 120.0 nfs_amount: type: number format: double nullable: true description: Soma das notas do produto, as existentes e as que a geração gravaria; nulo quando a soma é negativa example: 120.0 balance: type: number format: double description: Receita menos a soma das notas example: 0.0 valid: type: boolean description: Indica se o produto está sem erros. Produto inválido não gera nota example: true errors: type: array description: Os motivos de o produto estar inválido, como a falta de regra de nota fiscal aplicável ou o CPF/CNPJ inválido do tomador items: type: string existing_nfs: type: array description: As notas não canceladas que o produto já tem; os dados de cada uma estão em [Consultar nota fiscal por ID](#tag/Notas-Fiscais/paths/~1nfs~1{id}/get) items: "$ref": "#/components/schemas/entity_reference" new_nfs: type: array description: As notas que a geração gravaria items: "$ref": "#/components/schemas/nf_generation_draft" nf_generations_response: type: object description: Resposta da consulta das notas a gerar, com o momento da consulta e a paginação. properties: data: type: array description: Os produtos da página atual. items: "$ref": "#/components/schemas/nf_generation" previewed_at: type: string format: date-time description: Momento da consulta, com fração de segundo. Envie-o no pedido de geração example: '2026-10-16T10:15:30.123456-03:00' pagination: "$ref": "#/components/schemas/pagination" nf_generation_create: type: object description: 'O pedido de geração: as notas escolhidas na consulta das notas a gerar.' required: - company_identifier - previewed_at - nfs properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ da empresa de referência, a mesma da consulta das notas a gerar previewed_at: type: string format: date-time description: O `previewed_at` devolvido pela consulta que mostrou estas notas. Nota gravada depois dele para algum dos produtos recusa a geração com 409 example: '2026-10-16T10:15:30.123456-03:00' include_without_revenue: type: boolean default: false description: 'O mesmo valor usado na consulta: com `true`, as notas de valor zero dos produtos sem receita também podem ser geradas. Padrão: `false`' example: false nfs: type: array minItems: 1 maxItems: 500 description: As notas a gerar, no máximo 500 por pedido, sem repetir a mesma nota items: type: object required: - sale_product_id - recipient_kind properties: sale_product_id: type: string format: uuid description: O `sale_product.id` do produto na consulta das notas a gerar example: 9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8 recipient_kind: type: string enum: - payer - supplier - representative description: O `recipient.kind` da nota na consulta das notas a gerar example: payer nf_generation_created: type: object description: As notas fiscais geradas. properties: data: type: array description: As notas geradas, completas, ou só com o `id` para quem não consulta notas fiscais na empresa delas. items: "$ref": "#/components/schemas/nf" log_summary: type: object description: 'Representa uma linha do histórico na consulta: apenas os campos da própria linha.' properties: id: &735 type: string format: uuid description: Identificador único da linha do histórico example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 kind: &736 type: string enum: - insertion - edition - deletion - custom - export - email description: |- Ação registrada.
  • insertion: cadastro do registro.
  • edition: alteração do registro.
  • deletion: exclusão do registro.
  • custom: ação personalizada da tela que gerou o registro.
  • export: exportação de dados.
  • email: e-mail enviado pelo registro, como o boleto ou a fatura de uma conta a pagar ou receber. A descrição traz os destinatários e os arquivos anexados.
example: edition origin: &737 type: string nullable: true description: Origem da alteração. O conjunto é aberto e cresce conforme novas telas passam a registrar histórico, então trate o valor como texto livre. Os valores conhecidos são cidade, conta, conta_cobranca, conta_movimento, conta_receber, cvc_extrato, financeiro, financeiro_categoria, financeiro_item, nota_fiscal, pessoa, regra_nota_fiscal, tarefa, usuario, vendas, vendas_produtos e viagem. Uma exportação de relatório grava o nome da tela no lugar do recurso, como em vendas por produto. Nulo em registros antigos, gravados antes de a origem passar a ser preenchida. example: financeiro_categoria description: &738 type: string description: Descrição da alteração, no texto gravado no momento em que ela ocorreu. Traz uma linha por campo alterado, separadas por quebra de linha CRLF, que no JSON chega escapada como \r\n. No log gravado por uma requisição da API, a primeira linha nomeia a ação e a credencial que a fez, e os campos alterados vêm nas linhas seguintes example: Valor de "10" para "20" created_at: &739 type: string format: date-time description: Data e hora em que a alteração foi registrada example: '2026-08-05T09:12:33' required: - id - kind - description - created_at log: type: object description: Representa uma linha do histórico com as referências para o autor e para o registro auditado. properties: id: *735 kind: *736 origin: *737 description: *738 created_at: *739 person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Autor da alteração. Nulo quando o registro foi gerado pelo sistema ou pela API
  • Chame o endpoint [Consultar pessoa por ID](#tag/Pessoas/paths/~1people~1{id}/get) para os dados completos.
resource: allOf: - "$ref": "#/components/schemas/entity_reference" description: 'Registro auditado. É sempre o registro principal: em uma alteração de categoria ou de item de um lançamento financeiro o identificador é o do lançamento, e em uma alteração de produto da venda é o da venda' required: - id - kind - description - created_at - resource logs_response: type: object description: Resposta contendo a lista de logs com informações de paginação. properties: data: type: array description: Array contendo os logs da página atual. items: "$ref": "#/components/schemas/log_summary" pagination: "$ref": "#/components/schemas/pagination" custom_field_definition: type: object description: 'Representa a definição de um campo personalizado: o identificador e os metadados do campo.' properties: id: type: integer description: Identificador único do campo personalizado. example: 123 resource: type: string enum: - sales - travels - people - bills - tasks description: Recurso (origem) do campo, no vocabulário público da API. example: sales name: type: string description: Nome do campo personalizado. example: Centro de custo kind: type: string enum: - numeric - currency - text - date - choices description: |- Tipo do valor aceito pelo campo.
  • numeric: número inteiro.
  • currency: valor monetário.
  • text: texto livre.
  • date: data.
  • choices: uma das opções cadastradas (ver choices).
example: choices required: type: boolean description: Indica se o campo é obrigatório no recurso ao qual ele está associado. example: true active: type: boolean description: Indica se o campo está ativo. example: true choices: type: array items: type: string description: Opções cadastradas de um campo do tipo lista (choices). Vazio nos demais tipos. example: - Matriz - Filial required: - id - resource - name - kind - required - active - choices custom_fields_response: type: object description: Resposta contendo a lista de campos personalizados com informações de paginação. properties: data: type: array description: Array contendo os campos personalizados da página atual. items: "$ref": "#/components/schemas/custom_field_definition" pagination: "$ref": "#/components/schemas/pagination" commission_plan_summary: type: object description: Representa um plano de comissão na consulta em lista. properties: id: type: string format: uuid description: Identificador único do plano de comissão example: 6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d description: type: string description: Nome do plano example: Plano padrão required: - id - description commission_plan: description: Representa um plano de comissão, com as faixas de meta. allOf: - "$ref": "#/components/schemas/commission_plan_summary" - type: object properties: goal_ranges: type: array description: Faixas de meta do plano, pelo percentual atingido. items: "$ref": "#/components/schemas/commission_plan_goal_range" required: - goal_ranges commission_plan_goal_range: type: object description: Faixa de meta do plano. properties: id: type: string format: uuid description: Identificador da faixa, usado para mantê-la na alteração achieved_percentage: type: number description: Percentual da meta do mês a partir do qual a faixa vale (o "Percentual atingido da meta" do Monde) example: 100.0 products: type: array description: Produtos da faixa. A entrada com `product` nulo vale para todos os produtos. items: "$ref": "#/components/schemas/commission_plan_product" required: - id - achieved_percentage - products commission_plan_product: type: object description: Produto da faixa, com os valores de cada função. properties: id: type: string format: uuid description: Identificador da entrada do produto na faixa, usado para mantê-la na alteração product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Produto da entrada. Nulo na entrada de todos os produtos. rules: type: array description: Valores de comissão de cada função no produto. items: "$ref": "#/components/schemas/commission_plan_rule" required: - id - product - rules commission_plan_rule: type: object description: Valores de comissão de uma função no produto da faixa. properties: id: type: string format: uuid description: Identificador da regra, usado para mantê-la na alteração person_role: allOf: - "$ref": "#/components/schemas/entity_reference" description: Função comissionada commission_type: &740 type: string enum: - percentage - amount description: "`percentage` para um percentual sobre os campos da venda, `amount` para um valor fixo por produto vendido. Omitido na regra nova, vale `percentage`." example: percentage percentage: &741 type: number description: Percentual da comissão, com até 4 casas decimais, não negativo. Na comissão `amount`, é ignorado e gravado zerado. example: 5.0 amount: &742 type: number description: Valor fixo da comissão por produto vendido, não negativo. Na comissão `percentage`, é ignorado e gravado zerado. example: 0.0 calculated_on: &743 type: array description: 'Campos da venda sobre os quais o percentual é calculado (o "Sobre" do Monde). Descontos (`discount`, `rav_fee_discount`, `du_fee_discount`), taxas de cartão (`cc_du_fee`, `cc_rav_fee`, `agency_card_rate`), abatimentos (`deductions`) e o saldo excluído (`deleted_balance`) são subtraídos; os reembolsos (`customer_refund`, `vendor_refund`) e a multa do fornecedor (`supplier_fine`) entram com o sinal que têm na receita: o reembolso ao cliente, o reembolso pago ao fornecedor e a multa diminuem o valor; a comissão e o over do intermediário (`intermediary_commission_amount`, `intermediary_over_amount`) são subtraídos para toda função que não seja a de intermediário; os demais somam. `revenue` não pode ir junto com os valores que a compõem. Obrigatório, com ao menos um campo, na comissão `percentage`; na `amount`, é ignorado e gravado vazio.' items: type: string enum: - total_amount - products_total - taxes_total - revenue - du_fee - rav_fee - agency_service_fee - agency_fee - commission_amount - over_amount - cc_du_fee - cc_rav_fee - discount - intermediary_commission_amount - intermediary_over_amount - rav_fee_discount - du_fee_discount - deductions - vendor_refund - customer_refund - agency_card_rate - supplier_fine - deleted_balance example: - commission_amount - over_amount differentiate_intermediary: type: boolean description: '`true` quando a venda que tem intermediário usa os valores de `with_intermediary` (a "Comissão diferenciada em vendas com Intermediário" do Monde)' example: false with_intermediary: "$ref": "#/components/schemas/commission_plan_intermediary_values" required: - id - person_role - commission_type - percentage - amount - calculated_on - differentiate_intermediary - with_intermediary commission_plan_intermediary_values: type: object description: 'Valores da comissão na venda que tem intermediário, usados quando `differentiate_intermediary` é `true`. Mesmas regras de `commission_type`, `percentage`, `amount` e `calculated_on`. Com `differentiate_intermediary` `false`, ficam zerados: tipo `percentage`, valores 0 e nenhum campo.' properties: commission_type: *740 percentage: *741 amount: *742 calculated_on: *743 goal: type: object description: Representa a meta de uma pessoa numa função em um ano. properties: id: type: string format: uuid description: Identificador único da meta example: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a person_role: allOf: - "$ref": "#/components/schemas/entity_reference" description: Função da pessoa person: allOf: - "$ref": "#/components/schemas/entity_reference" description: Pessoa commission_plan: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Plano de comissão da pessoa na função, do cadastro de funções. Nulo quando a pessoa não tem plano. year: type: integer description: Ano da meta example: 2026 months: "$ref": "#/components/schemas/goal_months" required: - id - person_role - person - commission_plan - year - months goal_months: type: object description: Valor da meta de cada mês, de `january` a `december`. properties: january: type: number minimum: 0 example: 50000.0 february: type: number minimum: 0 example: 50000.0 march: type: number minimum: 0 example: 50000.0 april: type: number minimum: 0 example: 50000.0 may: type: number minimum: 0 example: 50000.0 june: type: number minimum: 0 example: 50000.0 july: type: number minimum: 0 example: 50000.0 august: type: number minimum: 0 example: 50000.0 september: type: number minimum: 0 example: 50000.0 october: type: number minimum: 0 example: 50000.0 november: type: number minimum: 0 example: 50000.0 december: type: number minimum: 0 example: 50000.0 bank: type: object description: Representa um banco da tabela de referência. properties: id: type: string format: uuid description: Identificador único do banco. É o valor usado em `bank.id` ao cadastrar uma conta corrente. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 number: type: string maxLength: 5 description: Número (código de compensação) do banco example: '001' name: type: string description: Nome do banco example: Banco do Brasil S.A. required: - id - number - name bank_reconciliation_summary: type: object description: Extrato enviado para conciliar uma conta corrente. properties: id: type: string format: uuid description: Identificador (UUID) do extrato. example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 account: description: Conta corrente conciliada. allOf: - "$ref": "#/components/schemas/entity_reference" file_name: type: string description: Nome do arquivo enviado. example: extrato-janeiro.ofx bank_code: type: string nullable: true description: Código do banco declarado no arquivo. example: '033' branch: type: string nullable: true description: Agência declarada no arquivo. example: '1234' account_number: type: string nullable: true description: Número da conta declarado no arquivo. example: 56789-0 currency: type: string description: Moeda do extrato. example: BRL period_start: type: string format: date description: Início do período do extrato. example: '2025-01-01' period_end: type: string format: date description: Fim do período do extrato. example: '2025-01-31' ledger_balance: type: number nullable: true description: Saldo informado pelo banco. example: 15230.45 ledger_balance_date: type: string format: date nullable: true description: Data do saldo informado pelo banco. example: '2025-01-31' lines: type: object description: O que o envio fez com as linhas do arquivo. properties: inserted: type: integer description: Linhas que o arquivo trouxe pela primeira vez. example: 42 existing: type: integer description: Linhas que a conta já tinha por outro envio. example: 3 corrected: type: integer description: Correções do banco (CORRECTFITID) aplicadas. example: 0 uncorrected: type: integer description: Correções do banco que ficaram pendentes. example: 0 warnings: type: array description: Avisos do confronto do arquivo com a conta (banco, agência ou número que não conferem). items: type: string created_at: type: string description: Data e hora do envio. example: '2025-02-03T10:15:00' bank_reconciliation: type: object description: Extrato com o resumo da conciliação. properties: id: type: string format: uuid description: Identificador (UUID) do extrato. example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 account: description: Conta corrente conciliada. allOf: - "$ref": "#/components/schemas/entity_reference" file_name: type: string description: Nome do arquivo enviado. example: extrato-janeiro.ofx bank_code: type: string nullable: true description: Código do banco declarado no arquivo. example: '033' branch: type: string nullable: true description: Agência declarada no arquivo. example: '1234' account_number: type: string nullable: true description: Número da conta declarado no arquivo. example: 56789-0 currency: type: string description: Moeda do extrato. example: BRL period_start: type: string format: date description: Início do período do extrato. example: '2025-01-01' period_end: type: string format: date description: Fim do período do extrato. example: '2025-01-31' ledger_balance: type: number nullable: true description: Saldo informado pelo banco. example: 15230.45 ledger_balance_date: type: string format: date nullable: true description: Data do saldo informado pelo banco. example: '2025-01-31' lines: type: object description: O que o envio fez com as linhas do arquivo. properties: inserted: type: integer description: Linhas que o arquivo trouxe pela primeira vez. example: 42 existing: type: integer description: Linhas que a conta já tinha por outro envio. example: 3 corrected: type: integer description: Correções do banco (CORRECTFITID) aplicadas. example: 0 uncorrected: type: integer description: Correções do banco que ficaram pendentes. example: 0 warnings: type: array description: Avisos do confronto do arquivo com a conta (banco, agência ou número que não conferem). items: type: string created_at: type: string description: Data e hora do envio. example: '2025-02-03T10:15:00' situations: type: object description: Quantas linhas há em cada situação, no extrato inteiro. properties: ambiguous: type: integer description: Linhas em que mais de um lançamento empatou. example: 1 bank_only: type: integer description: Linhas sem lançamento no Monde. example: 4 system_only: type: integer description: Lançamentos sem linha no banco. example: 2 suggested: type: integer description: Linhas vinculadas que falta conferir. example: 10 reconciled: type: integer description: Linhas conciliadas. example: 28 pending_count: type: integer description: Quantas falta conciliar. example: 17 reconciled_count: type: integer description: Quantas estão conciliadas. example: 28 balance: type: object description: Confronto do saldo do banco com o do sistema. properties: date: type: string format: date nullable: true description: 'Data do confronto: o fim do período.' example: '2025-01-31' bank: type: number nullable: true description: Saldo do banco, na data informada por ele (`ledger_balance_date`). example: 15230.45 system: type: number description: 'Saldo do sistema na data: saldo inicial da conta mais as movimentações até ela.' example: 15180.45 difference: type: number nullable: true description: Banco menos sistema. Nulo quando o arquivo não traz o saldo do banco ou traz o de outra data que não o fim do período. example: 50.0 bank_reconciliations_response: type: object description: Lista paginada de extratos. properties: data: type: array items: "$ref": "#/components/schemas/bank_reconciliation_summary" pagination: "$ref": "#/components/schemas/pagination" bank_statement_upload: type: object description: Envio do extrato, em multipart/form-data. required: - account_id - file properties: account_id: type: string format: uuid description: Conta corrente ativa a conciliar (UUID). example: 5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b file: type: string format: binary description: Arquivo OFX (.ofx ou .qfx) exportado do internet banking, até 5 MB. transfer: type: object description: Transferência entre duas contas. properties: id: type: string format: uuid description: ID da transferência (o da movimentação de origem). example: 857569b5-2721-4756-a27a-748168e00606 date: type: string format: date description: Data da transferência (ISO 8601, `YYYY-MM-DD`). example: '2026-10-15' amount: type: number format: double description: 'Valor transferido, sempre positivo: sai da conta de origem e entra na de destino.' example: 150.25 description: type: string nullable: true description: Descrição da transferência, com até 100 caracteres. example: Sangria do caixa origin_account: "$ref": "#/components/schemas/entity_reference" destination_account: "$ref": "#/components/schemas/entity_reference" origin_movement: "$ref": "#/components/schemas/entity_reference" destination_movement: "$ref": "#/components/schemas/entity_reference" required: - id - date - amount - origin_account - destination_account - origin_movement - destination_movement transfer_create: type: object description: Dados da transferência a criar. properties: date: type: string format: date description: Data da transferência (ISO 8601, `YYYY-MM-DD`). example: '2026-10-15' origin_account_id: type: string format: uuid description: 'Conta de onde o valor sai: o `id` de uma conta corrente ou caixa ativa de [Contas e Cartões](#tag/Contas-e-Cartoes).' example: ddecf0c0-c13d-43e9-b14b-c394a8bbe853 destination_account_id: type: string format: uuid description: 'Conta onde o valor entra: o `id` de uma conta corrente ou caixa ativa, diferente da de origem.' example: 6e0216e5-5536-4f4b-8c93-36371398b3cf amount: type: number format: double description: Valor a transferir, maior que zero e com até 2 casas decimais. example: 150.25 description: type: string maxLength: 100 nullable: true description: Descrição da transferência, com até 100 caracteres. example: Sangria do caixa required: - date - origin_account_id - destination_account_id - amount transfer_update: type: object description: Campos da transferência a alterar. Todos são opcionais. properties: date: type: string format: date description: Data da transferência (ISO 8601, `YYYY-MM-DD`). example: '2026-10-15' origin_account_id: type: string format: uuid description: 'Conta de onde o valor sai: o `id` de uma conta corrente ou caixa ativa de [Contas e Cartões](#tag/Contas-e-Cartoes).' example: ddecf0c0-c13d-43e9-b14b-c394a8bbe853 destination_account_id: type: string format: uuid description: 'Conta onde o valor entra: o `id` de uma conta corrente ou caixa ativa, diferente da de origem.' example: 6e0216e5-5536-4f4b-8c93-36371398b3cf amount: type: number format: double description: Valor a transferir, maior que zero e com até 2 casas decimais. example: 200 description: type: string maxLength: 100 nullable: true description: Descrição da transferência, com até 100 caracteres. example: Sangria do caixa undo_bank_reconciliation: type: boolean description: 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. example: true transfer_exclusion: type: object description: Confirmação opcional da exclusão. properties: undo_bank_reconciliation: type: boolean description: 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. example: true account_balance: type: object description: Saldo da conta numa data. properties: account: "$ref": "#/components/schemas/entity_reference" date: type: string format: date description: Data do saldo. example: '2026-10-15' currency: type: string description: Moeda da conta (ISO 4217); os valores estão nela. example: BRL balance: type: number format: double description: Saldo ao fim da data. example: 1849.75 cash_closed_until: type: string format: date nullable: true description: Último dia com o caixa fechado; nulo quando o caixa nunca foi fechado. example: '2026-10-10' required: - account - date - currency - balance - cash_closed_until account_statement: type: object description: Extrato da conta num período. properties: account: "$ref": "#/components/schemas/entity_reference" currency: type: string description: Moeda da conta (ISO 4217); os valores estão nela. example: BRL date_from: type: string format: date description: Primeiro dia do extrato (ISO 8601, `YYYY-MM-DD`). Obrigatório. example: '2026-10-01' date_to: type: string format: date description: Último dia do extrato (ISO 8601, `YYYY-MM-DD`). Obrigatório; o período tem no máximo 45 dias, como no Monde. example: '2026-10-15' cash_closed_until: type: string format: date nullable: true description: Último dia com o caixa fechado; nulo quando o caixa nunca foi fechado. example: '2026-10-10' opening_balance: type: number format: double description: Saldo ao fim do dia anterior ao período. example: 2000 closing_balance: type: number format: double description: Saldo ao fim do último dia com movimentação no período (ou o de abertura, sem movimentação). example: 1849.75 data: type: array description: Linhas do extrato, na ordem do Monde. items: "$ref": "#/components/schemas/account_statement_entry" required: - account - currency - date_from - date_to - opening_balance - closing_balance - data account_statement_entry: type: object description: Linha do extrato. Os campos de saldo (`balance`, `cash_closed`) vêm nas linhas `opening_balance` e `daily_balance`; os de movimentação, nas linhas `bill_movement` e `transfer`. properties: type: type: string enum: - opening_balance - bill_movement - transfer - daily_balance description: 'Tipo da linha: `opening_balance` (saldo anterior), `bill_movement` (movimentação de um lançamento), `transfer` (movimentação de uma transferência) ou `daily_balance` (saldo ao fim do dia).' example: bill_movement date: type: string format: date description: Data da linha. No saldo anterior, o dia anterior ao período. example: '2026-10-02' balance: type: number format: double description: Saldo ao fim do dia, nas linhas de saldo. example: 2500 cash_closed: type: boolean description: Se o caixa daquele dia está fechado, nas linhas de saldo. example: true account_movement: "$ref": "#/components/schemas/entity_reference" bill: description: Lançamento de [Contas a Pagar e Receber](#tag/Contas-a-Pagar-e-Receber) da movimentação; nulo na transferência. oneOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' sale: description: Venda do lançamento, quando ele veio de uma venda. oneOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' number: type: string nullable: true description: Número do lançamento. example: '1520' description: type: string nullable: true description: Descrição do lançamento; na transferência, a conta do outro lado e a descrição dela. example: Pacote Lisboa document: type: string nullable: true description: Documento do lançamento. example: NF 3321 person: type: object nullable: true description: Pessoa do lançamento, com o nome e o CPF ou CNPJ. properties: name: type: string example: Ana Souza document: type: string nullable: true example: '52998224725' check: type: object nullable: true description: 'Cheque da movimentação: número e banco.' properties: number: type: integer example: 123 bank: type: string nullable: true example: '341' card: type: object nullable: true description: 'Cartão da movimentação: operadora, últimos dígitos e cartão de passagem.' properties: brand: type: string example: Visa last_digits: type: string nullable: true example: '1234' ticket_card: type: string nullable: true example: billet: type: object nullable: true description: 'Boleto do lançamento: número.' properties: number: type: integer example: 4410 amount: type: number format: double description: 'Valor da movimentação: positivo entra, negativo sai.' example: 500 required: - type - date cash_closure_create: type: object description: Dia a fechar e, opcionalmente, o saldo conferido. properties: date: type: string format: date description: Dia até o qual o caixa fica fechado (ISO 8601, `YYYY-MM-DD`). Não pode ser futuro nem anterior ao fechamento atual. example: '2026-10-15' expected_balance: type: number format: double description: Saldo do dia conferido pelo integrador (o `balance` de [Consultar saldo da conta](#tag/Extrato-e-Caixa/paths/~1accounts~1{account_id}~1balance/get) na mesma data). Quando vem e o saldo mudou, o fechamento é recusado com 422. example: 1849.75 required: - date cash_closure: type: object description: Situação do caixa da conta depois do fechamento. properties: account: "$ref": "#/components/schemas/entity_reference" cash_closed_until: type: string format: date description: Último dia com o caixa fechado; nulo quando o caixa nunca foi fechado. example: '2026-10-15' required: - account - cash_closed_until category_group_detail: type: object description: Representa um grupo de categorias financeiras. properties: id: type: string format: uuid description: Identificador único do grupo example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: type: string description: Nome do grupo example: Despesas Administrativas kind: type: string enum: - expense - revenue description: 'Tipo do grupo: `expense` (despesa) ou `revenue` (receita).' example: expense required: - id - name - kind category_group_detail_create: type: object writeOnly: true description: Dados para cadastrar um grupo de categorias. required: - name - kind properties: name: type: string maxLength: 50 description: Nome do grupo, até 50 caracteres. Obrigatório na inclusão. example: Impostos kind: type: string enum: - expense - revenue description: 'Tipo do grupo: `expense` (despesa) ou `revenue` (receita). Obrigatório.' example: expense category_group_detail_update: type: object writeOnly: true description: Dados para alterar um grupo de categorias. Envie só os campos que mudam. properties: name: type: string maxLength: 50 description: Nome do grupo, até 50 caracteres. Obrigatório na inclusão. example: Tributos kind: type: string enum: - expense - revenue description: 'Aceito só com o tipo atual do grupo: outro tipo é recusado com 422.' example: expense category_group_exclusion: type: object description: Confirmação opcional da exclusão. properties: delete_categories: type: boolean description: 'Confirma que a exclusão do grupo exclui também as categorias dele. Sem ela, o grupo com categorias responde 409. Aceita só `true` ou `false`: outro valor responde 422.' example: true webhook: type: object description: Assinatura de webhook da credencial. properties: id: type: string format: uuid description: ID do webhook. url: type: string format: uri description: Endereço https que recebe o POST. description: type: - string - 'null' description: Descrição livre, até 255 caracteres. events: type: array items: type: string description: Eventos assinados, no formato `recurso.ação`. active: type: boolean description: Se o webhook recebe entregas. consecutive_failures: type: integer description: Entregas esgotadas seguidas. Volta a zero na primeira entrega bem-sucedida. disabled_at: type: - string - 'null' format: date-time description: Quando o webhook foi desativado por falhas seguidas. last_error: type: - string - 'null' description: O último erro de entrega. created_at: type: string format: date-time description: Data e hora do cadastro. updated_at: type: string format: date-time description: Data e hora da última alteração. webhook_created: allOf: - "$ref": "#/components/schemas/webhook" - type: object properties: secret: type: string description: O segredo gerado pela API, devolvido só nesta resposta. Ausente quando o segredo foi enviado. webhook_write: type: object description: Campos do webhook. Na criação, `url` e `events` são obrigatórios; na alteração, todos são opcionais. properties: url: type: string format: uri description: Endereço https que recebe o POST. Endereço de rede interna, local ou reservada é recusado. description: type: - string - 'null' maxLength: 255 description: Descrição livre, até 255 caracteres. events: type: array minItems: 1 items: type: string description: Lista de eventos do catálogo, de recursos que a credencial pode ler. Não pode ser vazia. active: type: boolean description: Se o webhook recebe entregas. secret: type: string minLength: 32 maxLength: 255 writeOnly: true description: Chave do HMAC-SHA256 da assinatura, de 32 a 255 caracteres. Só de gravação. webhook_delivery: type: object description: Entrega de um evento ao webhook. properties: id: type: string format: uuid description: ID da entrega, o mesmo do cabeçalho `X-Monde-Delivery` e do `id` do corpo. event: type: string description: Evento entregue. status: type: string enum: - pending - delivered - failed description: "`pending` (aguardando ou em nova tentativa), `delivered` ou `failed` (tentativas esgotadas)." attempts: type: integer description: Tentativas feitas. response_status: type: - integer - 'null' description: Código HTTP da última resposta, nulo quando não houve resposta. last_error: type: - string - 'null' description: Erro da última tentativa. payload: "$ref": "#/components/schemas/webhook_payload" delivered_at: type: - string - 'null' format: date-time description: Quando a entrega foi confirmada. created_at: type: string format: date-time description: Quando o evento foi despachado. updated_at: type: string format: date-time description: Data e hora da última tentativa. webhook_payload: type: object description: Corpo do POST entregue ao endereço do webhook. properties: id: type: string format: uuid description: ID da entrega. event: type: string description: Evento, no formato `recurso.ação`. resource: type: string description: Recurso da API dos registros. occurred_at: type: string format: date-time description: Quando aconteceu a mudança mais recente entre os registros do aviso. data: type: array maxItems: 100 description: 'Os registros, até 100: `id` para a consulta, `company_id` (nulo nos cadastros que não pertencem a uma empresa) e, nos eventos de negócio, `subresource_id`, o item que provocou o evento.' items: type: object required: - id - company_id properties: id: type: string company_id: type: - string - 'null' format: uuid subresource_id: type: string webhook_event: type: object description: Evento do catálogo. properties: name: type: string description: Nome do evento, usado em `events`. resource: type: string description: Recurso da API. action: type: string description: 'Ação: `changed`, `deleted` ou um evento de negócio.' description: type: string description: O que o evento avisa. subscribable: type: boolean description: Se a credencial autenticada pode assinar o evento. responses: internal_server_error: description: Ocorreu um erro interno em nosso servidor. Tente novamente e, se o erro persistir, entre em contato com nosso suporte em suporte@monde.com.br. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Ocorreu um erro interno em nosso servidor. Tente novamente e, se o erro persistir, entre em contato com nosso suporte. unauthorized: description: Credenciais de acesso não são válidas. Solicite credenciais válidas diretamente com a agência de viagens. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Credenciais de acesso não são válidas. forbidden: description: A requisição foi recusada, e a mensagem devolvida em errors diz por quê. São cinco causas, e o remédio de cada uma é diferente — a empresa em que a credencial trabalha não tem licença ativa do Monde, o recurso exige a licença Monde Pro (caso dos guias) e a empresa não a tem, a empresa está somente leitura e a ação grava, a licença Monde Pro da empresa é somente leitura e a ação grava um guia, ou a credencial não tem a permissão exigida no recurso. Na empresa somente leitura, toda consulta continua respondendo. A falta de licença é sempre relatada antes da falta de permissão. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - A empresa não tem licença ativa do Monde. Contate o nosso time de suporte para mais informações. bad_request: description: Não foi possível processar a requisição devido a um erro de sintaxe ou formatação. Verifique se o corpo da requisição é um JSON válido. content: application/json: schema: type: object properties: errors: type: array items: type: string example: 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. conflict: description: Requisição conflitante. Retornado quando uma requisição com a mesma chave de idempotência já está sendo processada. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. example: errors: - Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão antes de tentar novamente. too_many_requests: description: Limite de requisições excedido. Aguarde um momento antes de tentar novamente. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Limite de requisições excedido. Aguarde um momento antes de tentar novamente. unsupported_media_type: description: O cabeçalho Content-Type da requisição especificou um tipo de mídia que não é suportado pela API. Certifique-se de que a requisição esteja utilizando application/json. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O cabeçalho Content-Type da requisição especificou um tipo de mídia que não é suportado pela API. Certifique-se de que a requisição esteja utilizando application/json. unprocessable_content: description: 'Ocorreu um erro de validação. Verifique as mensagens de erro retornadas para mais detalhes. O erro de um item de lista traz a posição do item na lista enviada, contada a partir de 0, em cada nível: O campo ''insurances[0] passengers[2] person name'' é obrigatório fala do terceiro passageiro do primeiro seguro. A regra conferida sobre a lista inteira, como o contato repetido, vem no nome da lista, sem posição. O item nulo ou em branco dentro de uma lista ([null], [""]) é recusado.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O campo 'custom_fields' deve ser uma lista ou um objeto, e não um valor simples. Envie no formato descrito na documentação. not_found: description: O recurso solicitado não foi encontrado. Verifique se o ID fornecido está correto. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O recurso solicitado não foi encontrado. product: description: Produto retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/product" examples: product_detail: summary: Produto com fornecimentos "$ref": "#/components/examples/product_detail" products: description: Lista de produtos retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de produtos com informações de paginação. properties: data: type: array description: Array contendo os produtos da página atual. items: "$ref": "#/components/schemas/product_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_products: summary: Todos os produtos "$ref": "#/components/examples/all_products" filtered_products: summary: Produtos filtrados "$ref": "#/components/examples/filtered_products" paginated_products: summary: Produtos paginados "$ref": "#/components/examples/paginated_products" supply: description: Fornecedor retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/supply" examples: supply: summary: Fornecimento "$ref": "#/components/examples/supply" supplies: description: Lista de fornecedores retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de fornecimentos com informações de paginação. properties: data: type: array items: "$ref": "#/components/schemas/supply" pagination: "$ref": "#/components/schemas/pagination" examples: supplies: summary: Fornecimentos do produto "$ref": "#/components/examples/supplies" representation: description: Representante retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/representation" examples: representation: summary: Representante "$ref": "#/components/examples/representation" representations: description: Lista de representantes retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de representantes com informações de paginação. properties: data: type: array items: "$ref": "#/components/schemas/representation" pagination: "$ref": "#/components/schemas/pagination" examples: representations: summary: Representantes do fornecimento "$ref": "#/components/examples/representations" sale: description: Venda retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/sale_detail" examples: all_products_sale: summary: Venda com todos os produtos "$ref": "#/components/examples/all_products_sale_single" visa_only_sale: summary: Venda de visto "$ref": "#/components/examples/visa_only_sale_single" sales: description: Lista de vendas retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/sales_response" examples: all_products_sales: summary: Venda com todos os produtos "$ref": "#/components/examples/all_products_sale_list" cabins: description: Lista de cabines retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de cabines com informações de paginação. properties: data: type: array description: Array contendo as cabines da página atual. items: "$ref": "#/components/schemas/cabin" pagination: "$ref": "#/components/schemas/pagination" examples: all_cabins: summary: Todas as cabines "$ref": "#/components/examples/all_cabins" paginated_cabins: summary: Cabines paginadas "$ref": "#/components/examples/paginated_cabins" cabin: description: Cabine retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/cabin" examples: cabin: summary: Cabine "$ref": "#/components/examples/cabin" ships: description: Lista de navios retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de navios com informações de paginação. properties: data: type: array description: Array contendo os navios da página atual. items: "$ref": "#/components/schemas/ship" pagination: "$ref": "#/components/schemas/pagination" examples: all_ships: summary: Todos os navios "$ref": "#/components/examples/all_ships" paginated_ships: summary: Navios paginados "$ref": "#/components/examples/paginated_ships" ship: description: Navio retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/ship" examples: ship: summary: Navio "$ref": "#/components/examples/ship" packages: description: Lista de pacotes retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de pacotes com informações de paginação. properties: data: type: array description: Array contendo os pacotes da página atual. items: "$ref": "#/components/schemas/package" pagination: "$ref": "#/components/schemas/pagination" examples: all_packages: summary: Todos os pacotes "$ref": "#/components/examples/all_packages" paginated_packages: summary: Pacotes paginados "$ref": "#/components/examples/paginated_packages" package: description: Pacote retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/package" examples: package: summary: Pacote "$ref": "#/components/examples/package" cost_center: description: Centro de custo retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/cost_center" examples: cost_center: summary: Centro de custo administrativo "$ref": "#/components/examples/cost_center" cost_centers: description: Lista de centros de custo retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de centros de custo com informações de paginação. properties: data: type: array description: Array contendo os centros de custo da página atual. items: "$ref": "#/components/schemas/cost_center" pagination: "$ref": "#/components/schemas/pagination" examples: all_cost_centers: summary: Todos os centros de custo "$ref": "#/components/examples/all_cost_centers" paginated_cost_centers: summary: Centros de custo paginados "$ref": "#/components/examples/paginated_cost_centers" currency: description: Moeda retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/currency" examples: currency: summary: Real "$ref": "#/components/examples/currency" currencies: description: Lista de moedas retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de moedas com informações de paginação. properties: data: type: array description: Array contendo as moedas da página atual. items: "$ref": "#/components/schemas/currency" pagination: "$ref": "#/components/schemas/pagination" examples: all_currencies: summary: Todas as moedas "$ref": "#/components/examples/all_currencies" paginated_currencies: summary: Moedas paginadas "$ref": "#/components/examples/paginated_currencies" exchange_rates: description: Cotações retornadas com sucesso. content: application/json: schema: type: object description: Resposta contendo as cotações da moeda com informações de paginação. properties: data: type: array description: Array contendo as cotações da página atual. items: "$ref": "#/components/schemas/exchange_rate" pagination: "$ref": "#/components/schemas/pagination" examples: exchange_rates: summary: Cotações da moeda "$ref": "#/components/examples/exchange_rates" exchange_rate: description: Cotação retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate" examples: exchange_rate: summary: Cotação "$ref": "#/components/examples/exchange_rate" category: description: Categoria retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/category" examples: category: summary: Categoria "$ref": "#/components/examples/category" categories: description: Lista de categorias retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de categorias com informações de paginação. properties: data: type: array description: Array contendo as categorias da página atual. items: "$ref": "#/components/schemas/category_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_categories: summary: Todas as categorias "$ref": "#/components/examples/all_categories" paginated_categories: summary: Categorias paginadas "$ref": "#/components/examples/paginated_categories" city: description: Cidade retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/city" examples: city: summary: Cidade "$ref": "#/components/examples/city" cities: description: Lista de cidades retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de cidades com informações de paginação. properties: data: type: array description: Array contendo as cidades da página atual. items: "$ref": "#/components/schemas/city_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_cities: summary: Todas as cidades "$ref": "#/components/examples/all_cities" paginated_cities: summary: Cidades paginadas "$ref": "#/components/examples/paginated_cities" person_role: description: Função retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/person_role" examples: person_role: summary: Função "$ref": "#/components/examples/person_role" person_roles: description: Lista de funções retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de funções com informações de paginação. properties: data: type: array description: Array contendo as funções da página atual. items: "$ref": "#/components/schemas/person_role_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_person_roles: summary: Todas as funções "$ref": "#/components/examples/all_person_roles" seller: description: Vendedor retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/seller" examples: seller: summary: Vendedor ativo "$ref": "#/components/examples/seller" sellers: description: Lista de vendedores retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de vendedores com informações de paginação. properties: data: type: array description: Array contendo os vendedores da página atual. items: "$ref": "#/components/schemas/seller_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_sellers: summary: Todos os vendedores "$ref": "#/components/examples/all_sellers" paginated_sellers: summary: Vendedores paginados "$ref": "#/components/examples/paginated_sellers" payment_method: description: Forma de pagamento retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/payment_method" examples: payment_method: summary: Dinheiro "$ref": "#/components/examples/payment_method" payment_methods: description: Lista de formas de pagamento retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de formas de pagamento com informações de paginação. properties: data: type: array description: Array contendo as formas de pagamento da página atual. items: "$ref": "#/components/schemas/payment_method" pagination: "$ref": "#/components/schemas/pagination" examples: all_payment_methods: summary: Todas as formas de pagamento "$ref": "#/components/examples/all_payment_methods" paginated_payment_methods: summary: Formas de pagamento paginadas "$ref": "#/components/examples/paginated_payment_methods" account: description: Conta ou cartão retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/account" examples: account: summary: Cartão de crédito "$ref": "#/components/examples/account" accounts: description: Lista de contas e cartões retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de contas e cartões com informações de paginação. properties: data: type: array description: Array contendo as contas e cartões da página atual. items: "$ref": "#/components/schemas/account_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_accounts: summary: Todas as contas e cartões "$ref": "#/components/examples/all_accounts" paginated_accounts: summary: Contas e cartões paginados "$ref": "#/components/examples/paginated_accounts" nf_rule: description: Regra da nota fiscal retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/nf_rule" examples: nf_rule: summary: Regra padrão de pacotes "$ref": "#/components/examples/nf_rule" nf_rules: description: Lista de regras da nota fiscal retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de regras da nota fiscal com informações de paginação. properties: data: type: array description: Array contendo as regras da página atual. items: "$ref": "#/components/schemas/nf_rule_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_nf_rules: summary: Todas as regras da nota fiscal "$ref": "#/components/examples/all_nf_rules" paginated_nf_rules: summary: Regras da nota fiscal paginadas "$ref": "#/components/examples/paginated_nf_rules" task: description: Tarefa retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/task" examples: task_detail: summary: Tarefa com histórico e campos personalizados "$ref": "#/components/examples/task_detail" tasks: description: Lista de tarefas retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de tarefas com informações de paginação. properties: data: type: array description: Array contendo as tarefas da página atual. items: "$ref": "#/components/schemas/task_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_tasks: summary: Todas as tarefas "$ref": "#/components/examples/all_tasks" paginated_tasks: summary: Tarefas paginadas "$ref": "#/components/examples/paginated_tasks" task_categories: description: Lista de categorias de tarefas retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de categorias de tarefas com informações de paginação. properties: data: type: array description: Array contendo as categorias de tarefas da página atual. items: "$ref": "#/components/schemas/task_category" pagination: "$ref": "#/components/schemas/pagination" examples: all_task_categories: summary: Todas as categorias de tarefas "$ref": "#/components/examples/all_task_categories" task_category: description: Categoria de tarefa retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/task_category" examples: task_category: summary: Categoria de tarefa "$ref": "#/components/examples/task_category" travels: description: Lista de viagens retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de viagens com informações de paginação. properties: data: type: array description: Array contendo as viagens da página atual. items: "$ref": "#/components/schemas/travel_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_travels: summary: Todas as viagens "$ref": "#/components/examples/all_travels" paginated_travels: summary: Viagens paginadas "$ref": "#/components/examples/paginated_travels" travel: description: Viagem retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/travel" examples: travel: summary: Detalhe da viagem "$ref": "#/components/examples/travel" quote: description: Orçamento retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/quote" examples: quote: summary: Orçamento de lua de mel "$ref": "#/components/examples/quote" quotes: description: Lista de orçamentos retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de orçamentos com informações de paginação. properties: data: type: array description: Array contendo os orçamentos da página atual. items: "$ref": "#/components/schemas/quote_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_quotes: summary: Todos os orçamentos "$ref": "#/components/examples/all_quotes" paginated_quotes: summary: Orçamentos paginados "$ref": "#/components/examples/paginated_quotes" guide: description: Guia retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/guide" examples: guide: summary: Guia de Lisboa "$ref": "#/components/examples/guide" guides: description: Lista de guias retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de guias com informações de paginação. properties: data: type: array description: Array contendo os guias da página atual. items: "$ref": "#/components/schemas/guide_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_guides: summary: Todos os guias "$ref": "#/components/examples/all_guides" paginated_guides: summary: Guias paginados "$ref": "#/components/examples/paginated_guides" invoice_rule: description: Regra de faturamento retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/invoice_rule" examples: invoice_rule: summary: Faturamento semanal aéreo "$ref": "#/components/examples/invoice_rule" invoice_rules: description: Lista de regras de faturamento retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de regras de faturamento com informações de paginação. properties: data: type: array description: Array contendo as regras da página atual. items: "$ref": "#/components/schemas/invoice_rule_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_invoice_rules: summary: Todas as regras de faturamento "$ref": "#/components/examples/all_invoice_rules" paginated_invoice_rules: summary: Regras de faturamento paginadas "$ref": "#/components/examples/paginated_invoice_rules" integration: description: Integração retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/integration" examples: integration: summary: Integração ativa "$ref": "#/components/examples/integration" integrations: description: Lista de integrações retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de integrações com informações de paginação. properties: data: type: array description: Array contendo as integrações da página atual. items: "$ref": "#/components/schemas/integration_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_integrations: summary: Todas as integrações "$ref": "#/components/examples/all_integrations" paginated_integrations: summary: Integrações paginadas "$ref": "#/components/examples/paginated_integrations" people: description: Lista de pessoas retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de pessoas com informações de paginação. properties: data: type: array description: Array contendo as pessoas da página atual. items: "$ref": "#/components/schemas/person_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_people: summary: Todas as pessoas "$ref": "#/components/examples/all_people" paginated_people: summary: Pessoas paginadas "$ref": "#/components/examples/paginated_people" person: description: Pessoa retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/person_detail" examples: person_detail: summary: Consulta de pessoa por ID "$ref": "#/components/examples/person_detail" label: description: Marcador retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/label" examples: label: summary: Marcador VIP "$ref": "#/components/examples/label" labels: description: Lista de marcadores retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de marcadores com informações de paginação. properties: data: type: array description: Array contendo os marcadores da página atual. items: "$ref": "#/components/schemas/label" pagination: "$ref": "#/components/schemas/pagination" examples: all_labels: summary: Todos os marcadores "$ref": "#/components/examples/all_labels" paginated_labels: summary: Marcadores paginados "$ref": "#/components/examples/paginated_labels" company: description: Empresa retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/company" examples: company: summary: Empresa "$ref": "#/components/examples/company" companies: description: Lista de empresas retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de empresas com informações de paginação. properties: data: type: array description: Array contendo as empresas da página atual. items: "$ref": "#/components/schemas/company" pagination: "$ref": "#/components/schemas/pagination" examples: all_companies: summary: Todas as empresas "$ref": "#/components/examples/all_companies" bill: description: Conta a pagar ou receber retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/bill" examples: receivable_bill: summary: Conta a receber (fatura de cliente) "$ref": "#/components/examples/receivable_bill_single" vendor_invoice_bill: summary: Conta a pagar (fatura de fornecedor) "$ref": "#/components/examples/vendor_invoice_bill_single" card_invoice_bill: summary: Conta a pagar (fatura de cartão) "$ref": "#/components/examples/card_invoice_bill_single" commission_bill: summary: Conta a pagar (comissão) "$ref": "#/components/examples/commission_bill_single" bills: description: Lista de contas a pagar e receber retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/bills_response" examples: receivable_bills: summary: Contas a receber e a pagar "$ref": "#/components/examples/bills_list" paginated_bills: summary: Contas paginadas "$ref": "#/components/examples/paginated_bills" account_movements: description: Lista de movimentações retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/account_movements_response" examples: all_account_movements: summary: Todas as movimentações "$ref": "#/components/examples/all_account_movements" paginated_account_movements: summary: Movimentações paginadas "$ref": "#/components/examples/paginated_account_movements" account_movement: description: Movimentação retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/account_movement" examples: settlement_account_movement: summary: Liquidação em cartão "$ref": "#/components/examples/settlement_account_movement" transfer_account_movement: summary: Transferência entre contas "$ref": "#/components/examples/transfer_account_movement" refunds: description: Lista de reembolsos retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/refunds_response" examples: all_refunds: summary: Todos os reembolsos "$ref": "#/components/examples/all_refunds" paginated_refunds: summary: Reembolsos paginados "$ref": "#/components/examples/paginated_refunds" refund: description: Reembolso retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/refund" examples: vendor_refund: summary: Reembolso de fornecedor "$ref": "#/components/examples/vendor_refund" customer_refund: summary: Reembolso de cliente "$ref": "#/components/examples/customer_refund" passenger_lists: description: Lista de passageiros retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/passenger_list_response" examples: passenger_list: summary: Lista de passageiros "$ref": "#/components/examples/passenger_list" sales_by_products: description: Vendas por produto retornadas com sucesso. content: application/json: schema: "$ref": "#/components/schemas/sales_by_product_response" examples: sales_by_product: summary: Vendas por produto "$ref": "#/components/examples/sales_by_product" sales_by_sellers: description: Vendas por vendedor retornadas com sucesso. content: application/json: schema: "$ref": "#/components/schemas/sales_by_seller_response" examples: sales_by_seller: summary: Vendas por vendedor "$ref": "#/components/examples/sales_by_seller" cvc_statements: description: Lista de recibos retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/cvc_statements_response" examples: all_cvc_statements: summary: Todos os recibos "$ref": "#/components/examples/all_cvc_statements" paginated_cvc_statements: summary: Recibos paginados "$ref": "#/components/examples/paginated_cvc_statements" cvc_statement: description: Recibo retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/cvc_statement" examples: cvc_statement_with_sale: summary: Recibo com venda vinculada "$ref": "#/components/examples/cvc_statement_with_sale" manual_adjustment_cvc_statement: summary: Ajuste manual sem venda "$ref": "#/components/examples/manual_adjustment_cvc_statement" nfs: description: Lista de notas fiscais retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/nfs_response" examples: all_nfs: summary: Todas as notas fiscais "$ref": "#/components/examples/all_nfs" paginated_nfs: summary: Notas fiscais paginadas "$ref": "#/components/examples/paginated_nfs" nf: description: Nota fiscal retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/nf" examples: issued_nf: summary: Nota fiscal emitida "$ref": "#/components/examples/issued_nf" canceled_nf: summary: Nota fiscal cancelada "$ref": "#/components/examples/canceled_nf" nf_generations: description: Notas a gerar retornadas com sucesso. content: application/json: schema: "$ref": "#/components/schemas/nf_generations_response" examples: nf_generation_preview: summary: Produto com uma nota do pagante a gerar "$ref": "#/components/examples/nf_generation_preview" nf_generation_created: description: Notas fiscais geradas com sucesso. content: application/json: schema: "$ref": "#/components/schemas/nf_generation_created" examples: generated_nfs: summary: Nota gerada "$ref": "#/components/examples/generated_nfs" logs: description: Lista de logs retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/logs_response" examples: all_logs: summary: Logs "$ref": "#/components/examples/all_logs" paginated_logs: summary: Logs paginados "$ref": "#/components/examples/paginated_logs" log: description: Log retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/log" examples: edition_log: summary: Log de edição "$ref": "#/components/examples/edition_log" system_log: summary: Log gravado pela API "$ref": "#/components/examples/system_log" custom_fields: description: Lista de campos personalizados retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/custom_fields_response" examples: all_custom_fields: summary: Campos personalizados "$ref": "#/components/examples/all_custom_fields" custom_field: description: Campo personalizado retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/custom_field_definition" examples: custom_field: summary: Campo personalizado "$ref": "#/components/examples/custom_field" sale_product_additional_fields: description: Campos adicionais retornados com sucesso. content: application/json: schema: type: object properties: data: type: array description: Os três campos adicionais, sempre todos, na ordem em que aparecem na tela do produto no Monde. items: type: object required: - key - label - active properties: key: type: string enum: - external_number - additional1 - additional2 description: Nome do campo no produto da venda. label: type: - string - 'null' description: Título que a agência deu ao campo no Monde. Nulo quando o campo não tem título. active: type: boolean description: Se o campo tem título e, por isso, aparece no Monde e é gravado e devolvido pela API. example: data: - key: external_number label: Ferrovia active: true - key: additional1 label: Nº Pedido active: true - key: additional2 label: active: false commission_plan: description: Plano de comissão retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/commission_plan" examples: commission_plan: summary: Plano de comissão "$ref": "#/components/examples/commission_plan" commission_plans: description: Lista de planos de comissão retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de planos de comissão com informações de paginação. properties: data: type: array description: Array contendo os planos de comissão da página atual. items: "$ref": "#/components/schemas/commission_plan_summary" pagination: "$ref": "#/components/schemas/pagination" examples: all_commission_plans: summary: Todos os planos de comissão "$ref": "#/components/examples/all_commission_plans" goal: description: Meta retornada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/goal" examples: goal: summary: Meta "$ref": "#/components/examples/goal" goals: description: Lista de metas retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de metas com informações de paginação. properties: data: type: array description: Array contendo as metas da página atual. items: "$ref": "#/components/schemas/goal" pagination: "$ref": "#/components/schemas/pagination" examples: all_goals: summary: Todas as metas "$ref": "#/components/examples/all_goals" bank: description: Banco retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/bank" examples: bank: summary: Banco do Brasil "$ref": "#/components/examples/bank" banks: description: Lista de bancos retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo lista de bancos com informações de paginação. properties: data: type: array description: Array contendo os bancos da página atual. items: "$ref": "#/components/schemas/bank" pagination: "$ref": "#/components/schemas/pagination" examples: all_banks: summary: Todos os bancos "$ref": "#/components/examples/all_banks" category_group_detail: description: Grupo retornado com sucesso. content: application/json: schema: "$ref": "#/components/schemas/category_group_detail" examples: category_group_detail: summary: Grupo de despesa "$ref": "#/components/examples/category_group_detail" category_groups: description: Lista de grupos retornada com sucesso. content: application/json: schema: type: object description: Resposta contendo a lista de grupos com informações de paginação. properties: data: type: array description: Array contendo os grupos da página atual. items: "$ref": "#/components/schemas/category_group_detail" pagination: "$ref": "#/components/schemas/pagination" examples: all_category_groups: summary: Todos os grupos "$ref": "#/components/examples/all_category_groups" webhooks: description: Webhooks da credencial. content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/webhook" pagination: "$ref": "#/components/schemas/pagination" example: data: - id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: 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: webhook_deliveries: description: Entregas do webhook. content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/webhook_delivery" pagination: "$ref": "#/components/schemas/pagination" example: data: - id: 7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d event: sales.product_canceled status: delivered attempts: 1 response_status: 204 last_error: 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: webhook_events: description: Catálogo de eventos. content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/webhook_event" example: data: - name: sales.closed resource: sales action: closed description: Venda fechada subscribable: true examples: upload_attachments: summary: Exemplo de envio de anexo. value: resource_type: sale resource_id: c52a1c51-80e2-4a28-925e-2102a7b5d4e1 file: "@voucher.pdf" description: voucher upload_attachments_response: summary: Exemplo de resposta do envio de anexo. value: id: '0685f968-4afb-4574-be1b-3a1e5fc10d94' description: voucher extension: pdf content_type: application/pdf download_url: https://sua-agencia.monde.com.br/api/v3/attachments/0685f968-4afb-4574-be1b-3a1e5fc10d94/download product_detail: summary: Produto com fornecimentos description: Exemplo de resposta com um produto e seus fornecimentos, fornecedores e representantes. value: 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.0 commission_amount: 0.0 over_percentage: 0.0 over_value: 100.0 du_percentage: 0.0 rav_percentage: 0.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.0 commission_amount: 0.0 over_percentage: 0.0 over_value: 100.0 du_percentage: 0.0 rav_percentage: 0.0 representative: id: c3b7e8eb-1199-5457-c170-923c3fe56c92 all_products: summary: Todos os produtos description: Exemplo de resposta contendo produtos de diferentes tipos. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a name: Seguro Viagem kind: insurance passengers: true system: true active: true nbs_code: 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: included_services: - id: c3b7e8eb-1199-5457-c170-923c3fe56c92 name: Diárias de Hospedagem kind: hotel passengers: true system: true active: true nbs_code: 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: included_services: - id: 20febcb5-85ef-427d-9a4e-da407062432d name: Operação Própria kind: operation passengers: true system: false active: true nbs_code: included_services: Turismo de aventura - id: 3b857f74-8c82-4391-bc95-2245fc4ba341 name: Outros kind: others passengers: true system: true active: true nbs_code: included_services: - id: bdaaf1b2-ee48-4b20-810a-10ccc27875b0 name: Aluguel de Carro kind: car_rental passengers: true system: true active: true nbs_code: 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: 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: included_services: Produto exclusivo CVC - id: 4f1c9a27-58aa-4d3e-9f0b-1c7d6e2b8a94 name: Excursão kind: excursion passengers: true system: true active: true nbs_code: included_services: Passeio com guia acompanhante - id: d9d27b79-649e-4ef9-b198-f32baaa9f9d2 name: Visto kind: visa passengers: true system: true active: true nbs_code: included_services: pagination: &744 size: 20 has_next_page: false next_cursor: filtered_products: summary: Produtos filtrados description: Exemplo de resposta filtrada por tipos específicos (insurance e cruise). value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a name: Seguro Viagem kind: insurance passengers: true system: true active: true nbs_code: 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: included_services: pagination: size: 10 has_next_page: false next_cursor: paginated_products: summary: Produtos paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a name: Seguro Viagem kind: insurance passengers: true system: true active: true nbs_code: 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: included_services: - id: c3b7e8eb-1199-5457-c170-923c3fe56c92 name: Diárias de Hospedagem kind: hotel passengers: true system: true active: true nbs_code: 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: included_services: - id: 20febcb5-85ef-427d-9a4e-da407062432d name: Operação Própria kind: operation passengers: true system: false active: true nbs_code: included_services: Turismo de aventura pagination: size: 10 has_next_page: true next_cursor: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 create_product: summary: Criar um produto description: Exemplo de criação de um produto do tipo Outros, com passageiros e código NBS. value: name: Passeio de Barco included_services: Passeio de escuna com almoço kind: others passengers: true active: true nbs_code: 1.2501.11.00 update_product: summary: Inativar o produto description: Exemplo de alteração que só inativa o produto, mantendo os demais campos. value: active: false written_product_reference: summary: Registro alterado, sem a permissão de leitura description: 'Resposta quando a credencial não tem a permissão "Visualizar" de produtos: a alteração é gravada, e só o `id` volta.' value: id: f9d961b8-ea88-4346-8e52-afe94267417a supply: summary: Fornecimento description: Exemplo de resposta de um fornecimento do produto. value: id: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b description: Tarifa net commission_type: percentage commission_percentage: 10.0 commission_amount: 0.0 over_percentage: 2.5 over_value: 100.0 du_percentage: 0.0 rav_percentage: 0.0 restitutes_kandir_law: true supplier: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 representations: [] supplies: summary: Fornecimentos do produto description: Exemplo de lista de fornecimentos, com os representantes de cada um. value: data: - id: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b description: Tarifa net commission_type: percentage commission_percentage: 10.0 commission_amount: 0.0 over_percentage: 2.5 over_value: 100.0 du_percentage: 0.0 rav_percentage: 0.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.0 commission_amount: 50.0 over_percentage: 0.0 over_value: 100.0 du_percentage: 0.0 rav_percentage: 0.0 representative: id: c3b7e8eb-1199-5457-c170-923c3fe56c92 pagination: *744 create_supply: summary: Adicionar um fornecedor description: Exemplo de fornecedor com comissão em percentual e over. value: supplier: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 description: Tarifa net commission_type: percentage commission_percentage: 10.0 over_percentage: 2.5 over_value: 100.0 update_supply: summary: Passar a comissão para valor description: Exemplo de alteração que troca a comissão para valor; o percentual de comissão fica zerado. value: commission_type: amount commission_amount: 35.0 representation: summary: Representante description: Exemplo de resposta de um representante do fornecimento. value: id: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a commission_type: amount commission_percentage: 0.0 commission_amount: 50.0 over_percentage: 0.0 over_value: 100.0 du_percentage: 0.0 rav_percentage: 0.0 representative: id: c3b7e8eb-1199-5457-c170-923c3fe56c92 representations: summary: Representantes do fornecimento description: Exemplo de lista de representantes. value: data: - id: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a commission_type: amount commission_percentage: 0.0 commission_amount: 50.0 over_percentage: 0.0 over_value: 100.0 du_percentage: 0.0 rav_percentage: 0.0 representative: id: c3b7e8eb-1199-5457-c170-923c3fe56c92 pagination: *744 create_representation: summary: Adicionar um representante description: Exemplo de representante com comissão em valor. value: representative: id: c3b7e8eb-1199-5457-c170-923c3fe56c92 commission_type: amount commission_amount: 50.0 update_representation: summary: Alterar o over description: Exemplo de alteração só do percentual de over. value: over_percentage: 1.5 all_products_sale_list: value: data: - id: 9f8e7d6c-5b4a-3210-9876-5432109876ab sale_number: 987 sale_date: '2026-11-16' status: closed observations: Venda finalizada. printed_receipt: true created_at: '2026-11-16T10:30:00' totals: products: 19188.57 fees: 598.84 discount: 225.0 revenue: 1500.0 balance: 0 final_amount: 19870.43 pagination: size: 20 has_next_page: false next_cursor: all_products_sale_single: value: id: 9f8e7d6c-5b4a-3210-9876-5432109876ab sale_number: 987 sale_date: '2026-11-16' status: closed observations: Venda finalizada. printed_receipt: true created_at: '2026-11-16T10:30:00' totals: products: 19188.57 fees: 598.84 discount: 225.0 revenue: 1500.0 balance: 0 final_amount: 19870.43 company: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 created_by: &752 id: b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e operation: id: 8936058a-2906-4239-9a7f-e22ccc2c195e seller: &753 id: 7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13 payer: &748 id: 2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4 intermediary: &754 id: d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8 requester: &755 id: b17c5e38-6a90-4d21-9f43-8e2b70c5a916 approver: &756 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-21' end_date: '2026-12-06' destination: international status: active issue_date: '2026-11-16' canceled_at: 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 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.0 cc_rav_fee: 0 totals: &1023 fees: 25.0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 10.0 products: 625.95 customer_amount: 650.95 amount: 650.95 supplier: &745 id: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b representative: &746 id: '028ea1ef-3f8e-4c7f-93da-463794a5afda' passengers: - &1024 document: '9921508090000' cost_center: Corporativa EXT canceled_at: fees: 25.0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 625.95 customer_amount: 650.95 total_amount: 650.95 person: &747 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-22' arrival_date: '2026-12-06' 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-16' canceled_at: 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 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.0 cc_rav_fee: 0 totals: &1025 fees: 120.0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 100.0 products: 8358.77 customer_amount: 8478.77 amount: 8478.77 supplier: *745 representative: *746 passengers: - &1026 document: CRZ-90412 cost_center: Corporativa EXT canceled_at: fees: 120.0 tip: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 8358.77 customer_amount: 8478.77 total_amount: 8478.77 person: *747 hotels: - id: 3c4d5e6f-7081-492a-bc3d-4e5f60718293 local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' destination: international accommodation_kind: Duplo Casal room_category: Deluxe meal_plan: All Inclusive nights: 8 status: active issue_date: '2026-11-16' canceled_at: 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 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.0 cc_rav_fee: 0 totals: &1027 fees: 281.54 rav_fee: 0 rav_fee_discount: 0 agency_fee: 563.07 discount: 50.0 products: 5630.73 customer_amount: 6475.34 amount: 6475.34 supplier: *745 representative: *746 passengers: - &1028 document: HTL-55821 emission_name: Maria da Silva cost_center: Corporativa EXT canceled_at: 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: *747 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-16' canceled_at: 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 Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 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.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 totals: &1029 fees: 136.06 rav_fee: 204.01 rav_fee_discount: 0 agency_fee: 0 discount: 20.0 products: 1360.67 du_fee: 104.01 du_fee_discount: 0 customer_amount: 1804.75 amount: 1804.75 supplier: &1030 id: 3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4 representative: *746 segments: - &1031 airline_code: AA flight_number: '1234' class: A origin: NAS departure_date: '2026-11-21T00:00:44' destination: JFK arrival_date: '2026-11-21T00:00:44' passengers: - &1032 ticket_number: '99526874895' emission_name: Maria da Silva cost_center: Corporativa EXT canceled_at: 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: *747 train_tickets: - id: 5e6f7081-92a3-4b4c-de5f-607182930415 local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 departure_date: '2026-11-21T00:00:44' arrival_date: '2026-11-24T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 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.0 cc_rav_fee: 0 totals: &1033 fees: 24.05 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 5.0 products: 240.5 customer_amount: 264.55 amount: 264.55 supplier: *745 representative: *746 passengers: - &1034 document: RE9988777 cost_center: Corporativa EXT canceled_at: 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: *747 ground_transportations: - id: 6f708192-a3b4-4c5d-ef60-718293041526 local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 departure_date: '2026-11-21T00:00:44' arrival_date: '2026-11-24T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 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.0 cc_rav_fee: 0 totals: &1035 fees: 12.19 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 5.0 products: 121.95 customer_amount: 134.14 amount: 134.14 supplier: *745 representative: *746 passengers: - &1036 document: '0001234567' cost_center: Corporativa EXT canceled_at: 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: *747 car_rentals: - id: 708192a3-b4c5-4d6e-f071-829304152637 local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico rental_days: 7 status: active issue_date: '2026-11-16' canceled_at: 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 Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 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.0 cc_rav_fee: 0 totals: &1037 fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 10.0 products: 350.0 customer_amount: 350.0 amount: 350.0 supplier: *745 representative: *746 passengers: - &1038 document: LOC-77310 cost_center: Corporativa EXT canceled_at: fees: 0 other_fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 350.0 customer_amount: 350.0 total_amount: 350.0 person: *747 travel_packages: - id: 8192a3b4-c5d6-4e7f-0182-930415263748 local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight status: active issue_date: '2026-11-16' canceled_at: 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 Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 commission_percentage: 10 over_amount: 0 over_percentage: 0 over: 0 intermediary_commission_amount: 125.0 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.0 cc_rav_fee: 0 totals: &1039 fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 25.0 products: 2500.0 customer_amount: 2500.0 amount: 2500.0 supplier: *745 representative: *746 passengers: - &1040 document: PCT2024050001 cost_center: Corporativa EXT canceled_at: fees: 0 other_fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *747 others: - id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 product: &1041 id: a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b document: OUT123456 destination: Salvador status: active issue_date: '2026-11-16' canceled_at: 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 vendor_reservation_url: https://www.epicjourney.com/reservation/9877 currency: BRL exchange_rate: 1 commission_amount: 12.0 commission_percentage: 2 over_amount: 0 over_percentage: 0 over: 0 intermediary_commission_amount: 4.0 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: unit_price: unit_fee: totals: &1042 fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 0 products: 2500.0 customer_amount: 2500.0 amount: 2500.0 supplier: *745 representative: *746 passengers: - &1043 document: OUT2024060012 cost_center: Corporativa EXT canceled_at: fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *747 excursions: - id: d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081 local_id: c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e document: EXC123456 departure_date: '2026-11-21T00:00:44' arrival_date: '2026-11-21T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9880 currency: BRL exchange_rate: 1 commission_amount: 10.0 commission_percentage: 10 over_amount: 0 over_percentage: 0 over: 0 intermediary_commission_amount: 5.0 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: &1044 fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 0 products: 350.0 customer_amount: 350.0 amount: 350.0 supplier: *745 representative: *746 passengers: - &1045 document: EXC2024060034 cost_center: Corporativa EXT canceled_at: fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 350.0 customer_amount: 350.0 total_amount: 350.0 person: *747 cvc_packages: - id: 5c4b3a29-1e0d-4982-7c6b-5a4938271605 product: &1049 id: c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d package_name: CVC Caribe 7 noites receipt_number: '89100000183488' departure_date: '2026-12-01T00:00:44' arrival_date: '2026-12-08T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Traslados inclusos vendor_reservation_url: https://www.epicjourney.com/reservation/9879 currency: BRL exchange_rate: 1 commission_amount: 490.0 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.0 unit_fee: 80.0 totals: &1050 fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 0 products: 3160.0 customer_amount: 3160.0 amount: 3160.0 supplier: *745 representative: *746 operations: - id: 6d5c4b3a-2f1e-4093-8d7c-6b5a49382716 product: &1046 id: b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c document: OP-000123 departure_date: '2026-11-23T00:00:44' arrival_date: '2026-11-23T00:00:44' status: active issue_date: '2026-11-16' canceled_at: calculate_commission: true deleted_balance: 0 observations: City tour confirmado. included_services: |- Guia local incluso Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9878 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: unit_price: unit_fee: totals: &1047 fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 0 products: 2500.0 customer_amount: 2500.0 amount: 2500.0 supplier: *745 passengers: - &1048 document: OP2024060056 cost_center: Corporativa EXT canceled_at: fees: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *747 payments: agency: &1073 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: - &1064 id: 3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718 credit: - &1065 id: c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f due_date: '2026-12-16' document: CRED-000123 amount: 6475.34 payer: *748 origin_sale: id: 3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8 products: - amount: 6475.34 sale_product: &1062 id: 3c4d5e6f-7081-492a-bc3d-4e5f60718293 to_invoice: - &1066 bill: id: 4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819 cost_center: Diretoria amount: 2350.0 products: - &750 amount: 2500.0 sale_product: &1057 id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 - amount: -150.0 sale_product: id: 1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071 retained_by_intermediary: - &1067 id: 7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f01 due_date: '2026-12-16' amount: 195.0 payer: *748 products: - amount: 625.95 sale_product: &1063 id: 1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071 legacy: - &1068 id: d3e4f5a6-b7c8-4d9e-8f01-2b3c4d5e6f70 due_date: '2026-10-17' amount: 300.0 check: card: brand: mastercard last_digits: '5678' authorization: ABC123 payer: *748 payment_method: id: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 products: - &749 amount: 8358.77 sale_product: &1056 id: 2b3c4d5e-6f70-4819-ab2c-3d4e5f607182 vendor: &1074 credit_card: - id: e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081 local_id: pagamento-4 due_date: '2026-12-16' card_last_digits: '1234' authorization: XYZ789 installments: 2 payer: *748 products: &1069 - *749 - *750 - amount: 3160.0 sale_product: &1058 id: 5c4b3a29-1e0d-4982-7c6b-5a4938271605 - amount: 2500.0 sale_product: &1059 id: 6d5c4b3a-2f1e-4093-8d7c-6b5a49382716 check: - &1070 id: f5a6b7c8-d9e0-4f1a-8b23-4d5e6f708192 due_date: '2026-12-16' bank_code: '341' check_number: 654321 payer: *748 products: - &751 amount: 134.14 sale_product: &1061 id: 6f708192-a3b4-4c5d-ef60-718293041526 credit: - id: a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3 local_id: pagamento-6 due_date: '2026-12-16' document: CRED-000123 payer: *748 products: &1071 - *751 others: - id: b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4 local_id: pagamento-5 due_date: '2026-12-16' details: Fatura payer: *748 products: &1072 - amount: 2500.0 sale_product: &1060 id: 8192a3b4-c5d6-4e7f-0182-930415263748 commissions: - &1079 description: 'Plano: Padrão, cálculo: 10%' amount: 700.0 retained_amount: 0.0 balance: 700.0 person: id: 0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5 - &1080 description: Comissão Intermediário amount: 49.75 retained_amount: 0.0 balance: 49.75 person: id: 1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6 - &1081 description: amount: -100.0 retained_amount: 0.0 balance: -100.0 person: id: 2c3d4e5f-6071-4283-8294-b2c3d4e5f6a7 financial: observations: Teste de observações financeiras vendor_bills: - &1075 id: c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39 standalone_bills: - &1076 id: f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f vendor_items: - &1077 id: 4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16 kind: invoice description: due_date: '2026-11-10' amount: -320.0 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: - &1078 id: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 kind: lei_kandir description: 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: payment: visa_only_sale_single: value: id: 5b2e8d14-7a39-4c6f-9e01-3d8a7f6c2b95 sale_number: 988 sale_date: '2026-11-16' departure_date: '2026-12-16' return_date: '2026-12-31' status: opened observations: printed_receipt: false created_at: '2026-11-16T10:30:00' company: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 created_by: *752 operation: seller: *753 payer: *748 intermediary: *754 requester: *755 approver: *756 promoter: travel: custom_fields: [] totals: products: 150.0 fees: 1017.5 discount: 0 balance: 250.0 final_amount: 1417.5 revenue: 250.0 insurances: [] cruises: [] hotels: [] airline_tickets: [] train_tickets: [] ground_transportations: [] car_rentals: [] travel_packages: [] others: [] cvc_packages: [] operations: [] excursions: [] visas: - id: 3c9e1f47-2b8d-4a65-9f13-8e7d6c5b4a21 local_id: 7d3a9c51-2e84-4f6b-a1c7-5b9e0d2f8a36 document: DS160-AA00X1B2C3 visa_type: Turismo destination_country: US destination: international departure_date: '2026-12-16T09:00:00' arrival_date: '2026-12-31T18:00:00' status: active issue_date: '2026-11-16' canceled_at: calculate_commission: true deleted_balance: 0 delete_supplier_balance: false supplier_fine: 0 supplier_fine_origin_currency: 0 observations: Entrevista no consulado americano em São Paulo. included_services: |- Agendamento da entrevista Preenchimento do formulário DS-160 vendor_reservation_url: reservation_due_date: currency: BRL origin_currency: BRL exchange_rate: 1 commission_amount: 0 commission_percentage: 0 over_amount: 0 over_percentage: 0 over: 100 intermediary_commission_amount: 0 intermediary_commission_percentage: 0 intermediary_over_amount: 0 intermediary_over_percentage: 0 intermediary_over: 100 agency_service_fee: 250.0 agency_card_rate: 0 deductions: 0 discount_amount: 0 cc_rav_fee: 0 totals: fees: 1017.5 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 discount: 0 products: 150.0 customer_amount: 150.0 amount: 1417.5 supplier: *745 representative: passengers: - document: AA1234567 cost_center: canceled_at: fees: 1017.5 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 150.0 customer_amount: 150.0 total_amount: 1167.5 person: *747 payments: agency: bills: [] refunds: [] credit: [] to_invoice: [] retained_by_intermediary: [] legacy: [] vendor: credit_card: - id: 8e4f2a61-0c7d-4b93-a5e8-1f6d9c3b7a42 local_id: pagamento-1 due_date: '2026-11-16' card_last_digits: '1234' authorization: XYZ789 installments: 2 payer: *748 products: - amount: 1167.5 sale_product: id: 3c9e1f47-2b8d-4a65-9f13-8e7d6c5b4a21 check: [] credit: [] others: [] commissions: [] attachments: [] financial: observations: vendor_bills: [] standalone_bills: [] vendor_items: - id: 2d7a5c93-6e1b-4f08-b4a2-9c3e8f1d6b70 kind: invoice description: due_date: amount: -1167.5 currency: BRL sale_product: id: 3c9e1f47-2b8d-4a65-9f13-8e7d6c5b4a21 person: *745 bill: payment: id: 8e4f2a61-0c7d-4b93-a5e8-1f6d9c3b7a42 all_products_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: &761 external_id: a8a41bec-e2a2-4d6a-b2f9-8fbc29169e46 name: João da Silva cpf: '83115137168' payer: &762 person_kind: individual external_id: cce45f2c-30e3-43a6-bbf1-af340188a04c name: Márcio da Veiga legal_name: 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: email: contato@marcio.com phone_number: '11999990001' mobile_number: '11999990002' address: &1010 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: &763 person_kind: individual external_id: 8a9de5ce-dac6-4721-851b-7366bf9ff5b0 name: Isabel Ribas legal_name: 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: email: contato@isabel.com phone_number: '11999990003' mobile_number: '11999990004' address: &1011 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: &764 person_kind: individual external_id: b7f3c1a2-9d84-4e60-8c15-2a6f0e3d4b91 name: Renata Furtado legal_name: 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: email: contato@renata.com phone_number: '11999990005' mobile_number: '11999990006' address: &1012 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: &765 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: email: contato@beatriz.com phone_number: '11999990007' mobile_number: '11999990008' address: &1013 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: - &766 local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: &757 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: &1018 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: &758 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: &1022 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: &783 - &806 document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: &759 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: email: maria.silva@example.com phone_number: '11999990009' mobile_number: '11999990010' address: &1014 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: - &767 local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: &784 - &807 document: CRZ-90412 amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *759 hotels: - &768 local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: &786 - &808 document: HTL-55821 amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *759 airline_tickets: - &769 local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: &787 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: &1020 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: *758 segments: &788 - &1051 airline_code: AA flight_number: '1234' class: A origin: NAS departure_date: '2026-11-21T00:00:44' destination: JFK arrival_date: '2026-11-21T00:00:44' seats: - seat_number: A27 ticket_number: '99526874895' passengers: &789 - &809 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: *759 train_tickets: - &770 local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: &790 - &1052 railway_operator: SNCF origin: Paris Gare de Lyon departure_date: '2026-11-21T00:00:44' destination: Nice-Ville arrival_date: '2026-11-21T06:00:44' supplier: *757 representative: *758 passengers: &791 - &810 amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *759 ground_transportations: - &771 local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: &792 - &1053 coach_company: Viação UTIL service_class: LE origin: Terminal Rodoviário Novo Rio departure_date: '2026-11-19T00:00:44' destination: Terminal Rodoviário de Santos arrival_date: '2026-11-19T06:00:44' seats: - seat_number: '27' ticket_number: '0001234567' supplier: *757 representative: *758 passengers: &793 - &811 amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *759 car_rentals: - &772 local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: &794 - &812 document: LOC-77310 amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *759 travel_packages: - &773 local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: &795 - &813 amount: 2500.0 fees: 125.0 other_fees: 25.0 rav_fee: 50.0 rav_fee_discount: 10.0 agency_fee: 30.0 document: PCT2024050001 person: *759 excursions: - &774 local_id: c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e document: EXC123456 departure_date: '2026-11-21T08:00:00' arrival_date: '2026-11-21T18:00:00' observations: Saída do hotel às 8h. included_services: |- Guia local incluso Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9880 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 20 discount_amount: 5.0 supplier: *757 representative: *758 passengers: &796 - &1054 amount: 350.0 fees: 17.5 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: EXC2024060034 person: *759 payments: - &775 local_id: pagamento-1 agency: credit_card: due_date: '2026-12-16' settlement_date: '2026-11-16' card_brand: mastercard card_last_digits: '5678' authorization: ABC123 bank_account: &760 bank_code: '237' agency_number: '1234' agency_digit: '5' account_number: '56789' account_digit: '0' products: - &800 sale_product_local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 amount: 264.55 - &776 local_id: pagamento-2 agency: bank_slip: due_date: '2026-12-16' settlement_date: '2026-11-16' bank_account: *760 products: - &802 sale_product_local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 amount: 350.0 - &777 local_id: pagamento-3 agency: bank_deposit: due_date: '2026-12-16' settlement_date: '2026-11-16' observations: TED bank_account: *760 products: - &799 sale_product_local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 amount: 6475.34 - &797 sale_product_local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef amount: 625.95 - &778 local_id: pagamento-4 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - &798 sale_product_local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 amount: 8358.77 - &779 local_id: pagamento-5 vendor: others: details: Fatura payer: &781 person_kind: individual external_id: cce45f2c-30e3-43a6-bbf1-af340188a04c name: Márcio da Veiga products: - &803 sale_product_local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 amount: 2500.0 - &780 local_id: pagamento-6 vendor: credit: products: - &801 sale_product_local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 amount: 134.14 closed_sale_with_commissions: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - *766 cruises: - *767 hotels: - *768 airline_tickets: - *769 train_tickets: - *770 ground_transportations: - *771 car_rentals: - *772 travel_packages: - *773 excursions: - *774 payments: - *775 - *776 - *777 - *778 - *779 - *780 status: closed commissions: - &1082 kind: seller value: 150.0 person: person_kind: individual external_id: a8a41bec-e2a2-4d6a-b2f9-8fbc29169e46 name: João da Silva - &1083 kind: intermediary value: 80.0 retained_value: 10.0 person: person_kind: individual external_id: 8a9de5ce-dac6-4721-851b-7366bf9ff5b0 name: Isabel Ribas - &1084 kind: person value: 50.0 description: Indicação person: person_kind: company external_id: 5d1c7a40-3b8e-4f2a-9c61-7e0b2d4f8a13 name: Agência Parceira cpf_cnpj: '11222333000181' required_fields_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *781 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international currency: BRL supplier: external_id: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b name: Epic Journey Insurance passengers: - amount: 625.95 person: &782 external_id: 322ff2c2-43e0-4376-bea5-20f88b673b6d name: Maria da Silva cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' ship_name: MXS Example Seaview currency: BRL supplier: external_id: f2e3d4c5-b6a7-4c8d-9e0f-1a2b3c4d5e6f name: Epic Journey Cruises passengers: - amount: 8358.77 person: *782 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506091' check_in: '2026-12-09' check_out: '2026-12-16' currency: BRL supplier: external_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d name: Epic Journey Hotel passengers: - amount: 5630.73 person: *782 airline_tickets: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international currency: BRL segments: - airline_code: AA flight_number: '1234' origin: NAS departure_date: '2026-11-21T00:00:44' destination: JFK arrival_date: '2026-11-21T00:00:44' supplier: airline_code: AA name: American Airlines passengers: - amount: 1360.67 person: *782 train_tickets: - local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 currency: EUR segments: - railway_operator: SNCF origin: Paris Gare de Lyon departure_date: '2026-11-21T00:00:44' destination: Nice-Ville arrival_date: '2026-11-21T06:00:44' supplier: external_id: 1d26857c-6eb2-47f0-814e-fc3bd27e6cb9 name: Rail Europe passengers: - amount: 240.5 person: *782 ground_transportations: - local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 currency: BRL segments: - coach_company: Viação UTIL origin: Terminal Rodoviário Novo Rio departure_date: '2026-11-19T00:00:44' destination: Terminal Rodoviário de Santos arrival_date: '2026-11-19T06:00:44' supplier: external_id: b3c4d5e6-f7a8-4b9c-0d1e-2f3a4b5c6d7e name: Viação UTIL passengers: - amount: 121.95 person: *782 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Brasília dropoff_date: '2026-11-28' dropoff_location: Centro de Brasília currency: BRL supplier: external_id: c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f name: Epic Journey Car Rental passengers: - amount: 350.0 person: *782 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight currency: BRL supplier: external_id: e3f4a5b6-c7d8-4e9f-0a1b-2c3d4e5f6a7b name: Epic Journey Travel Packages passengers: - amount: 2500.0 person: *782 multiple_products_of_same_kind_sale: description: 'Exemplo simplificado: paga apenas insurance e cruise; em uso real, os demais produtos também teriam pagamento.' x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: *783 - local_id: 82670c74-0180-4362-bd69-2bda5803ca74 document: '14296923' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: &785 external_id: 4a162ad1-fdbb-41f9-b49e-70dfb1c80f6c name: Kaleigh Glover gender: female birthdate: '1991-05-14' cpf: rg: passport_number: US748239 passport_expiration_date: '2033-03-12' foreigner: true foreign_identity_document: '182430728200321' email: kg@test.com phone_number: "+390612345670" mobile_number: "+393331234571" address: &1017 postal_code: '00187' street: Via Veneto street_number: '15' neighborhood: Ludovisi additional_info: Appartamento 3B city_ibge: city_name: Roma state_code: RM country_code: IT cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: *784 - local_id: fe9dfa42-55a2-44d9-88ad-d5deccff6336 booking_number: '987568490' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: - document: CRZ-90412 amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *785 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: *786 - local_id: d309a038-3d41-447b-8c00-0d9841d27d70 booking_number: '1020506092' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: - document: HTL-55821 amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *785 airline_tickets: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: *787 representative: *758 segments: *788 passengers: *789 - local_id: 6c3bddd0-6cae-4918-8528-eba333f2e3fd locator: WABCJK destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: *787 representative: *758 segments: - airline_code: AA flight_number: '1234' class: A origin: NAS departure_date: '2026-11-21T00:00:44' destination: JFK arrival_date: '2026-11-21T00:00:44' seats: - seat_number: A28 ticket_number: '99526874896' passengers: - ticket_number: '99526874896' original_ticket_number: '99526874895' emission_name: Kaleigh Glover amount: 1360.67 boarding_fee: 136.06 rav_fee: 204.01 du_fee: 104.01 person: *785 train_tickets: - local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: *790 supplier: *757 representative: *758 passengers: *791 - local_id: 444e0743-63ee-407f-a40f-e8cd0517ef92 document: RE9988778 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: *790 supplier: *757 representative: *758 passengers: - amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *785 ground_transportations: - local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: *792 supplier: *757 representative: *758 passengers: *793 - local_id: d8515741-369f-4fe8-9c5a-fe9a67b6cf02 document: GT123457 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: *792 supplier: *757 representative: *758 passengers: - amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *785 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: *794 - local_id: 14515a24-c160-480e-8c83-fa24202fdb46 document: CR987654321 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - document: LOC-77310 amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *785 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: *795 - local_id: 24e6d37f-3e4e-46bf-8954-f4570ef74b35 document: TP987654321 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: - amount: 2500.0 fees: 125.0 other_fees: 25.0 rav_fee: 50.0 rav_fee_discount: 10.0 agency_fee: 30.0 document: PCT2024050001 person: *785 excursions: - local_id: c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e document: EXC123456 departure_date: '2026-11-21T08:00:00' arrival_date: '2026-11-21T18:00:00' observations: Saída do hotel às 8h. included_services: |- Guia local incluso Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9880 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 20 discount_amount: 5.0 supplier: *757 representative: *758 passengers: *796 - local_id: 5b7e2c91-8d4f-4a36-9e1b-0c2f6a8d3e47 document: EXC123457 departure_date: '2026-11-21T08:00:00' arrival_date: '2026-11-21T18:00:00' observations: Saída do hotel às 8h. included_services: |- Guia local incluso Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9880 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 20 discount_amount: 5.0 supplier: *757 representative: *758 passengers: - amount: 350.0 fees: 17.5 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: EXC2024060034 person: *785 payments: - &805 local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *797 - *798 insurance_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - *766 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *797 sale_with_custom_fields: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - *766 custom_fields: - id: 12345 value: Reunião comercial operation_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 operation: local_id: 9f8e7d6c-5b4a-3210-fedc-ba9876543210 product_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 document: OP-2026-0001 departure_date: '2026-11-21' arrival_date: '2026-12-06' observations: Excursão operada pela própria agência included_services: Traslados, guia local e hospedagem vendor_reservation_url: https://www.epicjourney.com/reservation/op-1 currency: BRL exchange_rate: 1 intermediary_commission_amount: 30.0 agency_service_fee: 80.0 discount_amount: 10.0 passengers: - &1085 amount: 1200.0 fees: 60.0 document: OP-000123 person: *759 operation_no_passengers_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 operation: local_id: 1a2b3c4d-5e6f-7081-9203-a4b5c6d7e8f9 product_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 document: OP-2026-0002 departure_date: '2026-11-21' arrival_date: '2026-12-06' observations: Cota de operação própria, vendida por quantidade. currency: BRL exchange_rate: 1 quantity: 3 unit_price: 500.0 unit_fee: 20.0 agency_fee: 15.0 discount_amount: 10.0 others_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 others: - local_id: 3c4d5e6f-7081-4293-a4b5-c6d7e8f90a1b product_id: b42f0434-9c36-46ed-96cb-f5c81f025599 document: OU-2026-0001 destination: international departure_date: '2026-11-21' arrival_date: '2026-12-06' observations: Chip de internet internacional included_services: Chip com 10 GB de dados vendor_reservation_url: https://www.epicjourney.com/reservation/ou-1 currency: BRL exchange_rate: 1 commission_amount: 80.0 intermediary_commission_amount: 20.0 agency_service_fee: 30.0 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - &1086 amount: 800.0 fees: 40.0 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: OU-000123 person: *759 others_no_passengers_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 others: - local_id: 4d5e6f70-8192-43a4-b5c6-d7e8f90a1b2c product_id: c53a1545-0d47-47fe-a7c6-06d92f136600 document: OU-2026-0002 destination: international departure_date: '2026-11-21' observations: Ingressos vendidos por quantidade. currency: USD exchange_rate: 5.2 quantity: 2 unit_price: 100.0 unit_fee: 15.0 agency_fee: 10.0 supplier: *757 cruise_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 cruises: - *767 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *798 hotel_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 hotels: - *768 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *799 airline_ticket_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 airline_tickets: - *769 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_local_id: d4e5f6a7-b8c9-0123-4567-890123def012 amount: 1804.75 train_ticket_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 train_tickets: - *770 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *800 excursion_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 excursions: - *774 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_local_id: c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e amount: 367.5 visa_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 visas: - local_id: 7d3a9c51-2e84-4f6b-a1c7-5b9e0d2f8a36 document: DS160-AA00X1B2C3 visa_type: Turismo destination_country: US destination: international departure_date: '2026-12-16T09:00:00' arrival_date: '2026-12-31T18:00:00' observations: Entrevista no consulado americano em São Paulo. included_services: |- Agendamento da entrevista Preenchimento do formulário DS-160 currency: BRL exchange_rate: 1 commission_amount: 0 agency_service_fee: 250.0 supplier: *757 passengers: - &1055 amount: 150.0 fees: 1017.5 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 document: AA1234567 person: *759 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_local_id: 7d3a9c51-2e84-4f6b-a1c7-5b9e0d2f8a36 amount: 1167.5 ground_transportation_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 ground_transportations: - *771 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *801 car_rental_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 car_rentals: - *772 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *802 travel_package_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 travel_packages: - *773 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *803 company_payer_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: person_kind: company external_id: 3c1e6b21-5d44-4d98-8f21-2f90b6a8c3e7 name: Tech Solutions LTDA legal_name: Tech Solutions Tecnologia Ltda cpf_cnpj: '86452403000197' rg_ie: '9876543' email: teste@techsolutions.com.br phone_number: '1133224455' mobile_number: '11998877665' address: &1015 postal_code: '04547002' street: Avenida Brigadeiro Faria Lima street_number: '2000' neighborhood: Itaim Bibi additional_info: 12º andar city_ibge: '3550308' city_name: São Paulo state_code: SP country_code: BR intermediary: *763 approver: *764 requester: *765 insurances: - *766 cruises: - *767 hotels: - *768 airline_tickets: - *769 train_tickets: - *770 ground_transportations: - *771 car_rentals: - *772 travel_packages: - *773 excursions: - *774 payments: - *775 - *776 - *777 - *778 - *779 - *780 foreigner_payer_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: person_kind: individual external_id: d82e4b79-6b2a-44f8-a431-027b2d7a9e68 name: John Smith gender: male birthdate: '1982-11-30' passport_number: AA1234567 passport_expiration_date: '2030-09-20' foreigner: true foreign_identity_document: F987654321 email: john.smith@example.com phone_number: "+390612345672" mobile_number: "+393331234572" address: &1016 postal_code: '00198' street: Via dei Parioli street_number: '25' neighborhood: Parioli additional_info: Appartamento 4C city_ibge: city_name: Roma state_code: RM country_code: IT intermediary: *763 approver: *764 requester: *765 insurances: - *766 cruises: - *767 hotels: - *768 airline_tickets: - *769 train_tickets: - *770 ground_transportations: - *771 car_rentals: - *772 travel_packages: - *773 excursions: - *774 payments: - *775 - *776 - *777 - *778 - *779 - *780 datetime_products_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21T00:00:44' end_date: '2026-12-06T00:00:44' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: *783 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22T00:00:44' arrival_date: '2026-12-06T00:00:44' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: *784 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09T00:00:44' check_out: '2026-12-16T00:00:44' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: *786 airline_tickets: - *769 train_tickets: - *770 ground_transportations: - *771 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21T00:00:44' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28T00:00:44' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: *794 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26T00:00:44' end_date: '2026-12-03T00:00:44' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: *795 excursions: - *774 payments: - *775 - *776 - *777 - *778 - *779 - *780 foreign_sale: description: 'Exemplo simplificado: paga apenas insurance e cruise; em uso real, os demais produtos também teriam pagamento.' x-ignore-on-postman: airline_tickets,train_tickets,ground_transportations,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: EUR exchange_rate: 6.1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: &804 external_id: 30a20d58-b4f7-465d-b8b0-f89b2fc00b67 name: EuroTravel legal_name: EuroTravel Global GmbH cnpj: ie: foreigner: true email: contact@eurotravel.com phone_number: "+390212345678" mobile_number: "+393331234567" address: &1019 postal_code: '20121' street: Via Monte Napoleone street_number: '8' neighborhood: Centro additional_info: Piano 3 city_ibge: city_name: Milano state_code: MI country_code: IT representative: *758 passengers: *783 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: EUR exchange_rate: 6.1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *804 representative: *758 passengers: *784 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' destination: international accommodation_kind: Duplo Casal room_category: Deluxe meal_plan: All Inclusive included_services: |- Grand European Hotels: Rue de la Paix, 82, FR Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: EUR exchange_rate: 6.1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *804 representative: *758 passengers: *786 airline_tickets: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: EUR exchange_rate: 6.1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: airline_code: LH airline_number: '220' name: European Wings legal_name: European Wings AG cnpj: ie: foreigner: true email: contact@europeanwings.com phone_number: "+390212345679" mobile_number: "+393331234570" address: &1021 postal_code: '20124' street: Via Torino street_number: '45' neighborhood: Centro additional_info: Piano 5 city_ibge: city_name: Milano state_code: MI country_code: IT representative: *758 segments: *788 passengers: *789 train_tickets: - local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: *790 supplier: *757 representative: *758 passengers: *791 ground_transportations: - local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: EUR exchange_rate: 6.1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: *792 supplier: *804 representative: *758 passengers: *793 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: EUR exchange_rate: 6.1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *804 representative: *758 passengers: *794 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: EUR exchange_rate: 6.1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *804 representative: *758 passengers: *795 excursions: - *774 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef amount: 3818.3 - sale_product_local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 amount: 50988.5 foreign_passenger_sale: description: 'Exemplo simplificado: paga apenas insurance e cruise; em uso real, os demais produtos também teriam pagamento.' x-ignore-on-postman: airline_tickets,train_tickets,ground_transportations,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: *785 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: - document: CRZ-90412 amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *785 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: - document: HTL-55821 amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *785 airline_tickets: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: *787 representative: *758 segments: - airline_code: AA flight_number: '1234' class: A origin: NAS departure_date: '2026-11-21T00:00:44' destination: JFK arrival_date: '2026-11-21T00:00:44' seats: - seat_number: A28 ticket_number: '99526874896' passengers: - ticket_number: '99526874896' original_ticket_number: '99526874895' emission_name: Kaleigh Glover amount: 1360.67 boarding_fee: 136.06 rav_fee: 204.01 du_fee: 104.01 person: *785 train_tickets: - local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: *790 supplier: *757 representative: *758 passengers: - amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *785 ground_transportations: - local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: *792 supplier: *757 representative: *758 passengers: - amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *785 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - document: LOC-77310 amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *785 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: - amount: 2500.0 fees: 125.0 other_fees: 25.0 rav_fee: 50.0 rav_fee_discount: 10.0 agency_fee: 30.0 document: PCT2024050001 person: *785 excursions: - *774 payments: - *805 multiple_passengers_sale: description: 'Exemplo simplificado: paga apenas insurance e cruise; em uso real, os demais produtos também teriam pagamento.' x-ignore-on-postman: airline_tickets,train_tickets,ground_transportations,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - *806 - document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: *785 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: - *807 - document: CRZ-90412 amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *785 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: - *808 - document: HTL-55821 amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *785 airline_tickets: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: *787 representative: *758 segments: *788 passengers: - *809 - ticket_number: '99526874896' original_ticket_number: '99526874895' emission_name: Kaleigh Glover amount: 1360.67 boarding_fee: 136.06 rav_fee: 204.01 du_fee: 104.01 person: *785 train_tickets: - local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: *790 supplier: *757 representative: *758 passengers: - *810 - amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *785 ground_transportations: - local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: *792 supplier: *757 representative: *758 passengers: - *811 - amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *785 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - *812 - document: LOC-77310 amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *785 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: - *813 - amount: 2500.0 fees: 125.0 other_fees: 25.0 rav_fee: 50.0 rav_fee_discount: 10.0 agency_fee: 30.0 document: PCT2024050001 person: *785 excursions: - *774 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef amount: 1251.9 - sale_product_local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 amount: 16717.54 multiple_passengers_one_amount_sale: description: 'Exemplo simplificado: paga apenas insurance e cruise; em uso real, os demais produtos também teriam pagamento.' x-ignore-on-postman: airline_tickets,train_tickets,ground_transportations,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - *806 - person: *785 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: - *807 - person: *785 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: - *808 - person: *785 airline_tickets: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: *787 representative: *758 segments: *788 passengers: - *809 - ticket_number: '99526874896' original_ticket_number: '99526874895' emission_name: Kaleigh Glover person: *785 train_tickets: - local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: *790 supplier: *757 representative: *758 passengers: - *810 - person: *785 ground_transportations: - local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: *792 supplier: *757 representative: *758 passengers: - *811 - person: *785 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - *812 - person: *785 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: - *813 - person: *785 excursions: - *774 payments: - *805 partial_payment_sale: description: 'Exemplo de venda com pagamento parcial: cobre apenas parte do valor total. Em uso real, os demais produtos também teriam pagamento.' x-ignore-on-postman: airline_tickets,train_tickets,ground_transportations,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: *783 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: *784 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: *786 airline_tickets: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: *787 representative: *758 segments: *788 passengers: *789 train_tickets: - local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: *790 supplier: *757 representative: *758 passengers: *791 ground_transportations: - local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: *792 supplier: *757 representative: *758 passengers: *793 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: *794 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: *795 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef amount: 312.98 - sale_product_local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 amount: 4179.39 own_operation_sale: x-ignore-on-postman: airline_tickets,train_tickets,ground_transportations,car_rentals,travel_packages,excursions value: company_identifier: '46598887000162' sale_date: '2026-11-16' operation_id: 8936058a-2906-4239-9a7f-e22ccc2c195e seller: *761 payer: *762 intermediary: *763 insurances: - *766 cruises: - *767 hotels: - *768 airline_tickets: - *769 train_tickets: - *770 ground_transportations: - *771 car_rentals: - *772 travel_packages: - *773 payments: - *775 - *776 - *777 - *778 - *779 - *780 update_sale_header: description: '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.' value: approver: *764 custom_fields: - id: 12345 value: Reunião anual update_sale_products: description: O seguro com id é alterado com os dados enviados, os demais seguros da venda são excluídos, e os pagamentos passam a ser os da lista. value: insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: *783 id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 payments: - local_id: pagamento-1 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef amount: 625.95 update_sale_payments: description: O pagamento enviado pelo id fica como está, o novo é incluído apontando o produto pelo id, e os demais pagamentos da venda são removidos. Os produtos ficam como estão. value: payments: - id: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 - local_id: pagamento-2 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - sale_product_id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 amount: 300.0 reopen_sale: description: Na venda fechada, o status opened reabre a venda antes de alterar a data, que a venda fechada não aceita. Se a alteração for recusada, a venda continua fechada. value: status: opened sale_date: '2026-10-10' updated_sale_reference: description: 'Resposta à credencial que não pode consultar a venda alterada: o id da venda e o id e o local_id de cada produto e pagamento enviado.' value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 insurances: - id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef payments: vendor: credit_card: - id: 0f4c8a1e-2b7d-4e93-a5c6-81d9e3f20b47 local_id: pagamento-1 sale_product_cancellation_whole_product: description: 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. value: 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 sale_product_cancellation_some_passengers: description: Cancela só um passageiro, com a data dele. O produto continua ativo enquanto houver passageiro ativo. value: passengers: - person: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 canceled_at: '2026-10-14' sale_product_cancellation_rest_with_fine: description: 'Depois de cancelar um passageiro, cancela o que continuava ativo e com isso o produto inteiro: exclui o saldo do cliente e o que ainda seria faturado ao fornecedor, e lança a multa cobrada por ele.' value: passengers: - person: id: c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e canceled_at: '2026-10-15' calculate_commission: false delete_customer_balance: true delete_supplier_balance: true supplier_fine: 150.0 sale_product_reactivation_one_passenger: description: Reativa só um passageiro cancelado, citado pelo `id` da pessoa. A multa e o saldo excluído ficam enquanto houver passageiro cancelado. value: passengers: - person: id: c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e sale_product_reactivation_rest: description: 'Depois de reativar um passageiro, reativa o que continuava cancelado. Com isso voltam todos, e o resto do cancelamento é desfeito: a multa e o saldo excluído zeram.' value: passengers: - person: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 sale_product_cancellation_partial_response: description: '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.' value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_number: 1024 status: opened insurances: - id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 status: active canceled_at: 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: person: id: c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e sale_product_cancellation_whole_response: description: 'Trecho da resposta quando o pedido deixa todos os passageiros cancelados, com saldo do fornecedor excluído e multa: o produto fica `canceled`, com o `canceled_at` do dia. Os demais campos da venda são os da consulta por ID.' value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_number: 1024 status: opened insurances: - id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 status: canceled canceled_at: '2026-10-15' calculate_commission: false deleted_balance: 650.95 delete_supplier_balance: true supplier_fine: 150.0 supplier_fine_origin_currency: 150.0 passengers: - canceled_at: '2026-10-14' person: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - canceled_at: '2026-10-15' person: id: c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e sale_product_reactivation_response: description: '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.' value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_number: 1024 status: opened insurances: - id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 status: active canceled_at: calculate_commission: true deleted_balance: 0 delete_supplier_balance: false supplier_fine: 0 supplier_fine_origin_currency: 0 passengers: - canceled_at: person: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - canceled_at: person: id: c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e sale_product_cancellation_sale_reference: description: A credencial sem a permissão de consultar vendas recebe só o `id` da venda. value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_vendor_item_due_date_and_description: description: Muda o vencimento e a descrição do item ainda a faturar. value: due_date: '2026-12-15' description: Faturar em dezembro sale_vendor_item_description_only: description: 'Muda só a descrição: o vencimento fica como está.' value: description: Repasse do seguro sale_vendor_item_sale_response: description: '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.' value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_number: 1024 status: closed financial: observations: vendor_bills: - id: c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39 standalone_bills: [] vendor_items: - id: 4a6d2e18-9c3f-4b75-8e01-2d7f5a9c3b16 kind: invoice description: due_date: '2026-11-10' amount: -320.0 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: - 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: payment: sale_vendor_item_sale_reference: description: A credencial sem permissão de consultar vendas recebe só o `id` da venda. value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_vendor_invoice_advance: description: Gera o pagamento avulso com todo o saldo do item. value: kind: advance items: - id: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 amount: 650.95 sale_vendor_invoice_deposit: description: 'Gera o sinal de parte do item do produto: a sobra fica em aberto.' value: kind: deposit product_id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 items: - id: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 amount: 200.0 sale_vendor_invoice_bill_reference: description: A credencial que não consulta a fatura gerada recebe só o `id` dela. value: id: c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39 sale_to_invoice: description: Fatura para o pagante da venda o saldo do cliente de um produto, sem centro de custo. value: products: - sale_product_id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 amount: 650.95 sale_to_invoice_with_cost_center: description: Fatura para uma pessoa jurídica, com um dos centros de custo cadastrados nela. O produto de saldo negativo vai com o valor negativo. value: payer_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 cost_center: Diretoria products: - sale_product_id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 amount: 1200.0 - sale_product_id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 amount: -150.0 sale_to_invoice_return: description: Devolve ao cliente, pela fatura de cliente, o saldo negativo de um produto. value: description: Reembolso do seguro products: - sale_product_id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 amount: -150.0 sale_to_invoice_removal: description: Remove a linha do Faturar da fatura de cliente que não tem centro de custo. value: bill_id: 4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819 cost_center: sale_to_invoice_removal_confirmed: description: 'Remove a linha de uma venda fechada, cuja fatura de cliente está liquidada: reabre a venda e desfaz a liquidação da fatura.' value: bill_id: 4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819 cost_center: Diretoria reopen_sale: true remove_settlement: true sale_to_invoice_sale_reference: description: A credencial sem a permissão de consultar vendas recebe só o `id` da venda. value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 all_cabins: summary: Todas as cabines description: Exemplo de resposta contendo todas as cabines cadastradas. value: data: - name: Externa - name: Interna - name: Suíte - name: Varanda pagination: size: 20 has_next_page: false next_cursor: paginated_cabins: summary: Cabines paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - name: Suíte - name: Varanda pagination: size: 2 has_next_page: false next_cursor: cabin: summary: Cabine description: Exemplo de resposta de uma cabine. value: name: Varanda create_cabin: summary: Cadastrar cabine description: Exemplo de cadastro de cabine. value: name: Varanda update_cabin: summary: Renomear cabine description: Exemplo de alteração que renomeia a cabine. value: name: Varanda Premium all_ships: summary: Todos os navios description: Exemplo de resposta contendo todos os navios cadastrados. value: data: - name: Costa Diadema - name: MSC Preziosa - name: MSC Seaview pagination: size: 20 has_next_page: false next_cursor: paginated_ships: summary: Navios paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - name: MSC Seaview pagination: size: 2 has_next_page: false next_cursor: ship: summary: Navio description: Exemplo de resposta de um navio. value: name: MSC Preziosa create_ship: summary: Cadastrar navio description: Exemplo de cadastro de navio. value: name: MSC Preziosa update_ship: summary: Renomear navio description: Exemplo de alteração que renomeia o navio. value: name: MSC Preziosa II all_packages: summary: Todos os pacotes description: Exemplo de resposta contendo todos os pacotes cadastrados. value: data: - name: Bariloche 5 noites services_included: - name: Disney 7 noites services_included: Aéreo, hotel e ingressos para os parques pagination: size: 20 has_next_page: false next_cursor: paginated_packages: summary: Pacotes paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - name: Disney 7 noites services_included: Aéreo, hotel e ingressos para os parques pagination: size: 2 has_next_page: false next_cursor: package: summary: Pacote description: Exemplo de resposta de um pacote. value: name: Disney 7 noites services_included: Aéreo, hotel e ingressos para os parques create_package: summary: Cadastrar pacote description: Exemplo de cadastro de pacote. value: name: Disney 7 noites services_included: Aéreo, hotel e ingressos para os parques update_package: summary: Renomear pacote description: Exemplo de alteração que renomeia o pacote. value: name: Disney 8 noites all_cost_centers: summary: Todos os centros de custo description: Exemplo de resposta contendo todos os centros de custo cadastrados. value: 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: paginated_cost_centers: summary: Centros de custo paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Marketing pagination: size: 2 has_next_page: false next_cursor: cost_center: summary: Centro de custo administrativo description: Exemplo de resposta de um centro de custo específico. value: id: f9d961b8-ea88-4346-8e52-afe94267417a description: Administrativo create_cost_center: summary: Novo centro de custo description: Centro de custo Marketing. value: description: Marketing update_cost_center: summary: Renomear centro de custo description: Altera a descrição. value: description: Marketing digital written_cost_center_reference: summary: Só o id description: Resposta a quem não tem a permissão de ler centros de custo. value: id: f9d961b8-ea88-4346-8e52-afe94267417a all_currencies: summary: Todas as moedas description: Exemplo de resposta contendo todas as moedas cadastradas. value: 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: &814 size: 20 has_next_page: false next_cursor: paginated_currencies: summary: Moedas paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - code: EUR description: Euro symbol: "€" active: false pagination: size: 2 has_next_page: false next_cursor: currency: summary: Real description: Exemplo de resposta de uma moeda específica. value: code: BRL description: Real symbol: R$ active: true deactivate_currency: summary: Desativar moeda description: Exemplo de alteração que desativa a moeda. value: active: false exchange_rate: summary: Cotação description: Exemplo de resposta de uma cotação. value: id: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 currency: code: USD value: 5.4321 quoted_at: '2026-10-14T09:30:00' exchange_rates: summary: Cotações da moeda description: Exemplo de resposta com o histórico de cotações da moeda. value: 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: *814 create_exchange_rate: summary: Gravar cotação description: Exemplo de gravação da cotação nova da moeda. value: value: 5.4321 update_exchange_rates: summary: Atualizar câmbios description: Exemplo de atualização das cotações do dólar e do euro. value: exchange_rates: - currency_code: USD value: 5.4321 - currency_code: EUR value: 6.1234 exchange_rate_update_response: summary: Cotações gravadas description: Exemplo de resposta em que só o dólar mudou de valor e foi gravado. value: exchange_rates: - id: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 currency: code: USD value: 5.4321 quoted_at: '2026-10-14T09:30:00' all_categories: summary: Todas as categorias description: Exemplo de resposta contendo categorias de despesa e receita. value: 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: paginated_categories: summary: Categorias paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - id: d4c8f9fc-22aa-4568-a281-a34d4bf67da3 description: Venda de Pacotes kind: revenue pass_through: false pagination: size: 2 has_next_page: false next_cursor: category: summary: Categoria description: Exemplo de resposta de uma categoria de receita, com o grupo. value: 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 create_category: summary: Nova categoria description: Categoria de despesa no grupo Despesas Administrativas. value: description: Aluguel group_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 pass_through: false update_category: summary: Renomear categoria description: Altera só a descrição; os demais campos ficam como estão. value: description: Aluguel da loja written_category_reference: summary: Só o id description: Resposta a quem não tem a permissão de ler categorias. value: id: f9d961b8-ea88-4346-8e52-afe94267417a all_cities: summary: Todas as cidades description: Exemplo de resposta contendo cidades brasileiras e estrangeira. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a name: Miami, FL ibge: siafi: - 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: paginated_cities: summary: Cidades paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: São Paulo ibge: '3550308' siafi: '7107' pagination: size: 2 has_next_page: false next_cursor: city: summary: Cidade description: Exemplo de resposta de uma cidade brasileira, com o estado e o país. value: 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 all_person_roles: summary: Todas as funções description: Exemplo de resposta com uma função da agência e as duas funções do sistema. value: 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: person_role: summary: Função description: Exemplo de resposta de uma função comissionada sobre uma empresa, com uma pessoa vinculada. value: 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.0 february: 50000.0 march: 60000.0 april: 50000.0 may: 50000.0 june: 50000.0 july: 80000.0 august: 50000.0 september: 50000.0 october: 50000.0 november: 50000.0 december: 90000.0 create_person_role: summary: Cadastrar uma função description: Exemplo de cadastro de uma função comissionada sobre uma empresa, já com uma pessoa vinculada. value: 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' update_person_role: summary: Alterar as pessoas da função description: 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. value: people: - id: 0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b commission_plan: not_commissioned: true start_date: - person: id: 9a8b7c6d-5e4f-4321-8a9b-0c1d2e3f4a5b start_date: '2026-03-01' link_person_to_system_role: summary: Vincular uma pessoa à função Vendedor description: Exemplo de alteração da função do sistema, em que só a lista de pessoas muda. value: people: - person: id: 3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7 start_date: '2026-01-01' update_person_goals: summary: Alterar as metas de uma pessoa description: Exemplo de alteração em que a meta de 2026 da pessoa muda só em junho e entra a meta de 2027, com o valor de janeiro nos meses omitidos. As metas que não vieram em `goals` são excluídas, e, como `people` é a lista final, os vínculos que não vieram nela são desfeitos. value: people: - id: 0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b goals: - id: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a months: june: 55000 - year: 2027 months: january: 60000 december: 100000 written_person_role_reference: summary: Função alterada, sem a permissão de leitura description: 'Resposta quando a credencial não pode ler funções: a alteração é gravada, e só o `id` volta.' value: id: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e all_sellers: summary: Todos os vendedores description: Exemplo de resposta contendo vendedores ativos e inativos. value: 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: paginated_sellers: summary: Vendedores paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - id: c3b7e8eb-1199-4457-9170-923c3fe56c92 active: false created_at: '2023-11-02T16:45:00' pagination: size: 1 has_next_page: false next_cursor: seller: summary: Vendedor ativo description: Exemplo de resposta de um vendedor específico. value: 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 create_seller: summary: Cadastrar vendedor description: Torna vendedor a pessoa física informada, já ativo. value: person_id: f9d961b8-ea88-4346-8e52-afe94267417a deactivate_seller: summary: Desativar vendedor description: Desativa o vendedor, que deixa de ser oferecido nas vendas novas. value: active: false written_seller_reference: summary: Alteração sem permissão de leitura description: 'Resposta da alteração quando a credencial não tem a permissão "Visualizar" de vendedores: traz só o `id`.' value: id: f9d961b8-ea88-4346-8e52-afe94267417a all_payment_methods: summary: Todas as formas de pagamento description: Exemplo de resposta contendo formas de pagamento do sistema e cadastradas pelo usuário. value: 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: paginated_payment_methods: summary: Formas de pagamento paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - id: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 name: Dinheiro system: true - id: f9d961b8-ea88-4346-8e52-afe94267417a name: Transferência Internacional system: false pagination: size: 2 has_next_page: false next_cursor: payment_method: summary: Dinheiro description: Exemplo de resposta de uma forma de pagamento específica. value: id: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 name: Dinheiro system: true create_payment_method: summary: Nova forma de pagamento description: Forma de pagamento da agência. value: name: Vale-viagem update_payment_method: summary: Renomear forma de pagamento description: Altera o nome. value: name: Voucher written_payment_method_reference: summary: Só o id description: Resposta a quem não tem a permissão de ler formas de pagamento. value: id: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 all_accounts: summary: Todas as contas e cartões description: Exemplo de resposta contendo uma conta corrente e um cartão de crédito. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a description: Banco do Brasil - Matriz kind: checking_account active: true currency: BRL initial_balance: 1500.0 bank_operation: agency: '1412' agency_digit: '5' number: '04640' digit: '2' pix_key: financeiro@agencia.com.br bill_expiration: bill_closing: - &815 id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Cartão Corporativo kind: card_account active: true currency: BRL initial_balance: 0.0 bank_operation: agency: agency_digit: number: digit: pix_key: bill_expiration: 10 bill_closing: 1 pagination: size: 20 has_next_page: false next_cursor: paginated_accounts: summary: Contas e cartões paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *815 pagination: size: 1 has_next_page: false next_cursor: account: summary: Cartão de crédito description: Exemplo de resposta de uma conta específica. value: id: f9d961b8-ea88-4346-8e52-afe94267417a description: Banco do Brasil - Matriz kind: checking_account active: true currency: BRL initial_balance: 1500.0 bank_operation: agency: '1412' agency_digit: '5' number: '04640' digit: '2' pix_key: financeiro@agencia.com.br bill_expiration: bill_closing: bank: id: c3b7e8eb-1199-4457-9170-923c3fe56c92 number: '001' name: Banco do Brasil owner: id: 7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b card_operator: companies: - &816 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 invoice_company: 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: late_fine: 2.0 late_interest: 1.0 bank_fee: 2.5 billet_rate: 0.0 last_remittance: 0 days_protest: bank_issues_billet: false bank_generates_number: false billet_instructions: local_of_payment: Pagável em qualquer banco até o vencimento guarantor: assignor_format: our_number_format: other_settings: cobre_bem: create_account: summary: Conta corrente com cobrança description: Cadastra uma conta corrente disponível numa empresa, liberada a um grupo de usuários e com a cobrança pelo Monde Bancos. value: kind: checking_account description: Banco do Brasil - Matriz currency: BRL initial_balance: 1500.0 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: - *816 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 create_card_account: summary: Cartão de crédito description: Cadastra um cartão de crédito com a fatura gerada na empresa informada. value: kind: card_account description: Cartão Corporativo currency: BRL owner: id: 7b0e3c8a-2f4d-4e9b-8c1a-5d6e7f809a1b card_operator: id: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d bill_expiration: 10 bill_closing: 1 companies: - *816 invoice_company: *816 update_account: summary: Alterar descrição e convênio description: '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.' value: description: Banco do Brasil - Filial pix_key: filial@agencia.com.br billing_accounts: - id: 0f1e2d3c-4b5a-4968-8776-655443322110 agreement_code: '7654321' written_account_reference: summary: Alteração sem permissão de leitura description: 'Resposta da alteração para a credencial que não pode ler contas e cartões: só o `id`.' value: id: f9d961b8-ea88-4346-8e52-afe94267417a all_nf_rules: summary: Todas as regras da nota fiscal description: Exemplo de resposta contendo uma regra geral e uma regra restrita a produto e fornecedor. value: 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: revenues: - du_fee - rav_fee - agency_service_fee discounts: - discount supplier_rule: recipient: revenues: [] discounts: [] representative_rule: recipient: revenues: [] discounts: [] - &817 id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Seguro viagem - fornecedor emite representative_scope: none created_at: '2023-11-02T16:45:00' payer_rule: &1087 recipient: revenues: [] discounts: [] supplier_rule: &1088 recipient: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 revenues: - commission_amount - over_amount discounts: [] representative_rule: &1089 recipient: revenues: [] discounts: [] pagination: size: 20 has_next_page: false next_cursor: paginated_nf_rules: summary: Regras da nota fiscal paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *817 pagination: size: 1 has_next_page: false next_cursor: nf_rule: summary: Regra padrão de pacotes description: Exemplo de resposta de uma regra de nota fiscal específica. value: id: f9d961b8-ea88-4346-8e52-afe94267417a description: Regra padrão de pacotes representative_scope: any created_at: '2024-03-15T10:30:00' product: supplier: representative: payer: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 created_by: id: 212b54b8-27df-4859-80a9-79ad855bcd09 payer_rule: recipient: revenues: - du_fee - rav_fee - agency_service_fee discounts: - discount supplier_rule: recipient: revenues: [] discounts: [] representative_rule: recipient: revenues: [] discounts: [] all_tasks: summary: Todas as tarefas description: Exemplo de resposta contendo tarefas pendente e concluída. value: 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: visualized: false deleted: false created_at: '2024-03-15T10:30:00' - &818 id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 number: 1043 title: Cobrar segunda parcela description: 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: paginated_tasks: summary: Tarefas paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *818 pagination: size: 1 has_next_page: false next_cursor: task_detail: summary: Tarefa com histórico e campos personalizados description: Exemplo de consulta de uma tarefa com o histórico e os campos personalizados. value: 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: 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: 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: person: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 attachments: - id: 0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e description: voucher.pdf extension: pdf content_type: application/pdf download_url: https://web.monde.com.br/api/v3/attachments/0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e/download - created_at: '2024-03-15T10:30:00' text: historic: Tarefa cadastrada person: attachments: [] custom_fields: - id: 123 value: Alta attachments: - id: 0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e description: voucher.pdf extension: pdf content_type: application/pdf download_url: https://web.monde.com.br/api/v3/attachments/0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e/download create_task: summary: Tarefa com todos os campos description: Exemplo de criação de uma tarefa com pessoa vinculada, comentário inicial e campo personalizado. value: 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 create_required_fields_task: summary: Tarefa só com os campos obrigatórios description: Exemplo de criação com o mínimo que o Monde exige — título e responsável. Sem vencimento, a tarefa nunca fica atrasada. value: company_identifier: '46598887000162' title: Cobrar segunda parcela assignee_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 update_task: summary: Alteração de tarefa description: Exemplo de alteração do título, do vencimento, do responsável e de um campo personalizado de uma tarefa já cadastrada. value: 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 complete_task: summary: Conclusão de tarefa description: Exemplo de conclusão de uma tarefa, sem alterar nenhum outro campo. value: completed: true written_task_reference: summary: Tarefa gravada, sem permissão de leitura description: 'Resposta da alteração e do comentário para a credencial que não tem a permissão "Visualizar" de tarefas na empresa da tarefa, mesmo na tarefa que ela criou: traz apenas o id da tarefa.' value: id: f9d961b8-ea88-4346-8e52-afe94267417a create_task_historic: summary: Comentário na tarefa description: Exemplo de comentário acrescentado ao histórico de uma tarefa existente. value: text: Cliente confirmou os dados do embarque. create_task_historic_with_attachments: summary: Comentário com anexos description: Exemplo de comentário com dois arquivos já enviados à tarefa em Enviar anexo. value: text: Seguem o voucher e o seguro viagem. attachment_ids: - 5f1c2a8e-9b4d-4c6a-8e2f-1a3b5c7d9e0f - 8a2d4e6f-1b3c-4d5e-9f7a-2c4e6a8b0d1f all_task_categories: summary: Todas as categorias de tarefas description: Exemplo de resposta contendo categorias de tarefas, duas delas no quadro. value: data: - id: 12 name: Cobrança kanban: false kanban_position: - 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: task_category: summary: Categoria de tarefa description: Exemplo de resposta com uma categoria de tarefa específica. value: id: 42 name: Emissão kanban: true kanban_position: 2 create_task_category: summary: Criar como segunda coluna do quadro description: Cria a categoria e a põe na segunda coluna do quadro de tarefas. value: name: Emissão kanban_position: 2 rename_task_category: summary: Renomear description: Altera só o nome da categoria; as tarefas dela acompanham. value: name: Emissão de bilhetes move_task_category: summary: Mover para a primeira coluna description: Leva a coluna da categoria para o início do quadro de tarefas. value: kanban_position: 1 hide_task_category: summary: Tirar do quadro description: Tira a categoria do quadro de tarefas, sem mexer nas tarefas dela. value: kanban: false written_task_category_reference: summary: Categoria alterada, sem permissão de leitura description: 'Resposta da alteração quando a credencial não tem a permissão de ler categorias de tarefas: só o `id`.' value: id: 42 all_travels: summary: Todas as viagens description: Exemplo de resposta contendo viagens a iniciar e finalizada. value: 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' - &819 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: created_at: '2024-01-10T09:00:00' pagination: size: 20 has_next_page: false next_cursor: paginated_travels: summary: Viagens paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *819 pagination: size: 1 has_next_page: false next_cursor: travel: summary: Detalhe da viagem description: Exemplo de viagem com referências às vendas e aos passageiros vinculados. value: 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 download_url: https://web.monde.com.br/api/v3/attachments/1c2d3e4f-5a6b-4c7d-9e8f-0a1b2c3d4e5f/download custom_fields: - id: 7 value: Lua de mel created_travel: summary: Viagem criada description: 'Viagem recém-cadastrada, ainda sem vendas vinculadas: sem datas e sem situação.' value: id: f9d961b8-ea88-4346-8e52-afe94267417a number: '000043' description: Lua de mel - Cancún situation: start_date: end_date: 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: sales: [] passengers: [] attachments: [] custom_fields: [] create_travel: summary: Cadastrar viagem description: Viagem com descrição, cliente, vendedor e observações. value: 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. update_travel: summary: Alterar a descrição e as observações description: Só os campos enviados mudam. value: description: Lua de mel - Cancún e Tulum observations: Incluir o passeio a Tulum. written_travel_reference: summary: Viagem gravada, sem permissão de leitura description: Resposta para a credencial que grava viagens mas não tem a permissão "Ler todas as viagens" na empresa da viagem. value: id: f9d961b8-ea88-4346-8e52-afe94267417a all_quotes: summary: Todos os orçamentos description: Exemplo de resposta contendo orçamentos ativo e desativado. value: 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 public_url: https://suaviagem.app/a1B2c3-cancun internal_observations: Cliente pediu retorno até sexta. cover_kind: color cover_color: "#1f4e79" cover_show_title: true cover_show_subtitle: true cover_image_url: created_at: '2024-03-15T10:30:00' updated_at: '2024-03-16T08:15:00' - &820 id: 41 title: Buenos Aires subtitle: Feriado prolongado details: Aéreo + hotel 4 estrelas no centro. valid_until: '2024-02-28' active: false public_url: https://suaviagem.app/x9Y8z7-buenos-aires internal_observations: cover_kind: none cover_color: cover_show_title: true cover_show_subtitle: true cover_image_url: created_at: '2024-01-10T09:00:00' updated_at: '2024-01-12T14:20:00' pagination: size: 20 has_next_page: false next_cursor: paginated_quotes: summary: Orçamentos paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *820 pagination: size: 1 has_next_page: false next_cursor: quote: summary: Orçamento de lua de mel description: Exemplo de resposta de um orçamento específico. value: id: 42 title: Cancún subtitle: Lua de mel - 14 noites details: Pacote com aéreo, hospedagem all inclusive e traslados. valid_until: '2024-05-31' active: true public_url: https://suaviagem.app/a1B2c3-cancun internal_observations: Cliente pediu retorno até sexta. cover_kind: color cover_color: "#1f4e79" cover_show_title: true cover_show_subtitle: true cover_image_url: 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 create_quote: summary: Criar um orçamento description: Exemplo de criação de um orçamento com pessoa e observações internas. value: 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: "

Pacote com aéreo, hospedagem all inclusive e traslados.

" internal_observations: Cliente pediu retorno até sexta. cover_color: "#1f4e79" update_quote: summary: Alterar subtítulo e validade description: Exemplo de alteração que muda só o subtítulo e a validade, mantendo os demais campos. value: subtitle: Lua de mel - 10 noites valid_until: '2035-06-15' unlink_quote_person: summary: Tirar a pessoa do orçamento description: Exemplo de alteração que deixa o orçamento sem pessoa. value: person_id: written_quote_reference: summary: Orçamento gravado, sem a permissão de leitura description: 'Resposta quando a credencial não tem a permissão "Ler todos os orçamentos" na empresa do orçamento: a gravação é feita, e só o `id` volta.' value: id: 42 duplicate_quote: summary: Duplicar um orçamento description: Exemplo de duplicação com a nova validade e outra pessoa. value: user_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 valid_until: '2035-07-31' person_id: 7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f duplicated_quote: summary: Cópia do orçamento description: Exemplo de resposta com a cópia criada. value: id: 43 title: "(cópia) Cancún" subtitle: Lua de mel - 14 noites details: "

Pacote com aéreo, hospedagem all inclusive e traslados.

" valid_until: '2035-07-31' active: true public_url: https://suaviagem.app/d4E5f6-copia-cancun internal_observations: Cliente pediu retorno até sexta. cover_kind: color cover_color: "#1f4e79" cover_show_title: true cover_show_subtitle: true cover_image_url: 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 all_guides: summary: Todos os guias description: Exemplo de resposta contendo um guia ativo e um desativado. value: data: - id: 42 title: Lisboa subtitle: Roteiro de 5 dias details: "

Dia 1

Chegada e passeio pela Baixa.

" active: true public_url: https://suaviagem.app/guia/a1B2c3-lisboa 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: created_at: '2024-03-15T10:30:00' updated_at: '2024-03-16T08:15:00' - &821 id: 41 title: Buenos Aires subtitle: Feriado prolongado details: "

Tango em San Telmo e jantar em Puerto Madero.

" active: false public_url: https://suaviagem.app/guia/x9Y8z7-buenos-aires internal_observations: cover_kind: color cover_color: "#5f6777" cover_show_title: true cover_show_subtitle: true hide_cover_text: false cover_image_url: created_at: '2024-01-10T09:00:00' updated_at: '2024-01-12T14:20:00' pagination: size: 20 has_next_page: false next_cursor: paginated_guides: summary: Guias paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *821 pagination: size: 1 has_next_page: false next_cursor: guide: summary: Guia de Lisboa description: Exemplo de resposta de um guia específico. value: id: 42 title: Lisboa subtitle: Roteiro de 5 dias details: "

Dia 1

Chegada e passeio pela Baixa.

" active: true public_url: https://suaviagem.app/guia/a1B2c3-lisboa 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: 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 create_guide: summary: Criar um guia description: Exemplo de criação de um guia com observações internas. value: company_identifier: '46598887000162' user_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 title: Lisboa subtitle: Roteiro de 5 dias details: "

Dia 1

Chegada e passeio pela Baixa.

" internal_observations: Enviar junto com o voucher. cover_color: "#1f4e79" update_guide: summary: Alterar título e subtítulo description: Exemplo de alteração que muda só o título e o subtítulo, mantendo os demais campos. value: title: Lisboa e Sintra subtitle: Roteiro de 6 dias deactivate_guide: summary: Desativar o guia description: Exemplo de alteração que desativa o guia, tirando do ar o link público. value: active: false written_guide_reference: summary: Guia alterado, sem a permissão de leitura description: 'Resposta quando a credencial não tem a permissão "Ler todos os guias" na empresa do guia: a alteração é gravada, e só o `id` volta.' value: id: 42 duplicate_guide: summary: Duplicar um guia description: Exemplo de duplicação informando o dono da cópia. value: user_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 duplicated_guide: summary: Cópia do guia description: Exemplo de resposta com a cópia criada. value: id: 43 title: "(cópia) Lisboa" subtitle: Roteiro de 5 dias details: "

Dia 1

Chegada e passeio pela Baixa.

" active: true public_url: https://suaviagem.app/guia/d4E5f6-copia-lisboa 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: 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 all_invoice_rules: summary: Todas as regras de faturamento description: Exemplo de resposta contendo regras de fornecedor e de cliente. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a description: Faturamento semanal aéreo person_kind: supplier destination: national movement: to_pay cost_center: closing: period_kind: weekly week_start: monday custom_period: custom_period_due_date: date_to_use: after_checkin due_date: days_to_skip: 5 on_weekend: stay - &822 id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Cliente corporativo mensal person_kind: customer destination: every movement: every_movement cost_center: Comercial closing: &1090 period_kind: monthly week_start: custom_period: custom_period_due_date: date_to_use: after_sale_date due_date: &1091 days_to_skip: 10 on_weekend: next pagination: size: 20 has_next_page: false next_cursor: paginated_invoice_rules: summary: Regras de faturamento paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *822 pagination: size: 1 has_next_page: false next_cursor: invoice_rule: summary: Faturamento semanal aéreo description: Exemplo de resposta de uma regra de faturamento específica. value: id: f9d961b8-ea88-4346-8e52-afe94267417a description: Faturamento semanal aéreo person_kind: supplier destination: national movement: to_pay cost_center: closing: period_kind: weekly week_start: monday custom_period: custom_period_due_date: date_to_use: after_checkin due_date: days_to_skip: 5 on_weekend: stay person: product: supplier: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 requester: all_integrations: summary: Todas as integrações description: Exemplo de resposta contendo integrações de fornecedor e de buscador. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a description: Assist Card Matriz active: true vendor_id: b2359357-cff7-4d43-b6d2-99adf2ff373b vendor_name: Assist Card - &823 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: paginated_integrations: summary: Integrações paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *823 pagination: size: 1 has_next_page: false next_cursor: integration: summary: Integração ativa description: Exemplo de resposta de uma integração específica, com o usuário e a senha omitidos. value: 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: filled: true - name: pass type: password value: filled: true all_people: summary: Todas as pessoas description: Exemplo de resposta da consulta contendo pessoa física e pessoa jurídica. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a code: 1042 person_kind: individual name: Carlos Souza legal_name: cpf_cnpj: '12345678909' gender: male birthdate: '1985-07-22' rg_ie: '203456789' city_inscription: tax_identification_number: passport_number: BR123456 passport_expiration_date: '2028-10-01' foreigner: false foreign_identity_document: email: carlos@exemplo.com.br phone_number: '4133334444' mobile_number: '41999998888' business_phone: '4130302020' website: cvc_code: observations: Cliente preferencial. charge_billet_fee: false created_at: '2021-11-05T10:30:00' address: &825 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: &826 marital_status: married rg_emitter: SSP/PR rg_issue_date: '2008-03-15' birth_certificate: mother_name: Ana Souza last_contacts: &827 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: airline: - &824 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: birthdate: rg_ie: '9012345678' city_inscription: '1234567' tax_identification_number: passport_number: passport_expiration_date: foreigner: false foreign_identity_document: email: contato@operadora.com.br phone_number: '4133334444' mobile_number: business_phone: website: https://www.operadora.com.br cvc_code: observations: charge_billet_fee: true created_at: '2019-04-18T08:15:00' address: &1092 postal_code: '80010000' street: Rua das Flores street_number: '100' neighborhood: Centro additional_info: city: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 additional_data: last_contacts: &1093 first_sale_date: last_sale_date: last_departure_date: last_return_date: last_task_update_at: tax_withholding: &1094 iss: true ir: false pis_cofins_csll: false airline: pagination: size: 20 has_next_page: false next_cursor: paginated_people: summary: Pessoas paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *824 pagination: size: 1 has_next_page: false next_cursor: person_detail: summary: Consulta de pessoa por ID description: Exemplo da consulta completa de uma pessoa física, com os blocos agrupados e as entidades fracas. value: id: f9d961b8-ea88-4346-8e52-afe94267417a code: 1042 person_kind: individual name: Carlos Souza legal_name: cpf_cnpj: '12345678909' gender: male birthdate: '1985-07-22' rg_ie: '203456789' city_inscription: tax_identification_number: passport_number: BR123456 passport_expiration_date: '2028-10-01' foreigner: false foreign_identity_document: email: carlos@exemplo.com.br phone_number: '4133334444' mobile_number: '41999998888' business_phone: '4130302020' website: cvc_code: observations: Cliente preferencial. charge_billet_fee: false created_at: '2021-11-05T10:30:00' address: *825 additional_data: *826 last_contacts: *827 tax_withholding: airline: birthplace: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 seller: id: c3b7e8eb-1199-4457-9170-923c3fe56c92 promoter: 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 download_url: https://web.monde.com.br/api/v3/attachments/3e1c4d5f-6071-4283-a495-1c2d3e4f5061/download credit_cards: - id: 6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c name: Cartão Corporativo last_digits: '1111' expiration_date: '2030-05-01' issuer: Visa ticket_card: cost_centers: kandir_law: invoice_rules: - id: 8b5e2f10-4c3d-4e6f-9a1b-2c3d4e5f6a7b photo: content_type: image/jpeg size: 48213 create_individual_person: summary: Cadastro de pessoa física description: Exemplo de cadastro de pessoa física com endereço, naturalidade, documentos e filiação. value: 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 create_company_person: summary: Cadastro de pessoa jurídica description: Exemplo de cadastro de pessoa jurídica com retenção de impostos e dados de companhia aérea. value: person_kind: company external_id: CRM-9902 name: Epic Journey legal_name: Epic Journey S.A. cpf_cnpj: '50559280000140' rg_ie: '123456789012' foreigner: false email: contato@epicjourney.com.br phone_number: '1134567890' website: https://epicjourney.com.br city_inscription: '987654321' tax_identification_number: US1234567 charge_billet_fee: true address: postal_code: '04078011' street: Avenida Divino Salvador street_number: '5000' city_ibge: '3550308' tax_withholding: iss: true ir: false pis_cofins_csll: true airline: code: JJ number: '957' credit_cards: - number: '4111111111111111' cvv: '123' name: EPIC JOURNEY issuer: Visa expiration_month: 11 expiration_year: 2030 cost_centers: - name: Diretoria - name: Comercial kandir_law: - product: id: 39476d8f-d375-4daa-94ea-4136da2be63a amount: national: ir: 1.5 csll: 1 pis: 0.65 cofins: 3 updated_person_reference: summary: Pessoa alterada, sem permissão de leitura description: 'Resposta da alteração para a credencial que não tem a permissão "Visualizar" de pessoas: traz apenas o id da pessoa alterada.' value: id: f9d961b8-ea88-4346-8e52-afe94267417a update_person: summary: Alteração de pessoa description: Exemplo de alteração de contato, endereço, marcadores e campos personalizados de uma pessoa já cadastrada. value: 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 all_labels: summary: Todos os marcadores description: Exemplo de resposta contendo todos os marcadores cadastrados. value: 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: paginated_labels: summary: Marcadores paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - id: c3b7e8eb-1199-4457-9170-923c3fe56c92 name: Lua de mel pagination: size: 2 has_next_page: false next_cursor: label: summary: Marcador VIP description: Exemplo de resposta de um marcador específico. value: id: 2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50 name: VIP create_label: summary: Criar marcador description: Cria o marcador VIP. value: name: VIP update_label: summary: Renomear marcador description: Troca o nome do marcador. value: name: Cliente VIP written_label_reference: summary: Alteração sem permissão de leitura description: 'Resposta da alteração quando a credencial não tem a permissão "Visualizar" de marcadores: traz só o `id`.' value: id: 2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50 all_companies: summary: Todas as empresas description: Exemplo de resposta com as empresas que a credencial alcança, uma delas somente leitura. value: 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: company: summary: Empresa description: Exemplo de resposta de uma empresa específica. value: 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 bills_list: summary: Contas a receber e a pagar description: Exemplo de resposta contendo uma conta a receber (fatura de cliente) e uma conta a pagar (fatura de cartão). value: 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.0 final_amount: 1500.0 issue_date: '2026-01-10' due_date: '2026-02-10' settlement_date: 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: observations: billet: &1095 status: registered number: 12345 our_number: '000000012345' amount: 1500.0 demonstrative: Pagável em qualquer banco até o vencimento. rejection_reason: account: id: d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9 check: card: - &828 id: 9f8e7d6c-5b4a-4938-8271-6f5e4d3c2b1a number: '67890' transaction_kind: debit kind: credit_card_invoice description: Fatura Mastercard document: invoice_number: 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: billet: check: card: &1096 brand: MasterCard last_digits: '4117' authorization: '600551159' pagination: size: 20 has_next_page: false next_cursor: paginated_bills: summary: Contas paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *828 pagination: size: 1 has_next_page: false next_cursor: receivable_bill_single: summary: Conta a receber (fatura de cliente) description: Exemplo de detalhe de uma fatura de cliente, com categorias, movimentações, rateios, itens, anexos e campos personalizados. value: 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.0 final_amount: 1500.0 issue_date: '2026-01-10' due_date: '2026-02-10' settlement_date: 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: observations: billet: status: registered number: 12345 our_number: '000000012345' amount: 1500.0 demonstrative: Pagável em qualquer banco até o vencimento. rejection_reason: account: id: d4e5f6a7-b8c9-4011-e2f3-a4b5c6d7e8f9 check: card: sale: 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: 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.0 amount: 750.0 company: id: f6a7b8c9-d0e1-4233-a4b5-c6d7e8f9a0b1 - percentage: 50.0 amount: 750.0 company: id: a7b8c9d0-e1f2-4344-b5c6-d7e8f9a0b1c2 per_cost_center: - percentage: 100.0 amount: 1500.0 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 download_url: https://web.monde.com.br/api/v3/attachments/b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3/download categories: - amount: 1500.0 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: - description: cost_center: checked: false amount: 205.28 sale: sale_product: cvc_statement: id: 6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d credit_card_items: [] card_invoice_bill_single: summary: Conta a pagar (fatura de cartão) description: Exemplo de detalhe de uma fatura de cartão, com as cobranças em credit_card_items e items vazio. value: id: 9f8e7d6c-5b4a-4938-8271-6f5e4d3c2b1a number: '67890' transaction_kind: debit kind: credit_card_invoice description: Fatura Mastercard document: invoice_number: 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: billet: check: card: brand: MasterCard last_digits: '4117' authorization: '600551159' sale: person: id: b2c3d4e5-f6a7-4809-c0d1-e2f3a4b5c6d7 company: id: 0a1b2c3d-4e5f-4677-8899-aabbccddeeff account: id: c0d1e2f3-a4b5-4677-d8e9-f0a1b2c3d4e5 payment_method: id: d1d2d3d4-e5e6-4900-f1f2-a3a4a5a6a7a8 operation: invoice_rule: created_by: id: e5f6a7b8-c9d0-4122-f3a4-b5c6d7e8f9a0 movements: - id: 7c8d9e0f-2a3b-4c5d-9e0f-1a2b3c4d5e6f apportionments: per_company: [] per_cost_center: [] custom_fields: [] attachments: [] categories: [] commissions: [] items: [] credit_card_items: - date: '2026-04-08' amount: -717.91 checked: false movement: id: 3e8a94e5-128a-4bcc-8e0d-c17025b0286a bill: id: d1e2f3a4-b5c6-4788-e9f0-a1b2c3d4e5f6 - date: '2026-04-08' amount: -272.0 checked: false movement: id: 5c9b07f2-3d61-4a88-9f2e-70b4c1a5d3e8 bill: id: e2f3a4b5-c6d7-4899-f0a1-b2c3d4e5f6a7 vendor_invoice_bill_single: summary: Conta a pagar (fatura de fornecedor) description: Exemplo de detalhe de uma fatura de fornecedor, com os itens em items e credit_card_items vazio. value: id: 3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d number: '291' transaction_kind: debit kind: vendor_invoice description: Fatura Fornecedor Avulsa document: invoice_number: amount: 4.0 final_amount: 4.0 issue_date: '2026-07-13' due_date: '2026-07-13' settlement_date: 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: observations: billet: check: card: sale: person: id: d1e2f3a4-b5c6-4788-e9f0-a1b2c3d4e5f6 company: id: 0a1b2c3d-4e5f-4677-8899-aabbccddeeff account: payment_method: operation: invoice_rule: 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: checked: false amount: -4.0 sale: id: 8b9c0d1e-2f3a-4b5c-8d6e-7f8a9b0c1d2e sale_product: id: f0a1b2c3-d4e5-4966-a7b8-c9d0e1f2a3b4 cvc_statement: credit_card_items: [] commission_bill_single: summary: Conta a pagar (comissão) description: Exemplo de detalhe de uma conta de comissão, com as linhas em commissions e os arrays de item vazios. value: id: 6f5e4d3c-2b1a-4098-8f7e-6d5c4b3a2109 number: '170114' transaction_kind: debit kind: commission description: Comissão - Julho/2026 document: invoice_number: amount: 317.1 final_amount: 317.1 issue_date: '2026-07-01' due_date: '2026-07-31' settlement_date: created_at: '2026-07-01T09:00:00' canceled: false checked: false invoice_closed: false system_generated: false generates_credit: false periodicity: without_periodicity recurrence_kind: non_recurrent recurrence_group_id: observations: billet: check: card: sale: person: id: b1c2d3e4-f5a6-4788-b9c0-d1e2f3a4b5c6 company: id: 0a1b2c3d-4e5f-4677-8899-aabbccddeeff account: payment_method: operation: invoice_rule: created_by: id: e5f6a7b8-c9d0-4122-f3a4-b5c6d7e8f9a0 movements: [] apportionments: per_company: [] per_cost_center: [] custom_fields: [] attachments: [] categories: [] commissions: - description: 'Plano: Carla Côrte Xavier Flor 10%, meta do mês' amount: 205.28 retained_amount: 0.0 balance: 205.28 person: id: c1d2e3f4-a5b6-4788-c9d0-e1f2a3b4c5d6 - description: 'Plano: Carla Côrte Xavier Flor 10%, meta do mês' amount: 111.82 retained_amount: 0.0 balance: 111.82 person: id: c1d2e3f4-a5b6-4788-c9d0-e1f2a3b4c5d6 items: [] credit_card_items: [] create_bill: summary: Conta a pagar completa description: Conta a pagar com documento, conta prevista, duas categorias, rateio por centro de custo e entre empresas, e campo personalizado. value: company_identifier: '46598887000162' transaction_kind: debit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Aluguel escritório - Outubro/2026 document: NF 1001 amount: 1500.0 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.0 description: Aluguel - category_id: e5f6a7b8-c9d0-4e1f-a2b3-c4d5e6f7a8b9 amount: 300.0 apportionments: per_cost_center: - cost_center_id: 0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d percentage: 60.0 per_company: - company_identifier: '46598887000162' percentage: 100.0 custom_fields: - id: 123 value: Matriz create_required_fields_bill: summary: Conta a receber só com os campos obrigatórios description: Conta a receber com uma categoria; a emissão é hoje e a conta é a de previsão padrão da empresa. value: company_identifier: '46598887000162' transaction_kind: credit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Mensalidade de consultoria amount: 800.0 due_date: '2026-10-20' categories: - category_id: d4c8f9fc-22aa-4568-a281-a34d4bf67da3 amount: 800.0 create_sale_bill: summary: Conta a pagar da venda description: Conta a pagar lançada na venda, sem company_identifier. O lançamento fica na empresa da venda, como avulso dela, e sem conta prevista. value: sale_id: 5b1d2c3e-6f7a-4b8c-9d0e-1f2a3b4c5d6e transaction_kind: debit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Transfer extra do pacote amount: 150.0 due_date: '2026-11-05' categories: - category_id: d4c8f9fc-22aa-4568-a281-a34d4bf67da3 amount: 150.0 create_settled_bill: summary: Conta a pagar já liquidada description: Conta a pagar criada já paga, com a movimentação em dinheiro na conta caixa. value: company_identifier: '46598887000162' transaction_kind: debit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Energia elétrica - Setembro/2026 amount: 420.0 issue_date: '2026-10-01' due_date: '2026-10-10' categories: - category_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d amount: 420.0 settlement_date: '2026-10-10' movements: - account_id: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01 payment_method_id: fc9f5c65-71b2-4bab-ba56-aee44fe6d998 date: '2026-10-10' amount: 420.0 create_settled_bill_with_fine: summary: Conta a pagar liquidada com multa description: 'Conta de R$ 420,00 paga com R$ 12,60 de multa: a diferença vai para a categoria informada, e o valor final passa a ser R$ 432,60.' value: company_identifier: '46598887000162' transaction_kind: debit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Energia elétrica - Setembro/2026 amount: 420.0 issue_date: '2026-10-01' due_date: '2026-10-10' categories: - category_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d amount: 420.0 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: 432.6 balance_resolution: category balance_category_id: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e create_installment_bill: summary: Conta a pagar parcelada description: Conta a pagar em 3 parcelas mensais. A resposta traz o lançamento com o `recurrence_group_id`; as 3 parcelas se consultam por ele em `GET /bills`, depois de geradas em segundo plano. value: company_identifier: '46598887000162' transaction_kind: debit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Notebook equipe comercial amount: 1500.0 issue_date: '2026-10-07' due_date: '2026-10-15' categories: - category_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d amount: 1500.0 recurrence_kind: installment periodicity: monthly installments: 3 create_recurrent_bill: summary: Conta a pagar recorrente description: Aluguel mensal. A recorrência gera os lançamentos dos próximos 5 anos, como no Monde. value: company_identifier: '46598887000162' transaction_kind: debit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Aluguel escritório amount: 3200.0 issue_date: '2026-10-01' due_date: '2026-10-10' categories: - category_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d amount: 3200.0 recurrence_kind: recurrent periodicity: monthly create_partial_settled_bill: summary: Conta a pagar com pagamento parcial description: Conta de R$ 420,00 paga com R$ 300,00. O lançamento é liquidado com o que foi pago, e o saldo de R$ 120,00 vira um novo lançamento em aberto, referenciado em `generated_bills`. value: company_identifier: '46598887000162' transaction_kind: debit person_id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Energia elétrica - Setembro/2026 amount: 420.0 issue_date: '2026-10-01' due_date: '2026-10-10' categories: - category_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d amount: 420.0 settlement_date: '2026-10-10' movements: - account_id: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01 payment_method_id: fc9f5c65-71b2-4bab-ba56-aee44fe6d998 date: '2026-10-10' amount: 300.0 partial_payment: true update_bill: summary: Alteração da descrição, documento, vencimento e observações description: Altera só os campos informados; os demais ficam como estão. value: description: Aluguel escritório - Novembro/2026 document: NF 1002 due_date: '2026-11-15' observations: Vencimento renegociado com o locador update_bill_values: summary: Alteração do valor, das categorias e do rateio por centro de custo description: Troca as categorias e o valor, e substitui o rateio por centro de custo; o rateio entre empresas fica como está. value: amount: 1600.0 categories: - category_id: d4c8f9fc-22aa-4568-a281-a34d4bf67da3 amount: 1300.0 description: Aluguel - category_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d amount: 300.0 apportionments: per_cost_center: - cost_center_id: 5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b percentage: 100 update_settled_bill: summary: Alteração do valor de um lançamento liquidado e conciliado description: Muda o valor e a movimentação que o paga, junto com a data de liquidação. O lançamento está na conciliação bancária, e a confirmação em `undo_bank_reconciliation` deixa a alteração ser gravada, desfazendo a conciliação da movimentação. value: amount: 1600.0 settlement_date: '2026-10-12' movements: - id: 6b1d0c2e-8f3a-4d5b-9e7c-1a2b3c4d5e6f amount: 1600.0 date: '2026-10-12' undo_bank_reconciliation: true settle_bill: summary: Liquidação pelo valor cheio description: Conta de R$ 420,00 paga em dinheiro na conta caixa. value: 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.0 settle_bill_with_fine: summary: Liquidação com multa description: 'Conta de R$ 420,00 paga com R$ 12,60 de multa: a diferença vai para a categoria informada, e o valor final passa a ser R$ 432,60.' value: 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: 432.6 balance_resolution: category balance_category_id: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e settle_bill_partially: summary: Pagamento parcial description: Conta de R$ 420,00 paga com R$ 300,00. O lançamento é liquidado com o que foi pago, e o saldo de R$ 120,00 vira um novo lançamento em aberto, referenciado em `generated_bills`. value: 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: 300.0 balance_resolution: partial settle_bills_in_batch: summary: Liquidação de duas contas na mesma conta description: Duas contas pagas em dinheiro na conta caixa, cada uma pelo valor final. value: 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 settle_sale_payments_in_batch: summary: Liquidação com os dados da venda description: Dois pagamentos da venda liquidados na conta corrente, cada um com a forma e os dados de cartão ou cheque da própria venda. value: bill_ids: - 3a4b5c6d-7e8f-4a0b-9c1d-2e3f4a5b6c7d - 4b5c6d7e-8f9a-4b1c-8d2e-3f4a5b6c7d8e settlement_date: '2026-10-14' account_id: 9e3a2b01-5c8f-4d22-8a4b-6f7e8d9c0b12 use_sale_data: true batch_settled_bills_references: summary: Lançamentos liquidados, sem permissão de leitura description: '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.' value: data: - id: 212b54b8-27df-4859-80a9-79ad855bcd09 - id: 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f written_bill_reference: summary: Lançamento alterado, sem permissão de leitura description: '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.' value: id: 212b54b8-27df-4859-80a9-79ad855bcd09 all_account_movements: summary: Todas as movimentações description: Exemplo de resposta com uma liquidação em cartão e uma transferência entre contas. value: data: - id: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 date: '2026-01-26' amount: -9112.17 transaction_kind: debit description: check: card: &1097 brand: MasterCard last_digits: '4117' authorization: '600551159' - &829 id: 0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40 date: '2026-01-26' amount: 63063.0 transaction_kind: credit description: Repasse diário check: card: pagination: size: 20 has_next_page: false next_cursor: paginated_account_movements: summary: Movimentações paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *829 pagination: size: 1 has_next_page: false next_cursor: settlement_account_movement: summary: Liquidação em cartão description: Exemplo de movimentação que liquida uma conta a pagar em cartão de crédito. value: id: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 date: '2026-01-26' amount: -9112.17 transaction_kind: debit description: check: 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: counterpart_account: transfer_account_movement: summary: Transferência entre contas description: Exemplo de movimentação de transferência, com a referência para o movimento do outro lado. value: id: 0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40 date: '2026-01-26' amount: 63063.0 transaction_kind: credit description: Repasse diário check: card: account: id: f9d961b8-ea88-4346-8e52-afe94267417a payment_method: bill: credit_card_invoice: counterpart_account: id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 all_refunds: summary: Todos os reembolsos description: Exemplo de resposta com um reembolso de fornecedor e um reembolso de cliente. value: 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' - &830 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: paginated_refunds: summary: Reembolsos paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *830 pagination: size: 1 has_next_page: false next_cursor: vendor_refund: summary: Reembolso de fornecedor description: Exemplo de reembolso de fornecedor, já com conta a pagar ou a receber. value: 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: &1098 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 sale_product: &1099 id: 7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92 person: &1100 id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 company: &1101 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 bill: &1102 id: 212b54b8-27df-4859-80a9-79ad855bcd09 customer_refund: summary: Reembolso de cliente description: Exemplo de reembolso de cliente ainda sem conta a pagar ou a receber. value: 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: &1103 id: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63 sale_product: &1104 id: e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148 person: &1105 id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 company: &1106 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 bill: create_customer_refund: summary: Reembolso ao cliente para faturar description: Exemplo de reembolso ao cliente que vai para a fatura do cliente. value: 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 create_vendor_refund: summary: Reembolso do fornecedor com conta a pagar description: Exemplo de reembolso pago ao fornecedor, com a fatura avulsa gerada na hora. value: sale_product_id: 7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92 refund_type: vendor amount: 91.36 transaction_kind: debit billing: bill issue_date: '2021-06-16' description: Reembolso Incentivo passenger_list: summary: Lista de passageiros description: Um passageiro de passagem aérea com conexão numa venda fechada, dentro de uma viagem, com assento marcado só no primeiro trecho. value: 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: 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: canceled_at: 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: departure_date: '2026-11-10T23:55:00' arrival_date: '2026-11-11T17:05:00' destination: international document: ABC123 product_details: nights: accommodation_kind: room_category: meal_plan: cabin_kind: cabin_number: cabin_category: ship_name: cruise_destination: vehicle_category: pickup_location: dropoff_location: package_name: transport: 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: amounts: currency: BRL amount: 3200.0 fees: 420.5 other_fees: 0.0 total_fees: 420.5 du_fee: 0.0 du_fee_discount: 0.0 rav_fee: 150.0 rav_fee_discount: 0.0 agency_fee: 0.0 customer_amount: 3200.0 total_amount: 3770.5 external_number: additional1: additional2: 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: requester: approver: own_operation: 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: sales_by_product: summary: Vendas por produto description: Uma passagem aérea com um passageiro, uma nota fiscal e a comissão, numa agência sem multimoedas. value: 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: 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: intermediary: approver: 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: 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: quantity: 1 destination: international document: ABC123 external_number: additional1: additional2: product_details: nights: accommodation_kind: room_category: meal_plan: cabin_kind: cabin_number: cabin_category: ship_name: cruise_destination: vehicle_category: pickup_location: dropoff_location: package_name: transport: 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.0 unit_fees: 380.0 total_products: 4500.0 fees: 380.0 other_fees: 0.0 total_fees: 380.0 du_fee: 120.0 cc_du_fee: 0.0 cc_du_fee_percentage: 0.0 du_fee_discount: 0.0 rav_fee: 0.0 cc_rav_fee: 0.0 cc_rav_fee_percentage: 0.0 rav_fee_discount: 0.0 agency_fee: 0.0 agency_service_fee: 0.0 discount: 0.0 total_discount: 0.0 deductions: 0.0 billing: 5000.0 total_amount: 5000.0 customer_refund: 0.0 supplier_refund: 0.0 agency_card_rate: 0.0 supplier_fine: 0.0 deleted_balance: 0.0 kandir_retention: 0.0 origin_amounts: currency: BRL exchange_rate: 1.0 total_products: 4500.0 total_fees: 380.0 agency_fee: 0.0 du_fee: 120.0 deductions: 0.0 agency_service_fee: 0.0 discount: 0.0 du_fee_discount: 0.0 rav_fee_discount: 0.0 total_amount: 5000.0 commission: commission_amount: 450.0 commission_percentage: 10.0 over: 0.0 over_amount: 0.0 over_percentage: 0.0 intermediary_commission_amount: 0.0 intermediary_commission_percentage: 0.0 intermediary_over_amount: 0.0 intermediary_over_percentage: 0.0 revenue: 570.0 revenue_percentage: 11.4 custom_fields: person: [] sale: [] travel: [] pagination: size: 20 has_next_page: false next_cursor: sales_by_seller: summary: Vendas por vendedor description: Uma vendedora com doze vendas fechadas no mês, numa empresa. value: 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.0 total_fees: 4980.4 du_fee: 1450.0 cc_du_fee: 0.0 du_fee_discount: 0.0 rav_fee: 960.0 cc_rav_fee: 0.0 rav_fee_discount: 0.0 agency_fee: 0.0 agency_service_fee: 0.0 discount: 178.75 deductions: 0.0 commission: commission_amount: 5390.5 over_amount: 420.0 intermediary_commission_amount: 0.0 intermediary_over_amount: 0.0 revenue: 7616.32 pagination: size: 20 has_next_page: false next_cursor: all_cvc_statements: summary: Todos os recibos description: 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. value: data: - id: 7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92 receipt_number: '89100000164635' movement_date: '2019-12-29' sale_date: '2019-12-29T18:00:00' cancellation_date: boarding_date: '2020-04-10' return_date: '2020-04-15' product_name: Hotel Internacional package_name: MADRI total_payments: 2068.04 total_taxes: 0.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 0.0 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 0.0 opfax: 1826.4 opfax_balance: 200.9 balance: 0.0 imported: true edited: false checked: false deleted: false created_at: '2019-12-30T12:14:02' - &831 id: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 receipt_number: '89930000112199' movement_date: '2019-12-26' sale_date: '2019-12-26T18:00:00' cancellation_date: 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.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 111.33 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 34.78 opfax: 0.0 opfax_balance: 0.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: paginated_cvc_statements: summary: Recibos paginados description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *831 pagination: size: 1 has_next_page: false next_cursor: cvc_statement_with_sale: summary: Recibo com venda vinculada description: Exemplo de recibo baixado, com venda, produto da venda e nota fiscal. value: id: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 receipt_number: '89930000112199' movement_date: '2019-12-26' sale_date: '2019-12-26T18:00:00' cancellation_date: 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.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 111.33 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 34.78 opfax: 0.0 opfax_balance: 0.0 balance: 76.55 imported: true edited: false checked: false deleted: false created_at: '2019-12-30T08:45:48' movement_kind: &1107 code: 0 name: BAIXA DE RECIBO company: &1108 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 contractor: &1109 id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 seller: &1110 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 intermediary: sale: &1111 id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_product: &1112 id: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63 nf: &1113 id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 created_by: &1114 id: 1c4d8f2a-5b73-4e91-a6c8-3d90f2e5b174 manual_adjustment_cvc_statement: summary: Ajuste manual sem venda description: 'Exemplo de ajuste manual: movimento sem número de recibo, sem datas de viagem e sem venda vinculada.' value: id: 0f9e5b3d-7a21-4c68-b0d4-9e2f6a1c4b85 receipt_number: movement_date: '2020-09-15' sale_date: cancellation_date: boarding_date: return_date: product_name: package_name: total_payments: 0.0 total_taxes: 0.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 0.0 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.0 balance: 12.32 imported: true edited: false checked: false deleted: false created_at: '2020-09-16T16:16:09' movement_kind: &1115 code: 11 name: AJUSTE MANUAL company: &1116 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 contractor: seller: intermediary: sale: sale_product: nf: created_by: &1117 id: 1c4d8f2a-5b73-4e91-a6c8-3d90f2e5b174 cvc_master_statement: summary: Recibo do Master - Extrato description: Recibo digitado, sem nota fiscal. value: id: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84 receipt_number: '0217000001234' movement_date: '2026-09-10' sale_date: '2026-09-02T00:00:00' cancellation_date: boarding_date: return_date: product_name: package_name: total_payments: 4800.0 total_taxes: 120.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 480.0 retained_commission: 0.0 intermediary_commission: 96.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.0 balance: 384.0 imported: false edited: true checked: false deleted: false created_at: '2026-09-10T14:32:05' movement_kind: &832 name: Repasse Master Franqueado company: &833 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 contractor: &834 id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 seller: &835 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 intermediary: sale: sale_product: nf: created_by: cvc_master_statement_with_nf: summary: Recibo com a nota fiscal gerada description: O mesmo recibo depois de gerar a nota, que aparece em `nf`. value: id: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84 receipt_number: '0217000001234' movement_date: '2026-09-10' sale_date: '2026-09-02T00:00:00' cancellation_date: boarding_date: return_date: product_name: package_name: total_payments: 4800.0 total_taxes: 120.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 480.0 retained_commission: 0.0 intermediary_commission: 96.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.0 balance: 384.0 imported: false edited: true checked: false deleted: false created_at: '2026-09-10T14:32:05' movement_kind: *832 company: *833 contractor: *834 seller: *835 intermediary: sale: sale_product: nf: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 created_by: cvc_master_statements: summary: Recibos do Master - Extrato description: Exemplo de resposta com um recibo importado. value: data: - id: 8a5f1d27-3e9c-4b80-b6d2-1c7e4f9a3b56 receipt_number: '0217000001198' movement_date: '2026-09-08' sale_date: '2026-08-28T15:12:00' cancellation_date: 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.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 623.05 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.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: create_nf: summary: Nota com o tomador digitado description: Insere uma nota com os dados do tomador informados, retenção de ISS e dois itens. value: 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.0 - local_id: linha-2 description: Intermediação de traslado amount: 350.0 create_nf_for_person: summary: Nota para uma pessoa do cadastro description: Insere uma nota cujo tomador é uma pessoa do cadastro; data, natureza da operação e alíquotas vêm das configurações. value: company_identifier: '62046591000140' person_id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 items: - local_id: linha-1 description: Intermediação de venda de pacote amount: 1840.0 update_nf: summary: Trocar a data e os itens description: Muda a data de emissão, altera o valor de um item, inclui outro e retira os que não vieram. value: issue_date: '2026-10-20' items: - id: f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13 amount: 1600.0 - local_id: linha-3 description: Intermediação de passeio amount: 120.0 created_nf: summary: Nota fiscal gravada description: Nota não emitida, com o local_id de cada item enviado. value: id: a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35 number: series: issue_date: '2026-10-16' status: unissued operation_nature: Prestação de Serviço cfop: nbs_code: '109051200' document: manual_emission: false amount: 1850.0 service_amount: 0.0 net_amount: 1850.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: Referente à viagem de outubro cvc_original_data: printed_at: canceled_at: created_at: '2026-10-16T10:12:44' recipient: &836 kind: payer name: Esferatur Passagens e Turismo Ltda cpf_cnpj: '76530260000130' state_inscription: 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: city: id: 0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92 taxes: &837 retain_iss: true retain_ir: false retain_pis_cofins_csll: false iss_percentage: 5.0 iss_amount: 92.5 pis_percentage: 0.0 pis_amount: 0.0 cofins_percentage: 0.0 cofins_amount: 0.0 ir_percentage: 0.0 ir_amount: 0.0 csll_percentage: 0.0 csll_amount: 0.0 nfse: &838 number: batch: protocol: verification_code: processed_at: errors: person: company: &839 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 sale_product: sale: created_by: canceled_by: items: - &1128 id: f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13 local_id: linha-1 description: Intermediação de hospedagem amount: 1500.0 service_amount: 0.0 approximate_taxes_amount: 0.0 - &1129 id: 4d9b2e86-1a7c-4c35-9f04-8b6e3a1d5c72 local_id: linha-2 description: Intermediação de traslado amount: 350.0 service_amount: 0.0 approximate_taxes_amount: 0.0 written_nf_reference: summary: Resposta sem permissão de leitura description: Para quem não pode ler notas fiscais na empresa, a escrita devolve só os identificadores. value: id: a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35 items: - id: f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13 local_id: linha-1 issuance_accepted: summary: Nota aguardando emissão description: A nota enviada ao e-Notas, aguardando a resposta da prefeitura. value: id: a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35 number: series: issue_date: '2026-10-16' status: awaiting_issue operation_nature: Prestação de Serviço cfop: nbs_code: '109051200' document: manual_emission: false amount: 1850.0 service_amount: 0.0 net_amount: 1850.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: Referente à viagem de outubro cvc_original_data: printed_at: canceled_at: created_at: '2026-10-16T10:12:44' recipient: *836 taxes: *837 nfse: *838 person: company: *839 sale_product: sale: created_by: canceled_by: items: - id: f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13 description: Intermediação de hospedagem amount: 1500.0 service_amount: 0.0 approximate_taxes_amount: 0.0 manual_issuance: summary: Número da NFS-e emitida na prefeitura value: nfse_number: '4521' amount_adjustment: summary: Reduzir o valor em 10% description: Reduz em 10% o valor de cada item da nota. value: percentage: -10 all_nfs: summary: Todas as notas fiscais description: Exemplo de resposta com uma nota cancelada e uma nota emitida. value: 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: nbs_code: document: '9572810403321' manual_emission: true amount: 1840.0 service_amount: 1840.0 net_amount: 1748.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: Nota cancelada a pedido do tomador. cvc_original_data: printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: &844 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: phone: "(11) 4831-1245" email: fiscal@voeazul.com.br foreign: false foreign_document: city: id: 6d2b8e04-91a7-4c35-8f60-2a7d1c9e5b38 taxes: &845 retain_iss: true retain_ir: false retain_pis_cofins_csll: false iss_percentage: 5.0 iss_amount: 92.0 pis_percentage: 0.0 pis_amount: 0.0 cofins_percentage: 0.0 cofins_amount: 0.0 ir_percentage: 0.0 ir_amount: 0.0 csll_percentage: 0.0 csll_amount: 0.0 nfse: &846 number: '13302' batch: '8471' protocol: '202302271003410001' verification_code: K2QW71PZ processed_at: '2023-02-27T10:05:12' errors: - &840 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: nbs_code: document: manual_emission: false amount: 113.48 service_amount: 2613.82 net_amount: 113.48 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: cvc_original_data: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: &841 kind: payer name: Esferatur Passagens e Turismo Ltda cpf_cnpj: '76530260000130' state_inscription: city_inscription: postal_code: '89010300' street: Alameda Rio Branco street_number: '238' neighborhood: Jardim Blumenau additional_info: 1º andar phone: "(47) 3221-0100" email: foreign: false foreign_document: city: id: 0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92 taxes: &842 retain_iss: false retain_ir: false retain_pis_cofins_csll: false iss_percentage: 5.0 iss_amount: 5.67 pis_percentage: 0.0 pis_amount: 0.0 cofins_percentage: 0.0 cofins_amount: 0.0 ir_percentage: 0.0 ir_amount: 0.0 csll_percentage: 0.0 csll_amount: 0.0 nfse: &843 number: '13299' batch: protocol: verification_code: BFLXB50A processed_at: '2023-02-09T17:26:29' errors: pagination: size: 20 has_next_page: false next_cursor: paginated_nfs: summary: Notas fiscais paginadas description: Exemplo de resposta paginada demonstrando a segunda página de resultados. value: data: - *840 pagination: size: 1 has_next_page: false next_cursor: issued_nf: summary: Nota fiscal emitida description: Exemplo de nota fiscal emitida, com um item e as referências para a venda que a originou. value: 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: nbs_code: document: manual_emission: false amount: 113.48 service_amount: 2613.82 net_amount: 113.48 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: cvc_original_data: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: *841 taxes: *842 nfse: *843 person: &1118 id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 company: &1119 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 sale_product: &1120 id: 7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92 sale: &1121 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 created_by: &1122 id: 3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15 canceled_by: items: - &1123 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.0 canceled_nf: summary: Nota fiscal cancelada description: Exemplo de nota fiscal cancelada, emitida manualmente e sem vínculo com produto de venda. value: 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: nbs_code: document: '9572810403321' manual_emission: true amount: 1840.0 service_amount: 1840.0 net_amount: 1748.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: Nota cancelada a pedido do tomador. cvc_original_data: printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: *844 taxes: *845 nfse: *846 person: company: &1124 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 sale_product: sale: created_by: &1125 id: 3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15 canceled_by: &1126 id: 3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15 items: - &1127 id: 8e3a1d57-0c4b-4f92-b6e8-3d7a5c9f1e24 description: Prestação de serviço de intermediação de venda de Pacote amount: 1840.0 service_amount: 1840.0 approximate_taxes_amount: 0.0 nf_generation_preview: value: 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: start_date: '2026-11-10' end_date: '2026-11-20' total_amount: 1500.0 revenues: 120.0 nfs_amount: 120.0 balance: 0.0 valid: true errors: [] existing_nfs: [] new_nfs: - recipient: kind: payer name: Maria Souza cpf_cnpj: '52998224725' state_inscription: city_inscription: postal_code: '89010300' street: Alameda Rio Branco street_number: '238' neighborhood: Centro additional_info: phone: "(47) 3221-0100" email: maria@example.com foreign: false foreign_document: 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: nbs_code: amount: 120.0 service_amount: 1500.0 net_amount: 120.0 taxes: retain_iss: false retain_ir: false retain_pis_cofins_csll: false iss_percentage: 5.0 iss_amount: 6.0 pis_percentage: 0.0 pis_amount: 0.0 cofins_percentage: 0.0 cofins_amount: 0.0 ir_percentage: 0.0 ir_amount: 0.0 csll_percentage: 0.0 csll_amount: 0.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: previewed_at: '2026-10-16T10:15:30.123456-03:00' pagination: size: 20 has_next_page: false next_cursor: generate_nfs: value: 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 generated_nfs: value: data: - id: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 number: series: '1' issue_date: '2026-10-16' status: unissued operation_nature: Prestação de Serviço cfop: nbs_code: document: manual_emission: false amount: 120.0 service_amount: 1500.0 net_amount: 120.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: cvc_original_data: printed_at: canceled_at: created_at: '2026-10-16T10:16:02' recipient: kind: payer name: Maria Souza cpf_cnpj: '52998224725' state_inscription: city_inscription: postal_code: '89010300' street: Alameda Rio Branco street_number: '238' neighborhood: Centro additional_info: phone: "(47) 3221-0100" email: maria@example.com foreign: false foreign_document: city: id: 8f0b2c4d-5e7a-4f9b-1c3d-6e8f0a2b4c5d taxes: retain_iss: false retain_ir: false retain_pis_cofins_csll: false iss_percentage: 5.0 iss_amount: 6.0 pis_percentage: 0.0 pis_amount: 0.0 cofins_percentage: 0.0 cofins_amount: 0.0 ir_percentage: 0.0 ir_amount: 0.0 csll_percentage: 0.0 csll_amount: 0.0 nfse: number: batch: protocol: verification_code: processed_at: errors: 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: canceled_by: items: - description: Passagem Aérea - venda 1532 amount: 120.0 service_amount: 1500.0 approximate_taxes_amount: 0.0 all_logs: summary: Logs description: 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. value: 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' - &847 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: paginated_logs: summary: Logs paginados description: Retorna a segunda página do histórico, com um log por página. value: data: - *847 pagination: size: 1 has_next_page: true next_cursor: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9sb2dzI2luZGV4In19--5eba5fa50c894ec54e4c22226618cbcb0f7cf86b38dfcd77fdb701eaa23b8aa9 edition_log: summary: Log de edição description: Retorna uma alteração feita por uma pessoa, com as referências para o autor e para o registro auditado. value: 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: &1130 id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 resource: &1131 id: 9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118 system_log: summary: Log gravado pela API description: 'Retorna um cadastro gravado por uma requisição da API, sem autor: a credencial que o gravou é nomeada na primeira linha da descrição.' value: 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' person: resource: &1132 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 all_custom_fields: summary: Campos personalizados description: Retorna as definições de campos personalizados de vendas, com um campo do tipo lista e um campo de texto. value: 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: custom_field: summary: Campo personalizado description: Retorna a definição de um único campo personalizado, do tipo lista, com as opções cadastradas. value: id: 123 resource: sales name: Centro de custo kind: choices required: true active: true choices: - Matriz - Filial all_commission_plans: summary: Todos os planos de comissão description: Exemplo de resposta com dois planos. value: 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: commission_plan: summary: Plano de comissão description: '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.' value: id: 6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d description: Plano padrão goal_ranges: - id: a0b1c2d3-e4f5-4a6b-8c7d-9e0f1a2b3c4d achieved_percentage: 0.0 products: - id: b1c2d3e4-f5a6-4b7c-9d8e-0f1a2b3c4d5e product: rules: - id: c2d3e4f5-a6b7-4c8d-8e9f-1a2b3c4d5e6f person_role: id: f453b283-750d-4c5d-a493-a6bf8064090e commission_type: percentage percentage: 3.0 amount: 0.0 calculated_on: - commission_amount - over_amount differentiate_intermediary: true with_intermediary: commission_type: percentage percentage: 1.5 amount: 0.0 calculated_on: - commission_amount - over_amount - intermediary_commission_amount - id: d3e4f5a6-b7c8-4d9e-9f0a-2b3c4d5e6f7a achieved_percentage: 100.0 products: - id: e4f5a6b7-c8d9-4e0f-8a1b-3c4d5e6f7a8b product: rules: - id: f5a6b7c8-d9e0-4f1a-9b2c-4d5e6f7a8b9c person_role: id: f453b283-750d-4c5d-a493-a6bf8064090e commission_type: percentage percentage: 5.0 amount: 0.0 calculated_on: - commission_amount - over_amount differentiate_intermediary: false with_intermediary: commission_type: percentage percentage: 0.0 amount: 0.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.0 amount: 50.0 calculated_on: [] differentiate_intermediary: false with_intermediary: commission_type: percentage percentage: 0.0 amount: 0.0 calculated_on: [] all_goals: summary: Todas as metas description: Exemplo de resposta com a meta de um vendedor. value: data: - &848 id: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a person_role: &1133 id: f453b283-750d-4c5d-a493-a6bf8064090e person: &1134 id: 3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7 commission_plan: &1135 id: 6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d year: 2026 months: &1136 january: 50000.0 february: 50000.0 march: 60000.0 april: 50000.0 may: 50000.0 june: 50000.0 july: 80000.0 august: 50000.0 september: 50000.0 october: 50000.0 november: 50000.0 december: 90000.0 pagination: size: 20 has_next_page: false next_cursor: goal: summary: Meta description: Exemplo da meta de um vendedor, com o plano de comissão dele. value: *848 all_banks: summary: Todos os bancos description: Exemplo de resposta contendo bancos da tabela de referência. value: 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: bank: summary: Banco do Brasil description: Exemplo de resposta de um banco específico. value: id: c3b7e8eb-1199-4457-9170-923c3fe56c92 number: '001' name: Banco do Brasil S.A. bank_reconciliation_list: summary: Extratos enviados value: data: - id: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 account: &849 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: &850 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: bank_reconciliation_detail: summary: Extrato com o resumo value: id: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 account: *849 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: *850 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.0 transfer: summary: Transferência value: &851 id: 857569b5-2721-4756-a27a-748168e00606 date: '2026-10-15' amount: 150.25 description: Sangria do caixa origin_account: &1137 id: ddecf0c0-c13d-43e9-b14b-c394a8bbe853 destination_account: &1138 id: 6e0216e5-5536-4f4b-8c93-36371398b3cf origin_movement: &1139 id: 857569b5-2721-4756-a27a-748168e00606 destination_movement: &1140 id: 21268e50-5cdb-47f9-9ba8-6c0b1f521419 transfers: summary: Lista de transferências value: data: - *851 pagination: size: 20 has_next_page: false next_cursor: create_transfer: summary: Transferir do caixa para o banco value: 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 update_transfer: summary: Alterar só o valor value: amount: 200 delete_reconciled_transfer: summary: Excluir transferência conciliada value: undo_bank_reconciliation: true account_balance: summary: Saldo da conta value: account: id: ddecf0c0-c13d-43e9-b14b-c394a8bbe853 date: '2026-10-15' currency: BRL balance: 1849.75 cash_closed_until: '2026-10-10' account_statement: summary: Extrato com um lançamento e uma transferência value: 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.0 closing_balance: 1849.75 data: - type: opening_balance date: '2026-09-30' balance: 2000.0 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: person: name: Ana Souza document: '52998224725' check: card: brand: Visa last_digits: '1234' ticket_card: billet: amount: 0.0 - type: daily_balance date: '2026-10-02' balance: 2000.0 cash_closed: true - type: transfer date: '2026-10-15' account_movement: id: 857569b5-2721-4756-a27a-748168e00606 bill: sale: number: description: 'Transferência para: Banco. Sangria do caixa' document: person: check: card: billet: amount: -150.25 - type: daily_balance date: '2026-10-15' balance: 1849.75 cash_closed: false close_cash: summary: Fechar o caixa conferindo o saldo value: date: '2026-10-15' expected_balance: 1849.75 cash_closure: summary: Caixa fechado value: account: id: ddecf0c0-c13d-43e9-b14b-c394a8bbe853 cash_closed_until: '2026-10-15' all_category_groups: summary: Todos os grupos description: Grupos de despesa e de receita. value: 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: category_group_detail: summary: Grupo de despesa description: Exemplo de um grupo de categorias de despesa. value: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 delete_category_group_with_categories: summary: Excluir o grupo com as categorias value: delete_categories: true name: Despesas Administrativas kind: expense create_category_group_detail: summary: Novo grupo description: Grupo de despesa. value: name: Impostos kind: expense update_category_group_detail: summary: Renomear grupo description: Altera só o nome. value: name: Tributos written_category_group_detail_reference: summary: Só o id description: Resposta a quem não tem a permissão de ler categorias. value: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 securitySchemes: bearerAuthentication: type: http scheme: bearer description: A credencial deve ser enviada no cabeçalho `Authorization` com o esquema `Bearer`. Veja a seção de [Autenticação](#tag/Autenticacao) para mais detalhes. commission_properties: commission_type: *4 commission_percentage: *5 commission_amount: *6 over_percentage: *7 over_value: *8 du_percentage: *9 rav_percentage: *10 representation_schema: type: object description: Representante vinculado a um fornecimento, com as condições comerciais próprias. properties: *852 supply_schema: type: object description: Fornecimento do produto, com o fornecedor e as condições comerciais negociadas com ele. properties: *853 commission_write_properties: commission_type: *13 commission_percentage: *14 commission_amount: *15 over_percentage: *16 over_value: *17 du_percentage: *18 rav_percentage: *19 supply_write_properties: supplier: *854 description: *855 restitutes_kandir_law: *856 commission_type: *13 commission_percentage: *14 commission_amount: *15 over_percentage: *16 over_value: *17 du_percentage: *18 rav_percentage: *19 representation_write_properties: representative: *857 commission_type: *13 commission_percentage: *14 commission_amount: *15 over_percentage: *16 over_value: *17 du_percentage: *18 rav_percentage: *19 product_write_properties: name: *858 included_services: *859 active: *860 nbs_code: *861 kind: *862 passengers: *863 insurance_scalars: document: *21 begin_date: *22 end_date: *23 destination: *24 status: *25 issue_date: *26 canceled_at: *27 calculate_commission: *28 deleted_balance: *29 delete_supplier_balance: *30 supplier_fine: *31 supplier_fine_origin_currency: *32 observations: *33 included_services: *34 vendor_reservation_url: *35 external_number: *36 additional1: *37 additional2: *38 reservation_due_date: *39 currency: *40 exchange_rate: *41 sale_currency: *42 origin_currency: *43 commission_amount: *44 commission_amount_origin_currency: *45 commission_percentage: *46 over_amount: *47 over_amount_origin_currency: *48 over_percentage: *49 over: *50 intermediary_commission_amount: *51 intermediary_commission_amount_origin_currency: *52 intermediary_commission_percentage: *53 intermediary_over_amount: *54 intermediary_over_amount_origin_currency: *55 intermediary_over_percentage: *56 intermediary_over: *57 agency_service_fee: *58 agency_service_fee_origin_currency: *59 agency_card_rate: *60 deductions: *61 deductions_origin_currency: *62 discount_amount: *63 discount_amount_origin_currency: *64 cc_rav_fee: *65 cruise_scalars: booking_number: *66 departure_date: *67 arrival_date: *68 ship_name: *69 cruise_destination: *70 accommodation_kind: *71 cabin_number: *72 cabin_kind: *73 cabin_category: *74 meal_plan: *75 status: *76 issue_date: *77 canceled_at: *78 calculate_commission: *79 deleted_balance: *80 delete_supplier_balance: *81 supplier_fine: *82 supplier_fine_origin_currency: *83 observations: *84 included_services: *85 vendor_reservation_url: *86 external_number: *87 additional1: *88 additional2: *89 reservation_due_date: *90 currency: *91 exchange_rate: *92 sale_currency: *93 origin_currency: *94 commission_amount: *95 commission_amount_origin_currency: *96 commission_percentage: *97 over_amount: *98 over_amount_origin_currency: *99 over_percentage: *100 over: *101 intermediary_commission_amount: *102 intermediary_commission_amount_origin_currency: *103 intermediary_commission_percentage: *104 intermediary_over_amount: *105 intermediary_over_amount_origin_currency: *106 intermediary_over_percentage: *107 intermediary_over: *108 agency_service_fee: *109 agency_service_fee_origin_currency: *110 agency_card_rate: *111 deductions: *112 deductions_origin_currency: *113 discount_amount: *114 discount_amount_origin_currency: *115 cc_rav_fee: *116 hotel_scalars: booking_number: *117 check_in: *118 check_out: *119 destination: *120 accommodation_kind: *121 room_category: *122 meal_plan: *123 nights: *124 status: *125 issue_date: *126 canceled_at: *127 calculate_commission: *128 deleted_balance: *129 delete_supplier_balance: *130 supplier_fine: *131 supplier_fine_origin_currency: *132 observations: *133 included_services: *134 vendor_reservation_url: *135 external_number: *136 additional1: *137 additional2: *138 reservation_due_date: *139 currency: *140 exchange_rate: *141 sale_currency: *142 origin_currency: *143 commission_amount: *144 commission_amount_origin_currency: *145 commission_percentage: *146 over_amount: *147 over_amount_origin_currency: *148 over_percentage: *149 over: *150 intermediary_commission_amount: *151 intermediary_commission_amount_origin_currency: *152 intermediary_commission_percentage: *153 intermediary_over_amount: *154 intermediary_over_amount_origin_currency: *155 intermediary_over_percentage: *156 intermediary_over: *157 agency_service_fee: *158 agency_service_fee_origin_currency: *159 agency_card_rate: *160 deductions: *161 deductions_origin_currency: *162 discount_amount: *163 discount_amount_origin_currency: *164 cc_rav_fee: *165 airline_ticket_scalars: locator: *166 destination: *864 status: *167 issue_date: *168 canceled_at: *169 calculate_commission: *170 deleted_balance: *171 delete_supplier_balance: *172 supplier_fine: *173 supplier_fine_origin_currency: *174 observations: *175 included_services: *176 vendor_reservation_url: *177 external_number: *178 additional1: *179 additional2: *180 reservation_due_date: *181 currency: *182 exchange_rate: *183 sale_currency: *184 origin_currency: *185 commission_amount: *186 commission_amount_origin_currency: *187 commission_percentage: *188 over_amount: *189 over_amount_origin_currency: *190 over_percentage: *191 over: *192 intermediary_commission_amount: *193 intermediary_commission_amount_origin_currency: *194 intermediary_commission_percentage: *195 intermediary_over_amount: *196 intermediary_over_amount_origin_currency: *197 intermediary_over_percentage: *198 intermediary_over: *199 agency_service_fee: *200 agency_service_fee_origin_currency: *201 agency_card_rate: *202 deductions: *203 deductions_origin_currency: *204 discount_amount: *205 discount_amount_origin_currency: *206 cc_rav_fee: *207 cc_du_fee: *208 train_ticket_scalars: document: *209 departure_date: *210 arrival_date: *211 status: *212 issue_date: *213 canceled_at: *214 calculate_commission: *215 deleted_balance: *216 delete_supplier_balance: *217 supplier_fine: *218 supplier_fine_origin_currency: *219 observations: *220 included_services: *221 vendor_reservation_url: *222 external_number: *223 additional1: *224 additional2: *225 reservation_due_date: *226 currency: *227 exchange_rate: *228 sale_currency: *229 origin_currency: *230 commission_amount: *231 commission_amount_origin_currency: *232 commission_percentage: *233 over_amount: *234 over_amount_origin_currency: *235 over_percentage: *236 over: *237 intermediary_commission_amount: *238 intermediary_commission_amount_origin_currency: *239 intermediary_commission_percentage: *240 intermediary_over_amount: *241 intermediary_over_amount_origin_currency: *242 intermediary_over_percentage: *243 intermediary_over: *244 agency_service_fee: *245 agency_service_fee_origin_currency: *246 agency_card_rate: *247 deductions: *248 deductions_origin_currency: *249 discount_amount: *250 discount_amount_origin_currency: *251 cc_rav_fee: *252 ground_transportation_scalars: document: *253 departure_date: *254 arrival_date: *255 status: *256 issue_date: *257 canceled_at: *258 calculate_commission: *259 deleted_balance: *260 delete_supplier_balance: *261 supplier_fine: *262 supplier_fine_origin_currency: *263 observations: *264 included_services: *265 vendor_reservation_url: *266 external_number: *267 additional1: *268 additional2: *269 reservation_due_date: *270 currency: *271 exchange_rate: *272 sale_currency: *273 origin_currency: *274 commission_amount: *275 commission_amount_origin_currency: *276 commission_percentage: *277 over_amount: *278 over_amount_origin_currency: *279 over_percentage: *280 over: *281 intermediary_commission_amount: *282 intermediary_commission_amount_origin_currency: *283 intermediary_commission_percentage: *284 intermediary_over_amount: *285 intermediary_over_amount_origin_currency: *286 intermediary_over_percentage: *287 intermediary_over: *288 agency_service_fee: *289 agency_service_fee_origin_currency: *290 agency_card_rate: *291 deductions: *292 deductions_origin_currency: *293 discount_amount: *294 discount_amount_origin_currency: *295 cc_rav_fee: *296 car_rental_scalars: document: *297 pickup_date: *298 pickup_location: *299 dropoff_date: *300 dropoff_location: *301 destination: *302 vehicle_category: *303 rental_days: *304 status: *305 issue_date: *306 canceled_at: *307 calculate_commission: *308 deleted_balance: *309 delete_supplier_balance: *310 supplier_fine: *311 supplier_fine_origin_currency: *312 observations: *313 included_services: *314 vendor_reservation_url: *315 external_number: *316 additional1: *317 additional2: *318 reservation_due_date: *319 currency: *320 exchange_rate: *321 sale_currency: *322 origin_currency: *323 commission_amount: *324 commission_amount_origin_currency: *325 commission_percentage: *326 over_amount: *327 over_amount_origin_currency: *328 over_percentage: *329 over: *330 intermediary_commission_amount: *331 intermediary_commission_amount_origin_currency: *332 intermediary_commission_percentage: *333 intermediary_over_amount: *334 intermediary_over_amount_origin_currency: *335 intermediary_over_percentage: *336 intermediary_over: *337 agency_service_fee: *338 agency_service_fee_origin_currency: *339 agency_card_rate: *340 deductions: *341 deductions_origin_currency: *342 discount_amount: *343 discount_amount_origin_currency: *344 cc_rav_fee: *345 travel_package_scalars: document: *346 begin_date: *347 end_date: *348 destination: *349 package_name: *350 transport: *351 status: *352 issue_date: *353 canceled_at: *354 calculate_commission: *355 deleted_balance: *356 delete_supplier_balance: *357 supplier_fine: *358 supplier_fine_origin_currency: *359 observations: *360 included_services: *361 vendor_reservation_url: *362 external_number: *363 additional1: *364 additional2: *365 reservation_due_date: *366 currency: *367 exchange_rate: *368 sale_currency: *369 origin_currency: *370 commission_amount: *371 commission_amount_origin_currency: *372 commission_percentage: *373 over_amount: *374 over_amount_origin_currency: *375 over_percentage: *376 over: *377 intermediary_commission_amount: *378 intermediary_commission_amount_origin_currency: *379 intermediary_commission_percentage: *380 intermediary_over_amount: *381 intermediary_over_amount_origin_currency: *382 intermediary_over_percentage: *383 intermediary_over: *384 agency_service_fee: *385 agency_service_fee_origin_currency: *386 agency_card_rate: *387 deductions: *388 deductions_origin_currency: *389 discount_amount: *390 discount_amount_origin_currency: *391 cc_rav_fee: *392 others_scalars: document: *865 destination: *866 departure_date: *867 arrival_date: *868 status: *869 issue_date: *870 canceled_at: *871 calculate_commission: *872 deleted_balance: *873 delete_supplier_balance: *874 supplier_fine: *875 supplier_fine_origin_currency: *876 observations: *877 included_services: *878 vendor_reservation_url: *879 external_number: *880 additional1: *881 additional2: *882 reservation_due_date: *883 currency: *884 exchange_rate: *885 sale_currency: *886 origin_currency: *887 commission_amount: *888 commission_amount_origin_currency: *889 commission_percentage: *890 over_amount: *891 over_amount_origin_currency: *892 over_percentage: *893 over: *894 intermediary_commission_amount: *895 intermediary_commission_amount_origin_currency: *896 intermediary_commission_percentage: *897 intermediary_over_amount: *898 intermediary_over_amount_origin_currency: *899 intermediary_over_percentage: *900 intermediary_over: *901 agency_service_fee: *902 agency_service_fee_origin_currency: *903 agency_card_rate: *904 deductions: *905 deductions_origin_currency: *906 discount_amount: *907 discount_amount_origin_currency: *908 cc_rav_fee: *909 quantity: *910 unit_price: *911 unit_fee: *912 agency_fee: *913 agency_fee_origin_currency: *914 excursion_scalars: document: *393 status: *394 issue_date: *395 canceled_at: *396 calculate_commission: *397 deleted_balance: *398 delete_supplier_balance: *399 supplier_fine: *400 supplier_fine_origin_currency: *401 included_services: *402 vendor_reservation_url: *403 external_number: *404 additional1: *405 additional2: *406 reservation_due_date: *407 currency: *408 exchange_rate: *409 sale_currency: *410 origin_currency: *411 commission_amount: *412 commission_amount_origin_currency: *413 commission_percentage: *414 over_amount: *415 over_amount_origin_currency: *416 over_percentage: *417 over: *418 intermediary_commission_amount: *419 intermediary_commission_amount_origin_currency: *420 intermediary_commission_percentage: *421 intermediary_over_amount: *422 intermediary_over_amount_origin_currency: *423 intermediary_over_percentage: *424 intermediary_over: *425 agency_service_fee: *426 agency_service_fee_origin_currency: *427 agency_card_rate: *428 deductions: *429 deductions_origin_currency: *430 discount_amount: *431 discount_amount_origin_currency: *432 cc_rav_fee: *433 visa_scalars: document: *434 visa_type: *435 destination_country: *915 destination: *436 status: *437 issue_date: *438 canceled_at: *439 calculate_commission: *440 deleted_balance: *441 delete_supplier_balance: *442 supplier_fine: *443 supplier_fine_origin_currency: *444 included_services: *445 vendor_reservation_url: *446 external_number: *447 additional1: *448 additional2: *449 reservation_due_date: *450 currency: *451 exchange_rate: *452 sale_currency: *453 origin_currency: *454 commission_amount: *455 commission_amount_origin_currency: *456 commission_percentage: *457 over_amount: *458 over_amount_origin_currency: *459 over_percentage: *460 over: *461 intermediary_commission_amount: *462 intermediary_commission_amount_origin_currency: *463 intermediary_commission_percentage: *464 intermediary_over_amount: *465 intermediary_over_amount_origin_currency: *466 intermediary_over_percentage: *467 intermediary_over: *468 agency_service_fee: *469 agency_service_fee_origin_currency: *470 agency_card_rate: *471 deductions: *472 deductions_origin_currency: *473 discount_amount: *474 discount_amount_origin_currency: *475 cc_rav_fee: *476 operation_scalars: document: *916 departure_date: *917 arrival_date: *918 status: *919 issue_date: *920 canceled_at: *921 calculate_commission: *922 deleted_balance: *923 observations: *924 included_services: *925 vendor_reservation_url: *926 external_number: *927 additional1: *928 additional2: *929 currency: *930 exchange_rate: *931 sale_currency: *932 origin_currency: *933 intermediary_commission_amount: *934 intermediary_commission_percentage: *935 intermediary_over_amount: *936 intermediary_over_percentage: *937 intermediary_over: *938 agency_service_fee: *939 agency_service_fee_origin_currency: *940 agency_card_rate: *941 discount_amount: *942 discount_amount_origin_currency: *943 quantity: *944 unit_price: *945 unit_fee: *946 agency_fee: *947 agency_fee_origin_currency: *948 cvc_package_scalars: package_name: *477 receipt_number: *478 departure_date: *479 arrival_date: *480 status: *481 issue_date: *482 canceled_at: *483 calculate_commission: *484 deleted_balance: *485 delete_supplier_balance: *486 supplier_fine: *487 supplier_fine_origin_currency: *488 observations: *489 included_services: *490 vendor_reservation_url: *491 external_number: *492 additional1: *493 additional2: *494 reservation_due_date: *495 currency: *496 exchange_rate: *497 origin_currency: *498 commission_amount: *499 commission_amount_origin_currency: *500 commission_percentage: *501 over_amount: *502 over_amount_origin_currency: *503 over_percentage: *504 over: *505 intermediary_commission_amount: *506 intermediary_commission_amount_origin_currency: *507 intermediary_commission_percentage: *508 intermediary_over_amount: *509 intermediary_over_amount_origin_currency: *510 intermediary_over_percentage: *511 intermediary_over: *512 agency_service_fee: *513 agency_service_fee_origin_currency: *514 agency_card_rate: *515 deductions: *516 deductions_origin_currency: *517 discount_amount: *518 discount_amount_origin_currency: *519 cc_rav_fee: *520 quantity: *521 unit_price: *522 unit_fee: *523 agency_credit_card_scalars: due_date: *949 settlement_date: *950 settlement_exchange_rate: *951 description: *952 card_last_digits: *953 card_brand: *954 authorization: *955 card_rate_percentage: *956 card_rate: *957 agency_bank_slip_scalars: due_date: *958 settlement_date: *959 settlement_exchange_rate: *960 description: *961 bank_slip_number: *962 amount: *963 agency_bank_deposit_scalars: due_date: *964 settlement_date: *965 settlement_exchange_rate: *966 description: *967 observations: *968 amount: *969 passenger_scalars: cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 insurance_passenger_scalars: document: *524 cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 train_passenger_scalars: document: *542 cost_center: *543 canceled_at: *544 fees: *545 fees_origin_currency: *546 rav_fee: *547 rav_fee_origin_currency: *548 rav_fee_discount: *549 rav_fee_discount_origin_currency: *550 agency_fee: *551 agency_fee_origin_currency: *552 amount: *553 amount_origin_currency: *554 customer_amount: *555 customer_amount_origin_currency: *556 total_amount: *557 total_amount_origin_currency: *558 ground_transportation_passenger_scalars: document: *560 cost_center: *561 canceled_at: *562 fees: *563 fees_origin_currency: *564 rav_fee: *565 rav_fee_origin_currency: *566 rav_fee_discount: *567 rav_fee_discount_origin_currency: *568 agency_fee: *569 agency_fee_origin_currency: *570 amount: *571 amount_origin_currency: *572 customer_amount: *573 customer_amount_origin_currency: *574 total_amount: *575 total_amount_origin_currency: *576 cruise_passenger_scalars: document: *577 cost_center: *578 canceled_at: *579 fees: *580 fees_origin_currency: *581 tip: *582 tip_origin_currency: *583 rav_fee: *584 rav_fee_origin_currency: *585 rav_fee_discount: *586 rav_fee_discount_origin_currency: *587 agency_fee: *588 agency_fee_origin_currency: *589 amount: *590 amount_origin_currency: *591 customer_amount: *592 customer_amount_origin_currency: *593 total_amount: *594 total_amount_origin_currency: *595 default_passenger_scalars: document: *597 cost_center: *598 canceled_at: *599 fees: *600 fees_origin_currency: *601 other_fees: *602 other_fees_origin_currency: *603 rav_fee: *604 rav_fee_origin_currency: *605 rav_fee_discount: *606 rav_fee_discount_origin_currency: *607 agency_fee: *608 agency_fee_origin_currency: *609 amount: *610 amount_origin_currency: *611 customer_amount: *612 customer_amount_origin_currency: *613 total_amount: *614 total_amount_origin_currency: *615 default_passenger_read_scalars: document: *596 cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 others_passenger_scalars: document: *970 cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 operation_passenger_scalars: document: *616 cost_center: *617 canceled_at: *618 fees: *619 fees_origin_currency: *620 amount: *621 amount_origin_currency: *622 customer_amount: *623 customer_amount_origin_currency: *624 total_amount: *625 total_amount_origin_currency: *626 hotel_passenger_scalars: document: *627 emission_name: *628 cost_center: *629 canceled_at: *630 fees: *631 fees_origin_currency: *632 other_fees: *633 other_fees_origin_currency: *634 rav_fee: *635 rav_fee_origin_currency: *636 rav_fee_discount: *637 rav_fee_discount_origin_currency: *638 agency_fee: *639 agency_fee_origin_currency: *640 amount: *641 amount_origin_currency: *642 customer_amount: *643 customer_amount_origin_currency: *644 total_amount: *645 total_amount_origin_currency: *646 airline_ticket_passenger_scalars: ticket_number: *647 original_ticket_number: *648 emission_name: *649 cost_center: *650 canceled_at: *651 boarding_fee: *652 boarding_fee_origin_currency: *653 other_fees: *654 other_fees_origin_currency: *655 rav_fee: *656 rav_fee_origin_currency: *657 rav_fee_discount: *658 rav_fee_discount_origin_currency: *659 du_fee: *660 du_fee_origin_currency: *661 du_fee_discount: *662 du_fee_discount_origin_currency: *663 agency_fee: *664 agency_fee_origin_currency: *665 amount: *666 amount_origin_currency: *667 customer_amount: *668 customer_amount_origin_currency: *669 total_amount: *670 total_amount_origin_currency: *671 passenger_person_create: person: *541 passenger_person_read: person: *559 id: 322ff2c2-43e0-4376-bea5-20f88b673b6d emission_rule_schema: type: object properties: *673 required: - recipient - revenues - discounts nf_rule_scalar_properties: id: *674 description: *675 representative_scope: *676 created_at: *677 nf_rule_reference_properties: product: *971 supplier: *972 representative: *973 payer: *974 created_by: *975 nf_rule_emission_properties: payer_rule: *678 supplier_rule: *679 representative_rule: *680 refund_scalar_properties: id: *681 refund_type: *682 amount: *683 description: *684 issue_date: *685 due_date: *686 cvc_statement_scalar_properties: id: *687 receipt_number: *688 movement_date: *689 sale_date: *690 cancellation_date: *691 boarding_date: *692 return_date: *693 product_name: *694 package_name: *695 total_payments: *696 total_taxes: *697 total_discounts: *698 total_abatement: *699 calculated_commission: *700 retained_commission: *701 intermediary_commission: *702 deposit: *703 opfax: *704 opfax_balance: *705 balance: *706 imported: *707 edited: *708 checked: *709 deleted: *710 created_at: *711 nf_recipient_properties: kind: *976 name: *977 cpf_cnpj: *978 state_inscription: *979 city_inscription: *980 postal_code: *981 street: *982 street_number: *983 neighborhood: *984 additional_info: *985 phone: *986 email: *987 foreign: *988 foreign_document: *989 city: *990 nf_taxes_properties: retain_iss: *991 retain_ir: *992 retain_pis_cofins_csll: *993 iss_percentage: *994 iss_amount: *995 pis_percentage: *996 pis_amount: *997 cofins_percentage: *998 cofins_amount: *999 ir_percentage: *1000 ir_amount: *1001 csll_percentage: *1002 csll_amount: *1003 nf_nfse_properties: number: *1004 batch: *1005 protocol: *1006 verification_code: *1007 processed_at: *1008 errors: *1009 nf_scalar_properties: id: *712 number: *713 series: *714 issue_date: *715 status: *716 operation_nature: *717 cfop: *718 nbs_code: *719 document: *720 manual_emission: *721 amount: *722 service_amount: *723 net_amount: *724 approximate_taxes_percentage: *725 approximate_taxes_amount: *726 observations: *727 cvc_original_data: *728 printed_at: *729 canceled_at: *730 created_at: *731 recipient: *732 taxes: *733 nfse: *734 log_scalar_properties: id: *735 kind: *736 origin: *737 description: *738 created_at: *739 products_standard_pagination: size: 20 has_next_page: false next_cursor: filtered_pagination: size: 10 has_next_page: false next_cursor: paginated_pagination: size: 10 has_next_page: true next_cursor: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 seller_read: id: 7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13 payer_read: id: 2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4 intermediary_read: id: d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8 requester_read: id: b17c5e38-6a90-4d21-9f43-8e2b70c5a916 approver_read: id: 95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4 promoter_read: id: 6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30 created_by_read: id: b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e operation_read: id: 8936058a-2906-4239-9a7f-e22ccc2c195e supplier_read: id: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b airline_supplier_read: id: 3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4 representative_read: id: '028ea1ef-3f8e-4c7f-93da-463794a5afda' seller: external_id: a8a41bec-e2a2-4d6a-b2f9-8fbc29169e46 name: João da Silva cpf: '83115137168' individual_payer: person_kind: individual external_id: cce45f2c-30e3-43a6-bbf1-af340188a04c name: Márcio da Veiga legal_name: 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: email: contato@marcio.com phone_number: '11999990001' mobile_number: '11999990002' address: *1010 individual_intermediary: person_kind: individual external_id: 8a9de5ce-dac6-4721-851b-7366bf9ff5b0 name: Isabel Ribas legal_name: 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: email: contato@isabel.com phone_number: '11999990003' mobile_number: '11999990004' address: *1011 individual_approver: person_kind: individual external_id: b7f3c1a2-9d84-4e60-8c15-2a6f0e3d4b91 name: Renata Furtado legal_name: 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: email: contato@renata.com phone_number: '11999990005' mobile_number: '11999990006' address: *1012 individual_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: email: contato@beatriz.com phone_number: '11999990007' mobile_number: '11999990008' address: *1013 passenger_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: email: maria.silva@example.com phone_number: '11999990009' mobile_number: '11999990010' address: *1014 required_fields_payer: person_kind: individual external_id: cce45f2c-30e3-43a6-bbf1-af340188a04c name: Márcio da Veiga company_payer: person_kind: company external_id: 3c1e6b21-5d44-4d98-8f21-2f90b6a8c3e7 name: Tech Solutions LTDA legal_name: Tech Solutions Tecnologia Ltda cpf_cnpj: '86452403000197' rg_ie: '9876543' email: teste@techsolutions.com.br phone_number: '1133224455' mobile_number: '11998877665' address: *1015 foreigner_payer: person_kind: individual external_id: d82e4b79-6b2a-44f8-a431-027b2d7a9e68 name: John Smith gender: male birthdate: '1982-11-30' passport_number: AA1234567 passport_expiration_date: '2030-09-20' foreigner: true foreign_identity_document: F987654321 email: john.smith@example.com phone_number: "+390612345672" mobile_number: "+393331234572" address: *1016 required_fields_passenger_person: external_id: 322ff2c2-43e0-4376-bea5-20f88b673b6d name: Maria da Silva foreign_passenger_person: external_id: 4a162ad1-fdbb-41f9-b49e-70dfb1c80f6c name: Kaleigh Glover gender: female birthdate: '1991-05-14' cpf: rg: passport_number: US748239 passport_expiration_date: '2033-03-12' foreigner: true foreign_identity_document: '182430728200321' email: kg@test.com phone_number: "+390612345670" mobile_number: "+393331234571" address: *1017 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: *1018 foreign_supplier: external_id: 30a20d58-b4f7-465d-b8b0-f89b2fc00b67 name: EuroTravel legal_name: EuroTravel Global GmbH cnpj: ie: foreigner: true email: contact@eurotravel.com phone_number: "+390212345678" mobile_number: "+393331234567" address: *1019 airline_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: *1020 foreign_airline_supplier: airline_code: LH airline_number: '220' name: European Wings legal_name: European Wings AG cnpj: ie: foreigner: true email: contact@europeanwings.com phone_number: "+390212345679" mobile_number: "+393331234570" address: *1021 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: *1022 required_fields_insurance_passenger: amount: 625.95 person: *782 insurance_passenger: document: '9921508090000' cost_center: Corporativa EXT canceled_at: fees: 25.0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 625.95 customer_amount: 650.95 total_amount: 650.95 person: *747 foreign_insurance_passenger: document: '9921508090000' cost_center: Corporativa EXT canceled_at: fees: 25.0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 625.95 customer_amount: 650.95 total_amount: 650.95 person: *785 required_fields_cruise_passenger: amount: 8358.77 person: *782 cruise_passenger: document: CRZ-90412 cost_center: Corporativa EXT canceled_at: fees: 120.0 tip: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 8358.77 customer_amount: 8478.77 total_amount: 8478.77 person: *747 foreign_cruise_passenger: document: CRZ-90412 cost_center: Corporativa EXT canceled_at: fees: 120.0 tip: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 8358.77 customer_amount: 8478.77 total_amount: 8478.77 person: *785 hotel_passenger: document: HTL-55821 emission_name: Maria da Silva cost_center: Corporativa EXT canceled_at: 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: *747 foreign_hotel_passenger: document: HTL-55821 emission_name: Maria da Silva cost_center: Corporativa EXT canceled_at: 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: *785 airline_passenger: ticket_number: '99526874895' emission_name: Maria da Silva cost_center: Corporativa EXT canceled_at: 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: *747 foreign_airline_passenger: ticket_number: '99526874896' emission_name: Kaleigh Glover cost_center: Corporativa EXT canceled_at: 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: *785 train_passenger: document: RE9988777 cost_center: Corporativa EXT canceled_at: 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: *747 foreign_train_passenger: document: RE9988777 cost_center: Corporativa EXT canceled_at: 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: *785 ground_transportation_passenger: document: '0001234567' cost_center: Corporativa EXT canceled_at: 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: *747 foreign_ground_transportation_passenger: document: '0001234567' cost_center: Corporativa EXT canceled_at: 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: *785 required_fields_car_rental_passenger: amount: 350.0 person: *782 car_rental_passenger: document: LOC-77310 cost_center: Corporativa EXT canceled_at: fees: 0 other_fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 350.0 customer_amount: 350.0 total_amount: 350.0 person: *747 foreign_car_rental_passenger: document: LOC-77310 cost_center: Corporativa EXT canceled_at: fees: 0 other_fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 350.0 customer_amount: 350.0 total_amount: 350.0 person: *785 required_fields_travel_package_passenger: amount: 2500.0 person: *782 travel_package_passenger: document: PCT2024050001 cost_center: Corporativa EXT canceled_at: fees: 0 other_fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *747 foreign_travel_package_passenger: document: PCT2024050001 cost_center: Corporativa EXT canceled_at: fees: 0 other_fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *785 excursion_passenger: document: EXC2024060034 cost_center: Corporativa EXT canceled_at: fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 350.0 customer_amount: 350.0 total_amount: 350.0 person: *747 others_passenger: document: OUT2024060012 cost_center: Corporativa EXT canceled_at: fees: 0 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *747 operation_passenger: document: OP2024060056 cost_center: Corporativa EXT canceled_at: fees: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *747 insurance_product: id: 1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071 document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international status: active issue_date: '2026-11-16' canceled_at: 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 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.0 cc_rav_fee: 0 totals: *1023 supplier: *745 representative: *746 passengers: - *1024 cruise_product: id: 2b3c4d5e-6f70-4819-ab2c-3d4e5f607182 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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-16' canceled_at: 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 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.0 cc_rav_fee: 0 totals: *1025 supplier: *745 representative: *746 passengers: - *1026 hotel_product: id: 3c4d5e6f-7081-492a-bc3d-4e5f60718293 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' destination: international accommodation_kind: Duplo Casal room_category: Deluxe meal_plan: All Inclusive nights: 8 status: active issue_date: '2026-11-16' canceled_at: 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 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.0 cc_rav_fee: 0 totals: *1027 supplier: *745 representative: *746 passengers: - *1028 airline_product: id: 4d5e6f70-8192-4a3b-cd4e-5f6071829304 locator: WABCJJ destination: international status: active issue_date: '2026-11-16' canceled_at: 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 Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 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.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 totals: *1029 supplier: *1030 representative: *746 segments: - *1031 passengers: - *1032 train_product: id: 5e6f7081-92a3-4b4c-de5f-607182930415 document: RE9988777 departure_date: '2026-11-21T00:00:44' arrival_date: '2026-11-24T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 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.0 cc_rav_fee: 0 totals: *1033 supplier: *745 representative: *746 passengers: - *1034 ground_transportation_product: id: 6f708192-a3b4-4c5d-ef60-718293041526 document: GT123456 departure_date: '2026-11-21T00:00:44' arrival_date: '2026-11-24T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 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.0 cc_rav_fee: 0 totals: *1035 supplier: *745 representative: *746 passengers: - *1036 car_rental_product: id: 708192a3-b4c5-4d6e-f071-829304152637 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico rental_days: 7 status: active issue_date: '2026-11-16' canceled_at: 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 Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 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.0 cc_rav_fee: 0 totals: *1037 supplier: *745 representative: *746 passengers: - *1038 travel_package_product: id: 8192a3b4-c5d6-4e7f-0182-930415263748 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight status: active issue_date: '2026-11-16' canceled_at: 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 Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 commission_percentage: 10 over_amount: 0 over_percentage: 0 over: 0 intermediary_commission_amount: 125.0 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.0 cc_rav_fee: 0 totals: *1039 supplier: *745 representative: *746 passengers: - *1040 others_product: id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 product: *1041 document: OUT123456 destination: Salvador status: active issue_date: '2026-11-16' canceled_at: 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 vendor_reservation_url: https://www.epicjourney.com/reservation/9877 currency: BRL exchange_rate: 1 commission_amount: 12.0 commission_percentage: 2 over_amount: 0 over_percentage: 0 over: 0 intermediary_commission_amount: 4.0 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: unit_price: unit_fee: totals: *1042 supplier: *745 representative: *746 passengers: - *1043 excursion_product: id: d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081 document: EXC123456 departure_date: '2026-11-21T00:00:44' arrival_date: '2026-11-21T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9880 currency: BRL exchange_rate: 1 commission_amount: 10.0 commission_percentage: 10 over_amount: 0 over_percentage: 0 over: 0 intermediary_commission_amount: 5.0 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: *1044 supplier: *745 representative: *746 passengers: - *1045 operation_product: id: 6d5c4b3a-2f1e-4093-8d7c-6b5a49382716 product: *1046 document: OP-000123 departure_date: '2026-11-23T00:00:44' arrival_date: '2026-11-23T00:00:44' status: active issue_date: '2026-11-16' canceled_at: calculate_commission: true deleted_balance: 0 observations: City tour confirmado. included_services: |- Guia local incluso Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9878 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: unit_price: unit_fee: totals: *1047 supplier: *745 passengers: - *1048 cvc_package_product: id: 5c4b3a29-1e0d-4982-7c6b-5a4938271605 product: *1049 package_name: CVC Caribe 7 noites receipt_number: '89100000183488' departure_date: '2026-12-01T00:00:44' arrival_date: '2026-12-08T00:00:44' status: active issue_date: '2026-11-16' canceled_at: 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 Traslados inclusos vendor_reservation_url: https://www.epicjourney.com/reservation/9879 currency: BRL exchange_rate: 1 commission_amount: 490.0 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.0 unit_fee: 80.0 totals: *1050 supplier: *745 representative: *746 insurance_passenger_create: document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: *759 cruise_passenger_create: document: CRZ-90412 amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *759 hotel_passenger_create: document: HTL-55821 amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *759 airline_passenger_create: 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: *759 train_passenger_create: amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *759 ground_transportation_passenger_create: amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *759 car_rental_passenger_create: document: LOC-77310 amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *759 travel_package_passenger_create: amount: 2500.0 fees: 125.0 other_fees: 25.0 rav_fee: 50.0 rav_fee_discount: 10.0 agency_fee: 30.0 document: PCT2024050001 person: *759 excursion_passenger_create: amount: 350.0 fees: 17.5 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: EXC2024060034 person: *759 visa_passenger_create: amount: 150.0 fees: 1017.5 rav_fee: 0 rav_fee_discount: 0 agency_fee: 0 document: AA1234567 person: *759 insurance_product_create: local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-11-21' end_date: '2026-12-06' destination: international included_services: |- Plano: Max BRL R$ 60.000,00 com cobertura de despesas médicas Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/9871 currency: BRL exchange_rate: 1 commission_amount: 50.07 intermediary_commission_amount: 25.04 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - *806 cruise_product_create: local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-11-22' arrival_date: '2026-12-06' 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 Código: 1234 vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 835.88 intermediary_commission_amount: 417.94 agency_service_fee: 100 discount_amount: 100.0 supplier: *757 representative: *758 passengers: - *807 hotel_product_create: local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-12-09' check_out: '2026-12-16' 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 Quarto com vista para cidade. vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 563.07 intermediary_commission_amount: 281.54 agency_service_fee: 100 discount_amount: 50.0 supplier: *757 representative: *758 passengers: - *808 airline_product_create: local_id: d4e5f6a7-b8c9-0123-4567-890123def012 locator: WABCJJ destination: international included_services: |- 3 bagagens despachadas sem custo Assento com reclinação total Acesso ao Lounge vendor_reservation_url: https://www.epicjourney.com/reservation/6598 currency: BRL exchange_rate: 1 commission_amount: 136.07 intermediary_commission_amount: 68.04 agency_service_fee: 100 discount_amount: 20.0 cc_rav_fee: 27.22 cc_du_fee: 27.22 supplier: *787 representative: *758 segments: - *1051 passengers: - *809 train_product_create: local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 document: RE9988777 included_services: |- Refeição inclusa Wi-Fi gratuito Vagão silencioso vendor_reservation_url: https://www.epicjourney.com/reservation/7852 currency: BRL exchange_rate: 1 commission_amount: 15.0 intermediary_commission_amount: 7.5 agency_service_fee: 100 discount_amount: 5.0 segments: - *1052 supplier: *757 representative: *758 passengers: - *810 ground_transportation_product_create: local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 document: GT123456 included_services: |- Refeição inclusa Wi-Fi gratuito. vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 8.55 intermediary_commission_amount: 4.28 agency_service_fee: 100 discount_amount: 5.0 segments: - *1053 supplier: *757 representative: *758 passengers: - *811 car_rental_product_create: local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-11-21' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-11-28' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico included_services: |- Quilometragem livre Seguro básico incluso Tanque cheio na retirada vendor_reservation_url: https://www.epicjourney.com/reservation/8765 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 100 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - *812 travel_package_product_create: local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-11-26' end_date: '2026-12-03' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight included_services: |- Hospedagem: Hotéis 4 estrelas Refeições: Café da manhã e jantar Passeios: City tour em 5 cidades Seguro viagem internacional vendor_reservation_url: https://www.epicjourney.com/reservation/9876 currency: BRL exchange_rate: 1 commission_amount: 250.0 intermediary_commission_amount: 125.0 agency_service_fee: 100 discount_amount: 25.0 supplier: *757 representative: *758 passengers: - *813 excursion_product_create: local_id: c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e document: EXC123456 departure_date: '2026-11-21T08:00:00' arrival_date: '2026-11-21T18:00:00' observations: Saída do hotel às 8h. included_services: |- Guia local incluso Transporte incluso vendor_reservation_url: https://www.epicjourney.com/reservation/9880 currency: BRL exchange_rate: 1 commission_amount: 35.0 intermediary_commission_amount: 17.5 agency_service_fee: 20 discount_amount: 5.0 supplier: *757 representative: *758 passengers: - *1054 visa_product_create: local_id: 7d3a9c51-2e84-4f6b-a1c7-5b9e0d2f8a36 document: DS160-AA00X1B2C3 visa_type: Turismo destination_country: US destination: international departure_date: '2026-12-16T09:00:00' arrival_date: '2026-12-31T18:00:00' observations: Entrevista no consulado americano em São Paulo. included_services: |- Agendamento da entrevista Preenchimento do formulário DS-160 currency: BRL exchange_rate: 1 commission_amount: 0 agency_service_fee: 250.0 supplier: *757 passengers: - *1055 insurance_payment: sale_product_local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef amount: 625.95 cruise_payment: sale_product_local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 amount: 8358.77 hotel_payment: sale_product_local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 amount: 6475.34 airline_ticket_payment: sale_product_local_id: d4e5f6a7-b8c9-0123-4567-890123def012 amount: 1804.75 train_ticket_payment: sale_product_local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 amount: 264.55 ground_transportation_payment: sale_product_local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 amount: 134.14 car_rental_payment: sale_product_local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 amount: 350.0 travel_package_payment: sale_product_local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 amount: 2500.0 excursion_payment: sale_product_local_id: c1d2e3f4-a5b6-4c78-9d0e-1f2a3b4c5d6e amount: 367.5 visa_payment: sale_product_local_id: 7d3a9c51-2e84-4f6b-a1c7-5b9e0d2f8a36 amount: 1167.5 others_payment: sale_product_local_id: c9d0e1f2-a3b4-5678-9012-345678b01234 amount: 2500.0 cvc_package_payment: sale_product_local_id: e1f2a3b4-c5d6-7890-1234-567890d01234 amount: 3160.0 operation_payment: sale_product_local_id: 9f8e7d6c-5b4a-3210-fedc-ba9876543210 amount: 1200.0 bank_account_example: bank_code: '237' agency_number: '1234' agency_digit: '5' account_number: '56789' account_digit: '0' vendor_credit_card_payment: card_last_digits: '1234' authorization: XYZ789 installments: 2 agency_credit_card_payment: due_date: '2026-12-16' settlement_date: '2026-11-16' card_brand: mastercard card_last_digits: '5678' authorization: ABC123 bank_account: *760 agency_bank_slip_payment: due_date: '2026-12-16' settlement_date: '2026-11-16' bank_account: *760 agency_bank_deposit_payment: due_date: '2026-12-16' settlement_date: '2026-11-16' observations: TED bank_account: *760 vendor_others_payment: details: Fatura vendor_minimal_payment: - *805 all_payment_methods: - *775 - *776 - *777 - *778 - *779 - *780 cruise_payment_read: amount: 8358.77 sale_product: *1056 others_payment_read: amount: 2500.0 sale_product: *1057 cvc_package_payment_read: amount: 3160.0 sale_product: *1058 operation_payment_read: amount: 2500.0 sale_product: *1059 travel_package_payment_read: amount: 2500.0 sale_product: *1060 ground_transportation_payment_read: amount: 134.14 sale_product: *1061 hotel_payment_read: amount: 6475.34 sale_product: *1062 insurance_payment_read: amount: 625.95 sale_product: *1063 all_payment_methods_read: agency: bills: - id: 9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d - id: 1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071 - id: 4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920 refunds: - *1064 credit: - *1065 to_invoice: - *1066 retained_by_intermediary: - *1067 legacy: - *1068 vendor: credit_card: - id: e4f5a6b7-c8d9-4e0f-9a12-3c4d5e6f7081 due_date: '2026-12-16' card_last_digits: '1234' authorization: XYZ789 installments: 2 payer: *748 products: *1069 check: - *1070 credit: - id: a6b7c8d9-e0f1-4a2b-9c34-5e6f708192a3 due_date: '2026-12-16' document: CRED-000123 payer: *748 products: *1071 others: - id: b7c8d9e0-f1a2-4b3c-8d45-6f708192a3b4 due_date: '2026-12-16' details: Fatura payer: *748 products: *1072 all_payment_methods_written: agency: *1073 vendor: *1074 sale_fields_create: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 insurances: - *766 cruises: - *767 hotels: - *768 airline_tickets: - *769 train_tickets: - *770 ground_transportations: - *771 car_rentals: - *772 travel_packages: - *773 excursions: - *774 payments: - *775 - *776 - *777 - *778 - *779 - *780 sale_without_product: company_identifier: '46598887000162' sale_date: '2026-11-16' seller: *761 payer: *762 intermediary: *763 approver: *764 requester: *765 sale_financial: observations: Teste de observações financeiras vendor_bills: - *1075 standalone_bills: - *1076 vendor_items: - *1077 - *1078 sale_commissions: - *1079 - *1080 - *1081 sale_commissions_create: - *1082 - *1083 - *1084 sales_standard_pagination: size: 20 has_next_page: false next_cursor: operation_passenger_create: amount: 1200.0 fees: 60.0 document: OP-000123 person: *759 operation_product_create: local_id: 9f8e7d6c-5b4a-3210-fedc-ba9876543210 product_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 document: OP-2026-0001 departure_date: '2026-11-21' arrival_date: '2026-12-06' observations: Excursão operada pela própria agência included_services: Traslados, guia local e hospedagem vendor_reservation_url: https://www.epicjourney.com/reservation/op-1 currency: BRL exchange_rate: 1 intermediary_commission_amount: 30.0 agency_service_fee: 80.0 discount_amount: 10.0 passengers: - *1085 operation_no_passengers_create: local_id: 1a2b3c4d-5e6f-7081-9203-a4b5c6d7e8f9 product_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 document: OP-2026-0002 departure_date: '2026-11-21' arrival_date: '2026-12-06' observations: Cota de operação própria, vendida por quantidade. currency: BRL exchange_rate: 1 quantity: 3 unit_price: 500.0 unit_fee: 20.0 agency_fee: 15.0 discount_amount: 10.0 others_passenger_create: amount: 800.0 fees: 40.0 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: OU-000123 person: *759 others_product_create: local_id: 3c4d5e6f-7081-4293-a4b5-c6d7e8f90a1b product_id: b42f0434-9c36-46ed-96cb-f5c81f025599 document: OU-2026-0001 destination: international departure_date: '2026-11-21' arrival_date: '2026-12-06' observations: Chip de internet internacional included_services: Chip com 10 GB de dados vendor_reservation_url: https://www.epicjourney.com/reservation/ou-1 currency: BRL exchange_rate: 1 commission_amount: 80.0 intermediary_commission_amount: 20.0 agency_service_fee: 30.0 discount_amount: 10.0 supplier: *757 representative: *758 passengers: - *1086 others_no_passengers_create: local_id: 4d5e6f70-8192-43a4-b5c6-d7e8f90a1b2c product_id: c53a1545-0d47-47fe-a7c6-06d92f136600 document: OU-2026-0002 destination: international departure_date: '2026-11-21' observations: Ingressos vendidos por quantidade. currency: USD exchange_rate: 5.2 quantity: 2 unit_price: 100.0 unit_fee: 15.0 agency_fee: 10.0 supplier: *757 cabins_standard_pagination: size: 20 has_next_page: false next_cursor: cabins_paginated_pagination: size: 2 has_next_page: false next_cursor: ships_standard_pagination: size: 20 has_next_page: false next_cursor: ships_paginated_pagination: size: 2 has_next_page: false next_cursor: packages_standard_pagination: size: 20 has_next_page: false next_cursor: packages_paginated_pagination: size: 2 has_next_page: false next_cursor: cost_centers_standard_pagination: size: 20 has_next_page: false next_cursor: cost_centers_paginated_pagination: size: 2 has_next_page: false next_cursor: currencies_standard_pagination: size: 20 has_next_page: false next_cursor: currencies_paginated_pagination: size: 2 has_next_page: false next_cursor: categories_standard_pagination: size: 20 has_next_page: false next_cursor: categories_paginated_pagination: size: 2 has_next_page: false next_cursor: cities_standard_pagination: size: 20 has_next_page: false next_cursor: cities_paginated_pagination: size: 2 has_next_page: false next_cursor: sellers_standard_pagination: size: 20 has_next_page: false next_cursor: sellers_paginated_pagination: size: 1 has_next_page: false next_cursor: payment_methods_standard_pagination: size: 20 has_next_page: false next_cursor: payment_methods_paginated_pagination: size: 2 has_next_page: false next_cursor: accounts_standard_pagination: size: 20 has_next_page: false next_cursor: accounts_paginated_pagination: size: 1 has_next_page: false next_cursor: accounts_company: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 accounts_card_example: id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Cartão Corporativo kind: card_account active: true currency: BRL initial_balance: 0.0 bank_operation: agency: agency_digit: number: digit: pix_key: bill_expiration: 10 bill_closing: 1 accounts_billing_example: 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: late_fine: 2.0 late_interest: 1.0 bank_fee: 2.5 billet_rate: 0.0 last_remittance: 0 days_protest: bank_issues_billet: false bank_generates_number: false billet_instructions: local_of_payment: Pagável em qualquer banco até o vencimento guarantor: assignor_format: our_number_format: other_settings: cobre_bem: accounts_checking_example: id: f9d961b8-ea88-4346-8e52-afe94267417a description: Banco do Brasil - Matriz kind: checking_account active: true currency: BRL initial_balance: 1500.0 bank_operation: agency: '1412' agency_digit: '5' number: '04640' digit: '2' pix_key: financeiro@agencia.com.br bill_expiration: bill_closing: nf_rules_standard_pagination: size: 20 has_next_page: false next_cursor: nf_rules_paginated_pagination: size: 1 has_next_page: false next_cursor: nf_rule_paginated_example: id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Seguro viagem - fornecedor emite representative_scope: none created_at: '2023-11-02T16:45:00' payer_rule: *1087 supplier_rule: *1088 representative_rule: *1089 tasks_standard_pagination: size: 20 has_next_page: false next_cursor: tasks_paginated_pagination: size: 1 has_next_page: false next_cursor: task_paginated_example: id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 number: 1043 title: Cobrar segunda parcela description: due: '2024-04-05T14:00:00' completed_at: '2024-04-05T11:12:00' visualized: true deleted: false created_at: '2024-03-15T10:30:00' task_categories_standard_pagination: size: 20 has_next_page: false next_cursor: travels_standard_pagination: size: 20 has_next_page: false next_cursor: travels_paginated_pagination: size: 1 has_next_page: false next_cursor: travel_paginated_example: 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: created_at: '2024-01-10T09:00:00' quotes_standard_pagination: size: 20 has_next_page: false next_cursor: quotes_paginated_pagination: size: 1 has_next_page: false next_cursor: quote_paginated_example: id: 41 title: Buenos Aires subtitle: Feriado prolongado details: Aéreo + hotel 4 estrelas no centro. valid_until: '2024-02-28' active: false public_url: https://suaviagem.app/x9Y8z7-buenos-aires internal_observations: cover_kind: none cover_color: cover_show_title: true cover_show_subtitle: true cover_image_url: created_at: '2024-01-10T09:00:00' updated_at: '2024-01-12T14:20:00' guides_standard_pagination: size: 20 has_next_page: false next_cursor: guides_paginated_pagination: size: 1 has_next_page: false next_cursor: guide_paginated_example: id: 41 title: Buenos Aires subtitle: Feriado prolongado details: "

Tango em San Telmo e jantar em Puerto Madero.

" active: false public_url: https://suaviagem.app/guia/x9Y8z7-buenos-aires internal_observations: cover_kind: color cover_color: "#5f6777" cover_show_title: true cover_show_subtitle: true hide_cover_text: false cover_image_url: created_at: '2024-01-10T09:00:00' updated_at: '2024-01-12T14:20:00' invoice_rules_standard_pagination: size: 20 has_next_page: false next_cursor: invoice_rules_paginated_pagination: size: 1 has_next_page: false next_cursor: invoice_rule_paginated_example: id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Cliente corporativo mensal person_kind: customer destination: every movement: every_movement cost_center: Comercial closing: *1090 due_date: *1091 integrations_standard_pagination: size: 20 has_next_page: false next_cursor: integrations_paginated_pagination: size: 1 has_next_page: false next_cursor: integration_paginated_example: id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Argo Buscador active: false vendor_id: 31d759f3-ee91-4a10-8432-0f76b40cd11e vendor_name: Argo IT people_standard_pagination: size: 20 has_next_page: false next_cursor: people_paginated_pagination: size: 1 has_next_page: false next_cursor: person_summary_individual: id: f9d961b8-ea88-4346-8e52-afe94267417a code: 1042 person_kind: individual name: Carlos Souza legal_name: cpf_cnpj: '12345678909' gender: male birthdate: '1985-07-22' rg_ie: '203456789' city_inscription: tax_identification_number: passport_number: BR123456 passport_expiration_date: '2028-10-01' foreigner: false foreign_identity_document: email: carlos@exemplo.com.br phone_number: '4133334444' mobile_number: '41999998888' business_phone: '4130302020' website: cvc_code: observations: Cliente preferencial. charge_billet_fee: false created_at: '2021-11-05T10:30:00' address: *825 additional_data: *826 last_contacts: *827 tax_withholding: airline: person_summary_company: 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: birthdate: rg_ie: '9012345678' city_inscription: '1234567' tax_identification_number: passport_number: passport_expiration_date: foreigner: false foreign_identity_document: email: contato@operadora.com.br phone_number: '4133334444' mobile_number: business_phone: website: https://www.operadora.com.br cvc_code: observations: charge_billet_fee: true created_at: '2019-04-18T08:15:00' address: *1092 additional_data: last_contacts: *1093 tax_withholding: *1094 airline: labels_standard_pagination: size: 20 has_next_page: false next_cursor: labels_paginated_pagination: size: 2 has_next_page: false next_cursor: bills_standard_pagination: size: 20 has_next_page: false next_cursor: bills_paginated_pagination: size: 1 has_next_page: false next_cursor: receivable_person: id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 card_person: id: b2c3d4e5-f6a7-4809-c0d1-e2f3a4b5c6d7 receivable_summary: 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.0 final_amount: 1500.0 issue_date: '2026-01-10' due_date: '2026-02-10' settlement_date: 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: observations: billet: *1095 check: card: card_summary: id: 9f8e7d6c-5b4a-4938-8271-6f5e4d3c2b1a number: '67890' transaction_kind: debit kind: credit_card_invoice description: Fatura Mastercard document: invoice_number: 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: billet: check: card: *1096 account_movements_standard_pagination: size: 20 has_next_page: false next_cursor: account_movements_paginated_pagination: size: 1 has_next_page: false next_cursor: account_movement_settlement_summary: id: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 date: '2026-01-26' amount: -9112.17 transaction_kind: debit description: check: card: *1097 account_movement_transfer_summary: id: 0d1f5a83-9b2c-4d6e-8a71-3c5f7e9b2d40 date: '2026-01-26' amount: 63063.0 transaction_kind: credit description: Repasse diário check: card: refunds_standard_pagination: size: 20 has_next_page: false next_cursor: refunds_paginated_pagination: size: 1 has_next_page: false next_cursor: refund_vendor_scalars: 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' refund_customer_scalars: 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' refund_vendor_example: 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: *1098 sale_product: *1099 person: *1100 company: *1101 bill: *1102 refund_customer_example: 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: *1103 sale_product: *1104 person: *1105 company: *1106 bill: cvc_statements_standard_pagination: size: 20 has_next_page: false next_cursor: cvc_statements_paginated_pagination: size: 1 has_next_page: false next_cursor: cvc_statement_receipt_scalars: id: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 receipt_number: '89930000112199' movement_date: '2019-12-26' sale_date: '2019-12-26T18:00:00' cancellation_date: 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.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 111.33 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 34.78 opfax: 0.0 opfax_balance: 0.0 balance: 76.55 imported: true edited: false checked: false deleted: false created_at: '2019-12-30T08:45:48' cvc_statement_partial_opfax_scalars: id: 7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92 receipt_number: '89100000164635' movement_date: '2019-12-29' sale_date: '2019-12-29T18:00:00' cancellation_date: boarding_date: '2020-04-10' return_date: '2020-04-15' product_name: Hotel Internacional package_name: MADRI total_payments: 2068.04 total_taxes: 0.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 0.0 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 0.0 opfax: 1826.4 opfax_balance: 200.9 balance: 0.0 imported: true edited: false checked: false deleted: false created_at: '2019-12-30T12:14:02' cvc_statement_manual_adjustment_scalars: id: 0f9e5b3d-7a21-4c68-b0d4-9e2f6a1c4b85 receipt_number: movement_date: '2020-09-15' sale_date: cancellation_date: boarding_date: return_date: product_name: package_name: total_payments: 0.0 total_taxes: 0.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 0.0 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.0 balance: 12.32 imported: true edited: false checked: false deleted: false created_at: '2020-09-16T16:16:09' cvc_statement_with_sale_example: id: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 receipt_number: '89930000112199' movement_date: '2019-12-26' sale_date: '2019-12-26T18:00:00' cancellation_date: 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.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 111.33 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 34.78 opfax: 0.0 opfax_balance: 0.0 balance: 76.55 imported: true edited: false checked: false deleted: false created_at: '2019-12-30T08:45:48' movement_kind: *1107 company: *1108 contractor: *1109 seller: *1110 intermediary: sale: *1111 sale_product: *1112 nf: *1113 created_by: *1114 cvc_statement_manual_adjustment_example: id: 0f9e5b3d-7a21-4c68-b0d4-9e2f6a1c4b85 receipt_number: movement_date: '2020-09-15' sale_date: cancellation_date: boarding_date: return_date: product_name: package_name: total_payments: 0.0 total_taxes: 0.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 0.0 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.0 balance: 12.32 imported: true edited: false checked: false deleted: false created_at: '2020-09-16T16:16:09' movement_kind: *1115 company: *1116 contractor: seller: intermediary: sale: sale_product: nf: created_by: *1117 cvc_master_statement_example: id: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84 receipt_number: '0217000001234' movement_date: '2026-09-10' sale_date: '2026-09-02T00:00:00' cancellation_date: boarding_date: return_date: product_name: package_name: total_payments: 4800.0 total_taxes: 120.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 480.0 retained_commission: 0.0 intermediary_commission: 96.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.0 balance: 384.0 imported: false edited: true checked: false deleted: false created_at: '2026-09-10T14:32:05' movement_kind: *832 company: *833 contractor: *834 seller: *835 intermediary: sale: sale_product: nf: created_by: cvc_master_statement_imported_scalars: id: 8a5f1d27-3e9c-4b80-b6d2-1c7e4f9a3b56 receipt_number: '0217000001198' movement_date: '2026-09-08' sale_date: '2026-08-28T15:12:00' cancellation_date: 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.0 total_discounts: 0.0 total_abatement: 0.0 calculated_commission: 623.05 retained_commission: 0.0 intermediary_commission: 0.0 deposit: 0.0 opfax: 0.0 opfax_balance: 0.0 balance: 623.05 imported: true edited: false checked: false deleted: false created_at: '2026-09-09T07:05:41' nfs_standard_pagination: size: 20 has_next_page: false next_cursor: nfs_paginated_pagination: size: 1 has_next_page: false next_cursor: nf_issued_scalars: 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: nbs_code: document: manual_emission: false amount: 113.48 service_amount: 2613.82 net_amount: 113.48 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: cvc_original_data: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: *841 taxes: *842 nfse: *843 nf_canceled_scalars: 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: nbs_code: document: '9572810403321' manual_emission: true amount: 1840.0 service_amount: 1840.0 net_amount: 1748.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: Nota cancelada a pedido do tomador. cvc_original_data: printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: *844 taxes: *845 nfse: *846 nf_issued_example: 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: nbs_code: document: manual_emission: false amount: 113.48 service_amount: 2613.82 net_amount: 113.48 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: cvc_original_data: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: *841 taxes: *842 nfse: *843 person: *1118 company: *1119 sale_product: *1120 sale: *1121 created_by: *1122 canceled_by: items: - *1123 nf_canceled_example: 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: nbs_code: document: '9572810403321' manual_emission: true amount: 1840.0 service_amount: 1840.0 net_amount: 1748.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: Nota cancelada a pedido do tomador. cvc_original_data: printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: *844 taxes: *845 nfse: *846 person: company: *1124 sale_product: sale: created_by: *1125 canceled_by: *1126 items: - *1127 nf_created_example: id: a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35 number: series: issue_date: '2026-10-16' status: unissued operation_nature: Prestação de Serviço cfop: nbs_code: '109051200' document: manual_emission: false amount: 1850.0 service_amount: 0.0 net_amount: 1850.0 approximate_taxes_percentage: 0.0 approximate_taxes_amount: 0.0 observations: Referente à viagem de outubro cvc_original_data: printed_at: canceled_at: created_at: '2026-10-16T10:12:44' recipient: *836 taxes: *837 nfse: *838 person: company: *839 sale_product: sale: created_by: canceled_by: items: - *1128 - *1129 logs_standard_pagination: size: 20 has_next_page: false next_cursor: logs_paginated_pagination: size: 1 has_next_page: true next_cursor: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9sb2dzI2luZGV4In19--5eba5fa50c894ec54e4c22226618cbcb0f7cf86b38dfcd77fdb701eaa23b8aa9 log_edition_scalars: id: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 kind: edition origin: financeiro_categoria description: Valor de "10" para "20" created_at: '2026-08-05T09:12:33' log_export_scalars: 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' log_system_scalars: 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' log_edition_example: 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: *1130 resource: *1131 log_system_example: 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' person: resource: *1132 custom_field_choices: id: 123 resource: sales name: Centro de custo kind: choices required: true active: true choices: - Matriz - Filial custom_field_text: id: 124 resource: sales name: Observação interna kind: text required: false active: true choices: [] goal_example: id: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a person_role: *1133 person: *1134 commission_plan: *1135 year: 2026 months: *1136 bank_reconciliation_summary_example: id: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 account: *849 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: *850 warnings: [] created_at: '2025-02-03T10:15:00' transfer_example: id: 857569b5-2721-4756-a27a-748168e00606 date: '2026-10-15' amount: 150.25 description: Sangria do caixa origin_account: *1137 destination_account: *1138 origin_movement: *1139 destination_movement: *1140 openapi: 3.1.0 info: title: Monde API version: V3 description: 'Bem-vindo a API da Monde! Essa documentação detalha os endpoints disponíveis para você integrar seu sistema conosco.

Sobre a API V3

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