---
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: |-
local_id. Dê a cada produto e a cada pagamento um local_id, um nome seu, único na requisição. Na resposta, cada um volta com o id gerado ao lado desse local_id. Guarde o par: para alterar a venda depois, você aponta cada produto e pagamento pelo id. O local_id não é gravado e não volta na consulta da venda. Exemplo: você envia "insurances": [{ "local_id": "seguro-1", ... }] e recebe "insurances": [{ "id": "5d7e2a91-…", "local_id": "seguro-1", ... }]; na alteração, aponta esse seguro por { "id": "5d7e2a91-…" }. Vale igual para cada pagamento.
status: closed para já criar a venda fechada, respeitando as regras de fechamento. Sem esse campo a venda nasce aberta.
commissions com alguma comissão exige também as permissões "Ver aba comissões" e "Adicionar comissões" de vendas, na empresa da venda, como no Monde; sem elas, a resposta é 403 com a mensagem do Monde, e a venda não é criada.
company_identifier, a criação é recusada com 422, como no Monde, que não deixa cadastrar venda fora de uma viagem nessa empresa. A API ainda não cria venda dentro de uma viagem.
payer precisa ter, depois da requisição, os campos que o Monde exige para salvar a venda: sempre nome e endereço com rua, número, bairro e cidade; CEP para brasileiro; data de nascimento, celular e CPF (brasileiro) ou passaporte (estrangeiro) para pessoa física; razão social, telefone, e CNPJ e IE (brasileira) ou documento fiscal estrangeiro (tax_identification_number) para pessoa jurídica. Vale o cadastro como fica depois da requisição, inclusive o que ela cria ou completa. Faltando algum, a resposta é 422 com um erro por campo, e nada é gravado.
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.
null é retirado (intermediary, approver, requester, operation_id e operation). seller e payer não podem ser retirados. Os campos personalizados enviados são gravados por cima dos atuais, e os demais ficam. O texto vazio é gravado como está (o valor vazio de um campo personalizado limpa o campo); no campo obrigatório, e em campo que não é texto, é recusado (422).insurances, hotels etc.), em segments, payments e commissions: o item com id fica ou é alterado, o sem id é incluído (com um local_id), e o que não vier sai. A lista omitida fica como está. A venda não fica sem produtos, nem o produto sem passageiros.id da consulta, e mudam só os campos enviados. Não sai o produto com pagamento, com passageiro cancelado ou com o valor do fornecedor já faturado; produto cancelado não é alterado. No transporte terrestre e no trem, reenvie included_services junto com os segments.person.id (como a consulta devolve) ou pelo external_id, e a mesma pessoa aparece uma vez só no produto: repetida na lista, a resposta é 422. A pessoa que já é passageiro ativo tem o mesmo passageiro alterado; a nova entra; o passageiro ativo que não vier sai. O cancelado fica, venha ou não na lista: reenviado igual ao lido, nada muda, e com algum valor diferente a resposta é 422, porque o passageiro cancelado só muda pela reativação. A lista com só passageiros cancelados também responde 422.id, o da resposta que o criou ou o da consulta. O payer só muda se a venda ficar sem pagamentos.status: closed para fechar a venda ao final da alteração, com as regras de fechamento do Monde. Na venda fechada, status: opened reabre a venda antes de aplicar o resto do pedido: a alteração vale por inteiro, e se alguma parte for recusada nada muda e a venda continua fechada. Reabrir só muda a situação da venda; comissões e financeiro ficam como estão. Fechar exige a permissão "Fechar venda"; reabrir exige a permissão própria "Reabrir venda", conferida na empresa da venda, e "Fechar venda" sozinha não reabre.company_identifier. É recusado quando a venda tem pagamento lançado, valor do fornecedor faturado ou está vinculada a uma viagem.commissions (mesmo vazia ou nula), mais "Adicionar comissões" para a lista com alguma comissão e "Excluir comissões" quando a venda já tem comissões manuais, e "Alterar vendas com recibo impresso" para qualquer alteração na venda com recibo impresso, mais "Trocar passageiro em vendas fechadas ou com recibo impresso" para trocar a pessoa de um passageiro dela. A pessoa, o vendedor, o navio e a cabine que a venda cria junto exigem "Editar" em Pessoas, Vendedores, Navios e Cabines, como na criação. Sem ela, a resposta é 403 com o nome da permissão, e nada é alterado. O campo reenviado igual ao gravado não pede permissão; commissions é a exceção, porque a lista enviada sempre substitui as comissões manuais.local_id ao lado do id de cada produto e pagamento enviado. Quando a credencial não pode consultar a venda, vêm só o id da venda e o id e o local_id do que você enviou, no mesmo formato. Consultar pede a permissão "Visualizar" de vendas na empresa da venda, também na venda que a própria credencial criou, e, na venda de outro vendedor, também a de abrir as vendas de outros vendedores: uma alteração sem nenhum campo não serve de consulta.429.
Idempotency-Key e aplique backoff exponencial.
422 como não encontrado quando a credencial tem a permissão de adicionar anexos mas não o lê, e 403 quando lê ou quando não tem a permissão de adicionar anexos.
403 com a mensagem do Monde.
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. 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. cabin_kind.%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.ship_name.%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.package_name.%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.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. 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.open: não liquidada, não cancelada, com vencimento
hoje ou no futuro, ou sem vencimento.overdue: não
liquidada, não cancelada, vencimento anterior a hoje.settled:
liquidada e não cancelada.canceled: cancelada, independente
de ter sido liquidada.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.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.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.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.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.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.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.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….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.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).transaction_kind) não muda: enviada,
é ignorada como qualquer campo fora do contrato.kind). O excluído e a fatura inválida
respondem 409.sale_payment,
ou com venda vinculada): pessoa, empresa e valor não mudam. No sale_standalone,
só a empresa.customer_invoice,
vendor_invoice, vendor_standalone): pessoa, empresa
e valor original não mudam; o valor vem dos itens.credit_card_invoice): vencimento, empresa e valor não mudam,
e ela não tem categorias. Os rateios dividem o valor final dela, a soma das
compras do cartão.commission): como
o lançamento avulso, mas sem operação própria.category_id. A operação própria só é aceita
no lançamento avulso (normal) sem número de fatura, como no Monde.settlement_date muda a data de liquidação,
que não pode ficar vazia nem passar da data da última movimentação. Mudar
a data de liquidação para uma diferente da gravada exige também a permissão
"Liquidar conta a pagar" ou "Liquidar conta a receber", conforme a natureza
do lançamento, como no Monde; sem ela, a resposta é 403 com a mensagem do
Monde. A mesma data reenviada não pede a permissão. Cada item de movements
com id aponta uma movimentação que o lançamento já tem, e muda
só a conta, a forma de pagamento, a data, o valor, a taxa de cartão, o cheque
ou o cartão enviados. O item sem id é uma movimentação nova,
como o Adicionar do Monde, e vem com a conta, a forma de pagamento, a data
e o valor. As movimentações não enviadas ficam como estão, e não é possível
retirar movimentação. Os ids das movimentações vêm em movements
de Consultar
conta a pagar ou receber por ID. As movimentações precisam somar exatamente
o valor final: mudar o valor pede a movimentação junto. Na movimentação com
taxa de cartão (card_rate), o valor é o que o cliente pagou,
e a conta recebe o valor menos a taxa: mudar só a taxa mantém o que o cliente
pagou e muda o que entrou na conta, como no Monde, e a categoria de taxa de
cartão acompanha, assim como a taxa cartão agência dos produtos da venda e
a receita dela. A forma de pagamento da movimentação com taxa gerada pelo
sistema não muda para outra que não seja cartão. A conta a receber pode passar
para a conta cartão de crédito, com a forma cartão de crédito: é o estorno,
que entra na fatura do cartão. A empresa do lançamento liquidado não muda.
O caixa fechado e, em contas a receber, o bloqueio da data de movimentação
valem como no Monde. Em lançamento em aberto, uma data em settlement_date
ou uma movimentação em movements é recusada: esta operação não
liquida.undo_bank_reconciliation
como true. Com a confirmação, a alteração é gravada, e a conciliação
dessa movimentação precisará ser refeita. A alteração que não mexe nas movimentações
conciliadas, como a das categorias, dos rateios ou da descrição, mantém a
conciliação e é gravada sem a confirmação.categories enviadas substituem as do lançamento, e a soma
com sinal delas é o valor final, como na inserção: a diferença para amount
é acréscimo ou desconto, sujeita ao bloqueio de acréscimo e desconto da empresa.
A lista não pode ficar vazia. O amount enviado sem categories
segue a regra do Monde: com uma categoria só, ela acompanha o novo valor;
com mais de uma, o novo valor precisa ser igual à soma delas, senão é recusado
e é preciso enviar as categorias junto.apportionments.per_cost_center pode ficar entre 0 e 100%
do valor final, e apportionments.per_company, quando informado,
precisa somar exatamente 100% e só aceita empresas em que a credencial também
pode inserir lançamentos. A lista vazia retira o rateio.company_identifier leva o lançamento para outra empresa, e exige
a permissão "Editar" de contas a pagar e receber também nela, que não pode
estar somente leitura. O lançamento de outro usuário exige também, na empresa
de destino, o acesso aos lançamentos de outros usuários (inteiro ou no recorte
do lançamento); sem ele, a resposta é 403 com a mensagem do Monde. Sem account_id,
a conta prevista continua a mesma se a nova empresa também a tem; senão, vale
a conta de previsão padrão da nova empresa. Como no Monde, o lançamento com
boleto registrado ou emitido não muda de empresa.recurrence_scope
seja this_and_following: aí ela vale também para os lançamentos
seguintes da série, como a opção "Atualizar este e próximos" do Monde. Os
seguintes são alterados em segundo plano, logo depois da resposta. Nunca se
levam a eles a liquidação, o número, o documento e os dados do boleto; o vencimento
deles segue a periodicidade da série a partir do lançamento alterado, e na
recorrência a emissão também. Cada seguinte só é alterado quando a credencial
poderia alterá-lo diretamente, com as regras do fim desta descrição: a permissão
"Editar" na empresa dele, que não pode estar somente leitura; no de outro
usuário, o acesso aos lançamentos de outros usuários (inteiro ou no recorte
do lançamento); e, no já liquidado, a "Editar lançamento liquidado". O seguinte
que não atende a isso fica como está, sem interromper os demais. O seguinte
excluído também fica como está. Em lançamento fora de uma série, this_and_following
é recusado.id.
Vale também para o lançamento que a própria credencial criou.'
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:
sale_payment, sale_standalone ou com venda vinculada): ele sai pela exclusão da venda;credit_card_invoice), que sai sozinha quando fica sem lançamentos;commission);Sem confirmação. Esta é a exclusão sem confirmação: o DELETE não tem corpo, e o corpo enviado é ignorado. Por isso, o lançamento liquidado e o lançamento com movimentação conciliada respondem 409, e o recurrence_scope responde 422: no lançamento de uma série, o DELETE exclui só ele. Quando a recusa 409 pedir uma confirmação, ou para excluir também os seguintes da série, use Excluir conta a pagar ou receber com confirmação, que tem as mesmas regras e leva as confirmações no corpo.
A exclusão fica no log do lançamento, em nome da credencial.
Exige a permissão "Excluir" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura; a permissão "Editar" não basta. As permissões são conferidas antes de tudo: sem a "Editar lançamento liquidado", o lançamento liquidado responde 403, mesmo o que também seria recusado com 409, como o gerado por venda. A credencial exclui o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. Não exige Idempotency-Key: repetir a requisição depois de excluído responde 409.
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.
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:
category: a diferença vai para uma categoria, como desconto (pago a menos) ou acréscimo (pago a mais), e o valor final passa a ser o que foi pago. A categoria vem em balance_category_id; sem ela, vale a categoria padrão da empresa para aquele caso (desconto concedido ou recebido, acréscimo cobrado ou pago), e sem padrão o pedido é recusado. A categoria precisa ser do tipo que leva o valor final ao que foi pago: a de despesa numa conta a pagar paga a mais, por exemplo. Vale o bloqueio de acréscimo e desconto da empresa.partial: só quando foi pago menos que o valor final. O lançamento é liquidado com o que foi pago e ganha o sufixo " 1/2" na descrição, e o saldo vira um novo lançamento em aberto, com o sufixo " 2/2" e as mesmas categorias na proporção do saldo. O saldo vem em generated_bills.Sem balance_resolution, as movimentações precisam somar exatamente o valor final. Na fatura de cartão, a diferença vai sempre para a próxima fatura do mesmo cartão, sem escolha (balance_resolution não muda o destino dela): o que faltou pagar entra nela como dívida, e o que sobrou, como abatimento. Na fatura de cliente gerada pelo Monde e na fatura de fornecedor, exceto a da CVC, a API liquida só o valor total, e o pagamento menor ou maior que ele é recusado com 422. Nas demais faturas, a diferença se resolve só com category; o pagamento parcial é recusado com 422.
Que lançamentos. Todos os tipos, como no Monde: o lançamento avulso (normal), o pagamento da venda (sale_payment), o avulso da venda (sale_standalone), a comissão (commission), a fatura de cliente e de fornecedor (customer_invoice, vendor_invoice, vendor_standalone) e a fatura de cartão (credit_card_invoice). Respondem 409, com o motivo: o lançamento já liquidado (para mudar a baixa, use a alteração), o excluído e a fatura inválida. O lançamento em outra moeda se liquida como no Monde: o amount da movimentação é na moeda do lançamento e, na conta em outra moeda, entra convertido pelo câmbio (exchange_rate). A movimentação numa conta fora do real guarda o câmbio de referência da moeda da conta para o real (reference_exchange_rate). Como no Monde, os dois vêm sugeridos pela última cotação e podem ser corrigidos: omitidos, valem as cotações (sem cotação cadastrada para converter, 422); informados, valem os do banco.
Pagamento da venda. Cada pagamento feito à agência numa venda (dinheiro, cartão, boleto, cheque, depósito e outros, uma conta por parcela) é um lançamento sale_payment, e o id dele vem em payments.agency.bills de Consultar venda por ID e da resposta da inserção e da alteração da venda. Os pagamentos ao fornecedor e o crédito na agência não geram lançamento e não se liquidam. A baixa usa a forma e os dados de pagamento combinados na venda, como o "Liquidar usando dados da venda" do Monde: payment_method_id é opcional na movimentação e, ausente, vale a forma da venda; a movimentação que usa a forma da venda recebe o cartão ou o cheque informados nela, que card e check substituem quando enviados. A taxa de cartão calculada na venda passa para a primeira movimentação, quando ela é de cartão (senão, fica no lançamento), sem precisar enviar card_rate: como em toda movimentação com taxa, o amount é o que o cliente pagou, e a conta recebe o amount menos a taxa. A taxa de cartão da liquidação é rateada entre os produtos da venda, na taxa cartão agência deles, e sai da receita da venda, como no Monde. O saldo do pagamento parcial (balance_resolution igual a partial) nasce ligado à mesma venda, sem os sufixos " 1/2" e " 2/2" na descrição: ele aparece em payments.agency.bills da venda. No pagamento parcial, os itens do pagamento ficam no lançamento até o valor pago, e o item que passa dele é dividido: a parte paga fica, e o resto vai para o saldo, cada parte com a taxa cartão agência na proporção do seu valor. As categorias do saldo vêm das categorias padrão de fatura da empresa; sem elas, a liquidação é recusada com 422 e nada é gravado. Pessoa, empresa e valor do pagamento não mudam.
Regras do Monde. Em contas a receber valem o bloqueio da data de movimentação e o de acréscimo e desconto da empresa, que para a integração valem sempre. O caixa do dia fechado recusa a movimentação com o motivo, como O caixa do dia "14/10/2026" da conta "Caixa" está fechado. A liquidação e as movimentações ficam no log do lançamento, em nome da credencial.
As respostas seguem uma ordem: a permissão (403), o formato do pedido (422), a situação do lançamento (409) e as regras da liquidação e do Monde (422). Os erros de um item de movements trazem a posição dele, contada a partir de 0.
Exige a permissão "Editar" de contas a pagar e receber na empresa do lançamento, que não pode estar somente leitura: liquidar é o mesmo direito de inserir o lançamento já liquidado. Exige também a permissão Liquidar conta a pagar ou Liquidar conta a receber, conforme a natureza do lançamento; sem ela, a resposta é 403 com a mensagem do Monde. A credencial liquida o lançamento que ela mesma criou e, com o acesso aos lançamentos de outros usuários (inteiro ou no recorte do lançamento), os demais. O lançamento de outro usuário fora desse acesso responde 404. Pela conexão automática, o lançamento de outra origem que o parceiro lê pela exceção concedida na homologação responde 403 com a mensagem do Monde. A resposta traz o lançamento liquidado, igual a Consultar conta a pagar ou receber por ID, com o saldo do pagamento parcial em generated_bills, quando a credencial também tem a permissão "Visualizar" de contas a pagar e receber na empresa do lançamento; sem ela, a liquidação é gravada do mesmo jeito e a resposta traz só o id. Vale também para o lançamento que a própria credencial criou.
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.
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.
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.
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.
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 debilling_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".
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.
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".
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, oid 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. É obill 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.
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".
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. credit: entrada de dinheiro na conta.debit: saída de dinheiro da conta.customer: reembolso do cliente.vendor: reembolso do fornecedor ou do representante.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). 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. 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.
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. 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. 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. 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. customer: a agência devolve o valor ao cliente. O reembolso é lançado negativo, em nome de person_id (o pagante da venda, quando omitido), na moeda de venda do produto e com vencimento no dia.vendor: o fornecedor devolve o valor à agência (credit, o padrão) ou a agência paga o fornecedor (debit), em nome do representante do produto ou, sem ele, do fornecedor, na moeda de venda do produto (na operadora, na moeda de origem).billing, invoice (Faturar) manda o reembolso para a fatura pelas regras de faturamento, em segundo plano: a do cliente sempre; a do fornecedor só com a fatura automática de fornecedor ligada, e fora dos produtos da CVC. Até lá, bill volta nulo. bill (Gerar conta a pagar/receber) gera na hora uma fatura avulsa só com o reembolso, com vencimento no dia, que volta em bill. 409), e o produto não pode estar excluído. O reembolso ao cliente só existe na agência: na operadora, responde 403. São recusados com 422: o reembolso com o controle de crédito ligado, o reembolso do fornecedor de operação própria e o reembolso sem a categoria padrão de reembolso configurada na empresa. id.
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. 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.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. 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. 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. 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. sale_date: data da venda.product_start: data de início do produto (embarque, check-in).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.sales: campos de vendas.travels: campos de viagens.people: campos de pessoas.bills: campos de contas a pagar e receber.tasks: campos de tarefas.Authorization da requisição, com o esquema Bearer.Authorization: Bearer bW9uZGV8dXNlcjpwYXNzMTIz
Idempotency-Key)
para garantir que requisições duplicadas (por exemplo, por timeout ou tentativas
automáticas) não sejam processadas mais de uma vez. 550e8400-e29b-41d4-a716-446655440000).X-Idempotent-Replay:
true.409 Conflict.422 Unprocessable Content), a chave volta
a ficar disponível: reenviar a mesma requisição com a mesma chave é processado
de novo.422
Unprocessable Content./64: todos os endereços
da mesma rede /64 somam no mesmo limite.429 Too Many Requests
e uma mensagem de erro.429,
aguarde antes de tentar novamente e use um tempo de espera crescente entre as
tentativas (backoff exponencial).pagination da resposta diz o tamanho da página, se existe uma
próxima e qual cursor pedir para chegar nela. cursor.has_next_page for true, repita a requisição enviando
cursor com o valor de next_cursor da resposta anterior.has_next_page for false, next_cursor
vem nulo e a varredura terminou.size
define quantos registros vêm por página: de 1 a 50. Sem o parâmetro, são 20.400.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.redirect_uri
com um code.code por
um token e usa o token para chamar a API em nome daquela agência.id_token nem dados do
usuário.https://web.monde.com.br.
https://web.monde.com.br/partners/signup
e confirme o e-mail. O Monde analisa o cadastro, define as permissões e aprova.client_id e o client_secret aparecem nessa
página; o secret é exibido uma única vez, então guarde-o na hora. Se precisar
vê-lo de novo, solicite a regeneração ao Monde.client_secret
só no seu backend. Ele nunca vai para o navegador nem para o app do usuário.https://web.monde.com.br/partners/integration),
informe a redirect_uri e a URL da política de privacidade, que a
agência vê ao autorizar. A conexão fica habilitada assim que o cadastro está aprovado
e as duas estão informadas, sem nenhum outro passo. Enquanto falta uma delas,
a autorização não funciona. redirect_uri é uma só por
parceiro e precisa usar https. Ela precisa ser idêntica, caractere
por caractere, na autorização e na troca do token (uma barra no fim já é diferença).
Endereços http, inclusive localhost e 127.0.0.1,
não são aceitos.state e um code_verifier
novos e guarde os dois na sessão do usuário. O code_verifier é um
texto aleatório de 43 a 128 caracteres; o code_challenge é BASE64URL(SHA256(code_verifier)),
sem o = no fim. PKCE é obrigatório e só aceita S256:
ele é o que impede outro sistema de trocar um code interceptado.
code_verifier=$(openssl rand -base64 64 | tr -d '=+/\\n' | cut -c1-64) code_challenge=$(printf
'%s' "$code_verifier" | openssl dgst -sha256 -binary | openssl base64
| tr '+/' '-_' | tr -d '=\\n') Redirecione o usuário da agência para a URL
de autorização, com os valores codificados para URL: GET https://web.monde.com.br/oauth/authorize?response_type=code&client_id=SEU_CLIENT_ID&redirect_uri=SUA_REDIRECT_URI&state=STATE&code_challenge=CODE_CHALLENGE&code_challenge_method=S256
scope: o que o parceiro pode fazer são as permissões
definidas na aprovação.client_id não é de um parceiro
ativo e aprovado, se a conexão ainda não está habilitada (falta a redirect_uri
ou a política de privacidade), se a redirect_uri não é a cadastrada,
ou se falta o code_challenge ou o code_challenge_method
não é S256, o Monde responde 400 numa página própria
e não volta para a redirect_uri.redirect_uri com o code e o mesmo state
que você enviou: SUA_REDIRECT_URI?code=agencia%7CujES3JCJylJRoM3j_kGeavaD2hFqz2oqw1Lazq_u0rs&state=STATEQuando a agência recusa:
SUA_REDIRECT_URI?error=access_denied&error_description=O+dono+do+recurso+ou+o+servidor+de+autoriza%C3%A7%C3%A3o+negou+a+requisi%C3%A7%C3%A3o.&state=STATE
state com o da sessão. Se for diferente ou faltar,
descarte a resposta.code é opaco. Use o valor decodificado
da URL do jeito que veio, sem cortar nem trocar caracteres. Ele vale 10 minutos
e só pode ser trocado uma vez.redirect_uri
quando quem entrou não é administrador da agência. Nesse caso o usuário vê a explicação
numa página do Monde. O consentimento oferece todas as empresas ativas da agência,
e nenhuma é recusada por licença.href aponta para
a URL de autorização que você monta no seu backend a cada acesso, com um code_challenge
PKCE novo (passo 2 acima), nunca um link estático. O símbolo do Monde é hospedado
por nós: https://web.monde.com.br/logo-monde-conectar.svg (colorido,
para fundo claro) e https://web.monde.com.br/logo-monde-conectar-branco.svg
(branco, para fundo azul). Três variações: <a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0
20px 0 14px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600
14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar-branco.svg"
alt="Monde" style="height:22px"> Conectar com o Monde</a>
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;gap:10px;height:40px;padding:0
20px 0 14px;background:#fff;color:#344050;border:1px solid #d8e2ef;border-radius:6px;font:600
14px 'Open Sans',Arial,sans-serif;text-decoration:none"><img src="https://web.monde.com.br/logo-monde-conectar.svg"
alt="Monde" style="height:22px"> Conectar com o Monde</a>
<a href="URL_DE_AUTORIZACAO" style="display:inline-flex;align-items:center;height:40px;padding:0
20px;background:#2c7be5;color:#fff;border:1px solid #2c7be5;border-radius:6px;font:600
14px 'Open Sans',Arial,sans-serif;text-decoration:none">Conectar com o
Monde</a> application/x-www-form-urlencoded;
o mesmo corpo em JSON (application/json) também é aceito. curl
-X POST https://web.monde.com.br/oauth/token -H "Content-Type: application/x-www-form-urlencoded"
--data-urlencode "grant_type=authorization_code" --data-urlencode "code=CODE"
--data-urlencode "redirect_uri=SUA_REDIRECT_URI" --data-urlencode "client_id=SEU_CLIENT_ID"
--data-urlencode "client_secret=SEU_CLIENT_SECRET" --data-urlencode
"code_verifier=CODE_VERIFIER" Resposta 200: {
"access_token": "YWdlbmNpYXw2ZjFj...", "token_type":
"Bearer", "scope": "full_access", "created_at":
1790602784 } O access_token não expira e não vem refresh_token.
Guarde-o no backend, um por agência conectada, e trate-o como senha. 400
com {"error":"invalid_grant","error_description":"..."}:
code vencido ou já trocado, code_verifier que não corresponde
ao code_challenge, ou redirect_uri diferente da usada
na autorização. Recomece pela autorização.400 com {"error":"invalid_request","error_description":"..."}:
o code_verifier não foi enviado.401 com {"error":"invalid_client","error_description":"..."}:
client_id ou client_secret errado.404
com corpo vazio: o code chegou alterado.https://web.monde.com.br/api/v3
com o token no cabeçalho Authorization (o token já carrega a agência).
Authorization: Bearer SEU_ACCESS_TOKENPara confirmar que a conexão funciona sem criar dado, chame
GET /api/v3/sales com o token: curl
https://web.monde.com.br/api/v3/sales -H "Authorization: Bearer SEU_ACCESS_TOKEN"
-H "Content-Type: application/json" 200
com a lista das vendas que o parceiro alcança (as que ele criou e, quando o Monde
concedeu na aprovação o acesso a outras origens, também as demais; sem essa exceção,
a lista vem vazia numa conexão nova): o token é válido e a integração está pronta.403 com {"errors":["Você não tem permissão
para executar essa ação."]}: o token é válido, mas o parceiro não
tem a permissão "Visualizar" de vendas na empresa.401
com {"errors":["Credenciais de acesso não são válidas."]}:
o token é inválido ou a conexão foi excluída. Recomece pela autorização.POST
/sales.401.curl -X POST https://web.monde.com.br/oauth/revoke
--data-urlencode "token=SEU_ACCESS_TOKEN" --data-urlencode "client_id=SEU_CLIENT_ID"
--data-urlencode "client_secret=SEU_CLIENT_SECRET" A resposta
é 200 com {}. A conexão com a agência é excluída na
hora e o token para de funcionar. Para conectar de novo, recomece pela autorização.
403 com {"error":"unauthorized_client",...}:
client_id ou client_secret errado, ou o token
não pertence a este client_id. Nada é revogado.redirect_uri: o seu backend
consulta as conexões novas e recebe cada uma já com o token, sem ninguém copiar
chave. https://web.monde.com.br/partners/integration),
só depois que a consulta abaixo estiver implementada. A conexão automática precisa
estar habilitada (passo 1).client_id
e o client_secret em HTTP Basic: curl -X POST https://web.monde.com.br/oauth/connections
-u "SEU_CLIENT_ID:SEU_CLIENT_SECRET" O client_id
e o client_secret também podem ir no corpo, como na troca do token,
mas nunca na URL: na query string eles são ignorados e a resposta é 401.
Resposta 200: { "data": [ { "id": "5b0f3c2e-8a51-4f6e-9a3d-2f4f1f0c9e11",
"access_token": "YWdlbmNpYXw2ZjFj...", "token_type":
"Bearer", "company": { "name": "Agência Exemplo",
"cnpj": "12345678000190" }, "authorized_at": "2026-10-19T14:32:05.000-03:00"
} ], "pagination": { "size": 50, "has_next_page":
false, "next_cursor": null } } access_token no backend
antes de qualquer outro passo: ele não volta numa próxima consulta. Se ele se
perder, a agência exclui a integração e conecta de novo. Use o id
para não processar a mesma conexão duas vezes do seu lado.access_token
é igual ao do passo 4: não expira, não tem refresh_token, é usado
na API v3 do mesmo jeito (passo 5) e revogado do mesmo jeito (passo 6).company é a empresa da agência que foi conectada. Use o CNPJ para
ligar a conexão ao cliente certo na sua plataforma.data. O nó
pagination tem o formato da paginação
da API, mas a fila não usa cursor: com has_next_page igual a true,
consulte de novo em seguida, sem parâmetro, e o next_cursor vem sempre
nulo. Sem conexão nova, a lista vem vazia. Com duas consultas ao mesmo tempo,
uma delas pode vir com a lista vazia e has_next_page igual a true:
consulte de novo.Cache-Control: no-store:
não a guarde em cache nem em log, porque ela leva os tokens.401
com {"error":"invalid_client","error_description":"..."}:
client_id ou client_secret errado, ou a conexão automática
não está habilitada. Nada é entregue.single: solteiro(a).married: casado(a).separated: separado(a).divorced: divorciado(a).widowed: viúvo(a).civil_union: união estável.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.others
(padrão): outros produtos.operation: operação própria,
só em base de agência.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. self_provided:
transporte próprio.road_transport: transporte rodoviário.no_transport: sem transporte.charter_flight:
voo fretado.scheduled_flight: voo regular.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.
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. 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. departure_date.
Opcional. 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. 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. departure_date.
Opcional. 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).
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.checking_account: conta
corrente.card_account: cartão de crédito.check_account: cheques.cashier_account:
caixa.none:
aplica-se apenas a vendas sem representante.specific:
aplica-se apenas ao representante indicado em representative.any: aplica-se a qualquer representante.upcoming:
a iniciar.ongoing: em viagem.finished:
finalizada.<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çamentoPacote 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 `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 guiaChegada 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, `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.every:
todos.national: nacional.international:
internacional.cruise: navio (disponível apenas
para o produto Seguro Viagem).every_movement
e não tem efeito. every_movement: todos.to_pay:
a pagar para o fornecedor.to_receive: a receber
do fornecedor.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.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.stay: mantém a data.next:
move para o próximo dia útil.previous: move
para o dia útil anterior.single: solteiro(a).married: casado(a).separated: separado(a).divorced: divorciado(a).widowed: viúvo(a).civil_union: união estável.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.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.customer e o fornecedor nos itens vendor. 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. 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.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.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.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.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.credit: entrada de dinheiro na conta.debit: saída de dinheiro da conta.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 customer: reembolso do cliente.vendor: reembolso do fornecedor ou do representante.customer: a agência devolve o valor ao cliente.vendor: reembolso com o fornecedor ou o representante do produto.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.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).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.payer: pagante.supplier: fornecedor.representative: representante.payer: pagante.supplier: fornecedor.representative: representante.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.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 numeric: número inteiro.currency: valor monetário.text: texto livre.date: data.choices: uma das opções cadastradas (ver choices).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: "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: "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: "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: "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, semcompany_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.https://web.monde.com.br/api/v3.
string, integer, float, boolean,
etc. .)
como separador decimal, apenas nas últimas duas casas. Exemplo: 99999.99.
required.
"") é um valor de texto: no campo de texto,
é gravado como foi enviado, e no campo de texto obrigatório é recusado (422).
Em campo de outro tipo (objeto, lista, número, booleano, data, opção ou referência
por id), "" é recusado (422). PATCH),
o campo omitido fica como está, e o enviado como null tem o valor
retirado. O campo que o registro não pode ficar sem recusa o null
(422).