---
paths:
"/sales":
get:
operationId: listSales
summary: List sales
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Sales
description: Returns a paginated list of sales. By default, returns only opened
and closed sales; to include canceled sales, use the status parameter.
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: 'Date field used by the filter. Accepted values: sale_date (sale
date), departure_date (trip start) and return_date (trip end). Required
when date_from or date_to is provided.'
example: sale_date
- in: query
name: date_from
required: false
schema:
type: string
format: date
description: Filter sales whose field chosen in date_field is on or after
this date, in ISO 8601 format (YYYY-MM-DD).
example: '2024-01-01'
- in: query
name: date_to
required: false
schema:
type: string
format: date
description: Filter sales whose field chosen in date_field is on or before
this date, in ISO 8601 format (YYYY-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: 'Filter sales by status. For multiple statuses, separate values
with commas (e.g., opened,closed,canceled). Accepted values: opened, closed
and canceled. When the parameter is not provided, the API returns only opened
and closed sales; canceled sales are returned only when explicitly requested.'
example:
- opened
- closed
examples:
single_status:
summary: Filter by single status
value:
- canceled
multiple_statuses:
summary: Filter by multiple statuses
value:
- opened
- closed
- canceled
- in: query
name: people_id
required: false
schema:
type: array
items:
type: string
format: uuid
style: form
explode: false
description: 'Filter sales by a participating person, given their identifier
(UUID). A sale is returned when the person appears in any role: payer, seller,
intermediary, requester, approver, promoter, passenger, supplier, representative
or the person who registered the sale. For multiple identifiers, separate
them with commas — a sale is returned when any of the people participates
in it.'
example:
- b2a6d7da-ff94-40e3-b069-812b2fd45b91
examples:
single_person:
summary: Filter by a single person
value:
- b2a6d7da-ff94-40e3-b069-812b2fd45b91
multiple_people:
summary: Filter by multiple people
value:
- b2a6d7da-ff94-40e3-b069-812b2fd45b91
- 3f1c9e20-5d7a-4b6c-9e2f-1a2b3c4d5e6f
- in: query
name: number
required: false
schema:
type: integer
description: Filter sales by the number shown in the app (e.g., 1024). One
number per request.
example: 1024
- in: query
name: updated_since
required: false
schema:
type: string
format: date-time
description: 'Filter sales updated at or after this instant, in ISO 8601 format.
Accepts a date (YYYY-MM-DD, taken as the start of the day) or a date-time
(YYYY-MM-DDTHH:MM:SS). When the value carries no time zone, the Brasília
time zone is assumed. Useful to reprocess only what changed since the last
query, even within the same day. A sale comes back when its header changes
or when one of these parts of it, shown in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get),
changes: products, passengers, segments and seats, commissions, attachments,
payments and the linked bills (addition, cancellation and deletion). Settling
a bill only brings the sale back when it changes the agency card fee of
the products (a settlement or reversal with a card fee) or when it is partial
and creates the balance bill. A change to a record the sale only references
(person, catalog product, supplier, commissioned role) does not bring the
sale back: that data is read from each record''s own endpoint. The list
brings the sale summary, and the detail comes from Get sale by ID. To also
follow deleted sales, send `status=opened,closed,canceled` along. To avoid
missing a sale written by an operation that finished after the cutoff, keep
the instant the query started, before the first page, and start the next
query from it with an overlap of a few minutes before it, which also covers
the difference between your clock and Brasília time. Upsert each sale by
id: the same sale may come again, without duplicating.'
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: Filter sales by product kind, with the same kind
values as the products. A sale is returned when it has a non-deleted product
of the given kind. For multiple kinds, separate them with commas — a sale
is returned when it has a product of any of them.
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: Create a sale
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Sales
description: |-
local_id. Give each product and each payment a local_id, a name of yours, unique in the request. In the response, each one comes back with the generated id next to that local_id. Keep the pair: to update the sale later, you point to each product and payment by its id. The local_id is not stored and does not come back in the sale get. Example: you send "insurances": [{ "local_id": "insurance-1", ... }] and get "insurances": [{ "id": "5d7e2a91-…", "local_id": "insurance-1", ... }]; in the update, you point to that insurance by { "id": "5d7e2a91-…" }. The same goes for each payment.
status: closed to create the sale already closed, honoring the closing rules. Without this field the sale is created open.
commissions with any commission also requires the "View commissions tab" and "Add commissions" permissions on sales, in the company of the sale, as in Monde; without them, the answer is 403 with the Monde message, and the sale is not created.
company_identifier, the creation is rejected with 422, as in Monde, which does not allow registering a sale outside a trip in that company. The API cannot yet create a sale within a trip.
payer registration must have, after the request, the fields Monde requires to save the sale: always name and an address with street, number, neighborhood and city; postal code for Brazilians; birthdate, mobile number and CPF (Brazilian) or passport (foreigner) for individuals; legal name, phone number, and CNPJ and IE (Brazilian) or foreign tax document (tax_identification_number) for companies. The registration counts as it stands after the request, including what the request creates or completes. If any is missing, the response is 422 with one error per field, and nothing is saved.
Deletes the sale the way Monde does: it is not removed, its status becomes canceled. The deleted sale no longer shows in List sales, unless the status parameter asks for canceled sales, and is still available when queried by ID. The agency can restore it in Monde.
The status changes before the response. Right after, Monde undoes what the sale generated in the finances: payments are removed and their receivables are deleted, a payment included in a client invoice leaves it, supplier items not yet invoiced are removed and commissions paid by a payment's financial entry are unlinked from it. What is still owed for each product becomes a balance again, owed by the payer (by the intermediary, on tour operators). This part finishes a few moments after the response.
The sale is not deleted, and the response is 409 with the reason, when it:
A sale with a printed receipt also requires the "Change sales with a printed receipt" permission, as in Monde; without it, the answer is 403.
Does not require Idempotency-Key: repeating the request after the sale is deleted returns 409.
null is removed (intermediary, approver, requester, operation_id and operation). seller and payer cannot be removed. The custom fields sent overwrite the current ones, and the others stay. Empty text is saved as sent (an empty custom field value clears the field); on a required field, and on a field that is not text, it is refused (422).insurances, hotels etc.), in segments, payments and commissions: an item with id stays or is changed, an item without id is added (with a local_id), and what is not sent is removed. An omitted list stays as it is. The sale cannot be left without products, nor a product without passengers.id from the get, and only the fields sent change. A product with payments, with a canceled passenger or whose supplier amount is already invoiced is not removed; a canceled product is not changed. In ground transportation and train tickets, resend included_services with the segments.person.id (as the get returns it) or by the external_id, and the same person appears only once in the product: repeated in the list, the response is 422. A person who is already an active passenger has that same passenger changed; a new person is added; an active passenger not sent is removed. A canceled passenger stays, sent or not: resent as read, nothing changes, and with any different value the response is 422, because a canceled passenger only changes through the reactivation. A list with only canceled passengers also answers 422.id, the one from the response that created it or from the get. The payer only changes if the sale is left without payments.status: closed to close the sale at the end of the update, with the closing rules of Monde. On a closed sale, status: opened reopens the sale before applying the rest of the request: the update applies as a whole, and if any part is refused nothing changes and the sale stays closed. Reopening only changes the sale status; commissions and financial entries stay as they are. Closing requires the "Close sale" permission; reopening requires its own "Reopen sale" permission, checked in the company of the sale, and "Close sale" alone does not reopen.company_identifier. It is refused when the sale has a payment with a bill, an invoiced supplier amount or is linked to a travel.commissions (even empty or null), plus "Add commissions" for a list with any commission and "Delete commissions" when the sale already has manual commissions, and "Change sales with a printed receipt" for any change to a sale with a printed receipt, plus "Swap passenger in closed sales or sales with a printed receipt" to swap the person of one of its passengers. The person, the seller, the ship and the cabin the sale creates along require "Edit" on People, Sellers, Ships and Cabins, as in the creation. Without it, the answer is 403 with the name of the permission, and nothing is changed. A field resent equal to the stored one asks no permission; commissions is the exception, because the list sent always replaces the manual commissions.local_id next to the id of each product and payment sent. When the credential cannot get the sale, only the sale id and the id and local_id of what you sent come back, in the same format. Getting the sale requires the "View" permission on sales in the sale's company, also for a sale the credential itself created, and, for a sale of another seller, also the permission to open the sales of other sellers: an update without any field does not serve as a get.429.
Idempotency-Key and apply exponential backoff.
422 as not found when the credential may add attachments but cannot read it, and 403 when it can read it or may not add attachments.
403 with the Monde message.
''insurances[0] passengers[2]
person name'' refers to the third passenger of the first insurance.
A rule checked over the whole list, such as a repeated contact, comes
on the list name, without position. A null or blank item inside a list
([null], [""]) is refused.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
description: 'Error message list. Example: `[Invalid format for
attachment, File ''voucher.exe'' with extension ''.exe'' is
not allowed. Allowed extensions: ''.pdf, .doc, .docx, .odt,
.xls, .xlsx, .ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic,
.heif, .txt, .csv'', File ''voucher.pdf'' (5.2 MB) exceeds the
maximum allowed size of 12 MB]`'
examples:
- - Invalid format for attachment
- 'File ''voucher.exe'' with extension ''.exe'' is not allowed.
Allowed extensions: ''.pdf, .doc, .docx, .odt, .xls, .xlsx,
.ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic, .heif,
.txt, .csv'''
- File 'voucher.pdf' (5.2 MB) exceeds the maximum allowed size
of 12 MB
example:
errors:
- Invalid format for attachment
- 'File ''voucher.exe'' with extension ''.exe'' is not allowed. Allowed
extensions: ''.pdf, .doc, .docx, .odt, .xls, .xlsx, .ods, .ppt,
.pptx, .jpg, .jpeg, .png, .webp, .heic, .heif, .txt, .csv'''
- File 'voucher.pdf' (5.2 MB) exceeds the maximum allowed size of
12 MB
'429':
"$ref": "#/components/responses/too_many_requests"
'500':
"$ref": "#/components/responses/internal_server_error"
"/attachments/{id}":
patch:
operationId: renameAttachment
summary: Rename attachment
x-badges:
- name: Beta
tags:
- Attachments
description: 'Changes the name of the attachment, like Monde''s Renomear. Only
the name changes: the file and the owner record stay as they are. A blank
name is refused with 422. Requires the same permissions as attaching on the
owner record: its "Add attachments" and "Edit", with the reach to records
of other origins the credential has. An attachment of a record the credential
does not reach answers 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: Attachment identifier.
example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- description
properties:
description:
type: string
description: New name of the attachment. It cannot be blank.
example: Comprovante de pagamento
examples:
rename_attachment:
summary: Rename the attachment
value:
description: Comprovante de pagamento
responses:
'200':
description: The renamed attachment.
content:
application/json:
schema:
"$ref": "#/components/schemas/attachments_response"
examples:
upload_attachments:
summary: Attachment upload response example.
"$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: Delete attachment
x-badges:
- name: Beta
tags:
- Attachments
description: |-
Sends the attachment to the trash of the record, as in Monde, where it can be restored. The deleted attachment leaves the read of the record and can no longer be downloaded. 404.
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Attachment identifier.
example: b8c9d0e1-f2a3-4455-c6d7-e8f9a0b1c2d3
responses:
'204':
description: Attachment deleted.
'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: Download attachment
x-badges:
- name: Beta
tags:
- Attachments
description: |-
Redirects (302) to a temporary link to the file, which expires in a few minutes. A new request generates a new link. The content is gzip-compressed and comes without the Content-Encoding header: decompress it before use. cabin_kind.%20, slash as %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: Current cabin name, URL-encoded
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: Update cabin
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Cabins
description: 'Updates the cabin by its current name, sent in the path URL-encoded.
An omitted field stays as it is. A new name renames the cabin, and the sale
products that use it show the new name, as in Monde.ship_name.%20, slash as %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: Current ship name, URL-encoded
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: Update ship
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Ships
description: 'Updates the ship by its current name, sent in the path URL-encoded.
An omitted field stays as it is. A new name renames the ship, and the sale
products that use it show the new name, as in Monde.package_name.%20, slash as %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: Current package name, URL-encoded
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: Update package
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Packages
description: 'Updates the package by its current name, sent in the path URL-encoded.
An omitted field stays as it is. Included services sent null are cleared.
A new name renames the package, and the sale products that use it show the
new name, as in Monde.individual or company.'
example: individual
- in: query
name: code
required: false
schema:
type: integer
description: Filters by the person's sequential code (exact match).
example: 1024
- in: query
name: email
required: false
schema:
type: string
description: Filters by email, case- and accent-insensitive (substring match).
example: contato@exemplo.com
- in: query
name: label_id
required: false
schema:
type: string
format: uuid
description: Filters the people who have the given label (UUID, the `id` from
[List labels](#tag/Labels)).
example: 2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50
- in: query
name: birthday_from
required: false
schema:
type: string
format: date
description: 'Start of the birthday window (YYYY-MM-DD). Returns the people
whose birth day and month fall between `birthday_from` and `birthday_to`,
whatever the year, including a window that crosses the turn of the year.
Replaces Monde''s Birthdays report: for today''s birthdays, send today''s
date in both parameters. Send both together; the window can be up to 366
days long.'
example: '2026-12-28'
- in: query
name: birthday_to
required: false
schema:
type: string
format: date
description: End of the birthday window (YYYY-MM-DD), inclusive. See `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: Create a person
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: 'Creates an individual or a legal person. Every request creates
a new registration: the `external_id`, when provided, must be free, and the
CPF/CNPJ cannot belong to any person already registered. The response returns
the created person in the same format as the get by ID. Sending `seller` also
requires the "Change seller" permission, and `promoter`, the "Change promoter"
one, as in Monde; without it, the answer is 403. Sending `credit_cards` or
`kandir_law` also requires the "View financial tab" permission on people,
and adding cards, the "Register credit card" one, as in Monde, where the cards
and the Kandir law sit on the Financial tab of the person; without it, the
answer is 403 with the Monde message. Without "View financial tab", the response
does not bring `credit_cards` nor `kandir_law`, and without "View credit card
data", it does not bring `credit_cards`: the field does not come.'
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- "$ref": "#/components/parameters/content_type_json"
- "$ref": "#/components/parameters/idempotency_key_header"
responses:
'200':
description: 'Repeated request with the same Idempotency-Key: returns the
answer of the first call, without creating another person.'
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response replays a request that was already
processed.
content:
application/json:
schema:
"$ref": "#/components/schemas/person_detail"
examples:
person_detail:
summary: Person by ID
"$ref": "#/components/examples/person_detail"
'201':
description: Person created successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/person_detail"
examples:
person_detail:
summary: Person by 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: Individual person registration
"$ref": "#/components/examples/create_individual_person"
create_company_person:
summary: Legal person registration
"$ref": "#/components/examples/create_company_person"
"/people/{id}":
get:
operationId: getPerson
summary: Get person by ID
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: 'Returns the full data of a person by its identifier, including
the grouped blocks (additional data, last contacts, withholdings, and airline)
and the weak entities (contacts, labels, custom fields, attachments, credit
cards (always masked), and Kandir Law tax withholding). Like the Financial
tab in Monde, `credit_cards` and `kandir_law` only come with the "View financial
tab" permission on people, and `credit_cards`, also with the "View credit
card data" one. Without the permission, the field does not come: it is left
out, not sent as null.'
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: Unique person identifier (UUID).
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: Update a person
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: 'Updates a person already registered. Send only the fields that
must change: a field left out stays as it is, and a field sent as null is
removed. Empty text is saved as sent; on a required field, and on a field
that is not text, it is refused (422), the codes that locate the city (`city_ibge`,
`city_name`, `state_code`, `country_code`) and the `code` of `airline`, which
is unique among people, included. An object sent as null removes everything
it writes (`address`, `birthplace`, `additional_data`, `airline`), and a null
field inside it, only that data; the city is removed when `city_ibge` and
`city_name` come null. A null `seller` or `promoter` removes the seller or
the promoter. These cannot be removed, and sending them as null is refused
(422): `name`, `person_kind`, `foreigner`, `charge_billet_fee`, the `external_id`
(it can be replaced by another one, but not removed), the `tax_withholding`
flags and, when the person is a Monde user, the `email`. The kind of the person
does not change: `person_kind`, when provided, must be the one the person
already is. The `external_id` starts identifying the person, as long as it
does not identify another one; the CPF/CNPJ and the airline code cannot belong
to another person. As in Monde, the stored CPF/CNPJ is checked on every update:
on a person with an invalid document, the update answers 422 on the `cpf_cnpj`
field until it is sent corrected, or null to remove it. When the person is
a Monde user, the `email` cannot be the one of another user either. The `labels`,
`contacts`, `credit_cards`, `cost_centers` and `kandir_law` lists work by
replacement: the list sent becomes the list of the person, an empty or null
list removes every item and leaving the field out keeps the current ones.
Custom fields do not replace: every one sent is written over the current value,
one sent with a null or empty value is cleared (a required one is refused),
and the remaining ones stay. The response returns the updated person in the
same format as the get by ID when the credential also has the "View" permission
on people; without it, the update is written all the same and the response
returns only the `id` of the person. A person that is a company of the system
and the email of a person that is an active Monde user are only changed by
an administrator, as in Monde: the update answers 403 with the reason. Changing
or removing (null) `seller` also requires the "Change seller" permission,
and changing or removing `promoter`, the "Change promoter" one; the one resent
equal to the current one, and a null one on a person without seller or promoter,
ask no permission. Sending `credit_cards` or `kandir_law` with some item,
or empty or null when they remove what the person has, also requires the "View
financial tab" permission on people, and each card operation, its own permission,
as in Monde: adding a card (item without `id`) requires "Register credit card";
changing a card (item with `id` and some field different from the stored one,
or with `number` or `cvv`, which always count as a change; one resent as the
query returns it asks nothing) requires "View credit card data" and "Edit
credit card"; and a list that leaves out a card the person has, removing it,
requires "Remove credit card". A card cited only by its `id` stays as it is
and asks no permission of its own. Without the permission, the answer is 403
with the Monde message, and nothing is changed. In the response, without "View
financial tab", `credit_cards` and `kandir_law` do not come, and without "View
credit card data", `credit_cards` does not come: the field is left out, not
sent as null.'
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: Unique person identifier (UUID).
example: f9d961b8-ea88-4346-8e52-afe94267417a
responses:
'200':
description: Person updated successfully.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response replays a request that was already
processed.
content:
application/json:
schema:
anyOf:
- "$ref": "#/components/schemas/person_detail"
- "$ref": "#/components/schemas/entity_reference"
examples:
person_detail:
summary: Person by ID
"$ref": "#/components/examples/person_detail"
updated_person_reference:
summary: Person updated, without read permission
"$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: Person update
"$ref": "#/components/examples/update_person"
delete:
operationId: deletePerson
summary: Delete a person
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: 'Deletes the person permanently. Only a person without related
records can be deleted — sales (as customer, passenger, intermediary or supplier),
financial entries, invoices, quotes, tasks, commissions, cards, accounts,
attachments (including the ones already removed), among others — and that
is neither a system user nor a system company. In those cases the response
is 409 and nothing is changed. Along with the person, its contacts, labels
and `external_id` are removed, as well as the links in which it appears as
a contact of another person; it also leaves the invoice rules and cost centers
it was part of, stops being the seller or the promoter of other people and
is no longer set on the integrations where it appeared. The deletion is recorded
in the person history. It does not require `Idempotency-Key`: repeating the
request after the deletion responds 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: Unique person identifier (UUID).
example: f9d961b8-ea88-4346-8e52-afe94267417a
responses:
'204':
description: Person deleted successfully. The response has no body.
'401':
"$ref": "#/components/responses/unauthorized"
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'409':
description: 'The person cannot be deleted: it has related records, it has
attachments or it is a system user. Nothing was changed.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- The person cannot be deleted because it has related records,
such as sales, financial entries, invoices or tasks.
- The person cannot be deleted because it has attachments, including
the ones already removed.
- The person is a system user and cannot be deleted through the
API.
example:
errors:
- The person cannot be deleted because it has related records, such
as sales, financial entries, invoices or tasks.
'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: Download person photo
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: Returns the individual's photo (or the company's logo) as an image,
with the `Content-Type` of the stored format. Requires the permission to read
people. This call does not require the `Content-Type` header.
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- name: person_id
in: path
required: true
schema:
type: string
format: uuid
description: Unique person identifier (UUID).
example: f9d961b8-ea88-4346-8e52-afe94267417a
responses:
'200':
description: The image stored in the person's record.
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: The person does not exist, has no photo, or the stored photo
is not an image in a known format.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The requested resource was not found.
'429':
"$ref": "#/components/responses/too_many_requests"
'500':
"$ref": "#/components/responses/internal_server_error"
post:
operationId: uploadPersonPhoto
summary: Upload person photo
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: Stores the individual's photo (or the company's logo), replacing
any existing one. The image goes in the `file` field of a `multipart/form-data`
request and must be a JPEG of up to 150 KB, the same limits as Monde, which
only displays images in that format. Requires the permission to edit people,
in a company that is not read-only. The change is recorded in the person's
history.
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: Unique person identifier (UUID).
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: The image, as JPEG, up to 150 KB.
responses:
'200':
description: 'Resent with the same Idempotency-Key and the same file: returns
the first call''s response without storing again.'
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present with the value `true` when the response repeats
the first call.
content:
application/json:
schema:
anyOf:
- "$ref": "#/components/schemas/person_detail"
- "$ref": "#/components/schemas/entity_reference"
examples:
person_detail:
summary: Person by ID
"$ref": "#/components/examples/person_detail"
'201':
description: Photo stored. Returns the person's record, or only the `id`
to whoever cannot read people.
content:
application/json:
schema:
anyOf:
- "$ref": "#/components/schemas/person_detail"
- "$ref": "#/components/schemas/entity_reference"
examples:
person_detail:
summary: Person by 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: 'A validation error occurred. Check the returned error messages
for more details. An error on a list item carries the item position in
the list sent, counted from 0, at every level: ''insurances[0] passengers[2]
person name'' refers to the third passenger of the first insurance.
A rule checked over the whole list, such as a repeated contact, comes
on the list name, without position. A null or blank item inside a list
([null], [""]) is refused.'
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: Remove person photo
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: Removes the individual's photo (or the company's logo). Requires
the permission to edit people, in a company that is not read-only. The removal
is recorded in the person's history.
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: Unique person identifier (UUID).
example: f9d961b8-ea88-4346-8e52-afe94267417a
responses:
'204':
description: Photo removed.
'401':
"$ref": "#/components/responses/unauthorized"
'403':
"$ref": "#/components/responses/forbidden"
'404':
description: The person does not exist or has no photo.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The requested resource was not found.
'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: Convert an individual into a company, or the reverse
x-badges:
- name: Beta
color: "#f5803e"
tags:
- People
description: 'Converts the person into the kind given in `person_kind`, like
the **Converter para Pessoa Jurídica** / **Converter para Pessoa Física**
action of Monde''s people list. Data that only the original kind has is erased:
converting to a company erases CPF, RG, gender, business phone, passport and
its expiration, RG issuer and issue date, and birthplace; converting to an
individual erases CNPJ, state registration, legal name and website. A system
user cannot become a company, and a system company does not change kind. Requires
the permission to edit people, in a company that is not read-only. The kind
does not change through [Update person](#tag/People/paths/~1people~1{id}/patch),
only here.'
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: Unique person identifier (UUID).
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: 'Target kind: `individual` or `company`. Must differ
from the current kind.'
examples:
convert_to_company:
summary: Convert into a company
value:
person_kind: company
responses:
'200':
description: Person converted. Returns the converted record, or only the
`id` to whoever cannot read people. Resending with the same Idempotency-Key
returns the same response without converting again.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present with the value `true` when the response repeats
the first call.
content:
application/json:
schema:
anyOf:
- "$ref": "#/components/schemas/person_detail"
- "$ref": "#/components/schemas/entity_reference"
examples:
person_detail:
summary: Person by 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: 'A validation error occurred. Check the returned error messages
for more details. An error on a list item carries the item position in
the list sent, counted from 0, at every level: ''insurances[0] passengers[2]
person name'' refers to the third passenger of the first insurance.
A rule checked over the whole list, such as a repeated contact, comes
on the list name, without position. A null or blank item inside a list
([null], [""]) is refused.'
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: List labels
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Labels
description: Returns the list of labels registered in the system.
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: Create label
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Labels
description: Creates a label. The name is required, has up to 38 characters
and cannot repeat the name of another label. Requires the "Edit" permission
on labels.
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- "$ref": "#/components/parameters/content_type_json"
- "$ref": "#/components/parameters/idempotency_key_header"
responses:
'200':
description: 'Request repeated with the same `Idempotency-Key`: returns
the response of the original creation, without creating another label.'
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response is the replay of a previous creation.
content:
application/json:
schema:
"$ref": "#/components/schemas/label"
examples:
label:
summary: VIP label
"$ref": "#/components/examples/label"
'201':
description: Label created successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/label"
examples:
label:
summary: VIP label
"$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: Create label
"$ref": "#/components/examples/create_label"
"/labels/{id}":
get:
operationId: getLabel
summary: Get label by ID
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Labels
description: Returns a specific label by its identifier.
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: Unique identifier of the label
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: Update label
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Labels
description: Renames a label. A name omitted stays as it is; sent as null or
as an empty text, it is rejected (422), as a label cannot be left without
a name. The new name follows the same rules as the creation, and the people
that have the label keep it. Requires the "Edit" permission on labels. The
response brings the changed label when the credential also has the "View"
permission on labels; without it, the change is saved all the same and the
response brings only the label `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: Unique identifier of the label
example: f9d961b8-ea88-4346-8e52-afe94267417a
responses:
'200':
description: Label updated successfully.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response is the replay of a previous update.
content:
application/json:
schema:
anyOf:
- "$ref": "#/components/schemas/label"
- "$ref": "#/components/schemas/entity_reference"
examples:
label:
summary: VIP label
"$ref": "#/components/examples/label"
written_label_reference:
summary: Update without read permission
"$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: Rename label
"$ref": "#/components/examples/update_label"
delete:
operationId: deleteLabel
summary: Delete label
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Labels
description: Deletes the label permanently and removes it from every person
that had it, as the deletion in Monde does. The deletion cannot be undone.
Requires the "Delete" permission on labels.
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: Unique identifier of the label
example: f9d961b8-ea88-4346-8e52-afe94267417a
responses:
'204':
description: Label deleted successfully. The response has no body.
'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: List companies
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Companies
description: 'Returns the active companies where the credential has the "Read
all companies" permission, in alphabetical order of the name. A read only
company is in the list, flagged in `read_only`: it is still queried, but it
rejects writes.'
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: Get company by ID
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Companies
description: Returns a specific company by its identifier. Requires the "Read
all companies" permission in the company itself, which must be active. A company
out of that reach answers 403, also when the id does not exist.
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: Unique identifier of the company
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: List accounts payable and receivable
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: Returns the list of accounts payable and receivable of the companies
where the credential has permission. By default, returns only open and overdue
(unsettled, not canceled) bills; to include settled or canceled ones, use
the status parameter. Use the filters to narrow by date (date_field
with date_from/date_to), nature (transaction_kind), kind and status. Each
entry comes summarized; the full detail comes from 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: 'Date field used by the filter. Accepted values: issue_date,
due_date and settlement_date. Required when date_from or date_to is provided.
To filter by settlement_date, include settled in the status parameter, since
the default (open, overdue) excludes settled bills.'
example: due_date
- in: query
name: date_from
required: false
schema:
type: string
format: date
description: Filter bills whose field chosen in date_field is on or after
this date, in ISO 8601 format (YYYY-MM-DD).
example: '2024-01-01'
- in: query
name: date_to
required: false
schema:
type: string
format: date
description: Filter bills whose field chosen in date_field is on or before
this date, in ISO 8601 format (YYYY-MM-DD).
example: '2024-12-31'
- in: query
name: transaction_kind
required: false
schema:
type: string
enum:
- credit
- debit
description: 'Filters by the nature of the entry: credit (accounts
receivable) or debit (accounts payable). When absent, returns
both.'
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: 'Origin of the entry. normal: standalone
entry.sale_payment: sale payment.sale_standalone:
sale standalone.vendor_standalone: vendor standalone.vendor_invoice:
vendor invoice.customer_invoice: customer invoice.credit_card_invoice:
credit card invoice.commission: commission.open: unsettled, not canceled, due today or in the
future, or with no due date.overdue: unsettled, not
canceled, due before today.settled: settled and not
canceled.canceled: canceled, whether or not it was
settled.open
and overdue bills; settled and canceled bills are returned
only when explicitly requested.'
example:
- open
- overdue
- in: query
name: recurrence_group_id
required: false
schema:
type: string
format: uuid
description: Filters by the entries of an installment or recurrence series,
by the recurrence_group_id of any of them, such as the one
returned on creation. Combine with status to include the settled
ones.
example: 5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f
- in: query
name: number
required: false
schema:
type: string
description: Filters by the bill number shown in the app (one per request).
Installment bills carry a parcel suffix (e.g., 362-1), so provide
the number exactly as shown.
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: Create account payable or receivable
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Creates an open or already settled financial entry, with the same
rules as Monde''s manual entry. transaction_kind sets whether
it is an account receivable (credit) or payable (debit),
and any category is accepted.categories is the final amount (final_amount):
a category of the same kind as the entry adds, one of the opposite kind is
deducted (the kind comes in kind, in List
categories). If the final amount differs from amount, the
difference is a surcharge or discount, subject to the company''s surcharge
and discount lock. The final amount cannot be negative, and the same category
cannot repeat with the same description.apportionments.per_cost_center)
may total between 0 and 100% of the final amount; the split between companies
(apportionments.per_company), when sent, must total exactly 100%
and only accepts companies where the credential can also create entries. For
tour operators, apportionments and own operation are rejected.settlement_date with
the movements, one per account the money entered or left. It
also requires the "Settle account payable" or "Settle account receivable"
permission, according to the entry, as in Monde; without it, the answer is
403. When the movements do not add up to the final amount, say what to do
with the difference in balance_resolution, as in the settlement:
with category, it goes to a category, as a discount (paid less)
or surcharge (paid more), and the final amount becomes what was paid. The
category comes in balance_category_id; without it, the company''s
default category for that case applies (discount given or received, surcharge
charged or paid), and without a default the request is rejected. The category
must be of the kind that brings the final amount to what was paid. Without
balance_resolution, the movements must add up exactly to the
final amount; a payment with interest or discount can also be sent by adjusting
the categories. With partial, the partial payment, when less
than the final amount was paid: the entry is settled with what was paid and
gets the " 1/2" suffix in the description, and the balance becomes a new open
entry, with the " 2/2" suffix and the same categories in the balance''s proportion.
As in Monde, both keep the same number in parts: entry 71 becomes
71-1 and the balance 71-2. An installment that already
has a part in its number (72-2) keeps it, and the balance takes
the next free part. With no balance, the partial payment generates nothing;
an overpayment is rejected. partial_payment: true is still accepted
and is the same as balance_resolution: partial; sent together,
both must say the same, and a partial_payment that contradicts
balance_resolution is rejected with 422. The settlement date
cannot be later than the last movement date, and the issue date cannot be
later than the settlement. Each movement uses an active account linked to
the company, and the payment method follows the account kind: cash and check
accounts accept cash or check, a credit card account accepts only credit card,
and a checking account accepts the others. A check requires its number. Installments
(installments) only in a credit card account. On accounts receivable
the movement date lock applies, and a closed cash day rejects the movement
with the reason (in Portuguese), such as O caixa do dia "10/10/2026"
da conta "Caixa" está fechado.card_rate, as in Monde: amount
is what the customer paid, and the account receives amount less
the fee. The sum of the fees becomes the card fee category configured in the
company, which lowers the final amount; if that category is already in categories,
the fee goes into it, and its amount becomes the sum of the fees. Without
the category configured, the fee is rejected with 422, as is a fee on another
payment method, on an account payable or outside a checking account, and a
fee equal to or greater than amount. Example: an account receivable
of R$ 420.00 with a R$ 20.00 fee: the movement has amount 420
and card_rate 20, the account receives R$ 400.00 and the final
amount becomes R$ 400.00.recurrence_kind
with the periodicity. In installments (installment),
installments is the total number of installments, from 2 to 200,
and each installment repeats the entry''s full amount: R$ 1,500.00 in 3 installments
creates 3 entries of R$ 1,500.00. Installments fall due one per period from
due_date, get the " 1/3" suffix in the description and -1
in the number; the description has up to 50 characters precisely so that suffix
fits. The recurrence (recurrent) creates the entries for the
next 5 years with the same amount and description, and Monde keeps creating
the following ones. The fortnight (biweekly) is 15 days. The
series is generated in the background, as in Monde: the response brings the
first entry with recurrence_group_id already filled in, and the
others show up shortly after in List
accounts payable and receivable with the recurrence_group_id
filter. Until the series is generated, the entry read by ID shows no recurrence_group_id,
and recurrence_status tells whether it is still pending or the
last attempt failed. The installment suffixes go into the description and
number of every entry when the series is generated, the first one included.
A partial payment and balance_resolution cannot be combined with
installments or recurrence: the installments copy the first entry''s categories,
and the difference category belongs only to its settlement.issue_date,
the issue date is the earliest of today, the due date and the settlement date;
when sent, it cannot be later than the due date. Without account_id,
the entry gets the company''s default forecast account; a sale entry is left
without a forecast account, as in Monde. The entry is always in BRL. Fields
outside the contract are ignored.categories, movements, custom_fields
and the apportionments) carries the item position in the list sent, counted
from 0: ''movements[1] account_id'' refers to the second movement.
Each item in error gets its own message. A rule checked over the whole list,
such as the movements total or a repeated category, comes on the list name,
without position. A format error on an item field also carries the position:
check sent as text instead of an object answers The ''movements[0]
check'' field must be a list or an object….sale_id, by the id from GET
/sales. The entry is created as a sale standalone entry (kind
equal to sale_standalone), linked to the sale and in its company,
and it shows up in financial.standalone_bills of Get
sale by ID. Only the company comes from the sale: person, categories,
amounts and the other fields come from the payload, as in any entry. company_identifier
may be omitted; when sent, it must be the CNPJ of the sale company. A closed
sale accepts the entry, and a deleted one answers 409. A sale entry has no
own operation, installments or recurrence: operation_id and recurrence_kind
are rejected with 422. It can be created already settled, like the others.
It requires, in the sale company, the permissions to create accounts payable
and receivable described below and the "View financial tab" permission on
sales; the permission to edit the sale is not required, since the sale does
not change. The sale must be among those the credential reads: one out of
reach answers 422 on sale_id, like one that does not exist. Since
the Financial tab only shows with the sale open, a sale from another seller
also requires "Open sales of other sellers", and without it the answer is
403; through an automatic connection authorized before the "of others" permissions,
only a sale created by the connection itself.generated_bills the partial payment''s
balance, which is created in the same call: if it is rejected, nothing is
saved. Installments and recurrences do not come in generated_bills:
they are fetched by recurrence_group_id. Following the series,
by the read by ID or by the list, requires the permission to read accounts
payable and receivable.'
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- "$ref": "#/components/parameters/content_type_json"
- "$ref": "#/components/parameters/idempotency_key_header"
responses:
'200':
description: 'Request repeated with the same Idempotency-Key:
returns the original creation response, without creating another entry.'
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response is the replay of a previous creation.
content:
application/json:
schema:
"$ref": "#/components/schemas/bill_created"
examples:
receivable_bill:
summary: Account receivable (customer invoice)
"$ref": "#/components/examples/receivable_bill_single"
'201':
description: Account payable or receivable created successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/bill_created"
examples:
receivable_bill:
summary: Account receivable (customer invoice)
"$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: Full account payable
"$ref": "#/components/examples/create_bill"
create_required_fields_bill:
summary: Account receivable with only the required fields
"$ref": "#/components/examples/create_required_fields_bill"
create_sale_bill:
summary: Account payable of a sale
"$ref": "#/components/examples/create_sale_bill"
create_settled_bill:
summary: Account payable already settled
"$ref": "#/components/examples/create_settled_bill"
create_settled_bill_with_fine:
summary: Account payable settled with a late fee
"$ref": "#/components/examples/create_settled_bill_with_fine"
create_partial_settled_bill:
summary: Account payable with a partial payment
"$ref": "#/components/examples/create_partial_settled_bill"
create_installment_bill:
summary: Account payable in installments
"$ref": "#/components/examples/create_installment_bill"
create_recurrent_bill:
summary: Recurring account payable
"$ref": "#/components/examples/create_recurrent_bill"
"/bills/{id}":
get:
operationId: getBill
summary: Get account payable or receivable by ID
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Returns the full detail of an account payable or receivable: billet,
categories, apportionment across companies, cost center apportionment, settlement
movements, items, credit card invoice charges, commissions, attachments and
custom fields.'
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: Unique identifier of the account payable or receivable.
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: Update account payable or receivable
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Updates a financial entry, open or settled, with the same rules
as the manual entry in Monde. Send only the fields that must change: an omitted
field stays as it is. document, observations and
operation_id are cleared when sent as null; person_id,
description, issue_date, due_date,
account_id and amount are required on the entry,
and sending them null or empty is refused, as is a null or empty company_identifier.
A list sent as null counts as the empty list: a null categories
is refused like the empty list, and a null apportionments empties
both apportionments (a null per_cost_center or per_company
empties only that one). Custom fields are not replaced: each one sent is written
over the current one, one sent with a null or empty value is
cleared, and the others stay; required ones do not have to be sent again,
but cannot be cleared. Empty text is saved as sent; on a required field, and
on a field that is not text, it is refused (422).transaction_kind) does not change:
when sent, it is ignored like any field outside the contract.kind). A deleted entry and an invalid
invoice answer 409.sale_payment,
or with a linked sale): person, company and amount do not change. On sale_standalone,
only the company.customer_invoice,
vendor_invoice, vendor_standalone): person, company
and original amount do not change; the amount comes from the items.credit_card_invoice): due date, company and
amount do not change, and it has no categories. The apportionments split its
final amount, the sum of the card purchases.commission):
like the standalone entry, but without the own operation.category_id. The own operation is accepted only on a
standalone entry (normal) without an invoice number, as in Monde.settlement_date changes the settlement date,
which cannot be empty or later than the date of the last movement. Changing
the settlement date to one different from the stored one also requires the
"Settle account payable" or "Settle account receivable" permission, depending
on the nature of the entry, as in Monde; without it, the answer is 403 with
the Monde message. The same date sent again asks no permission. Each item
of movements with an id points to a movement the
entry already has, and changes only the account, payment method, date, amount,
card fee, check or card sent. An item without id is a new movement,
like Monde''s Adicionar, and comes with the account, payment method, date
and amount. The movements not sent stay as they are, and movements cannot
be removed. The movement ids come in movements of Get
account payable or receivable by ID. The movements must add up exactly
to the final amount: changing the amount requires the movement along with
it. On a movement with a card fee (card_rate), the amount is
what the customer paid, and the account receives the amount less the fee:
changing only the fee keeps what the customer paid and changes what went into
the account, as in Monde, and the card fee category follows, as do the agency
card fee of the sale products and the sale revenue. The payment method of
a movement with a system-generated fee cannot change to one that is not a
card. An account receivable can move to a credit card account, with the credit
card payment method: it is the refund, which goes into the card invoice. The
company of a settled entry does not change. The closed cash day and, in accounts
receivable, the movement date block apply as in Monde. On an open entry, a
date in settlement_date or a movement in movements
is refused: this operation does not settle.undo_bank_reconciliation as true.
With the confirmation, the change is written, and the reconciliation of that
movement will have to be redone. A change that does not touch the reconciled
movements, such as one to the categories, the apportionments or the description,
keeps the reconciliation and is written without the confirmation.categories sent replace those of the
entry, and their signed sum is the final amount, as in the creation: the difference
from amount is a surcharge or discount, subject to the company''s
surcharge and discount block. The list cannot be empty. An amount
sent without categories follows the Monde rule: with a single
category, it follows the new amount; with more than one, the new amount must
equal their sum, otherwise it is refused and the categories must be sent along.apportionments.per_cost_center can
be between 0 and 100% of the final amount, and apportionments.per_company,
when sent, must add up to exactly 100% and only accepts companies where the
credential can also create entries. An empty list removes the apportionment.company_identifier moves the entry to another company, and requires
the "Edit" permission on accounts payable and receivable there too, and that
company cannot be read-only. An entry of another user also requires, in the
target company, access to the entries of other users (whole or the entry''s
slice); without it, the answer is 403 with the Monde message. Without account_id,
the forecast account stays the same if the new company also has it; otherwise,
the default forecast account of the new company applies. As in Monde, an entry
with a registered or issued billet does not change company.recurrence_scope is this_and_following:
then it also applies to the following entries of the series, as the "Update
this and following" option in Monde. The following entries are updated in
the background, right after the response. Settlement, number, document and
billet data are never taken to them; their due date follows the periodicity
of the series from the changed entry, and in a recurrence the issue date does
too. Each following entry is only changed when the credential could change
it directly, with the rules at the end of this description: the "Edit" permission
in its company, which cannot be read-only; on an entry of another user, access
to the other users'' entries (whole or in the entry''s slice); and, on a settled
one, "Edit settled entry". A following entry that does not meet this stays
as it is, without stopping the others. A deleted following entry also stays
as it is. On an entry outside a series, this_and_following is
refused.id. This also applies to the entry the credential itself
created.'
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: Unique identifier of the account payable or receivable.
example: 212b54b8-27df-4859-80a9-79ad855bcd09
responses:
'200':
description: Account payable or receivable updated successfully.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response is the replay of a previous update.
content:
application/json:
schema:
anyOf:
- "$ref": "#/components/schemas/bill"
- "$ref": "#/components/schemas/entity_reference"
examples:
receivable_bill:
summary: Account receivable (customer invoice)
"$ref": "#/components/examples/receivable_bill_single"
written_bill_reference:
summary: Entry written, without read permission
"$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: 'Conflicting request: a request with the same idempotency key
is already being processed, or the entry cannot be changed: it is deleted,
an invalid invoice, or the change undoes the bank reconciliation of a
movement and the request did not bring undo_bank_reconciliation
as true.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- A request with this idempotency key is already being processed.
Please wait for it to complete before retrying.
- The financial entry is deleted and cannot be changed.
- An invalid invoice cannot be changed.
- 'This financial entry is in the bank reconciliation, and the
change alters the amount, date or account of a reconciled movement:
its reconciliation will be undone and will have to be redone.
To save it anyway, send ''undo_bank_reconciliation'' as true.'
- 'The client invoice is open, and the billing account only applies
to a closed invoice: the bank slip charges what it holds. To
close the invoice along, send ''close_invoice'' as true.'
example:
errors:
- 'This financial entry is in the bank reconciliation, and the change
alters the amount, date or account of a reconciled movement: its
reconciliation will be undone and will have to be redone. To save
it anyway, send ''undo_bank_reconciliation'' as 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: Change of description, document, due date and observations
"$ref": "#/components/examples/update_bill"
update_bill_values:
summary: Change of amount, categories and cost center apportionment
"$ref": "#/components/examples/update_bill_values"
update_settled_bill:
summary: Change of the amount of a settled and reconciled entry
"$ref": "#/components/examples/update_settled_bill"
delete:
operationId: deleteBill
summary: Delete account payable or receivable
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: |-
Deletes the entry as Monde does: it is not erased, it is marked as deleted (canceled equal to true). It no longer shows up in List accounts payable and receivable, unless the status parameter asks for the canceled ones, and stays available in the query by ID, with the categories, apportionments and attachments it had.
Which entries. The standalone entry (normal) and the client and vendor invoice (customer_invoice, vendor_invoice, vendor_standalone). On an invoice, its items leave it: client items are invoiced again by the invoicing rules, vendor items wait to be invoiced (and are invoiced again when the agency invoices vendors automatically), and the CVC statement items entered straight on the invoice and the items of a canceled sale are erased. The invoice is marked as deleted, even with no items. These answer 409, with the reason:
sale_payment, sale_standalone or with a linked sale): it leaves through the sale deletion;credit_card_invoice), which leaves on its own when it has no entries;commission);No confirmation. This is the deletion without confirmation: the DELETE has no body, and a body sent is ignored. So a settled entry and an entry with a reconciled movement answer 409, and a recurrence_scope answers 422: on an entry of a series, the DELETE deletes only that entry. When the 409 refusal asks for a confirmation, or to also delete the following entries of the series, use Delete account payable or receivable with confirmation, which has the same rules and carries the confirmations in the body.
The deletion is recorded in the entry log, on behalf of the credential.
It requires the "Delete" permission on accounts payable and receivable on the entry's company, which cannot be read-only; the "Edit" permission is not enough. Permissions are checked before anything else: without "Edit settled entry", a settled entry answers 403, even one that would also be refused with 409, such as an entry generated by a sale. The credential deletes the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message. It does not require Idempotency-Key: repeating the request after the deletion answers 409.
Deletes the entry with the answers to the questions Monde asks before deleting: remove the settlement, undo the bank reconciliation and also delete the following entries of the series. It is the same deletion as Delete account payable or receivable, with the same rules, permissions and responses. The difference is that the confirmations go in the body of this POST, not in the DELETE: the body of a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may drop it along the way.
The entry is not
erased: it is marked as deleted (canceled equal to true),
as in Monde. The entries accepted and the 409 refusals are those of the DELETE.
Settled entry. Deleting removes the settlement, and the movements
leave the accounts, like the Monde question "This account is already settled.
Remove the settlement and delete?". A request without remove_settlement
equal to true answers 409. It also requires the "Edit settled
entry" permission on accounts payable and receivable. A closed cash register
on the date of a movement, and a card movement of a credit card invoice already
settled, prevent the deletion: the response is 422 with the reason.
Bank
reconciliation. An entry with a reconciled movement answers 409, with
the Monde warning, until the request carries undo_bank_reconciliation
equal to true. With the confirmation, the reconciliation is undone
and will have to be redone.
Installments and recurrence. On
an entry of a series, the deletion applies only to it, unless recurrence_scope
is this_and_following, like the "Delete this and following" option
in Monde: the following entries of the series with no movement are erased,
in the background, right after the response, and the series stops repeating.
Each following entry is only erased when the credential could delete it directly:
with the "Delete" permission on accounts payable and receivable in its company,
which cannot be read-only; on an entry of another user, access to the other
users'' entries (whole or in the entry''s slice); and, on a settled one, "Edit
settled entry". A following entry that does not meet this stays, out of the
series. The erased ones do not come back. On an entry outside a series, this_and_following
is refused.
The body only carries these confirmations, and an omitted field counts as not confirmed. A value out of format answers 422, before the 409 refusals. The deletion is recorded in the entry log, on behalf of the credential.
It requires the "Delete" permission on accounts payable and receivable on the entry''s company, which cannot be read-only; the "Edit" permission is not enough. Permissions are checked before anything else: without "Edit settled entry", a settled entry answers 403. The credential deletes the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message.
It requires Idempotency-Key:
without it, the response is 400. A resend with the same key returns the response
of the first deletion, 204 with the X-Idempotent-Replay:
true header, without deleting again.
only_this
(default) deletes only this one; this_and_following
also deletes the following entries of the series that have no
movement and that the credential could delete directly.'
remove_settlement:
type: boolean
description: Confirms the deletion of a settled entry, which removes
its settlement and movements. Required as true on
a settled entry.
undo_bank_reconciliation:
type: boolean
description: Confirms that the entry's bank reconciliation will
be undone. Required as true on an entry with a reconciled
movement.
example:
remove_settlement: true
responses:
'204':
description: Entry deleted successfully. The response has no body.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response is the repetition of a previous
deletion.
'400':
"$ref": "#/components/responses/bad_request"
'401':
"$ref": "#/components/responses/unauthorized"
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'409':
description: 'Conflicting request: a request with the same idempotency key
is already being processed, or the entry cannot be deleted, or the confirmation
to remove the settlement or to undo the reconciliation is missing. The
message says why. Nothing was changed.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- A request with this idempotency key is already being processed.
Please wait for it to complete before retrying.
- 'The financial entry is settled: deleting it removes the settlement,
and its movements leave the accounts. To delete it anyway, use
POST /bills/{id}/removal with ''remove_settlement'' as true.'
- 'This financial entry is in the bank reconciliation: deleting
it undoes its reconciliation, which will have to be redone.
To delete it anyway, use POST /bills/{id}/removal with ''undo_bank_reconciliation''
as true.'
example:
errors:
- 'The financial entry is settled: deleting it removes the settlement,
and its movements leave the accounts. To delete it anyway, use POST
/bills/{id}/removal with ''remove_settlement'' as 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: Settle account payable or receivable
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: |-
Settles an open financial entry, with the settlement rules of Monde. Send the settlement date (settlement_date) and the movements (movements), one per account the money came into or left, with the account, payment method, date and amount, as in the creation already settled. Each movement uses an active account linked to the entry's company, and the payment method follows the account type: cash and check accounts accept cash or check, a credit card account accepts only credit card, and a checking account accepts the others. A check requires its number. Installments (installments) only on a credit card account. The settlement date cannot be later than the date of the last movement, and the issue date cannot be later than the settlement date.
Card fee and refund. On an account receivable paid by credit or debit card into a checking account, card_rate is the card operator fee: the account receives amount less the fee, and the sum of the fees becomes the company's card fee category, which lowers the final amount, as in the settled creation. An account receivable settled in a credit card account, with the credit card payment method, is the refund, which goes into the card invoice.
Amount paid different from the final amount. When the movements do not add up to the final amount, say what to do with the difference in balance_resolution, as Monde asks when settling:
category: the difference goes to a category, as a discount (paid less) or surcharge (paid more), and the final amount becomes what was paid. The category comes in balance_category_id; without it, the company's default category for that case applies (discount granted or received, surcharge charged or paid), and without a default the request is refused. The category must be of the type that brings the final amount to what was paid: an expense on an account payable paid more, for instance. The company's surcharge and discount block applies.partial: only when less than the final amount was paid. The entry is settled with what was paid and gets the suffix " 1/2" in the description, and the balance becomes a new open entry, with the suffix " 2/2" and the same categories in proportion to the balance. The balance comes in generated_bills.Without balance_resolution, the movements must add up exactly to the final amount. On a credit card invoice, the difference always goes to the next invoice of the same card, with no choice (balance_resolution does not change where it goes): what was left unpaid enters it as debt, and what was overpaid, as a deduction. On a customer invoice generated by Monde and on a supplier invoice other than the CVC one, the API settles only the full amount, and a payment lower or greater than it is refused with 422. On other invoices, the difference is resolved only with category; a partial payment is refused with 422.
Which entries. Every kind, as in Monde: the standalone entry (normal), the sale payment (sale_payment), the sale standalone entry (sale_standalone), the commission (commission), the customer and supplier invoice (customer_invoice, vendor_invoice, vendor_standalone) and the credit card invoice (credit_card_invoice). These answer 409, with the reason: an entry already settled (to change the settlement, use the update), a deleted one and an invalid invoice. An entry in another currency is settled as in Monde: the movement amount is in the currency of the entry and, in an account in another currency, goes in converted by the exchange rate (exchange_rate). A movement in an account outside BRL keeps the reference exchange rate from the account currency into BRL (reference_exchange_rate). As in Monde, both are suggested by the latest rate and can be corrected: when omitted, the registered rates apply (without a registered rate to convert, 422); when sent, the ones from the bank apply.
Sale payment. Each payment made to the agency in a sale (cash, card, billet, check, deposit and others, one entry per installment) is a sale_payment entry, and its id comes in payments.agency.bills of Get sale by ID and of the response of the sale creation and update. Payments to the supplier and agency credit create no entry and are not settled. The settlement uses the payment method and data agreed in the sale, like "Settle using sale data" in Monde: payment_method_id is optional in the movement and, when absent, the sale's method applies; the movement using the sale's method gets the card or check informed in the sale, which card and check replace when sent. The card fee calculated in the sale moves to the first movement, when it is a card one (otherwise, it stays on the entry), without sending card_rate: as in every movement with a fee, the amount is what the customer paid, and the account receives the amount less the fee. The card fee of the settlement is prorated among the sale products, in their agency card fee, and comes off the sale revenue, as in Monde. The balance of a partial payment (balance_resolution as partial) is created linked to the same sale, without the " 1/2" and " 2/2" suffixes in the description: it shows up in payments.agency.bills of the sale. In the partial payment, the payment items stay on the entry up to the amount paid, and the item that goes past it is split: the paid part stays, and the rest goes to the balance, each part with the agency card fee in proportion to its amount. The categories of the balance come from the company's default invoice categories; without them, the settlement is refused with 422 and nothing is written. The payment's person, company and amount do not change.
Monde rules. On accounts receivable, the company's movement date block and surcharge and discount block apply, and for the integration they always apply. A closed cash day refuses the movement with the reason, such as O caixa do dia "14/10/2026" da conta "Caixa" está fechado. The settlement and the movements are recorded in the entry's log, on behalf of the credential.
Responses follow an order: the permission (403), the request format (422), the entry's situation (409) and the settlement and Monde rules (422). The errors of an item of movements bring its position, counted from 0.
Requires the "Edit" permission on accounts payable and receivable in the entry's company, which cannot be read-only: settling is the same right as creating the entry already settled. It also requires the Settle account payable or Settle account receivable permission, according to the nature of the entry; without it, the response is 403 with the Monde message. The credential settles the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message. The response brings the settled entry, the same as Get account payable or receivable by ID, with the partial payment balance in generated_bills, when the credential also has the "View" permission on accounts payable and receivable in the entry's company; without it, the settlement is written all the same and the response brings only the id. This also applies to the entry the credential itself created.
Undoes the settlement of an entry, as removing the settlement in Monde: the settlement date is cleared, the movements leave the accounts and the entry is open again. The card fee and bank fee generated by the settlement go along, except the card fee calculated in the sale, which stays on the sale payment. The agency card fee of the sale products goes back to zero, and the sale revenue no longer deducts it, as in Monde; on a new settlement, the fee is prorated by the amount of each product; the surcharge and discount posted in it stay, and the final amount keeps them. The entry with the balance of a partial payment also stays. A billet pending write-off goes back to registered, and the credit generated by the settlement is reversed. The removal of the movements is recorded in the entry''s log, on behalf of the credential.
Which entries. The same ones the settlement accepts. These answer 409, with the reason: an open entry, a deleted one and an invoice whose balance was taken to another entry (its settlement is not undone while the balance is there). On a credit card invoice, the balance taken to the next invoice of the same card leaves it along; the refusal only comes when that next invoice is already settled.
No confirmation.
This is the undo without confirmation: the DELETE has no body, and a body
sent is ignored. So an entry with a reconciled movement answers 409, and a
recurrence_scope answers 422: on an entry of a series, the DELETE
undoes only its own settlement. When the 409 refusal asks for the confirmation,
or to also undo the settlement of the following entries of the series, use
Undo
the settlement with confirmation, which has the same rules and carries
the confirmations in the body.
A closed cash day on the date of any movement, and a card movement of a credit card invoice already settled, prevent the undo: the response is 422 with the reason.
Requires the "Edit"
and "Edit settled entry" permissions on accounts payable and receivable, in
the entry''s company, which cannot be read-only. Permissions are checked before
anything else: without "Edit settled entry", the response is 403 even for
an entry that is already open. The credential undoes the settlement of the
entry it created itself and, with the access to the entries of other users
(whole or in the slice of the entry), the others. An entry of another user
outside that access answers 404. Through the automatic connection, an entry
from another origin that the partner reads through the exception granted on
approval answers 403 with the Monde message. It does not require an Idempotency-Key:
repeating the request after the undo answers 409.
Undoes the settlement of the entry with the answers to the Monde questions: undo the bank reconciliation and also undo the settlement of the following entries of the series. It is the same undo as Undo the settlement of account payable or receivable, with the same rules, permissions and responses. The difference is that the confirmations go in the body of this POST, not in the DELETE: the body of a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may drop it along the way.
The settlement date is cleared, the movements leave the accounts and the entry is open again, as in the DELETE. The entries accepted and the 409 refusals are also those of the DELETE.
Bank reconciliation. An entry
with a reconciled movement answers 409, with the Monde warning, until the
request brings undo_bank_reconciliation as true.
With the confirmation, the reconciliation is undone and will have to be redone.
A closed cash day on the date of any movement, and a card movement of a credit card invoice already settled, prevent the undo: the response is 422 with the reason. The body only carries the confirmations, and an omitted field counts as not confirmed. A value out of format answers 422, before the refusals with 409.
Installments and recurrence. On an entry of a series,
only its settlement is undone, unless recurrence_scope is this_and_following,
like the "Update this and following" option in Monde: then the settlement
of the following settled entries of the series is undone too. The following
open entries, the deleted ones and the previous ones stay as they are. Each
following entry goes through the same refusals as the entry sent (the balance
taken to another entry, the reconciliation without the undo_bank_reconciliation
confirmation) and requires that the credential could undo its settlement directly.
It is all or nothing: if one of them cannot be reopened, no settlement is
undone, and the response is 409 naming the following entry that blocked it
and why; a closed cash day on the date of a movement of any of them answers
422. On an entry outside a series, this_and_following is refused
with 422.
Requires the "Edit" and "Edit settled entry" permissions on accounts payable and receivable, in the entry''s company, which cannot be read-only. Permissions are checked before anything else: without "Edit settled entry", the response is 403 even for an entry that is already open. The credential undoes the settlement of the entry it created itself and, with the access to the entries of other users (whole or in the slice of the entry), the others. An entry of another user outside that access answers 404. Through the automatic connection, an entry from another origin that the partner reads through the exception granted on approval answers 403 with the Monde message.
It requires Idempotency-Key: without it, the response is 400.
A resend with the same key returns the response of the first request, 204
with the X-Idempotent-Replay: true header, without undoing again.
only_this
(default) undoes only this settlement; this_and_following
also undoes the settlement of the following settled entries of
the series.'
undo_bank_reconciliation:
type: boolean
description: Confirms that the entry's bank reconciliation will
be undone. Required as true on an entry with a reconciled
movement, and it also covers the following entries of the series
with this_and_following.
example:
recurrence_scope: this_and_following
undo_bank_reconciliation: true
responses:
'204':
description: Settlement undone successfully. The response has no body.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response is the repetition of a previous
request.
'400':
"$ref": "#/components/responses/bad_request"
'401':
"$ref": "#/components/responses/unauthorized"
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'409':
description: 'Conflicting request: a request with the same idempotency key
is already being processed, or the settlement cannot be undone, or the
confirmation to undo the reconciliation is missing. The message says why.
Nothing was changed.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- A request with this idempotency key is already being processed.
Please wait for it to complete before retrying.
- The financial entry is not settled.
- The financial entry is deleted and cannot be changed.
- The settlement could not be removed. The balance of this invoice
is linked to another financial entry.
- 'This financial entry is in the bank reconciliation: undoing
the settlement undoes its reconciliation, which will have to
be redone. To undo it anyway, use POST /bills/{id}/settlement/removal
with ''undo_bank_reconciliation'' as true.'
- 'No settlement was undone: the following financial entry 5f0c1a2b-3d4e-4f60-8a9b-0c1d2e3f4a5b,
due on 10/12/2026, cannot be reopened. The credential is not
allowed to undo the settlement of this financial entry.'
example:
errors:
- 'This financial entry is in the bank reconciliation: undoing the
settlement undoes its reconciliation, which will have to be redone.
To undo it anyway, use POST /bills/{id}/settlement/removal with
''undo_bank_reconciliation'' as 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: Settle accounts payable and receivable in batch
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Settles several open entries in one call, like settling the
entries checked in the Monde list. Send the ids in bill_ids,
up to 100, without repeating. Each entry is settled for its whole final amount,
on the same date (settlement_date), in the same account (account_id)
and with the same payment method (payment_method_id) and the
same check (check) or card (card) data. To pay only
part of an entry, or to split the settlement among accounts, use Settle
account payable or receivable.
All or nothing. If one of
the entries cannot be settled, none is, and the message names the one that
refused it, by its number: Não é possível liquidar o lançamento Nº 71.
O lançamento está excluído e não pode ser alterado..
Sale
data. With use_sale_data set to true, each sale
payment is settled with the payment method and the check or card data agreed
in its own sale, like the Monde "Liquidar usando dados da venda". It only
applies when every entry is a sale payment (sale_payment), and
then payment_method_id, check and card
are not accepted. The default is false.
Account, payment
method and card fee. The account must be active and linked to the companies
of every entry, and the payment method follows the account type, as in the
settlement of one entry: cash and check accounts accept cash or check, the
credit card account accepts only credit card, and the checking account accepts
the others. Installments (installments) only in a credit card
account. The card fee is not sent: it comes from the categories of each entry,
as in Monde, and card_rate is refused.
Currency.
The entries must be in the same currency. An account in another currency is
only accepted when Monde works with more than one currency (in an operator
or with multiple currencies), as in the Monde batch settlement; there, exchange_rate
converts the amount of all of them; omitted, the latest exchange rate applies,
and without a registered rate the request is refused with 422.
Which entries. The same ones the settlement of one entry accepts, with the same 409 refusals: the entry already settled, the deleted one and the invalid invoice. The Monde rules apply to each one, such as the issue date later than the settlement, the company locks and the closed cash day, which answer 422 with the reason. The settlement and the movements go to the log of each entry, on behalf of the credential.
The responses follow an order: the entry that does not exist (404, with the ids), the permission (403), the request format (422), the status of each entry (409) and the settlement and Monde rules (422).
Requires, on each entry, the permissions of the settlement
of one entry: "Edit" on accounts payable and receivable in its company,
which cannot be read-only, and Settle accounts payable or Settle
accounts receivable, according to its nature. Missing it on one entry
is enough for the response to be 403 with the Monde message and nothing to
be settled. The reach is also the same: the credential settles the entries
it created and, with access to other users'' entries, the others; one outside
that access answers 404. The response brings in data the settled
entries, each one like Get
account payable or receivable by ID, when the credential has the "View"
permission on accounts payable and receivable in its company; without it,
the settlement is written all the same and only the id comes.
Restores a deleted entry, like Restore in Monde: the deletion is logical, and the entry comes back to the listings as it was before being deleted, with its categories, apportionments and attachments. The settlement that went away with the deletion does not come back: the restored entry is open, and to settle it again use Settle account payable or receivable. A billet left waiting to be cleared at the bank because of the deletion goes back to registered, except on a fintech billing account, where the clearing was already requested from the bank. The restoration is in the entry''s log, on behalf of the credential.
Which
entries. Only the standalone entry (normal), as in Monde.
These answer 409, with the reason: an entry that is not deleted, one generated
by a sale (restored from the sale), the client and supplier invoice, the commission
and the other types. Following entries of a series removed by "delete this
and following" no longer exist and do not come back.
Requires the "Restore"
and "Edit" permissions on accounts payable and receivable, in the entry''s
company, which cannot be read-only. The credential restores the entry it created
itself and, with the access to the entries of other users (whole or in the
slice of the entry), the others. An entry of another user outside that access
answers 404. Through the automatic connection, an entry from another origin
that the partner reads through the exception granted on approval answers 403
with the Monde message. It requires neither Idempotency-Key nor
a body: repeating the request after the restoration answers 409. The response
brings the restored entry, like Get
account payable or receivable by ID, when the credential has the "View"
permission on accounts payable and receivable in its company; without that
permission, only the id. This also applies to the entry the credential
itself created.
Generates the bank slip of the receivable, like Monde''s Imprimir Boleto: a bank slip not issued yet is numbered and issued, with the digitable line and the barcode, and one already issued is returned again, with the same number. A bank slip registered by PJBank is returned with the Pix copy-and-paste code; while it is on its way to the bank, the response is 422, and you have to wait for the registration. For the PDF, use Download the bank slip PDF.
Billing account. The bank slip is issued
by the billing account of the entry, written in billing_account_id
on creation or update. Without one, the only billing account of the company
that issues without registration applies; with more than one, the response
is 422 with their ids, and the chosen one goes in billing_account_id,
as Monde asks. The chosen one is written on the entry.
Foreign currency.
The bank slip is issued in reais. On an entry in another currency, send the
exchange rate of the issue in exchange_rate: without it, the
response is 422, as Monde asks for the exchange rate.
Open client
invoice. The bank slip charges what the invoice holds, and Monde only
issues it with the invoice closed: it asks whether to close the invoice. Through
the API, an open client invoice answers 409 until the request brings close_invoice
as true, which closes the invoice and issues the bank slip, with
the rules and the "Fechar Fatura" permission of Close
a client invoice.
Monde''s refusals answer 422 with its message: a payable, a settled entry and a billing status that does not allow issuing. A deleted entry answers 409.
Requires the "Imprimir boleto" permission of sales in the entry company and, on a bank slip not issued yet, also "Gerar boletos" of payables and receivables, with the company open for writing, as in Monde. The reach is that of the entry query.
' 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: Receivable ID. example: 212b54b8-27df-4859-80a9-79ad855bcd09 requestBody: required: false content: application/json: schema: type: object properties: billing_account_id: type: string format: uuid description: Billing account of the bank slip, by the id inbilling_accounts
of GET /accounts/{id}. Only used when the entry has
no billing account and the company has more than one that issues
without registration.
example: 6b7c2d1e-3f4a-4b5c-8d9e-0f1a2b3c4d5e
exchange_rate:
type: number
format: double
description: 'Exchange rate of the issue, greater than zero, on
an entry in a foreign currency: the bank slip is issued in reais.'
example: 5.4321
close_invoice:
type: boolean
description: Confirms closing the open client invoice, to generate
its bank slip. Without it, an open invoice answers 409.
example: true
examples:
issue_billet:
summary: Generate the bank slip by the billing account of the entry
value: {}
responses:
'200':
description: The generated bank slip, with what the payer needs to pay it.
content:
application/json:
schema:
type: object
properties:
bill:
"$ref": "#/components/schemas/entity_reference"
number:
type: integer
nullable: true
description: Bank slip number.
our_number:
type: string
nullable: true
description: Bank slip our number (nosso número).
digitable_line:
type: string
nullable: true
description: Digitable line of the bank slip.
barcode:
type: string
nullable: true
description: Barcode number of the bank slip.
amount:
type: number
format: double
nullable: true
description: Bank slip amount, in reais.
due_date:
type: string
format: date
nullable: true
description: Bank slip due date.
pix_code:
type: string
nullable: true
description: Pix copy-and-paste code of a bank slip registered
by PJBank; null otherwise.
bank:
type: object
description: 'Bank of the bank slip: the number with the check
digit and the name.'
properties:
code:
type: string
nullable: true
name:
type: string
nullable: true
examples:
issued_billet:
summary: Bank slip issued by 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: The invoice does not accept the action. The message gives the
reason. Nothing was changed.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- The financial entry is deleted and cannot be changed.
- 'The client invoice is open, and the bank slip only comes from
a closed invoice: it charges what the invoice holds. To close
the invoice and generate the bank slip, send ''close_invoice''
as true.'
example:
errors:
- 'The client invoice is open, and the bank slip only comes from a
closed invoice: it charges what the invoice holds. To close the
invoice and generate the bank slip, send ''close_invoice'' as 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: Download the bank slip PDF
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Returns the PDF of the bank slip already generated, the same one Monde sends by e-mail: the payer receipt and the payment slip, with the barcode and, on PJBank, the Pix QR code. On an entry in a foreign currency, the bank slip uses the exchange rate of the last generation.
A bank slip not generated yet answers 409: generate it first with Generate the bank slip of a receivable. A billing status Monde does not print answers 422.
Requires the "Imprimir boleto" permission of sales in the entry company, with the reach of the entry query.
' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - in: path name: id required: true schema: type: string format: uuid description: Receivable ID. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: The bank slip PDF. 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: The invoice does not accept the action. The message gives the reason. Nothing was changed. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - The financial entry is deleted and cannot be changed. - The bank slip has not been generated yet. Generate it first with POST /bills/{id}/billet. example: errors: - The bank slip has not been generated yet. Generate it first with 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: Close a client invoice x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: 'Closes the client invoice, like Monde''s Fechar Fatura: a closed invoice does not accept changes to its items, so it can be sent to the client. The first closing numbers the invoice and stamps the date it was invoiced; an invoice that had never been invoiced gets the closing day as its issue date. Closing again after reopening keeps the number.
Only client invoices are closed. The following answer 409, with the reason: a deleted financial entry, one that is not a client invoice and an invoice already closed. The following answer 422, as in Monde: an issue date before the earliest sale of the items and an item still awaiting deletion.
Requires the "Fechar
Fatura" permission of payables and receivables in the invoice company, which
cannot be read-only. It does not require "Edit": as in Monde, the credential
only has to reach the invoice, with the same reach as the query. The response
brings the closed invoice, or only its id to a credential without
the "View" permission.
Reopens a closed client invoice, like Monde''s Reabrir Fatura, so its items can be changed again. The invoice number stays. If the invoice was already sent to the client, consider making the changes in the next invoice.
The following answer 409, with the reason: a deleted financial entry, one that is not a client invoice and an invoice that is not closed. An item still awaiting deletion prevents reopening, with 422, as in Monde.
Requires
the "Reabrir Fatura" permission of payables and receivables in the invoice
company, which cannot be read-only, with the same reach as Close
a client invoice. It requires neither Idempotency-Key nor
a body: repeating the request after reopening answers 409.
Changes the two columns Monde edits in the invoice items grid.
checked marks or unmarks the item as checked, and applies to
vendor invoices generated by Monde and to separate vendor invoices. cost_center
changes the item cost center, and applies to client invoices generated by
Monde, outside an operator base, which does not show the column. With a legal
person payer, the cost center must be one of those registered on it (the match
ignores case and surrounding spaces, and the item keeps the name as registered),
unless the agency uses free text cost centers; null clears the
cost center. An item that becomes equal to another one of the invoice is added
to it, as in Monde.
Item added to another one. Two items of
an invoice are equal when they have the same sale product, side, kind and
cost center. An item that becomes equal to another one is added to it and
ceases to exist, and its id starts answering 404. It happens
when the cost center changes, where the changed item goes away and the other
one stays, and when the item enters another invoice, where the item that entered
goes away and the one already there stays. A refund is never added. After
each action on the items, the valid ids are those in items
of the response; to find the line again, use sale_product, side,
kind and cost_center. Repeating with the same Idempotency-Key
returns the original response, with the ids of that moment: for
the current ones, read the invoice with Get
payable or receivable by ID.
Which invoices. The actions on the items apply to client invoices, vendor invoices and separate vendor invoices, except the CVC vendor invoice. The following answer 409, with the reason: a deleted financial entry, one that is not such an invoice, a settled invoice, a closed invoice and a field that does not apply to that invoice. Monde asks whether to undo the settlement or reopen the invoice and repeats the operation; through the API, undo the settlement with Undo the settlement of a payable or receivable or reopen the invoice with Reopen a client invoice before repeating.
Requires the "Edit" permission
of payables and receivables in the invoice company, with the same reach as
editing the financial entry. An item that is not on the invoice answers 404.
The response brings the invoice as it ended up, like Get
payable or receivable by ID, or only its id to a credential
without the "View" permission.
id of each item in items
of Get payable or receivable by ID.
example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
checked:
type: boolean
description: Marks the item as checked (true) or not
(false).
example: true
cost_center:
type: string
nullable: true
maxLength: 50
description: Item cost center. null clears the cost
center.
example: Diretoria
examples:
check_item:
summary: Mark the item as checked
value:
checked: true
responses:
'200': &1
description: The invoice as it ended up after the action, or only its id
to a credential that does not read bills.
content:
application/json:
schema:
anyOf:
- "$ref": "#/components/schemas/bill"
- "$ref": "#/components/schemas/entity_reference"
examples:
written_bill_reference:
summary: Entry written, without read permission
"$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: The invoice does not accept the action. The message gives the
reason. Nothing was changed.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- The financial entry is deleted and cannot be changed.
- This financial entry is not an invoice with items. The actions
on the items apply to client invoices, vendor invoices and separate
vendor invoices, except the CVC vendor invoice.
- The invoice is settled. To perform this operation, undo the
settlement first.
- The invoice is closed. To perform this operation, reopen the
invoice first. If the invoice was already sent to the client,
consider making the changes in the next invoice.
- Items are only checked on vendor invoices generated by Monde
and on separate vendor invoices.
- The item cost center only changes on client invoices generated
by Monde.
example:
errors:
- Items are only checked on vendor invoices generated by Monde and
on separate vendor invoices.
'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: Correct the values of an invoice item
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Corrects the values of an item, like Monde''s Corrigir valores.
It applies to client and vendor invoices generated by Monde, on an item linked
to a sale product. value is the new item amount, with its sign,
and the difference goes to the next invoice. On a vendor invoice, the commission,
the over and the card fees (cc_du_fee and cc_rav_fee)
change on the sale product, and the invoice item follows; the commission and
the over take the percentage or the amount, and the other one is calculated
over the product base. On a client invoice, only value. An omitted
field stays as it is. The corrected item keeps the same id; the
difference is a new item on the next invoice, where it may be added to an
equal item.
Changing value requires the invoice to be
open: settled and closed invoices answer 409. The commission, the over and
the fees change even with the invoice closed, and the adjustment goes to another
invoice of the vendor. A card fee above the product fee answers 422, as in
Monde.
Requires the "Edit" and "Alterar taxa CC" permissions of payables and receivables, in the invoice company. When the correction actually changes the commission, over or fees of the product of a closed sale, it also requires "Alterar dados do produto em vendas fechadas" of sales; and, on a sale with a printed receipt, "Alterar vendas com recibo impresso". Without them, the response is 403 with Monde''s message.
' 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: Invoice ID. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: id required: true schema: type: string format: uuid description: Invoice item ID, theid of each item in items
of Get payable or receivable by ID.
example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
value:
type: number
format: double
description: New item amount, with its sign. The difference goes
to the next invoice.
example: -80.0
commission_percentage:
type: number
format: double
description: Commission percentage of the sale product. Vendor invoices
only.
example: 10.0
commission_amount:
type: number
format: double
description: Commission amount of the sale product. Vendor invoices
only.
example: 20.0
over_percentage:
type: number
format: double
description: Over percentage of the sale product. Vendor invoices
only.
example: 0.0
over_amount:
type: number
format: double
description: Over amount of the sale product. Vendor invoices only.
example: 0.0
cc_du_fee:
type: number
format: double
description: CC DU fee of the sale product, which cannot exceed
the DU fee. Airfare vendor invoices only.
example: 0.0
cc_rav_fee:
type: number
format: double
description: CC RAV fee of the sale product, which cannot exceed
the RAV fee. Vendor invoices only.
example: 4.0
examples:
correct_commission:
summary: Correct the commission of the sale product
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: The invoice does not accept the action. The message gives the
reason. Nothing was changed.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- The financial entry is deleted and cannot be changed.
- This financial entry is not an invoice with items. The actions
on the items apply to client invoices, vendor invoices and separate
vendor invoices, except the CVC vendor invoice.
- The invoice is settled. To perform this operation, undo the
settlement first.
- The invoice is closed. To perform this operation, reopen the
invoice first. If the invoice was already sent to the client,
consider making the changes in the next invoice.
- Correcting values only applies to client and vendor invoices
generated by Monde.
- Correcting values only applies to items linked to a sale product.
example:
errors:
- Correcting values only applies to client and vendor invoices generated
by 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: Add items to the invoice
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Brings to the invoice items of another open invoice, like Monde''s
Adicionar itens à fatura. The items that can enter are those Items
that can enter the invoice lists: of the same person, company and currency,
from an invoice that is neither settled nor closed. A client invoice takes
items from another client invoice; a vendor invoice and a separate vendor
invoice, from vendor invoices generated by Monde and separate vendor invoices.
An id that cannot enter refuses the whole call with 422, and nothing is moved.
The invoice the item leaves, if left without items, is deleted. An item that
enters equal to an item of the invoice is added to it: the id
sent ceases to exist, and the response brings the item that was already there,
with the sum. See Item added to another one in Change
the checked status or cost center of an invoice item.
The same invoices and refusals of Change the checked status or cost center of an invoice item apply, as well as the same "Edit" permission. The response brings the invoice as it ended up.
' 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: Invoice ID. 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 of the items the action applies to. examples: item_ids: summary: Items of the action 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: The invoice does not accept the action. The message gives the reason. Nothing was changed. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - The financial entry is deleted and cannot be changed. - This financial entry is not an invoice with items. The actions on the items apply to client invoices, vendor invoices and separate vendor invoices, except the CVC vendor invoice. - The invoice is settled. To perform this operation, undo the settlement first. - The invoice is closed. To perform this operation, reopen the invoice first. If the invoice was already sent to the client, consider making the changes in the next invoice. example: errors: - The invoice is closed. To perform this operation, reopen the invoice first. If the invoice was already sent to the client, consider making the changes in the next invoice. '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: List invoice items x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: 'Lists the items of the invoices and of the accounts payable
and receivable, one per row, with the sale each came from and the entry it
belongs to: the breakdown of each payment. With date_field=settlement_date
and the period, it returns the items of everything settled in the month, without
opening invoice by invoice.
The amount carries the sign
Monde stores, and the items of an entry add up to its amount, negative on
an account payable. On a supplier invoice, what is paid to the supplier comes
negative and what is received from the customer, positive. The sum matches
the entry amount, not the final amount of the settlement.
The items of the same entry come together, from the latest settlement to the earliest, and those of open entries come last. Items of a deleted entry and items not yet in an entry are left out.
Requires the "Visualizar" permission of accounts payable and receivable and reaches the same entries as List accounts payable and receivable.
' 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: 'Entry ID: only its items. It is thebill of the
movement in Get account movement by ID.'
example: 212b54b8-27df-4859-80a9-79ad855bcd09
- in: query
name: account_id
required: false
schema:
type: string
format: uuid
description: 'Account ID of the entry: only the items of its entries.'
example: 6e0216e5-5536-4f4b-8c93-36371398b3cf
- in: query
name: person_id
required: false
schema:
type: string
format: uuid
description: Person ID of the item.
example: 7d2e4f6a-1b3c-4d5e-8f9a-0b1c2d3e4f5a
- in: query
name: side
required: false
schema:
type: string
enum:
- vendor
- customer
description: 'Item side: customer or vendor.'
example: vendor
- in: query
name: date_field
required: false
schema:
type: string
enum:
- settlement_date
- due_date
- issue_date
description: 'Date of the period: settlement_date (entry settlement),
due_date (entry due date) or issue_date (item
issue date). Required with date_from or date_to.'
example: settlement_date
- in: query
name: date_from
required: false
schema:
type: string
format: date
description: Start of the period, inclusive (YYYY-MM-DD).
example: '2026-10-01'
- in: query
name: date_to
required: false
schema:
type: string
format: date
description: End of the period, inclusive (YYYY-MM-DD).
example: '2026-10-31'
- "$ref": "#/components/parameters/cursor"
- "$ref": "#/components/parameters/size"
responses:
'200':
description: The invoice items, with the entry and the sale of each one.
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: Settlement of the entry the item belongs
to, which is the date of the payment it makes up. Null
on an open entry.
pagination:
"$ref": "#/components/schemas/pagination"
examples:
supplier_payment:
summary: Items of a supplier invoice payment
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: Items that can enter the invoice
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: Lists the items Add
items to the invoice accepts, with the invoice each one is on and its
due date, from the oldest due date to the newest. Only the invoices the credential
reaches come in. q searches, as in Monde, the invoice and sale
numbers, the product document, the item description, the vendor, the amount
and the sale and due dates.
Requires the "Edit" permission of payables and receivables in the invoice company. A deleted financial entry and one that is not an invoice with items answer 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: Invoice ID. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: query name: q required: false schema: type: string description: Text to search in the items. example: Hospedagem - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': description: The items that can enter the invoice. 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: Due date of the invoice the item is on now. pagination: "$ref": "#/components/schemas/pagination" examples: item_candidates: summary: Items of another invoice of the same vendor 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: The invoice does not accept the action. The message gives the reason. Nothing was changed. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - The financial entry is deleted and cannot be changed. - This financial entry is not an invoice with items. The actions on the items apply to client invoices, vendor invoices and separate vendor invoices, except the CVC vendor invoice. example: errors: - This financial entry is not an invoice with items. The actions on the items apply to client invoices, vendor invoices and separate vendor invoices, except the CVC vendor invoice. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/item_reprocessing": post: operationId: reprocessBillItems summary: Remove items from the invoice or recalculate the due date x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: 'Sends each item to the invoice its invoicing rule points to, as Monde does in two actions with the same engine. On a client invoice typed by hand it is Remover itens da fatura: the item leaves it and goes to the invoice generated by Monde. On an invoice generated by Monde it is Recalcular vencimento dos itens selecionados: the item changes invoice if the rule changed after invoicing. On other invoices, it answers 409. An id that is not on this invoice refuses the whole call with 422.
The same refusals of Change
the checked status or cost center of an invoice item apply. Requires the
"Edit" permission of payables and receivables, also for recalculating the
due date, which Monde does not require. The response brings the invoice as
it ended up and, in reprocessed_items, where each item sent ended
up: the invoice (bill) and the item on it (item).
The item is the item itself or, when the destination invoice
already had an equal item, the item it was added to; an item the rule keeps
on the invoice comes with the invoice itself. An invoice left without items
is deleted, and the response brings only reprocessed_items.
reprocessed_items.
When all items left and the invoice was deleted, only 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: Where each item sent ended up, one per id
of item_ids.
items:
type: object
properties:
id:
type: string
format: uuid
description: ID of the item sent. It ceases to exist when
the item was added to another one.
bill:
oneOf:
- "$ref": "#/components/schemas/entity_reference"
- type: 'null'
description: Invoice the item ended up on. It comes as
null if another action took the item out
of every invoice at the same time.
item:
allOf:
- "$ref": "#/components/schemas/entity_reference"
description: 'Item of the invoice it ended up on: the
same id sent or, when it was added to an
equal item, the id of that 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: The invoice does not accept the action. The message gives the
reason. Nothing was changed.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- The financial entry is deleted and cannot be changed.
- This financial entry is not an invoice with items. The actions
on the items apply to client invoices, vendor invoices and separate
vendor invoices, except the CVC vendor invoice.
- The invoice is settled. To perform this operation, undo the
settlement first.
- The invoice is closed. To perform this operation, reopen the
invoice first. If the invoice was already sent to the client,
consider making the changes in the next invoice.
- Removing items applies to client invoices typed by hand, and
recalculating the due date, to invoices generated by Monde.
Neither applies to this invoice.
example:
errors:
- Removing items applies to client invoices typed by hand, and recalculating
the due date, to invoices generated by Monde. Neither applies to
this invoice.
'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: Bill the invoice items separately
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Accounts Payable and Receivable
description: 'Takes the items to a new separate invoice, typed by hand, like
Monde''s Faturar Avulso: a separate vendor invoice when the items are vendor
items, and a client invoice when they are client items. The due date is due_date
or, without it, today, as in Monde. An item without amount stays on the invoice;
without any item with amount, the response is 422. An id that is not on this
invoice refuses the whole call with 422. The invoice the items leave, if left
without items, is deleted. The items keep the same id on the
new invoice.
The same invoices and refusals of Change
the checked status or cost center of an invoice item apply, as well as
the same "Edit" permission. The response is 201 with the new invoice, or only
its id to a credential without the "View" permission.
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: Filters the movements of a specific account.
example: f9d961b8-ea88-4346-8e52-afe94267417a
- in: query
name: payment_method_id
required: false
schema:
type: string
format: uuid
description: Filters the movements of a specific payment method.
example: c3b7e8eb-1199-4457-9170-923c3fe56c92
- in: query
name: transaction_kind
required: false
schema:
type: string
enum:
- credit
- debit
description: |-
Filters by the direction of the movement. credit: money coming into the account.debit: money going out of the account.customer: customer refund.vendor: supplier or representative refund.409 when the refund
invoice is settled or closed (reopen it in Monde first) or when the refund
is on an entry that is not an invoice. The customer refund, which in Monde
leaves through the payments grid of the sale, is only deleted on an open sale:
on a closed sale, it answers 409 (reopen the sale in Monde first).
bill on recording) or, with the automatic vendor
invoice off (and on products imported from CVC), the one on any invoice. In
Monde, it leaves by deleting the account, after a confirmation. This DELETE
is the deletion without confirmation: it has no body, and a body sent is ignored.
So that refund answers 409 and nothing changes. To confirm the
deletion of the account, use Delete
refund with confirmation. Idempotency-Key,
because the deletion changes the financial records. As the deleted refund
no longer exists, a resend with the same key after the deletion answers 404,
without deleting anything again.'
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: Refund identifier.
example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42
responses:
'204':
description: Refund deleted successfully.
'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: Delete refund with confirmation
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Refunds
description: 'Deletes the refund with the confirmation Monde asks for before
deleting the account payable/receivable the refund is on. It is the same deletion
as Delete refund,
with the same rules, permissions and responses. The difference is that the
confirmation goes in the body of this POST, not in the DELETE: the body of
a DELETE has no meaning in HTTP (RFC 9110), and proxies and HTTP clients may
drop it along the way. 409
refusals of the DELETE apply here too: a settled or closed invoice, an entry
that is not an invoice and a customer refund on a closed sale. bill on recording) or, with the automatic vendor
invoice off (and on products imported from CVC), the one on any invoice. In
Monde, it leaves by deleting the account, after a confirmation. Here, the
confirmation goes in remove_from_bill: without it as true,
the deletion answers 409 and nothing changes; with it, the
whole account is deleted, as in Monde: the refund leaves, and the
other items of the account are not deleted, they go back to pending, without
an invoice (with the automatic vendor invoice on, they go back to the invoice
of the billing rules). Example: an invoice of R$ 1,200.00 with this refund
of R$ 200.00 and another item of R$ 1,000.00 is deleted; the refund goes away,
and the R$ 1,000.00 item goes back to pending. What prevents deleting the
account in Monde (such as a system invoice that still has items) answers 409,
and nothing changes. remove_from_bill
is, in Monde, deleting the entry: it also requires Edit and
Delete on Accounts Payable and Receivable over that account
and, on another user''s account, the access to the entries of other users;
without them, 403. Idempotency-Key: without
it, the response is 400. As the deleted refund no longer exists,
a resend after the deletion answers 404, without deleting anything
again.'
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: Refund identifier.
example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
remove_from_bill:
type: boolean
description: 'Confirms the deletion of a vendor refund that has
already become an account payable/receivable: the whole account
is deleted, and its other items go back to pending, without an
invoice. Required as true in that case; otherwise
it changes nothing. A value that is not a boolean answers 422.'
example:
remove_from_bill: true
responses:
'204':
description: Refund deleted successfully.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Present when the response is the repetition of a previous
deletion.
'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: Record a refund on the sale
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Refunds
description: |-
Records the refund of a sale product, like the Customer Refund and Vendor Refund actions of the product in Monde. The refund goes into the product refund and, through it, into the sale revenue. customer: the agency gives the amount back to the customer. The refund is recorded as negative, on behalf of person_id (the sale payer, when omitted), in the product sale currency and due on the day.vendor: the vendor gives the amount back to the agency (credit, the default) or the agency pays the vendor (debit), on behalf of the product representative or, without one, the vendor, in the product sale currency (on an operator base, in the origin currency).billing, invoice sends the refund to the invoice by the billing rules, in the background: the customer invoice always; the vendor invoice only with the automatic vendor invoice on, and outside CVC products. Until then, bill comes back null. bill generates right away a separate invoice with the refund alone, due on the day, which comes back in bill. 409), and the product cannot be deleted. The customer refund exists only for agencies: on an operator base, it answers 403. Refused with 422: a refund with credit control on, a vendor refund of an own operation and a refund without the default refund category set on the company. 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: Identifier of the sale of the refunded product.
example: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63
responses:
'200':
description: 'Refund already recorded with the same idempotency key: the
original response is returned.'
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Indicates that the response is the replay of an already
processed request.
content:
application/json:
schema:
"$ref": "#/components/schemas/refund"
examples:
customer_refund:
summary: Customer refund
"$ref": "#/components/examples/customer_refund"
'201':
description: Refund recorded successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/refund"
examples:
customer_refund:
summary: Customer refund
"$ref": "#/components/examples/customer_refund"
vendor_refund:
summary: Supplier refund
"$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: Customer refund to invoice
"$ref": "#/components/examples/create_customer_refund"
create_vendor_refund:
summary: Vendor refund with account payable
"$ref": "#/components/examples/create_vendor_refund"
"/reports/passenger_lists":
get:
operationId: listPassengerList
summary: Get passenger list
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Reports
description: |-
The passengers of the products sold, as the Passenger List report in Monde: one row per passenger of each product, with their contact data, documents and address, the air segments with the seat, the product details and amounts, and the people of the sale. It is the same query as the report, so the API and the screen bring the same passengers. It requires the **Lista de Passageiros** permission of the **Lista de Passageiros** resource, as in Monde. Without the **Consultar passageiros de outros vendedores/intermediários** permission, only the passengers of the sales the integration itself created come. Through the automatic connection, that permission is an exception granted by Monde on approval.
The passengers come in departure order and, on the same day, by passenger. Deleted products are left out and, without `include_canceled`, so are the canceled passengers. A company without the permission in the credential or without a license does not come. As in Monde, the approver and the own operation only come for an agency, and the promoter only for an operator: the field that does not belong to the agency type is not in the response. As it brings the passengers' contact data and documents, each page fetched is recorded in the History as an export of the Passenger List.
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: 'Date that `date_from` and `date_to` filter: `departure_date`
(departure or start of the product), `arrival_date` (arrival or end of the
product), `sale_date` (date of the sale) or `canceled_at` (cancellation
of the passenger). Required when `date_from` or `date_to` is provided.'
example: departure_date
- in: query
name: date_from
required: false
schema:
type: string
format: date
description: First day of the period (ISO 8601, `YYYY-MM-DD`), inclusive.
example: '2026-11-01'
- in: query
name: date_to
required: false
schema:
type: string
format: date
description: Last day of the period (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: 'Sale statuses, comma-separated: `opened`, `closed` and `canceled`.
Default: `opened,closed`, as in Monde.'
example:
- opened
- closed
- in: query
name: include_canceled
required: false
schema:
type: boolean
description: 'With `true`, includes the passengers canceled in the product.
Default: `false`. Filtering by the cancellation date (`date_field=canceled_at`)
already includes them.'
example: false
- in: query
name: person_id
required: false
schema:
type: string
format: uuid
description: Only the passenger of this person.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: payer_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this payer.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: seller_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this seller. Together with `intermediary_id`,
the sales where the person is the seller **or** the intermediary come, as
in Monde.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: intermediary_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this intermediary. Together with `seller_id`,
the sales where the person is the seller **or** the intermediary come, as
in Monde.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: requester_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this requester.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: approver_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this approver.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: promoter_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this promoter.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: product_id
required: false
schema:
type: string
format: uuid
description: Only the products of this registered product, including the sales
where it is the own operation, as in Monde.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: supplier_id
required: false
schema:
type: string
format: uuid
description: Only the products of this supplier.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: representative_id
required: false
schema:
type: string
format: uuid
description: Only the products of this representative.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: city_id
required: false
schema:
type: string
format: uuid
description: Only the passengers who live in this city, the one in the person's
registration.
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: Only the sales of these companies, comma-separated.
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: Only the passengers with any of these labels, comma-separated.
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: Get sales by product
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Reports
description: |-
The products sold, as the Vendas por Produto report in Monde: one row per product, with the people of the sale, the product details and amounts, the passengers, the invoices and the air segments. It is the same query as the report, so the API and the screen bring the same products. It requires the **Vendas por Produto** permission of the **Vendas por Produto** resource, as in Monde. Without the **Consultar vendas de outros vendedores/intermediários** permission, only the products of the sales the integration itself created come. Through the automatic connection, that permission is an exception granted by Monde on approval. Without the **Visualizar comissão, over e receitas** permission, the `commission` object does not come.
The products come from the most recent sale to the oldest and, on the same date, by sale number. Deleted products are left out. A company without the permission in the credential or without a license does not come. As in Monde, with more than one currency (on an operator, or on an agency with multicurrency) the deductions, Additional 1, the invoices and the over base do not come, and the promoter only comes in that case. The External Number and the Additionals without a title in the Settings do not come either. As it brings the payer's contact data and document, each page fetched is recorded in the History as an export of 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: 'Date that `date_from` and `date_to` filter, as the "Data de"
of Monde: `sale_date` (sale date), `departure_date` (product start), `arrival_date`
(product end) or `canceled_at` (product cancellation). Required when `date_from`
or `date_to` is sent.'
example: sale_date
- in: query
name: date_from
required: false
schema:
type: string
format: date
description: First day of the period (ISO 8601, `YYYY-MM-DD`), inclusive.
example: '2026-10-01'
- in: query
name: date_to
required: false
schema:
type: string
format: date
description: Last day of the period (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: 'Sale statuses, comma-separated: `opened`, `closed` and `canceled`.
Default: `opened,closed`, as in 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: 'Product statuses, comma-separated: `active` and `canceled`.
Default: `active`, as in Monde. With `date_field=canceled_at`, both come,
whatever value is sent.'
example:
- active
- in: query
name: seller_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this seller.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: product_id
required: false
schema:
type: string
format: uuid
description: Only the products sold of this registered product.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: supplier_representative_id
required: false
schema:
type: string
format: uuid
description: Only the products where this person is the supplier **or** the
representative, as the Fornecedor/Representante filter of Monde.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
- in: query
name: own_operation_id
required: false
schema:
type: string
format: uuid
description: Only the sales of this own operation.
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: Only the sales of these companies, comma-separated.
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: Get sales by seller
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Reports
description: |-
The sale amounts summed by seller, as the Vendas por Vendedor report of Monde: one row per seller and company, with the number of sales and products and every amount column of the report. It is the same query as the report, so the API and the screen sum the same products. A seller who sells in more than one company comes in one row per company. It requires the **Vendas por Vendedor** permission of the **Vendas por Vendedor** resource, as in Monde, and does not exist on an operadora. Without the **Consultar vendas de outros vendedores/intermediários** permission, the sum brings only the sales the integration itself created. Through the automatic connection, that permission is an exception granted by Monde on approval.
The rows come in alphabetical order of the seller. Canceled sales and deleted products are left out. A company without the permission on the credential or without a license is not included. The sale period is required, in `date_from` and `date_to`: to sum several years, fetch one period at a time. Each page fetched is recorded in the History as an export of 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: Date that `date_from` and `date_to` filter. The report has only
one, the sale date (`sale_date`), so the parameter may be omitted.
example: sale_date
- in: query
name: date_from
required: true
schema:
type: string
format: date
description: First day of the sale period (ISO 8601, `YYYY-MM-DD`), inclusive.
Required.
example: '2026-10-01'
- in: query
name: date_to
required: true
schema:
type: string
format: date
description: Last day of the sale period (ISO 8601, `YYYY-MM-DD`), inclusive.
Required.
example: '2026-10-31'
- in: query
name: status
required: false
schema:
type: array
items:
type: string
enum:
- opened
- closed
style: form
explode: false
description: 'Sale statuses, comma separated: `opened` and `closed`. Default:
both, as in Monde. A canceled sale is not part of the report.'
example:
- closed
- in: query
name: product_status
required: false
schema:
type: array
items:
type: string
enum:
- active
- canceled
style: form
explode: false
description: 'Product statuses, comma separated: `active` and `canceled`.
Default: `active`, as in Monde.'
example:
- active
- in: query
name: seller_id
required: false
schema:
type: array
items:
type: string
format: uuid
style: form
explode: false
description: Only these sellers, comma separated.
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: Only the sales of these companies, comma separated.
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: List CVC statement receipts
x-badges:
- name: Beta
color: "#f5803e"
tags:
- CVC Statement
description: Returns the receipts of the companies the credential has permission
for. A deleted receipt is not returned.
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: Get CVC statement receipt by ID
x-badges:
- name: Beta
color: "#f5803e"
tags:
- CVC Statement
description: Returns a receipt by its identifier, including an already deleted
one, which comes with the deleted field true. It is the endpoint that resolves
the CVC statement references returned by other resources.
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: CVC statement receipt identifier.
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: List CVC Master Statement
x-badges:
- name: Beta
color: "#f5803e"
tags:
- CVC Master Statement
description: Returns the Master Statement receipts of the companies where the
credential has permission and that are enabled as a master franchise agency,
from the latest movement to the earliest. Deleted receipts are not returned.
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: Receipt list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/cvc_statements_response"
examples:
cvc_master_statements:
summary: Master Statement receipts
"$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: Get Master Statement receipt by ID
x-badges:
- name: Beta
color: "#f5803e"
tags:
- CVC Master Statement
description: 'Returns a Master Statement receipt by its identifier, including
a deleted receipt, which comes with `deleted` true. A receipt of another movement
kind returns `404`: it is read through the [CVC Statement](#tag/CVC-Statement).'
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: Master Statement receipt identifier.
example: 4c2e8a71-9d35-4b6f-a1e0-7f3b9c5d2e84
responses:
'200':
description: Receipt returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/cvc_statement"
examples:
cvc_master_statement:
summary: Master Statement receipt
"$ref": "#/components/examples/cvc_master_statement"
cvc_master_statement_with_nf:
summary: Receipt with the generated invoice
"$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: List invoices
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: 'Returns the invoices of the companies the credential has permission
for. Canceled invoices are returned as well: the cancellation shows in the
status. The list brings only the invoice own fields; for the items and the
references, use Get invoice by 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: |-
Filters by the invoice status. unissued: not issued.issued: issued.processing: invoice transmitted, awaiting the response.processing_cancellation: cancellation transmitted, awaiting the response.awaiting_processing: invoice not transmitted yet, queued for issue.canceled: canceled.awaiting_issue: awaiting issue.awaiting_cancellation: awaiting cancellation.company_identifier.
The recipient is the registered person (person_id), with their
data and withholdings, or the data sent in recipient, with the
withholdings in taxes. Operation nature, CFOP, NBS code and rates
come from the company's invoice settings when omitted, and the issue date
is today. The invoice amount is the sum of the items, and the taxes are calculated
on save. Numbering only comes with the issuance. local_id, returned in the response next to the identifier the
item received.
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- "$ref": "#/components/parameters/content_type_json"
- "$ref": "#/components/parameters/idempotency_key_header"
responses:
'201':
description: Invoice created successfully.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Client-generated idempotency key (UUID v4). See the [Idempotency](#tag/Idempotency)
section for more details.
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: Get invoice by ID
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: Returns an invoice by its identifier, with the items and the references
to the related entities. It is the endpoint that resolves the invoice references
returned by other resources.
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: Invoice identifier.
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: Edit standalone invoice
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: 'Changes an unissued invoice; an invoice in any other status answers
409. An omitted field stays as it is. Empty text is saved as sent; on a required
field, and on a field that is not text, it is refused (422). The items
list, when sent, is the final list: an item with id stays and
changes only what was sent, an item without id is added, and
an invoice item that was not sent is removed. The invoice company does not
change. 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: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'200':
description: Invoice changed successfully. Without the permission to read
invoices in the company, the response brings only the identifiers.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Client-generated idempotency key (UUID v4). See the [Idempotency](#tag/Idempotency)
section for more details.
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: Delete invoice
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: 'Deletes an unissued invoice. An issued invoice is not deleted
(409): cancel it with the cancellation endpoint. An invoice linked to a financial
entry is not deleted either (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: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'204':
description: Invoice deleted successfully.
'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: Issue NFS-e
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: 'Sends the unissued invoice to the NFS-e issuance through e-Notas.
Issuance is asynchronous: the 202 response brings the invoice awaiting issuance
(awaiting_issue), and the city hall answers later. Follow it
with Get invoice by ID: it goes through processing and ends issued
(issued), with the number in nfse.number, or back
to unissued (unissued), with the reason in nfse.errors.
awaiting_cancellation) until
the city hall confirms. Otherwise the invoice is canceled only in Monde, right
away (200): cancel it at the city hall as well.'
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: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'200':
description: Invoice canceled in Monde.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Client-generated idempotency key (UUID v4). See the [Idempotency](#tag/Idempotency)
section for more details.
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: Cancellation sent to the city hall through 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: Record manual NFS-e issuance
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: 'Records the NFS-e the agency issued directly on the city hall
website: the unissued invoice becomes issued, with the given number and flagged
as manual issuance. Without a number, it gets the next one of the RPS series.
Only for an unissued electronic invoice (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: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'200':
description: Manual issuance recorded.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Client-generated idempotency key (UUID v4). See the [Idempotency](#tag/Idempotency)
section for more details.
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: Adjust invoice amount
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: Increases or decreases by a percentage the amount of each item
of an unissued invoice (409 otherwise), rounded to two decimals. The invoice
amount becomes the sum of the items, and the taxes are recalculated. If the
amount turns negative, the invoice is saved with the error in 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: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'200':
description: Amount adjusted.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Client-generated idempotency key (UUID v4). See the [Idempotency](#tag/Idempotency)
section for more details.
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: Remove invoice numbering
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: Removes the number and the series of an unissued invoice (409 otherwise),
so it is numbered again on issuance. Repeating the removal changes nothing,
so this endpoint does not require an 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: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'204':
description: Numbering removed.
'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: Create copy for reissue
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: Creates a new, unissued invoice from a canceled invoice (409 otherwise),
to reissue it. The copy takes the issue date, the recipient and the items
of the original, with the company's current invoice settings; the registered
person and the withholdings are not copied, and the taxes are recalculated.
The response brings the copy.
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: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'201':
description: Copy created.
headers:
X-Idempotent-Replay:
schema:
type: string
enum:
- 'true'
description: Client-generated idempotency key (UUID v4). See the [Idempotency](#tag/Idempotency)
section for more details.
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: Download NFS-e XML
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: Returns the XML file of the issued NFS-e, downloaded from e-Notas
or, without it, the one saved in the invoice. An invoice that is not issued
answers 409, and an issued one without XML answers 404. Requires only the
permission to read invoices.
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'200':
description: NFS-e XML file.
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: Download NFS-e PDF
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Invoices
description: Redirects (302) to the PDF of the issued or canceled NFS-e at e-Notas,
the address Monde opens in the browser from the invoice. An invoice that is
neither issued nor canceled answers 409, and one without the address of the
PDF answers 404. Requires only the permission to read invoices.
security:
- bearerAuthentication: []
parameters:
- "$ref": "#/components/parameters/authorization_header"
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Invoice identifier.
example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83
responses:
'302':
description: Redirects to the NFS-e PDF at e-Notas.
headers:
Location:
schema:
type: string
format: uri
description: Address of the PDF at 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: List invoices to generate
x-badges:
- name: Beta
color: "#f5803e"
tags:
- Generate Invoices
description: 'Returns the products of closed sales (product not deleted) of
the companies where the credential can list invoices to generate, from the
oldest to the newest by sale date and number, with the invoices the invoice
(NF) rules build for each one. Each product gets up to one invoice per recipient
of the rule (payer, supplier and representative), valued by the formula minus
what the non-canceled invoices of the same product and recipient already covered.
A product whose invoices already cover its revenue is left out. Without a
period, the list brings the sales from the first day of the month until today.
As in Monde, the sales the credential itself created come in; the sales of
the other sellers come in the companies where it also has **Consultar vendas
de outros vendedores/intermediários** in Sales. Each page scans at most 2,000
products: in a period where almost everything already has invoices, the page
may come with fewer items than `size`, or empty, with `has_next_page` true;
follow `next_cursor` until `has_next_page` is false. Keep the `previewed_at`
of the response: it goes in the generation request. The pages followed by
`next_cursor` return the `previewed_at` of the first one.'
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 of the reference company, which supplies the operation nature,
the CFOP, the tax rates, the issue date and the item template of the invoices.
Required.
example: '11222333000181'
- in: query
name: date_field
required: false
schema:
type: string
enum:
- sale_date
- product_start
description: |-
The date the period filters. Required when `date_from` or `date_to` is given. sale_date: sale date.product_start: product start date (departure, check-in).insertion: record created.edition: record changed.deletion: record deleted.custom: custom action of the screen that generated the entry.export: data export.email: e-mail sent from the record, such as the billet or the invoice of a bill. The description lists the recipients and the attached files.sales: sales fields.travels: travels fields.people: people fields.bills: accounts payable and receivable fields.tasks: tasks fields.Authorization header, using the Bearer scheme.Authorization: Bearer bW9uZGV8dXNlcjpwYXNzMTIz
Idempotency-Key)
to ensure duplicate requests (for example, due to timeouts or automatic retries)
are not processed more than once. 550e8400-e29b-41d4-a716-446655440000).X-Idempotent-Replay:
true header.409 Conflict.422 Unprocessable Content), the key becomes available
again: sending the same request with the same key is processed again.422 Unprocessable Content./64 network: every address in the same
/64 network adds up to the same limit.429 Too Many Requests
and an error message.429, wait
before retrying and use an increasing wait time between attempts (exponential
backoff).pagination
node in the response tells the page size, whether a next page exists and which
cursor to send to reach it. cursor.has_next_page
is true, repeat the request sending cursor with the
next_cursor value from the previous response.has_next_page
is false, next_cursor comes back null and the walk is
over.size sets how many records
come per page: from 1 to 50. Without the parameter, it is 20.400.The sale the credential created is always its own; the ones of other sellers require the Consult, Open and Edit sales of other sellers permissions, as in Monde (see the FAQ).
' - name: Products description: 'Query and maintain the catalog of travel products (insurance, cruises, hotels, airline tickets, own operations, and others) used in sales, with the suppliers of each product and the representatives of each supplier. Suppliers and representatives are parts of the product: they are read with the permission to read products, and each has its own permissions to write and to delete, as in Monde.' - name: Cabins description: Query and maintain the cabin types registered in the system to use in cruise products. - name: Ships description: Query and maintain the ships registered in the system to use in cruise products. - name: Packages description: Query and maintain the tour packages used in the sales' tour package products. - name: Cost Centers description: Query and maintain the cost centers registered in the system to use in financial transactions. - name: Currencies description: Query and maintain the currencies registered in the system and their exchange rates, to use in sale products and financial transactions. - name: Categories description: Query and maintain the financial categories registered in the system, grouped by kind (revenue or expense) and group. - name: Category Groups description: 'Query and maintain the groups that organize the financial categories. Each group is an expense or a revenue group, and its categories inherit that kind. Uses the Categories permissions. Monde deletes on its own a group left without categories when a category is saved through it: register the group together with its first category. Through the API, deleting the last category of a group also deletes the group.' - name: Cities description: Query the cities the agency can use, with state, country, and official codes (IBGE and SIAFI). They are the ones registered in the agency and the ones in Monde's city list, which has the IBGE municipalities and the cities abroad. A city of the list enters the agency's registry, with the same `id`, when a person or invoice starts using it. - name: Person roles description: 'Query, register, update, and delete the person roles of the commissions module, as in the Monde Roles screen: the role name, the companies or sellers over whose sales it is commissioned, and the people linked to it, with the commission plan, start date and goals of each one. The Seller and Intermediary roles belong to the system: they are not renamed, are not commissioned over companies or sellers, and are not deleted, but they take people. Goals are written here, as in the "Plan and Goals" of the person in Monde: the `goals` list of each person in `people`, with the "Edit" permission on roles; the [Goals](#tag/Goals) resource only reads them. The resource exists only in agencies: in an operator installation, every call responds `403`. Reading requires the "View" permission on roles; writing, the "Edit" permission on roles in a company that is not read only; deleting, the "Delete" permission on roles.' - name: Sellers description: 'Query, register, change and delete the sellers used in sales. A seller is an individual person already registered, and its identifier is the person identifier. There is a single seller registry for the whole system, with no company: the permissions apply in any active company where they are granted, and writing requires a company that is not read only.' - name: Payment Methods description: Query and maintain the payment methods registered in the system to use in financial transactions. - name: Accounts and Cards description: 'Query, create, update and delete accounts and cards: cash account, checking account and credit card, with bank and card data, the companies where each account is available, the user groups with access and the bank slip billing of the checking account.' - name: Banks description: 'Query Monde''s bank table, the same one used to set the bank of a checking account. Through the API the table is read-only: banks are registered in Monde.' - name: Invoice (NF) Rules description: 'Query the invoice (nota fiscal) issuing rules, with the sale fields that compose each issuance. The rules belong to no company: they apply to the whole agency, and exist only on an agency installation.' - name: Tasks description: Query, create, update, and delete tasks, with assignee, linked person, category, and due date, and comment on their history. The task the credential created is always its own; the ones of other users require the See tasks of other users permission, as in Monde (see the FAQ). - name: Task Categories description: 'Query, create, update and delete task categories. Each category can be a column of the task board (kanban), and the order of the columns is also written here. Categories belong to no company: they apply to the whole agency.' - name: Travels description: Query, create, update and delete travels, with customer, seller, situation and the period calculated from the linked sales, and link or unlink sales. The travel the credential created, or with a sale it created, is always its own; the ones of other sellers require the Consult sales of other sellers permission, as in Monde, also to update, delete and link (see the FAQ). - name: Quotes description: Query, create, update, duplicate and delete the quotes registered in the system, with validity, status and the public viewing link. - name: Guides description: 'List, create, update, duplicate, and delete the agency''s travel guides: HTML content with a public viewing link, like the quotes one, but without a linked person and without a validity date. Guides are a feature of the Monde Pro license and exist only in the companies that purchased it. With a read-only Monde Pro license, the company''s guides are read, but not created, updated, duplicated, or deleted.' - name: Billing Rules description: Query the billing rules, with the rule owner, closing period and due date conditions. Rules apply to the whole agency, with no company. - name: Integrations description: 'Query the vendor integrations, which import the sales made in the vendor''s system. The vendor''s secrets (password, token, API keys and PIN) are never returned: the query only says whether they are filled.' - name: People description: Query the people registered in the system, with contact data, documents, and additional information. - name: Labels description: 'Query, create, change and delete the labels used to classify people. There is a single label registry for the whole system, with no company: the permissions apply in any active company where they are granted, and writing requires a company that is not read only.' - name: Companies description: 'Query the system companies the credential reaches: the active companies where it has the "Read all companies" permission. This is where the CNPJ that writes ask for in `company_identifier` comes from.' - name: Accounts Payable and Receivable description: 'Query and create the accounts payable and receivable (financial entries) of the companies where the credential has permission. The same resource covers both cases: accounts receivable (transaction_kind = credit) and accounts payable (transaction_kind = debit). It brings identification, values, status, categories, apportionments, settlement movements, items, commissions, attachments and custom fields. The entry the credential created is always its own; the ones of other users require the access to the entries of all users, or its slice, as in Monde (see the FAQ).' - name: Account movements description: 'Query the movements of accounts and cash registers: date, amount, direction, check and card data, and the references to the account, the payment method and the settled bill.' - name: Statement and Cash description: 'Balance, statement and cash closing of a checking or cash account, as on the Monde Account Statement screen. An account of another kind (credit card, checks, investment) answers 404. The balance and the statement belong to the **Saldo e Extrato** (balance and statement) resource, separate from reading [Accounts and Cards](#tag/Accounts-and-Cards), with the **Extrato de Conta** permission, as in Monde. Closing and reopening the cash ask for the **Fechar Caixa** and **Reabrir Caixa** permissions of the **Contas e Cartões** (accounts and cards) resource, one for each action, as in Monde. Through the automatic connection, reading the balance and the statement and closing and reopening the cash are an exception granted by Monde on approval: the statement brings every movement of the account and the closing applies to the whole account, including what the agency recorded. One of the account companies granting the permission is enough. The closing is a watermark: closing a day closes every day up to it, and with the cash closed Monde refuses to insert, change or delete movements on those days.' - name: Transfers between Accounts description: 'Read, create, change and delete the transfers between the agency accounts, as on the Monde Transfer screen. A transfer is two sibling movements: the outflow on the origin account (Debit in account payment method) and the inflow on the destination account (Bank deposit). Both also show up in [Account movements](#tag/Account-movements) and in the [statement](#tag/Statement-and-Cash). Only active checking or cash accounts transfer, and both accounts must belong to companies where the credential holds the permission: reaching one of them is not enough. A closed cash on the date refuses saving, changing and deleting, as in Monde. Permissions of the **Transfers between Accounts** resource, the Monde ones: **Transferência entre Contas** (read), **Editar** (create and change), **Excluir** (delete) and **Visualizar Log** (view log), which shows the history of the transfers in [Logs](#tag/Logs) (origin `conta_movimento`). Through the automatic connection, reading, editing, deleting and viewing the log are an exception granted by Monde on approval: a transfer does not record who created it, so whoever reads or writes transfers also reaches the ones the agency recorded.' - name: Refunds description: 'Query, record and delete the sale refunds: refund side, amount, dates and the references to the sale, the sale product, the person, the company and the account payable or receivable.' - name: Reports description: 'The reports of Monde, with the same query as the screen: the API and the report bring the same rows, with the same filters. Each report requires its own permission, as in Monde, and reaches only the companies where the credential has the permission and that have a license. The rows are paginated by cursor. As the reports bring people''s contact data and documents, each page fetched is recorded in the History as an export of the report.' - name: CVC Statement description: 'Query the receipts and movements of the CVC statement: amounts, commissions, balances, dates and the references to the company, the contractor, the seller, the intermediary, the sale, the sale product, the fiscal note and whoever registered it.' - name: CVC Master Statement description: 'Read the receipts of CVC''s Master Statement, the "Master Franchise Transfer" ones. The Master Statement exists only in the company enabled as a master franchise agency, in Settings › CVC: a company without that setting is left out of the listing, and reading it by ID returns `403`. The receipt has the same format as the [CVC Statement](#tag/CVC-Statement).' - name: Invoices description: 'Query the service invoices: numbering, status, dates, amounts, withholdings and taxes, the recipient data stored on the invoice (with the reference to their city), the NFS-e data and, when getting the invoice by ID, the items and the references to person, company, sale product and sale.redirect_uri with a code.code for a token and uses the token
to call the API on behalf of that agency.id_token and no user data.https://web.monde.com.br.
https://web.monde.com.br/partners/signup
and confirm the email. Monde reviews the signup, sets the permissions and approves
it.client_id and client_secret show up on that
page; the secret is displayed a single time, so store it right away. If you need
to see it again, ask Monde to regenerate it.client_secret
on your backend only. It never goes to the browser or to the user's app.https://web.monde.com.br/partners/integration),
fill in the redirect_uri and the privacy policy URL, which the agency
sees when it authorizes. The connection is enabled as soon as the signup is approved
and both are filled in, with no other step. While either one is missing, authorization
does not work. redirect_uri, and
it must use https. It must be identical, character by character,
on the authorization and on the token exchange (a trailing slash already counts
as a difference). http addresses are not accepted, localhost
and 127.0.0.1 included.state and a new code_verifier
on your backend and keep both in the user's session. The code_verifier
is a random string of 43 to 128 characters; the code_challenge is
BASE64URL(SHA256(code_verifier)), without the trailing =.
PKCE is required and only S256 is accepted: it is what keeps another
system from exchanging an intercepted code. 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')
Redirect the agency user to the authorization URL, with URL-encoded values: GET
https://web.monde.com.br/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&state=STATE&code_challenge=CODE_CHALLENGE&code_challenge_method=S256
scope: what the partner can do are the permissions
set on approval.client_id is not an active, approved
partner, if the connection is not enabled yet (the redirect_uri or
the privacy policy is missing), if the redirect_uri is not the registered
one, or if the code_challenge is missing or the code_challenge_method
is not S256, Monde answers 400 on its own page and does
not go back to the redirect_uri.redirect_uri with the code and the same state
you sent: YOUR_REDIRECT_URI?code=agencia%7CujES3JCJylJRoM3j_kGeavaD2hFqz2oqw1Lazq_u0rs&state=STATEWhen the agency refuses (the
error_description is always in Portuguese):
YOUR_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 with the one in the session. If it differs
or is missing, discard the response.code is opaque.
Use the URL-decoded value as it came, without trimming or replacing characters.
It is valid for 10 minutes and can be exchanged only once.redirect_uri when the signed-in user is not an agency
administrator. In that case the user sees the explanation on a Monde page. The
consent offers every active company of the agency, and none is refused for license.href points to the authorization URL you build on
your backend on each access, with a fresh PKCE code_challenge (step
2 above), never a static link. The Monde symbol is hosted by us: https://web.monde.com.br/logo-monde-conectar.svg
(colored, for light backgrounds) and https://web.monde.com.br/logo-monde-conectar-branco.svg
(white, for the blue background). Three variations: <a href="AUTHORIZATION_URL" 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"> Connect with Monde</a>
<a href="AUTHORIZATION_URL" 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"> Connect with Monde</a>
<a href="AUTHORIZATION_URL" 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">Connect with Monde</a>
application/x-www-form-urlencoded;
the same body as JSON (application/json) is also accepted. 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=YOUR_REDIRECT_URI" --data-urlencode "client_id=YOUR_CLIENT_ID"
--data-urlencode "client_secret=YOUR_CLIENT_SECRET" --data-urlencode
"code_verifier=CODE_VERIFIER" 200 response: {
"access_token": "YWdlbmNpYXw2ZjFj...", "token_type":
"Bearer", "scope": "full_access", "created_at":
1790602784 } The access_token does not expire and no refresh_token
is returned. Store it on your backend, one per connected agency, and treat it
as a password. 400 with {"error":"invalid_grant","error_description":"..."}:
code expired or already exchanged, code_verifier that
does not match the code_challenge, or a redirect_uri
different from the one used on the authorization. Start again from the authorization.400 with {"error":"invalid_request","error_description":"..."}:
the code_verifier was not sent.401 with {"error":"invalid_client","error_description":"..."}:
wrong client_id or client_secret.404
with an empty body: the code arrived altered.https://web.monde.com.br/api/v3
with the token in the Authorization header (the token already carries
the agency). Authorization: Bearer YOUR_ACCESS_TOKENTo confirm the connection works without creating data, call
GET /api/v3/sales with
the token: curl https://web.monde.com.br/api/v3/sales -H "Authorization:
Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json"
200 with the list of the sales the partner reaches (the
ones it created and, when Monde granted access to other origins on approval, the
others too; without that exception, the list comes empty on a new connection):
the token is valid and the integration is ready.403 with
{"errors":["Você não tem permissão para executar essa ação."]}:
the token is valid, but the partner does not have the "View" permission
on sales in the company.401 with {"errors":["Credenciais
de acesso não são válidas."]}: the token is invalid or the connection
was deleted. Start again from the authorization.POST /sales response.401.curl -X POST https://web.monde.com.br/oauth/revoke
--data-urlencode "token=YOUR_ACCESS_TOKEN" --data-urlencode "client_id=YOUR_CLIENT_ID"
--data-urlencode "client_secret=YOUR_CLIENT_SECRET" The response
is 200 with {}. The connection with the agency is deleted
immediately and the token stops working. To connect again, start over from the
authorization. 403 with {"error":"unauthorized_client",...}:
wrong client_id or client_secret, or the token
does not belong to this client_id. Nothing is revoked.redirect_uri: your backend polls the new connections
and receives each one already with its token, with nobody copying a key. https://web.monde.com.br/partners/integration),
only after the polling below is implemented. The automatic connection must be
enabled (step 1).client_id
and the client_secret in HTTP Basic: curl -X POST https://web.monde.com.br/oauth/connections
-u "YOUR_CLIENT_ID:YOUR_CLIENT_SECRET" The client_id
and the client_secret can also go in the body, as in the token exchange,
but never in the URL: in the query string they are ignored and the response is
401. Response 200: { "data": [ { "id":
"5b0f3c2e-8a51-4f6e-9a3d-2f4f1f0c9e11", "access_token": "YWdlbmNpYXw2ZjFj...",
"token_type": "Bearer", "company": { "name":
"Example Agency", "cnpj": "12345678000190" }, "authorized_at":
"2026-10-19T14:32:05.000-03:00" } ], "pagination": { "size":
50, "has_next_page": false, "next_cursor": null } }
access_token
in your backend before anything else: it does not come back in a later poll. If
it is lost, the agency deletes the integration and connects again. Use the id
to avoid processing the same connection twice on your side.access_token
is the same as in step 4: it does not expire, has no refresh_token,
is used in the v3 API the same way (step 5) and revoked the same way (step 6).company is the agency company that was connected. Use the CNPJ
to link the connection to the right customer on your platform.data node. The
pagination node has the format of the API pagination,
but the queue uses no cursor: when has_next_page is true,
poll again right away, without parameters, and next_cursor is always
null. With no new connection, the list is empty. With two polls at the same time,
one of them may come with an empty list and has_next_page as true:
poll again.Cache-Control: no-store:
do not keep it in a cache or a log, because it carries the tokens.401
with {"error":"invalid_client","error_description":"..."}:
wrong client_id or client_secret, or the automatic connection
is not enabled. Nothing is delivered.singlemarriedseparateddivorcedwidowedcivil_unioninsurance: travel insurance.cruise: cruise.hotel: hotel room
nights.airline_ticket: airline ticket.train_ticket
(others): train ticket.ground_transportation (others):
ground transportation.excursion (others): excursion.visa (others): consular visa.car_rental:
car rental.travel_package: travel packages.cvc_package: CVC package.operation:
own operation.others: other products.others
(default): other products.operation: own operation,
only in an agency base.passengers[].fees (and adds up to the sale total),
and the agency service fee goes in the product's agency_service_fee. "
items:
"$ref": "#/components/schemas/visa"
operation:
allOf:
- "$ref": "#/components/schemas/operation"
nullable: true
description: Own operation product of the sale. At most one per sale, and
the product must be the same as `operation_id` when both are sent. Travel
agencies only; on a tour operator (consolidator), the field is rejected
with 422.
others:
type: array
description: Other sale products, which may or may not have passengers.
items:
"$ref": "#/components/schemas/others"
cvc_packages:
type: array
readOnly: true
description: CVC packages of the sale. Always without passengers.
items:
"$ref": "#/components/schemas/cvc_package"
payments:
type: array
description: " List of payments made for the sale. Each payment has a single
method and can be distributed across one or more products, pointed to
by `sale_product_local_id` or `sale_product_id`, allowing detailed control
of how amounts were allocated per product. "
items:
"$ref": "#/components/schemas/payment"
commissions:
type: array
description: Commissions to record on the sale. Only accepted when `status`
is `closed`; each line's balance is the value minus the retained value.
On the sale creation, a list with any commission requires the "View commissions
tab" and "Add commissions" permissions on sales.
items:
"$ref": "#/components/schemas/commission_create"
attachments:
type: array
readOnly: true
description: List of attachments of the record.
items:
"$ref": "#/components/schemas/attachment_summary"
totals:
allOf:
- "$ref": "#/components/schemas/sale_totals"
description: Consolidated totals of the sale.
financial:
allOf:
- "$ref": "#/components/schemas/financial"
description: 'Financial data of the sale: financial remarks, vendor payouts
and separate accounts payable/receivable entries.'
sale_product_reference:
type: object
properties:
id:
type: string
format: uuid
description: 'Identifier of a product the sale already has (the same as
in the get by ID). With it, the product is changed; without it, the product
is added. With the id, local_id becomes optional: a payment in the same
request points to this product by sale_product_id.'
example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45
sale_update:
type: object
description: 'Fields of the sale update. All are optional: a field left out
stays as it is.'
properties:
company_identifier:
type: string
description: CNPJ of the sale company. With another CNPJ, the sale moves
to that company, if the change rules allow it.
example: '46598887000162'
sale_date:
"$ref": "#/components/schemas/sale_date"
status:
type: string
enum:
- opened
- closed
description: Send closed to close the sale at the end of the update, following
the closing rules. On an open sale, opened keeps it open; on a closed
sale, opened reopens it before applying the rest of the update and closed
keeps it closed.
operation_id:
"$ref": "#/components/schemas/operation_id"
observations:
type: string
nullable: true
description: General remarks about the sale. Replaces the current text;
send null to clear it. Also changes on a closed sale, as in Monde, and
the change goes to the sale log.
custom_fields:
type: array
description: 'Custom fields of the sale. Not replaced: each field sent is
written over the current value and the others stay. Sent blank or as null,
the field is cleared, unless it is required.'
items:
"$ref": "#/components/schemas/custom_field"
seller:
"$ref": "#/components/schemas/seller_create"
payer:
allOf:
- "$ref": "#/components/schemas/individual_or_company"
description: Payer of the sale. Only changes when, after the request, no
payment is left on the sale products. Cannot be sent as null.
intermediary:
"$ref": "#/components/schemas/intermediary"
requester:
allOf:
- "$ref": "#/components/schemas/individual_person"
description: Individual who requested the sale.
approver:
allOf:
- "$ref": "#/components/schemas/individual_or_company"
description: Person who approved the sale. Travel agencies only. A tour
operator (consolidator) sale has no approver, and the field sent with
a value is rejected with 422.
insurances:
type: array
description: List that replaces the products of this kind (insurances).
A product with id is changed, one without id is added and one left out
is removed from the sale. Left out, keeps the products of this kind; empty
or null, removes them all, as long as the sale keeps at least one product
and none of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/insurance"
cruises:
type: array
description: List that replaces the products of this kind (cruises). A product
with id is changed, one without id is added and one left out is removed
from the sale. Left out, keeps the products of this kind; empty or null,
removes them all, as long as the sale keeps at least one product and none
of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/cruise"
hotels:
type: array
description: List that replaces the products of this kind (hotels). A product
with id is changed, one without id is added and one left out is removed
from the sale. Left out, keeps the products of this kind; empty or null,
removes them all, as long as the sale keeps at least one product and none
of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/hotel"
airline_tickets:
type: array
description: List that replaces the products of this kind (airline_tickets).
A product with id is changed, one without id is added and one left out
is removed from the sale. Left out, keeps the products of this kind; empty
or null, removes them all, as long as the sale keeps at least one product
and none of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/airline_ticket"
train_tickets:
type: array
description: List that replaces the products of this kind (train_tickets).
A product with id is changed, one without id is added and one left out
is removed from the sale. Left out, keeps the products of this kind; empty
or null, removes them all, as long as the sale keeps at least one product
and none of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/train_ticket"
ground_transportations:
type: array
description: List that replaces the products of this kind (ground_transportations).
A product with id is changed, one without id is added and one left out
is removed from the sale. Left out, keeps the products of this kind; empty
or null, removes them all, as long as the sale keeps at least one product
and none of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/ground_transportation"
car_rentals:
type: array
description: List that replaces the products of this kind (car_rentals).
A product with id is changed, one without id is added and one left out
is removed from the sale. Left out, keeps the products of this kind; empty
or null, removes them all, as long as the sale keeps at least one product
and none of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/car_rental"
travel_packages:
type: array
description: List that replaces the products of this kind (travel_packages).
A product with id is changed, one without id is added and one left out
is removed from the sale. Left out, keeps the products of this kind; empty
or null, removes them all, as long as the sale keeps at least one product
and none of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/travel_package"
excursions:
type: array
description: List that replaces the products of this kind (excursions).
A product with id is changed, one without id is added and one left out
is removed from the sale. Left out, keeps the products of this kind; empty
or null, removes them all, as long as the sale keeps at least one product
and none of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/excursion"
others:
type: array
description: List that replaces the products of this kind (others). A product
with id is changed, one without id is added and one left out is removed
from the sale. Left out, keeps the products of this kind; empty or null,
removes them all, as long as the sale keeps at least one product and none
of them is blocked from removal.
items:
allOf:
- "$ref": "#/components/schemas/sale_product_reference"
- "$ref": "#/components/schemas/others"
visas:
type: array
description: List that replaces the products of this kind (visas). A product
with id is changed, one without id is added and one left out is removed
from the sale. Left out, keeps the products of this kind; empty or null,
removes them all, as long as the sale keeps at least one product and none
of them is blocked from removal.
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: Own operation of the sale. With id, changes the one the sale
has; without id, adds it. Sent as null, the own operation product is removed
from the sale, which must keep at least one product.
payments:
type: array
description: Final list of payments of the sale products. With id (the one
from the response that created it or from the sale reading), the payment
stays as it is and does not take a payment method along; without id, it
is added; one left out is removed. To change a payment, remove it and
add another. Empty or null, removes them all; if any cannot be removed,
the update is refused. In the product of a new payment, use sale_product_local_id
for a product sent in this request or sale_product_id for a product the
sale keeps.
items:
"$ref": "#/components/schemas/payment_update"
commissions:
type: array
description: List that replaces the manually informed commissions, in the
same format as on creation. Applies to a sale the request closes or that
is already closed. Empty or null, removes them all; with a paid commission,
the list cannot be replaced. Sending it, even empty or null, requires
the "View commissions tab" permission on sales, plus "Add commissions"
for a list with any commission and "Delete commissions" when the sale
already has manual commissions.
items:
"$ref": "#/components/schemas/commission_create"
sale_product_passenger_person:
type: object
description: The person of the passenger, by `id`.
required:
- id
properties:
id:
type: string
format: uuid
description: The person `id` of the passenger, as in `passengers[].person.id`
when reading the sale.
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
sale_product_cancellation:
type: object
description: The product cancellation. With passengers, `passengers` is required
and each item carries `person` and `canceled_at`; the product is canceled
when the list cancels the ones still missing. For a product without passengers,
send only the options, or `{}`. `canceled_at` at the root is refused. Fields
not in the documentation are ignored.
properties:
passengers:
type: array
description: 'The passengers to cancel, each with its own date. Required
for a product with passengers: to cancel the whole product, list every
active passenger. Do not send it for a product without passengers. Each
person goes only once: repeated, it answers 422.'
items:
type: object
required:
- person
- canceled_at
properties:
person:
"$ref": "#/components/schemas/sale_product_passenger_person"
canceled_at:
type: string
format: date
description: Cancellation date of this passenger, as `YYYY-MM-DD`.
Required. Cannot be earlier than the sale date.
example: '2026-10-15'
calculate_commission:
type: boolean
default: false
description: Keeps the canceled product in the commission plan goal calculation
(the same `calculate_commission` of the product reading). Default `false`.
Only applies when the request leaves every passenger canceled.
delete_customer_balance:
type: boolean
default: false
description: Deletes the pending customer balance of this product, which
becomes deleted balance.
delete_supplier_balance:
type: boolean
default: false
description: Deletes the items still open for the supplier (invoice and
Lei Kandir). Only applies when the request leaves every passenger canceled.
supplier_fine:
type: number
format: double
minimum: 0
default: 0
description: 'Fine charged by the supplier, as a positive amount, in the
currency the supplier is paid in: the final currency of the sale in an
agency and the origin currency of the product in an operator. When reading,
it comes back in `supplier_fine` in an agency and in `supplier_fine_origin_currency`
in an operator. Requires `delete_supplier_balance`.'
example: 150.0
sale_product_reactivation:
type: object
description: The product reactivation. With passengers, `passengers` is required
and each item carries `person`; the whole product comes back when the list
brings every canceled passenger. For a product without passengers, send `{}`.
Fields not in the documentation are ignored; the cancellation fields are refused.
properties:
passengers:
type: array
description: 'The canceled passengers to reactivate. Required for a product
with passengers: to reactivate the whole product, list every canceled
passenger. Do not send it for a product without passengers. Each person
goes only once: repeated, it answers 422.'
items:
type: object
required:
- person
properties:
person:
"$ref": "#/components/schemas/sale_product_passenger_person"
sale_totals_read:
type: object
readOnly: true
description: Sale totals aggregate.
properties:
products:
type: number
format: double
description: Sum of the sale product values in BRL.
fees:
type: number
format: double
description: Sum of the sale fees in BRL.
discount:
type: number
format: double
description: Sum of the sale discounts in BRL.
revenue:
type: number
format: double
description: Computed revenue of the sale in BRL.
balance:
type: number
format: double
description: Remaining balance of the sale in BRL.
final_amount:
type: number
format: double
description: Final value of the sale in BRL.
sale_summary:
type: object
readOnly: true
description: Sale listing item. Carries the sale scalar fields, related references
as id/name and the totals aggregate, without the weak entities (products,
payments, commissions, attachments, financial and custom fields), which are
available only when getting the sale by ID.
required:
- id
- sale_number
properties:
id:
type: string
format: uuid
description: Unique identifier of the sale in UUID format.
example: 212b54b8-27df-4859-80a9-79ad855bcd09
sale_number:
type: integer
description: Sequential sale number generated automatically by the system.
example: 987
sale_date:
type: string
format: date
description: Sale date in ISO 8601 format (YYYY-MM-DD).
departure_date:
type: string
format: date
nullable: true
description: Trip start date in ISO 8601 format (YYYY-MM-DD), computed from
the earliest start date among the sale products.
return_date:
type: string
format: date
nullable: true
description: Trip end date in ISO 8601 format (YYYY-MM-DD), computed from
the latest end date among the sale products.
status:
type: string
enum:
- opened
- closed
- canceled
description: Current status of the sale.
observations:
type: string
nullable: true
description: General remarks about the sale.
printed_receipt:
type: boolean
description: Indicates whether the sale receipt was printed.
created_at:
type: string
format: date-time
nullable: true
description: Date and time the sale was registered.
totals:
allOf:
- "$ref": "#/components/schemas/sale_totals_read"
description: Sale totals aggregate.
sale_detail:
readOnly: true
description: Complete sale. Besides the listing fields, it embeds the sale weak
entities (product arrays by type, payments, commissions, attachments, financial
and custom fields).
allOf:
- "$ref": "#/components/schemas/sale_summary"
- type: object
required:
- company
properties:
company:
allOf:
- "$ref": "#/components/schemas/entity_reference"
description: |-
Company that issued the sale. self_provided: self-provided transportation.road_transport: road transportation.no_transport:
no transportation.charter_flight: charter flight.scheduled_flight: scheduled flight.passengers[].fees (and adds up to the sale total), and the
agency service fee goes in the product's agency_service_fee. "
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: Identifier of the visa application, used to locate it with
the supplier or representative. It may be known as "protocol number",
"application number", among others. Optional.
maxLength: 40
visa_type: &435
type: string
description: 'Visa type, as free text up to 50 characters. Required. destination_country.
Optional.'
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: ' Information about the services included in the visa, such
as interview scheduling, form filling and passport delivery. The `\n`
character will be interpreted as a line break. passengers[].fees,
per applicant.'
agency_service_fee_origin_currency: &470
allOf:
- "$ref": "#/components/schemas/agency_service_fee"
readOnly: true
description: Amount of `agency_service_fee` in the product origin currency
(`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: Amount of `deductions` in the product origin currency (`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: Amount of `discount_amount` in the product origin currency
(`origin_currency`).
cc_rav_fee: &476
allOf:
- "$ref": "#/components/schemas/cc_rav_fee"
departure_date:
type: string
description: 'Visa start date and time, usually the planned travel date,
in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Required. departure_date.
Optional. fees.
items:
allOf:
- "$ref": "#/components/schemas/visa_passenger"
totals:
allOf:
- "$ref": "#/components/schemas/product_totals"
description: Consolidated totals of the product.
visa_read:
type: object
readOnly: true
description: " Consular visas of the sale, one per visa application. The visa
is a system product: there is no need to inform which product is being sold.
Each passenger is a visa applicant. passengers[].fees (and adds up to the sale total), and the
agency service fee goes in the product's agency_service_fee. "
required:
- visa_type
- destination_country
- currency
- supplier
- passengers
properties:
id:
type: string
format: uuid
readOnly: true
description: Unique identifier of the sale product in UUID format. It is
the target of the `sale_product` reference on the financial record, the
invoice, the refund and the CVC statement.
example: 3c9e1f47-2b8d-4a65-9f13-8e7d6c5b4a21
document: *434
visa_type: *435
destination_country:
type: string
readOnly: true
nullable: true
description: Country of the visa, by its ISO 3166-1 alpha-2 code (two letters),
such as "US" for the United States. Null on a visa registered without
a country.
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: 'Visa start date and time, usually the planned travel date,
in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Required. departure_date.
Optional. fees.
items:
allOf:
- "$ref": "#/components/schemas/visa_passenger_read"
operation:
type: object
description: Own-operation products of the sale (operated by the agency itself),
which may or may not have passengers.
required:
- product_id
- local_id
- product_name
- product_with_passengers
- currency
- supplier
- departure_date
properties:
product_id:
type: string
format: uuid
writeOnly: true
description: Identifier (UUID) of the own-operation product chosen from
the agency catalog. The product must be active. See the available products
at 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: General identifier for the product, used to locate it with
the supplier or representative. It may be known as "locator", "booking
number", "voucher code", "order code", among others.
departure_date:
type: string
description: 'Start date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
agency_service_fee.'
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: Visa applicant.
required:
- person
properties:
document: *596
cost_center: *525
canceled_at: *526
fees:
allOf:
- "$ref": "#/components/schemas/passenger_fees"
description: 'Consular fee of the applicant, charged by the consulate or
embassy for the visa application. Adds up to the product and sale totals.
The agency service fee does not go here: it goes in the product''s agency_service_fee.'
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: Ticket emission name.
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: Amount of `fees` in the product origin currency (`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: Amount of `other_fees` in the product origin currency (`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: Amount of `rav_fee` in the product origin currency (`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: Amount of `rav_fee_discount` in the product origin currency
(`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: Amount of `agency_fee` in the product origin currency (`origin_currency`).
amount: &641
allOf:
- "$ref": "#/components/schemas/passenger_amount"
amount_origin_currency: &642
allOf:
- "$ref": "#/components/schemas/passenger_amount"
readOnly: true
description: Amount of `amount` in the product origin currency (`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: Amount of `customer_amount` in the product origin currency
(`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: Amount of `total_amount` in the product origin currency (`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: Passenger ticket number.
maxLength: 30
original_ticket_number: &648
type: string
writeOnly: true
description: "⚠️ This field is not available yet — it is only documented
as a reference of what we have planned.checking_account: checking
account.card_account: credit card.check_account:
checks.cashier_account: cashier.none: applies only to sales without a representative.specific: applies only to the representative indicated
in representative.any: applies to
any representative.upcoming:
not started yet.ongoing: in progress.finished:
finished.<img data-quote-image>,
holding only the image reference.
example: "Pacote com aéreo, hospedagem all inclusive e traslados.
" valid_until: type: string format: date description: Quote validity date example: '2024-05-31' active: type: boolean description: Indicates whether the quote is active example: true public_url: type: string format: uri nullable: true description: Public viewing link of the quote (accessible only while active and within validity) example: https://suaviagem.app/a1B2c3-cancun internal_observations: type: string nullable: true description: Internal observations (not shown in the public link) example: Cliente pediu retorno até sexta. cover_kind: type: string enum: - color - image - none description: 'Public link cover: `color` (a background color), `image` (an image) or `none` (no cover). The image can only be chosen in Monde Web: through the API, `image` is only accepted on a quote that already has one. Switching to another option deletes the image. Sending only `cover_color` already chooses `color`, and `color` without `cover_color` takes the primary color of the company''s Quote Settings.' example: color cover_color: type: string nullable: true description: 'Cover background color, in hexadecimal (`#1f4e79`). Only applies to the `color` cover; on the others it is null. The color is saved on the quote: changing the primary color of the Quote Settings later does not change the cover. The title is black on a light background and white on a dark one.' example: "#1f4e79" cover_show_title: type: boolean description: Shows the title on the cover. On the `color` cover it is always `true`. example: true cover_show_subtitle: type: boolean description: Shows the subtitle on the cover. On the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`, the image is shown whole, uncropped and with no text over it. example: true cover_image_url: type: string format: uri nullable: true description: Temporary address of the cover image. Null when the cover is not `image`. example: created_at: type: string format: date-time description: Creation date and time example: '2024-03-15T10:30:00' updated_at: type: string format: date-time description: Last update date and time 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: Represents a quote registered in the system. allOf: - "$ref": "#/components/schemas/quote_summary" - type: object required: - company - user properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked to the quotePacote com aéreo, hospedagem all inclusive e traslados.
" active: type: boolean default: true description: Indicates whether the quote is active example: true internal_observations: type: string description: Internal observations (not shown in the public link) example: Cliente pediu retorno até sexta. cover_kind: type: string enum: - color - image - none description: 'Public link cover: `color` (a background color), `image` (an image) or `none` (no cover). The image can only be chosen in Monde Web: through the API, `image` is only accepted on a quote that already has one. Switching to another option deletes the image. Sending only `cover_color` already chooses `color`, and `color` without `cover_color` takes the primary color of the company''s Quote Settings.' example: color cover_color: type: string description: 'Cover background color, in hexadecimal (`#1f4e79`). Only applies to the `color` cover; on the others it is null. The color is saved on the quote: changing the primary color of the Quote Settings later does not change the cover. The title is black on a light background and white on a dark one.' example: "#1f4e79" cover_show_title: type: boolean description: Shows the title on the cover. On the `color` cover it is always `true`. example: true cover_show_subtitle: type: boolean description: Shows the subtitle on the cover. On the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`, the image is shown whole, uncropped and with no text over it. example: false quote_update: type: object writeOnly: true description: Data to update a quote. All fields are optional. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ of the company the quote moves to, digits only. Omitted keeps the current company; null or empty is refused. A company where the credential has no permission at all is refused as a CNPJ not found. user_id: type: string format: uuid description: Identifier of the user who owns the quote, the same person `id` returned by [List people](#tag/People/paths/~1people/get). The person must be an active Monde user with access to the quote's company. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 person_id: type: string format: uuid nullable: true description: 'Identifier of the quote''s person (customer), from [List people](#tag/People/paths/~1people/get). Null removes the person from the quote, and an empty text is refused (422); omitted keeps the current one. Sending a person requires the "Read all people" permission: without it, the person is refused (422) as one that does not exist.' example: 212b54b8-27df-4859-80a9-79ad855bcd09 title: type: string description: Quote title example: Cancún subtitle: type: string nullable: true description: Quote subtitle. Optional. example: Lua de mel - 10 noites valid_until: type: string format: date description: Quote validity date (YYYY-MM-DD). Cannot be in the past. example: '2035-06-15' details: type: string nullable: true description: 'Quote content, in HTML. The HTML is cleaned before saving, with the same rules as the [guides](#tag/Guides/paths/~1guides/post) content. Optional: on creation, without it the content template of the company is used, the one saved by the administrator on the Quote Settings screen of Monde Web; sent as an empty text, the quote has no content.' example: "Pacote com aéreo, hospedagem e traslados.
" active: type: boolean description: Indicates whether the quote is active example: false internal_observations: type: string nullable: true description: Internal notes (not shown on the public link). Null clears the field, and an empty text is saved as sent; omitted keeps what the quote has. example: Cliente aceitou a proposta. cover_kind: type: string enum: - color - image - none description: 'Public link cover: `color` (a background color), `image` (an image) or `none` (no cover). The image can only be chosen in Monde Web: through the API, `image` is only accepted on a quote that already has one. Switching to another option deletes the image. Sending only `cover_color` already chooses `color`, and `color` without `cover_color` takes the primary color of the company''s Quote Settings.' example: none cover_color: type: string nullable: true description: 'Cover background color, in hexadecimal (`#1f4e79`). Only applies to the `color` cover; on the others it is null. The color is saved on the quote: changing the primary color of the Quote Settings later does not change the cover. The title is black on a light background and white on a dark one.' example: "#1f4e79" cover_show_title: type: boolean description: Shows the title on the cover. On the `color` cover it is always `true`. example: true cover_show_subtitle: type: boolean description: Shows the subtitle on the cover. On the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`, the image is shown whole, uncropped and with no text over it. example: true quote_duplication: type: object writeOnly: true description: Data the quote copy does not inherit from the original. required: - user_id - valid_until properties: user_id: type: string format: uuid description: Identifier of the user who owns the copy, the same person `id` returned by [List people](#tag/People/paths/~1people/get). The person must be an active Monde user with access to the quote's company. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 valid_until: type: string format: date description: Quote validity date (YYYY-MM-DD). Cannot be in the past. example: '2035-07-31' person_id: type: string format: uuid description: 'Identifier of the copy''s person (customer), from [List people](#tag/People/paths/~1people/get). Optional: without it, the copy has no person. Sending a person requires the "Read all people" permission: without it, the person is refused (422) as one that does not exist.' example: 7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f guide_summary: type: object description: Represents a guide in the list query, with the guide's own fields. properties: id: type: integer description: Unique guide identifier example: 42 title: type: string description: Guide title example: Lisboa subtitle: type: string nullable: true description: Guide subtitle. Optional. example: Roteiro de 5 dias details: type: string description: Guide content, in HTML. Images come as `Chegada e passeio pela Baixa.
" active: type: boolean description: Whether the guide is active. The public link only opens an active guide. Once deactivated, the guide leaves the trips that show it in the passenger app and does not return to them when reactivated. example: true public_url: type: string format: uri nullable: true description: Public viewing link of the guide. Null when the guide's company is read-only, does not have the Monde Pro license, or has a read-only Monde Pro license. example: https://suaviagem.app/guia/a1B2c3-lisboa internal_observations: type: string nullable: true description: Internal observations (not shown on the public link) example: Enviar junto com o voucher. cover_kind: type: string enum: - color - image - none description: 'Cover of the public link: `color` (a background color), `image` (an image), or `none` (no cover). The image can only be chosen in Monde Web: through the API, `image` only works on a guide that already has one. Switching to another option deletes the image. Sending only `cover_color` already chooses `color`, and `color` without `cover_color` gets `#5f6777`. The former `default` cover is still accepted on writes and works as `color` in `#5f6777`.' example: color cover_color: type: string nullable: true description: Background color of the cover, in hexadecimal (`#1f4e79`). Only applies to the `color` cover; with the others, it is null. The title is black on a light background and white on a dark one. example: "#1f4e79" cover_show_title: type: boolean description: Shows the title on the cover. Always `true` on the `color` cover. example: true cover_show_subtitle: type: boolean description: Shows the subtitle on the cover. On the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`, the image shows in full, uncropped and with no text over it. example: true hide_cover_text: type: boolean description: 'Kept for existing API users: `true` is the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`. On writes, `true` turns both off on the `image` cover and is ignored on the others, and `false` turns both on; `cover_show_title` and `cover_show_subtitle` sent along take precedence over it.' example: false cover_image_url: type: string format: uri nullable: true description: Temporary address of the cover image. Null when the cover is not `image`. example: created_at: type: string format: date-time description: Creation date and time example: '2024-03-15T10:30:00' updated_at: type: string format: date-time description: Date and time of the last update 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: Represents a guide registered in the system. allOf: - "$ref": "#/components/schemas/guide_summary" - type: object required: - company - user properties: company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Company of the guideChegada e passeio pela Baixa.
" active: type: boolean default: true description: Whether the guide is active. The public link only opens an active guide. Once deactivated, the guide leaves the trips that show it in the passenger app and does not return to them when reactivated. example: true cover_kind: type: string enum: - color - image - none - default description: 'Cover of the public link: `color` (a background color), `image` (an image), or `none` (no cover). The image can only be chosen in Monde Web: through the API, `image` only works on a guide that already has one. Switching to another option deletes the image. Sending only `cover_color` already chooses `color`, and `color` without `cover_color` gets `#5f6777`. The former `default` cover is still accepted on writes and works as `color` in `#5f6777`.' example: color cover_color: type: string description: Background color of the cover, in hexadecimal (`#1f4e79`). Only applies to the `color` cover; with the others, it is null. The title is black on a light background and white on a dark one. example: "#1f4e79" cover_show_title: type: boolean description: Shows the title on the cover. Always `true` on the `color` cover. example: true cover_show_subtitle: type: boolean description: Shows the subtitle on the cover. On the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`, the image shows in full, uncropped and with no text over it. example: true hide_cover_text: type: boolean description: 'Kept for existing API users: `true` is the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`. On writes, `true` turns both off on the `image` cover and is ignored on the others, and `false` turns both on; `cover_show_title` and `cover_show_subtitle` sent along take precedence over it.' example: false internal_observations: type: string description: Internal observations (not shown on the public link) example: Enviar junto com o voucher. guide_update: type: object writeOnly: true description: Data to update a guide. All fields are optional. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ of the company the guide moves to, digits only. Omitted, it keeps the current company; null or empty is refused. A company where the credential has no permission at all is rejected as a CNPJ not found. user_id: type: string format: uuid description: Identifier of the user who owns the guide, the same person `id` obtained in [List people](#tag/People/paths/~1people/get). The person must be an active Monde user with access to the guide's company. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 title: type: string description: Guide title example: Lisboa e Sintra subtitle: type: string nullable: true description: Guide subtitle. Optional. example: Roteiro de 6 dias details: type: string description: 'Guide content, in HTML. The HTML is cleaned before it is saved: paragraphs, headings, lists, tables, links, bold, italic, quotes, and code pass, and everything else becomes text or is discarded. A guide has two heading levels, `Bate-volta a Sintra.
" active: type: boolean description: Whether the guide is active. The public link only opens an active guide. Once deactivated, the guide leaves the trips that show it in the passenger app and does not return to them when reactivated. example: false cover_kind: type: string enum: - color - image - none - default description: 'Cover of the public link: `color` (a background color), `image` (an image), or `none` (no cover). The image can only be chosen in Monde Web: through the API, `image` only works on a guide that already has one. Switching to another option deletes the image. Sending only `cover_color` already chooses `color`, and `color` without `cover_color` gets `#5f6777`. The former `default` cover is still accepted on writes and works as `color` in `#5f6777`.' example: none cover_color: type: string nullable: true description: Background color of the cover, in hexadecimal (`#1f4e79`). Only applies to the `color` cover; with the others, it is null. The title is black on a light background and white on a dark one. example: "#1f4e79" cover_show_title: type: boolean description: Shows the title on the cover. Always `true` on the `color` cover. example: false cover_show_subtitle: type: boolean description: Shows the subtitle on the cover. On the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`, the image shows in full, uncropped and with no text over it. example: false hide_cover_text: type: boolean description: 'Kept for existing API users: `true` is the `image` cover with `cover_show_title` and `cover_show_subtitle` set to `false`. On writes, `true` turns both off on the `image` cover and is ignored on the others, and `false` turns both on; `cover_show_title` and `cover_show_subtitle` sent along take precedence over it.' example: true internal_observations: type: string nullable: true description: Internal observations (not shown on the public link). Null clears the field, and an empty text is saved as sent; omitted, it keeps what the guide has. example: Atualizado com o passeio a Sintra. guide_duplication: type: object writeOnly: true description: Data the guide copy does not inherit from the original. required: - user_id properties: user_id: type: string format: uuid description: Identifier of the user who owns the copy, the same person `id` returned by [List people](#tag/People/paths/~1people/get). The person must be an active Monde user with access to the guide's company. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 invoice_rule_summary: type: object description: Represents a billing rule in the list read, with the register's own fields. properties: id: type: string format: uuid description: Unique rule identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Rule description (copied to the generated invoices) example: Faturamento semanal aéreo person_kind: type: string enum: - customer - supplier - representative description: " Kind of the rule owner.customer: customer.supplier: supplier.representative:
representative.every:
all.national: national.international:
international.cruise: cruise (available only for
the Travel Insurance product).every_movement
and has no effect. every_movement: all.to_pay:
payable to the supplier.to_receive: receivable
from the supplier.standalone: standalone — each sale in its own invoice
(item by item).daily: daily — one period per
day.weekly: weekly — Monday to Sunday.weekly_iata: weekly on the IATA calendar — due date
counted in business days (see days_to_skip).weekly_inside_month:
weekly within the month — Monday to Sunday, but a week never crosses
into the next month; the last week of the month is cut on the 1st.decendial: every ten days — ranges 1 to 10, 11 to
20, and 21 to 31.fortnightly: fortnightly —
ranges 1 to 15 and 16 to 31.monthly: monthly
— from day 1 to the last day of the month.custom:
custom — day ranges defined manually in custom_period.after_sale_date: after the sale date.before_checkin: before check-in.after_checkin:
after check-in.before_checkout: before check-out.after_checkout: after check-out.stay: keeps the date.next:
moves to the next business day.previous: moves
to the previous business day.singlemarriedseparateddivorcedwidowedcivil_unionapportionments.per_cost_center.
example: Alteração de pax
checked:
type: boolean
description: Indicates whether the item was checked.
example: false
amount:
type: number
format: double
description: Item amount, with its own sign indicating the direction of
that item flow. Since the entry amount is always the magnitude,
unsigned, the items add up to +amount when transaction_kind
is credit and to -amount when it is debit.
example: -4.0
side:
type: string
enum:
- vendor
- customer
description: |-
Side of the item in the invoice. customer: a customer amount, such as what they paid straight to the supplier or the sale balance.vendor: a supplier amount, such as the product cost to pay.invoice: to invoice.refund: refund.signal: down payment.lei_kandir: Lei Kandir.reversal: reversal.leftover: sale balance.retained: retained by the intermediary.fine: fine.cvc: CVC.generated_credit: generated credit.customer items and the supplier on vendor items. sale_product, when the reconciliation lands on an item that already has a sale product, or on its own, when the item came only from the statement. 362-1, which is why
this field is a string and not a number.
example: '12345'
transaction_kind:
type: string
enum:
- credit
- debit
description: 'Nature of the entry. credit: account
receivable.debit: account payable.normal: standalone
entry.sale_payment: sale payment.sale_standalone:
sale standalone.vendor_standalone: vendor standalone.vendor_invoice:
vendor invoice.customer_invoice: customer invoice.credit_card_invoice:
credit card invoice.commission: commission.pending while it is not generated yet,
generated once it is, and retrying when the
last attempt failed. Monde retries on its own, so retrying
may still become generated. Null when the entry is neither
an installment nor a recurrence.'
example: generated
observations:
type: string
nullable: true
description: Entry notes.
example:
billet:
allOf:
- "$ref": "#/components/schemas/bill_billet"
description: Billet data; null when the entry has neither a billet number
nor a billing account.
check:
allOf:
- "$ref": "#/components/schemas/bill_check"
description: Check data recorded on the bill; null when the payment was
not by check.
card:
allOf:
- "$ref": "#/components/schemas/bill_card"
description: Card data recorded on the bill; null when the payment was not
by card.
required:
- id
- transaction_kind
- kind
- amount
- final_amount
- canceled
bill:
type: object
description: Full detail of an account payable or receivable.
properties:
id:
type: string
format: uuid
description: Unique identifier of the entry.
example: 212b54b8-27df-4859-80a9-79ad855bcd09
number:
type: string
nullable: true
description: Sequential number of the entry. Installment entries get a suffix
with the installment number, such as 362-1, which is why
this field is a string and not a number.
example: '12345'
transaction_kind:
type: string
enum:
- credit
- debit
description: 'Nature of the entry. credit: account
receivable.debit: account payable.normal: standalone
entry.sale_payment: sale payment.sale_standalone:
sale standalone.vendor_standalone: vendor standalone.vendor_invoice:
vendor invoice.customer_invoice: customer invoice.credit_card_invoice:
credit card invoice.commission: commission.sale_id),
which stays in the sale company: there it may be omitted and, when sent,
it must be that company CNPJ.'
sale_id:
type: string
format: uuid
description: Sale on which the account payable or receivable is posted,
by the id from GET /sales, like the button on the sale Financial
tab in Monde. The entry is created as a sale standalone entry (sale_standalone),
in the sale company. It cannot be combined with operation_id
or with installments or recurrence.
example: 5b1d2c3e-6f7a-4b8c-9d0e-1f2a3b4c5d6e
transaction_kind:
type: string
enum:
- credit
- debit
description: 'Nature of the entry: credit (account receivable)
or debit (account payable).'
example: debit
person_id:
type: string
format: uuid
description: Person of the entry (customer or supplier), by the id from
GET /people.
example: c3b7e8eb-1199-4457-9170-923c3fe56c92
description:
type: string
maxLength: 50
description: Entry description, up to 50 characters. Of the 60 Monde stores,
10 are reserved for what the system itself appends, such as the " 1/3"
installment suffix and the " 1/2" of a partial payment.
example: Aluguel escritório - Outubro/2026
document:
type: string
maxLength: 50
description: Reference document, such as the invoice number, up to 50 characters.
example: NF 1001
amount:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
description: Entry amount, greater than zero, with up to 2 decimal places.
example: 1500.0
currency:
type: string
minLength: 3
maxLength: 3
description: 'ISO 4217 code of the entry currency, among the active currencies.
When omitted, the entry is in Real (BRL). Another currency
is only accepted when Monde works with more than one: on a tour operator
or with multicurrency. The amount, the categories and the movements come
in it; a movement in an account of another currency is converted by exchange_rate.'
example: USD
issue_date:
type: string
format: date
description: Issue date in ISO 8601 format (YYYY-MM-DD). When omitted, it
is today, or the due date or the settlement date when they are earlier.
It cannot be later than the due date or the settlement date.
example: '2026-10-07'
due_date:
type: string
format: date
description: Due date in ISO 8601 format (YYYY-MM-DD). For accounts receivable,
it is subject to the company's due date lock.
example: '2026-10-15'
account_id:
type: string
format: uuid
description: Account expected for the settlement, by the id from GET
/accounts. It must be active and linked to the entry's company,
of any type, including a credit card account on accounts receivable. When
omitted, the company's default forecast account applies.
example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01
operation_id:
type: string
format: uuid
description: Own operation, by the id of the own operation product. It must
be active. Travel agencies only.
example: 1f0e2d3c-4b5a-4978-8a9b-0c1d2e3f4a5b
observations:
type: string
description: Entry notes.
example: Contrato 2026/10
billing_account_id:
type: string
format: uuid
description: Billing account of the bank slip, by the id in billing_accounts
of GET /accounts/{id}. Receivables only. It must be active
and of an active bank account of the entry company. The entry starts forecasting
the income in the bank account of the billing account, and the bank slip
is numbered; on a registered billing account, like PJBank's, the bank
slip stays pending registration and Monde sends it to the bank.
example: 6b7c2d1e-3f4a-4b5c-8d9e-0f1a2b3c4d5e
billet_demonstrative:
type: string
description: Demonstrative of the bank slip, the text printed on it. Receivables
only.
example: Não receber após 30 dias do vencimento.
categories:
type: array
minItems: 1
description: Entry categories, at least one. Their signed sum is the final
amount.
items:
"$ref": "#/components/schemas/bill_category_create"
apportionments:
type: object
description: Entry apportionments. Travel agencies only.
properties:
per_cost_center:
type: array
description: Cost center apportionment, as a percentage of the final
amount. The total may be between 0 and 100%, and the same cost center
cannot repeat.
items:
"$ref": "#/components/schemas/bill_cost_center_create"
per_company:
type: array
description: Split between companies, as a percentage of the final amount.
When sent, the total must be exactly 100%, and the same company cannot
repeat.
items:
"$ref": "#/components/schemas/bill_company_apportionment_create"
custom_fields:
type: array
description: Finance custom fields, by the id from GET /custom_fields.
Required ones must be sent.
items:
"$ref": "#/components/schemas/custom_field"
settlement_date:
type: string
format: date
description: Settlement date in ISO 8601 format (YYYY-MM-DD), sent with
movements to create the entry already settled. It cannot
be later than the last movement date.
example: '2026-10-10'
movements:
type: array
description: Settlement movements, sent with settlement_date.
Without balance_resolution, they must add up to the final
amount.
items:
"$ref": "#/components/schemas/bill_movement_create"
partial_payment:
type: boolean
description: 'Partial payment, the same as balance_resolution
as partial: with true and movements adding up
to less than the final amount, the entry is settled with what was paid
and the balance becomes a new open entry, referenced in generated_bills.
It cannot be combined with installments or recurrence. Sent with balance_resolution,
it must say the same.'
example: true
balance_resolution:
type: string
enum:
- category
- partial
description: 'What to do with the difference between what was paid and the
final amount, in an entry created already settled: category
posts the difference to a discount or surcharge category; partial
settles what was paid and creates an open entry with the balance, only
when less was paid. It cannot be combined with installments or recurrence.'
example: category
balance_category_id:
type: string
format: uuid
description: 'Only with balance_resolution as category:
the category of the difference, by the id from GET /categories.
Without it, the company''s default category applies.'
example: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
recurrence_kind:
type: string
enum:
- installment
- recurrent
description: 'Creates the series from the entry, in the background: installment
or recurrent (for the next 5 years). Requires periodicity.
The series entries are fetched by the recurrence_group_id
in the response.'
example: installment
periodicity:
type: string
enum:
- weekly
- biweekly
- monthly
- bimonthly
- quarterly
- semiannual
- annual
description: 'Interval between the series entries: weekly,
biweekly (15 days), monthly, bimonthly,
quarterly, semiannual or annual.'
example: monthly
installments:
type: integer
minimum: 2
maximum: 200
description: Total number of installments, from 2 to 200, counting the entry
itself. Each installment repeats the full amount.
example: 3
bill_update:
type: object
writeOnly: true
description: Fields of an account payable or receivable that can be changed.
Only the ones sent change.
properties:
person_id:
type: string
format: uuid
description: Person of the entry (customer or supplier), by the id from
GET /people. Cannot be empty.
example: c3b7e8eb-1199-4457-9170-923c3fe56c92
description:
type: string
maxLength: 50
description: Description of the entry, up to 50 characters. Cannot be empty.
example: Aluguel escritório - Novembro/2026
document:
type: string
nullable: true
maxLength: 50
description: Reference document, such as the invoice number, up to 50 characters.
Null clears it; empty text is saved.
example: NF 1002
issue_date:
type: string
format: date
description: Issue date in ISO 8601 format (YYYY-MM-DD). Cannot be later
than the due date.
example: '2026-10-07'
due_date:
type: string
format: date
description: Due date in ISO 8601 format (YYYY-MM-DD). In accounts receivable,
it is subject to the company's due date block.
example: '2026-11-15'
account_id:
type: string
format: uuid
description: Forecast account for the settlement, by the id from GET
/accounts. Must be active and linked to the entry's company.
example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01
operation_id:
type: string
nullable: true
format: uuid
description: Own operation, by the id of the own operation product. Must
be active. Agencies and standalone entries without an invoice number only.
Null clears it.
example: 1f0e2d3c-4b5a-4978-8a9b-0c1d2e3f4a5b
observations:
type: string
nullable: true
description: Observations of the entry. Null clears them; empty text is
saved.
example: Vencimento renegociado com o locador
billing_account_id:
type: string
format: uuid
nullable: true
description: 'Billing account of the bank slip, by the id in billing_accounts
of GET /accounts/{id}. Receivables only, with the rules of
the creation. It only changes while there is no live bank slip at the
bank: an issued bank slip, and one registered or on its way to the bank,
lock the account. On a client invoice, it only applies to a closed invoice:
see close_invoice. Null removes the billing account.'
example: 6b7c2d1e-3f4a-4b5c-8d9e-0f1a2b3c4d5e
billet_demonstrative:
type: string
nullable: true
description: 'Demonstrative of the bank slip, the text printed on it. Receivables
only. Null or empty text clears it: Monde does not store an empty demonstrative.'
example: Não receber após 30 dias do vencimento.
close_invoice:
type: boolean
description: 'Confirms closing the open client invoice along with the billing
account: true closes the invoice and writes the billing account
in the same call, with the rules and the Fechar Fatura permission of Close
a client invoice. Without it, a billing account on an open client
invoice answers 409.'
example: true
company_identifier:
allOf:
- "$ref": "#/components/schemas/company_identifier"
description: CNPJ of the company the entry moves to. The credential must
be able to create entries there. An entry with a registered or issued
billet does not change company.
amount:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
description: Amount of the entry, greater than zero, with up to 2 decimal
places. Without categories, the single category follows the
new amount; with more than one, it must equal their sum.
example: 1500.0
categories:
type: array
minItems: 1
description: Categories of the entry, at least one. They replace the current
ones, and their signed sum is the final amount.
items:
"$ref": "#/components/schemas/bill_category_create"
apportionments:
type: object
nullable: true
description: Apportionments of the entry. Agencies only. Each one sent replaces
the current one; the one not sent stays as it is.
properties:
per_cost_center:
type: array
nullable: true
description: Cost center apportionment, as a percentage of the final
amount, between 0 and 100%. An empty list removes it.
items:
"$ref": "#/components/schemas/bill_cost_center_create"
per_company:
type: array
nullable: true
description: Apportionment across companies, as a percentage of the
final amount. When sent, the total must be exactly 100%. An empty
list removes it.
items:
"$ref": "#/components/schemas/bill_company_apportionment_create"
recurrence_scope:
type: string
enum:
- only_this
- this_and_following
description: 'Only for installment or recurrent entries: only_this
(default) changes this entry only; this_and_following changes
this entry and the following ones of the series, in the background; each
following entry only changes when the credential could change it directly.'
example: this_and_following
custom_fields:
type: array
description: Custom fields of the financial module, by the id from GET
/custom_fields. Each one sent is written over the current one;
the others stay.
items:
"$ref": "#/components/schemas/custom_field"
settlement_date:
type: string
format: date
description: Settled entries only. Settlement date in ISO 8601 format (YYYY-MM-DD).
Cannot be empty or later than the date of the last movement.
example: '2026-10-12'
movements:
type: array
description: Settled entries only. Movements the entry already has, each
one by its id, with what changes in it, and the new ones, without id,
complete. The ones not sent stay as they are; movements cannot be removed.
items:
"$ref": "#/components/schemas/bill_movement_update"
undo_bank_reconciliation:
type: boolean
description: 'Confirms a change that undoes the bank reconciliation: true
writes it, and the reconciliation of the movement whose amount, date or
account changed is undone. Without it, such a change answers 409; one
that does not touch the reconciled movements is written without it.'
example: true
bill_movement_update:
type: object
writeOnly: true
properties:
id:
type: string
format: uuid
description: Id of the entry's movement, from movements in
the query by ID. Without it, the movement is new, and account_id,
payment_method_id, date and amount
are required.
example: 6b1d0c2e-8f3a-4d5b-9e7c-1a2b3c4d5e6f
account_id:
type: string
format: uuid
description: Account the money came into or out of, by the id from GET
/accounts. Must be active and linked to the entry's company.
example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01
payment_method_id:
type: string
format: uuid
description: Payment method, by the id from GET /payment_methods.
Cash and check accounts take cash or check; a credit card account takes
only credit card.
example: fc9f5c65-71b2-4bab-ba56-aee44fe6d998
date:
type: string
format: date
description: Date of the movement in ISO 8601 format (YYYY-MM-DD). In accounts
receivable, it is subject to the company's movement date block.
example: '2026-10-12'
amount:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
description: 'Amount of the movement, in the entry''s currency, greater
than zero. With a card fee, it is what the customer paid, and the account
receives the amount less the fee: in Get
account movement by ID, it is amount plus card_rate.
The movements, net of the fees, must add up to the final amount.'
example: 1600.0
card_rate:
type: number
format: double
multipleOf: 0.01
minimum: 0
description: Card fee of the movement, greater than or equal to zero. Only
on accounts receivable, in a checking account and with the credit or debit
card payment method. Sent alone, it keeps what the customer paid and changes
what went into the account. Null means zero.
example: 32.0
installments:
type: integer
minimum: 1
maximum: 99
description: 'New movement only, without id: installments, from 1 to 99.
More than one only on a credit card account, where each installment enters
the invoice of its month. The installments of a stored movement do not
change.'
example: 1
check:
type: object
description: Check data, only with the check payment method.
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: Card data, only with the credit or debit card payment methods.
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: Account payable or receivable created successfully.
allOf:
- "$ref": "#/components/schemas/bill"
- type: object
required:
- generated_bills
properties:
generated_bills:
type: array
description: 'Entry generated in the same call: the partial payment''s
balance. Empty when there is none. It is read by GET /bills/{id}.
Installments and recurrences do not come here: they are generated in
the background and fetched by recurrence_group_id.'
items:
"$ref": "#/components/schemas/entity_reference"
bill_settlement:
type: object
writeOnly: true
description: Data to settle an open account payable or receivable.
required:
- settlement_date
- movements
properties:
settlement_date:
type: string
format: date
description: Settlement date in ISO 8601 format (YYYY-MM-DD). It cannot
be later than the date of the last movement, nor earlier than the issue
date.
example: '2026-10-14'
movements:
type: array
minItems: 1
description: 'Settlement movements, at least one: one per account the money
came into or left. Without balance_resolution, they must
add up to the final amount.'
items:
"$ref": "#/components/schemas/bill_movement_create"
balance_resolution:
type: string
enum:
- category
- partial
description: 'What to do with the difference between what was paid and the
final amount: category posts the difference to a discount
or surcharge category; partial settles what was paid and
creates an open entry with the balance, only when less was paid.'
example: category
balance_category_id:
type: string
format: uuid
description: 'Only with balance_resolution as category:
the category of the difference, by the id from GET /categories.
Without it, the company''s default category applies.'
example: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
bill_settled:
description: Account payable or receivable settled successfully.
allOf:
- "$ref": "#/components/schemas/bill"
- type: object
required:
- generated_bills
properties:
generated_bills:
type: array
description: The open entry with the balance of the partial payment, created
in the same call. Empty in the other cases.
items:
"$ref": "#/components/schemas/entity_reference"
bill_batch_settlement:
type: object
writeOnly: true
description: Data to settle several open entries at once, each one for its whole
final amount.
required:
- bill_ids
- settlement_date
- account_id
properties:
bill_ids:
type: array
minItems: 1
maxItems: 100
uniqueItems: true
description: Ids (UUID) of the entries to settle, from 1 to 100, without
repeating. All of them must be in the same currency.
items:
type: string
format: uuid
example:
- 212b54b8-27df-4859-80a9-79ad855bcd09
- 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f
settlement_date:
type: string
format: date
description: Settlement date in ISO 8601 format (YYYY-MM-DD), the same for
every entry. It is also the date of the movements, and the issue date
of each entry cannot be later than it.
example: '2026-10-14'
account_id:
type: string
format: uuid
description: 'Account the money came into or left, the same for every entry:
active and linked to the companies of all of them.'
example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01
use_sale_data:
type: boolean
default: false
description: With true, each sale payment is settled with the
payment method and the check or card data of its own sale, like the Monde
"Liquidar usando dados da venda". It only applies when every entry is
a sale payment, and then payment_method_id, check
and card are not accepted.
example: false
payment_method_id:
type: string
format: uuid
description: Payment method, the same for every entry, which follows the
account type. Omitted, each entry has no payment method in the movement.
Not accepted with use_sale_data set to true.
example: fc9f5c65-71b2-4bab-ba56-aee44fe6d998
installments:
type: integer
minimum: 1
maximum: 99
description: Installments, from 1 to 99. More than one only in a credit
card account, where each installment goes into its month's invoice.
example: 1
check:
type: object
description: Check data, only with the check payment method, which requires
the number. Not accepted with use_sale_data set to 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: Card data, only with the credit or debit card payment methods.
Not accepted with use_sale_data set to 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: Exchange rate from the entries' currency to the account's currency,
the same for all of them, when the two differ. Omitted, the latest exchange
rate applies; sent with the account in the entries' currency, it is ignored.
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: Account the money entered or left, by the id from GET
/accounts. It must be active and linked to the entry's company.
On accounts receivable, the credit card account is the refund, which goes
into the card invoice.
example: 8d2f1a90-4b7e-4c11-9f3a-5e6d7c8b9a01
payment_method_id:
type: string
format: uuid
description: 'Payment method, by the id from GET /payment_methods.
Cash and check accounts accept cash or check; a credit card account accepts
only credit card; a checking account accepts the others. On the settlement
of a sale payment (sale_payment) it is optional: when absent,
the sale''s payment method applies.'
example: fc9f5c65-71b2-4bab-ba56-aee44fe6d998
date:
type: string
format: date
description: Movement date in ISO 8601 format (YYYY-MM-DD). For accounts
receivable, it is subject to the company's movement date lock, and the
cash day cannot be closed.
example: '2026-10-10'
amount:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
description: Movement amount in the entry currency, greater than zero, with
up to 2 decimal places. With a card fee, it is what the customer paid,
and the account receives the amount less the fee. In an account in another
currency, it is converted by the latest rate (or, on the settlement, by
the exchange_rate sent); without a registered rate or a rate
sent, the movement is rejected.
example: 420.0
card_rate:
type: number
format: double
multipleOf: 0.01
minimum: 0
description: Card operator fee, greater than or equal to zero and less than
amount. Only on accounts receivable, in a checking account
and with the credit or debit card payment method. The sum of the fees
becomes the card fee category configured in the company.
example: 0
installments:
type: integer
minimum: 1
maximum: 99
description: Installments, from 1 to 99. More than one only in a credit
card account, where each installment goes into its month's invoice.
example: 1
check:
type: object
description: 'Check data, only with the check method: number
(required, digits only), bank and 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: 'Card data, only with the credit or debit card methods: brand,
last_digits and 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: 'Exchange rate that converts the entry currency into the account
currency: how much one unit of the entry currency is worth in the account
currency. Greater than zero; saved with 6 decimal places, and anything
beyond them is rounded. It only applies when the account is in another
currency, and the account receives amount times the rate.
When omitted, the latest rate applies, as Monde suggests when settling;
send the rate used by the bank to record the amount that actually came
in. With it, a missing registered rate does not reject the movement. In
an account in the entry currency, it is ignored.'
example: 5.4321
reference_exchange_rate:
type: number
format: double
exclusiveMinimum: 0
description: 'Reference exchange rate, which converts the account currency
into BRL: how much one unit of the account currency is worth in BRL. Greater
than zero; saved with 6 decimal places, and anything beyond them is rounded.
It only applies to an account outside BRL. When omitted, the latest rate
of the account currency applies, as Monde suggests when settling. In an
account in BRL, it is ignored.'
example: 5.4321
bill_category_create:
type: object
writeOnly: true
required:
- category_id
- amount
properties:
category_id:
type: string
format: uuid
description: Category, by the id from GET /categories.
example: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
amount:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
description: Category amount, greater than zero, with up to 2 decimal places.
example: 1200.0
description:
type: string
maxLength: 50
description: Line description, up to 50 characters.
example: Aluguel
bill_cost_center_create:
type: object
writeOnly: true
required:
- cost_center_id
- percentage
properties:
cost_center_id:
type: string
format: uuid
description: Cost center, by the id from GET /cost_centers.
example: 0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d
percentage:
type: number
format: double
minimum: 0
maximum: 100
description: Percentage, from 0 to 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 of the apportionment company. The credential must be able
to create entries in it.
percentage:
type: number
format: double
minimum: 0
maximum: 100
description: Percentage, from 0 to 100.
example: 100.0
bills_response:
type: object
description: Response containing the list of accounts payable and receivable
with pagination information.
properties:
data:
type: array
description: Array containing the accounts payable and receivable of the
current page.
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: Check number
example: 4567
bank:
type: string
nullable: true
description: Clearing code of the check bank
example: '341'
document:
type: string
nullable: true
description: Taxpayer id (CPF or CNPJ) of the check issuer, digits only
example: '03832060901'
account_movement_card:
type: object
nullable: true
properties:
brand:
type: string
nullable: true
description: Card brand
example: MasterCard
last_digits:
type: string
nullable: true
description: Last digits of the card
example: '4117'
authorization:
type: string
nullable: true
description: Authorization code from the card operator
example: '600551159'
account_movement_summary:
type: object
description: Summary of an account movement, as returned by the list endpoint.
properties:
id:
type: string
format: uuid
description: Unique identifier of the account movement
example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42
date:
type: string
format: date
nullable: true
description: Date of the movement in the account
example: '2026-01-26'
amount:
type: number
format: double
description: Amount of the movement, negative when money goes out of the
account
example: -9112.17
transaction_kind:
type: string
enum:
- credit
- debit
description: |-
Direction of the movement, derived from the sign of the amount. credit: money coming into the account.debit: money going out of the account.credit: money coming into the account.debit: money going out of the account.amount plus the fee. Zero when there is no fee.'
example: 0
account:
allOf:
- "$ref": "#/components/schemas/entity_reference"
nullable: true
description: |-
Account the movement was posted to customer: customer refund.vendor: supplier or representative refund.customer: the agency gives the amount back to the customer.vendor: refund with the product vendor or representative.credit: the agency receives. Vendor refund only, and its default.debit: the agency pays. The only one accepted on a customer refund, and its default.invoice: goes to the invoice by the billing rules.bill: generates right away a separate invoice with it alone.unissued: not issued.issued: issued.processing: invoice transmitted, awaiting the response.processing_cancellation: cancellation transmitted, awaiting the response.awaiting_processing: invoice not transmitted yet, queued for issue.canceled: canceled.awaiting_issue: awaiting issue.awaiting_cancellation: awaiting cancellation.payer: payer.supplier: supplier.representative: representative.payer: payer.supplier: supplier.representative: representative.insertion: record created.edition: record changed.deletion: record deleted.custom: custom action of the screen that generated the entry.export: data export.email: e-mail sent from the record, such as the billet or the invoice of a bill. The description lists the recipients and the attached files.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
and viagem. A report export records the screen name instead
of the resource, as in vendas por produto. Null on old entries,
recorded before the origin started being filled in.
example: financeiro_categoria
description: &738
type: string
description: Description of the change, in the text recorded when it happened.
It brings one line per changed field, separated by a CRLF line break,
which comes escaped as \r\n in the JSON. On a log written by an API request,
the first line names the action and the credential that made it, and the
changed fields come in the following lines
example: Valor de "10" para "20"
created_at: &739
type: string
format: date-time
description: Date and time the change was recorded
example: '2026-08-05T09:12:33'
required:
- id
- kind
- description
- created_at
log:
type: object
description: Represents a history entry with the references to the author and
to the audited record.
properties:
id: *735
kind: *736
origin: *737
description: *738
created_at: *739
person:
allOf:
- "$ref": "#/components/schemas/entity_reference"
nullable: true
description: |-
Author of the change. Null when the entry was generated by the system or by the API numeric: integer number.currency: monetary value.text: free text.date: date.choices: one of the registered options (see choices).choices).
Empty on the other kinds.
example:
- Matriz
- Filial
required:
- id
- resource
- name
- kind
- required
- active
- choices
custom_fields_response:
type: object
description: Response containing the list of custom fields with pagination information.
properties:
data:
type: array
description: Array containing the custom fields of the current page.
items:
"$ref": "#/components/schemas/custom_field_definition"
pagination:
"$ref": "#/components/schemas/pagination"
commission_plan_summary:
type: object
description: A commission plan in the list.
properties:
id:
type: string
format: uuid
description: Unique identifier of the commission plan
example: 6b5a4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d
description:
type: string
description: Plan name
example: Plano padrão
required:
- id
- description
commission_plan:
description: A commission plan, with its goal ranges.
allOf:
- "$ref": "#/components/schemas/commission_plan_summary"
- type: object
properties:
goal_ranges:
type: array
description: Goal ranges of the plan, by achieved percentage.
items:
"$ref": "#/components/schemas/commission_plan_goal_range"
required:
- goal_ranges
commission_plan_goal_range:
type: object
description: Goal range of the plan.
properties:
id:
type: string
format: uuid
description: Identifier of the range, used to keep it on update
achieved_percentage:
type: number
description: Percentage of the month goal from which the range applies
example: 100.0
products:
type: array
description: Products of the range. The entry with a null `product` applies
to all products.
items:
"$ref": "#/components/schemas/commission_plan_product"
required:
- id
- achieved_percentage
- products
commission_plan_product:
type: object
description: Product of the range, with the values of each role.
properties:
id:
type: string
format: uuid
description: Identifier of the product entry in the range, used to keep
it on update
product:
allOf:
- "$ref": "#/components/schemas/entity_reference"
nullable: true
description: Product of the entry. Null in the all-products entry.
rules:
type: array
description: Commission values of each role in the product.
items:
"$ref": "#/components/schemas/commission_plan_rule"
required:
- id
- product
- rules
commission_plan_rule:
type: object
description: Commission values of a role in the product of the range.
properties:
id:
type: string
format: uuid
description: Identifier of the rule, used to keep it on update
person_role:
allOf:
- "$ref": "#/components/schemas/entity_reference"
description: Commissioned role
commission_type: &740
type: string
enum:
- percentage
- amount
description: "`percentage` for a percentage over the sale fields, `amount`
for a fixed amount per sold product. Omitted in a new rule, it is `percentage`."
example: percentage
percentage: &741
type: number
description: Commission percentage, up to 4 decimal places, not negative.
In an `amount` commission, it is ignored and saved as zero.
example: 5.0
amount: &742
type: number
description: Fixed commission amount per sold product, not negative. In
a `percentage` commission, it is ignored and saved as zero.
example: 0.0
calculated_on: &743
type: array
description: 'Sale fields the percentage is calculated over. Discounts (`discount`,
`rav_fee_discount`, `du_fee_discount`), card fees (`cc_du_fee`, `cc_rav_fee`,
`agency_card_rate`), deductions (`deductions`) and the deleted balance
(`deleted_balance`) are subtracted; refunds (`customer_refund`, `vendor_refund`)
and the supplier fine (`supplier_fine`) keep the sign they have in the
revenue: the customer refund, a refund paid to the vendor and the fine
lower the amount; the intermediary commission and over (`intermediary_commission_amount`,
`intermediary_over_amount`) are subtracted for every role except the intermediary
one; the others are added. `revenue` cannot go together with the values
it is made of. Required, with at least one field, in a `percentage` commission;
in an `amount` one, it is ignored and saved empty.'
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` when a sale with an intermediary uses the values of
`with_intermediary`"
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: 'Commission values for sales with an intermediary, used when `differentiate_intermediary`
is `true`. Same rules as `commission_type`, `percentage`, `amount` and `calculated_on`.
With `differentiate_intermediary` `false`, they are zeroed: type `percentage`,
values 0 and no fields.'
properties:
commission_type: *740
percentage: *741
amount: *742
calculated_on: *743
goal:
type: object
description: The goal of a person in a role for a year.
properties:
id:
type: string
format: uuid
description: Unique identifier of the goal
example: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a
person_role:
allOf:
- "$ref": "#/components/schemas/entity_reference"
description: Role of the person
person:
allOf:
- "$ref": "#/components/schemas/entity_reference"
description: Person
commission_plan:
allOf:
- "$ref": "#/components/schemas/entity_reference"
nullable: true
description: Commission plan of the person in the role, from the roles registry.
Null when the person has no plan.
year:
type: integer
description: Year of the goal
example: 2026
months:
"$ref": "#/components/schemas/goal_months"
required:
- id
- person_role
- person
- commission_plan
- year
- months
goal_months:
type: object
description: Goal amount of each month, from `january` to `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: Represents a bank from the reference table.
properties:
id:
type: string
format: uuid
description: Unique identifier of the bank. It is the value used in `bank.id`
when registering a checking account.
example: c3b7e8eb-1199-4457-9170-923c3fe56c92
number:
type: string
maxLength: 5
description: Bank (clearing) number
example: '001'
name:
type: string
description: Bank name
example: Banco do Brasil S.A.
required:
- id
- number
- name
bank_reconciliation_summary:
type: object
description: Statement uploaded to reconcile a checking account.
properties:
id:
type: string
format: uuid
description: Statement identifier (UUID).
example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10
account:
description: Reconciled checking account.
allOf:
- "$ref": "#/components/schemas/entity_reference"
file_name:
type: string
description: Uploaded file name.
example: extrato-janeiro.ofx
bank_code:
type: string
nullable: true
description: Bank code declared in the file.
example: '033'
branch:
type: string
nullable: true
description: Branch declared in the file.
example: '1234'
account_number:
type: string
nullable: true
description: Account number declared in the file.
example: 56789-0
currency:
type: string
description: Statement currency.
example: BRL
period_start:
type: string
format: date
description: Statement period start.
example: '2025-01-01'
period_end:
type: string
format: date
description: Statement period end.
example: '2025-01-31'
ledger_balance:
type: number
nullable: true
description: Balance informed by the bank.
example: 15230.45
ledger_balance_date:
type: string
format: date
nullable: true
description: Date of the bank balance.
example: '2025-01-31'
lines:
type: object
description: What the upload did with the file lines.
properties:
inserted:
type: integer
description: Lines the file brought for the first time.
example: 42
existing:
type: integer
description: Lines the account already had from another upload.
example: 3
corrected:
type: integer
description: Bank corrections (CORRECTFITID) applied.
example: 0
uncorrected:
type: integer
description: Bank corrections left pending.
example: 0
warnings:
type: array
description: Warnings from comparing the file with the account (bank, branch
or number that do not match).
items:
type: string
created_at:
type: string
description: Upload date and time.
example: '2025-02-03T10:15:00'
bank_reconciliation:
type: object
description: Statement with the reconciliation summary.
properties:
id:
type: string
format: uuid
description: Statement identifier (UUID).
example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10
account:
description: Reconciled checking account.
allOf:
- "$ref": "#/components/schemas/entity_reference"
file_name:
type: string
description: Uploaded file name.
example: extrato-janeiro.ofx
bank_code:
type: string
nullable: true
description: Bank code declared in the file.
example: '033'
branch:
type: string
nullable: true
description: Branch declared in the file.
example: '1234'
account_number:
type: string
nullable: true
description: Account number declared in the file.
example: 56789-0
currency:
type: string
description: Statement currency.
example: BRL
period_start:
type: string
format: date
description: Statement period start.
example: '2025-01-01'
period_end:
type: string
format: date
description: Statement period end.
example: '2025-01-31'
ledger_balance:
type: number
nullable: true
description: Balance informed by the bank.
example: 15230.45
ledger_balance_date:
type: string
format: date
nullable: true
description: Date of the bank balance.
example: '2025-01-31'
lines:
type: object
description: What the upload did with the file lines.
properties:
inserted:
type: integer
description: Lines the file brought for the first time.
example: 42
existing:
type: integer
description: Lines the account already had from another upload.
example: 3
corrected:
type: integer
description: Bank corrections (CORRECTFITID) applied.
example: 0
uncorrected:
type: integer
description: Bank corrections left pending.
example: 0
warnings:
type: array
description: Warnings from comparing the file with the account (bank, branch
or number that do not match).
items:
type: string
created_at:
type: string
description: Upload date and time.
example: '2025-02-03T10:15:00'
situations:
type: object
description: How many lines are in each situation, in the whole statement.
properties:
ambiguous:
type: integer
description: Lines where more than one entry tied.
example: 1
bank_only:
type: integer
description: Lines without an entry in Monde.
example: 4
system_only:
type: integer
description: Entries without a bank line.
example: 2
suggested:
type: integer
description: Linked lines not yet verified.
example: 10
reconciled:
type: integer
description: Reconciled lines.
example: 28
pending_count:
type: integer
description: How many are left to reconcile.
example: 17
reconciled_count:
type: integer
description: How many are reconciled.
example: 28
balance:
type: object
description: Bank balance compared with the system balance.
properties:
date:
type: string
format: date
nullable: true
description: 'Comparison date: the period end.'
example: '2025-01-31'
bank:
type: number
nullable: true
description: Bank balance, on the date the bank reported (`ledger_balance_date`).
example: 15230.45
system:
type: number
description: 'System balance on the date: account initial balance plus
movements up to it.'
example: 15180.45
difference:
type: number
nullable: true
description: Bank minus system. Null when the file has no bank balance
or reports it on a date other than the period end.
example: 50.0
bank_reconciliations_response:
type: object
description: Paginated list of statements.
properties:
data:
type: array
items:
"$ref": "#/components/schemas/bank_reconciliation_summary"
pagination:
"$ref": "#/components/schemas/pagination"
bank_statement_upload:
type: object
description: Statement upload, as multipart/form-data.
required:
- account_id
- file
properties:
account_id:
type: string
format: uuid
description: Active checking account to reconcile (UUID).
example: 5a1b2c3d-4e5f-4061-8a7b-9c0d1e2f3a4b
file:
type: string
format: binary
description: OFX file (.ofx or .qfx) exported from internet banking, up
to 5 MB.
transfer:
type: object
description: Transfer between two accounts.
properties:
id:
type: string
format: uuid
description: ID of the transfer (the one of the origin movement).
example: 857569b5-2721-4756-a27a-748168e00606
date:
type: string
format: date
description: Date of the transfer (ISO 8601, `YYYY-MM-DD`).
example: '2026-10-15'
amount:
type: number
format: double
description: 'Transferred amount, always positive: it leaves the origin
account and enters the destination one.'
example: 150.25
description:
type: string
nullable: true
description: Description of the transfer, up to 100 characters.
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: Data of the transfer to create.
properties:
date:
type: string
format: date
description: Date of the transfer (ISO 8601, `YYYY-MM-DD`).
example: '2026-10-15'
origin_account_id:
type: string
format: uuid
description: 'Account the amount leaves: the `id` of an active checking
or cash account from [Accounts and Cards](#tag/Accounts-and-Cards).'
example: ddecf0c0-c13d-43e9-b14b-c394a8bbe853
destination_account_id:
type: string
format: uuid
description: 'Account the amount enters: the `id` of an active checking
or cash account, different from the origin one.'
example: 6e0216e5-5536-4f4b-8c93-36371398b3cf
amount:
type: number
format: double
description: Amount to transfer, greater than zero and with up to 2 decimal
places.
example: 150.25
description:
type: string
maxLength: 100
nullable: true
description: Description of the transfer, up to 100 characters.
example: Sangria do caixa
required:
- date
- origin_account_id
- destination_account_id
- amount
transfer_update:
type: object
description: Fields of the transfer to change. All of them are optional.
properties:
date:
type: string
format: date
description: Date of the transfer (ISO 8601, `YYYY-MM-DD`).
example: '2026-10-15'
origin_account_id:
type: string
format: uuid
description: 'Account the amount leaves: the `id` of an active checking
or cash account from [Accounts and Cards](#tag/Accounts-and-Cards).'
example: ddecf0c0-c13d-43e9-b14b-c394a8bbe853
destination_account_id:
type: string
format: uuid
description: 'Account the amount enters: the `id` of an active checking
or cash account, different from the origin one.'
example: 6e0216e5-5536-4f4b-8c93-36371398b3cf
amount:
type: number
format: double
description: Amount to transfer, greater than zero and with up to 2 decimal
places.
example: 200
description:
type: string
maxLength: 100
nullable: true
description: Description of the transfer, up to 100 characters.
example: Sangria do caixa
undo_bank_reconciliation:
type: boolean
description: Confirms that saving may undo the bank reconciliation of one
of the movements. Without it, the deletion of a reconciled transfer and
a change to the date, amount or account of the reconciled movement answer
409.
example: true
transfer_exclusion:
type: object
description: Optional confirmation of the deletion.
properties:
undo_bank_reconciliation:
type: boolean
description: Confirms that saving may undo the bank reconciliation of one
of the movements. Without it, the deletion of a reconciled transfer and
a change to the date, amount or account of the reconciled movement answer
409.
example: true
account_balance:
type: object
description: Balance of the account at a date.
properties:
account:
"$ref": "#/components/schemas/entity_reference"
date:
type: string
format: date
description: Date of the balance.
example: '2026-10-15'
currency:
type: string
description: Currency of the account (ISO 4217); the amounts are in it.
example: BRL
balance:
type: number
format: double
description: Balance at the end of the date.
example: 1849.75
cash_closed_until:
type: string
format: date
nullable: true
description: Last day with the cash closed; null when the cash was never
closed.
example: '2026-10-10'
required:
- account
- date
- currency
- balance
- cash_closed_until
account_statement:
type: object
description: Statement of the account in a period.
properties:
account:
"$ref": "#/components/schemas/entity_reference"
currency:
type: string
description: Currency of the account (ISO 4217); the amounts are in it.
example: BRL
date_from:
type: string
format: date
description: First day of the statement (ISO 8601, `YYYY-MM-DD`). Required.
example: '2026-10-01'
date_to:
type: string
format: date
description: Last day of the statement (ISO 8601, `YYYY-MM-DD`). Required;
the period has at most 45 days, as in Monde.
example: '2026-10-15'
cash_closed_until:
type: string
format: date
nullable: true
description: Last day with the cash closed; null when the cash was never
closed.
example: '2026-10-10'
opening_balance:
type: number
format: double
description: Balance at the end of the day before the period.
example: 2000
closing_balance:
type: number
format: double
description: Balance at the end of the last day with movements in the period
(or the opening one, without movements).
example: 1849.75
data:
type: array
description: Statement lines, in the Monde order.
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: Statement line. The balance fields (`balance`, `cash_closed`) come
in the `opening_balance` and `daily_balance` lines; the movement fields, in
the `bill_movement` and `transfer` lines.
properties:
type:
type: string
enum:
- opening_balance
- bill_movement
- transfer
- daily_balance
description: 'Kind of line: `opening_balance` (previous balance), `bill_movement`
(movement of an entry), `transfer` (movement of a transfer) or `daily_balance`
(balance at the end of the day).'
example: bill_movement
date:
type: string
format: date
description: Date of the line. On the previous balance, the day before the
period.
example: '2026-10-02'
balance:
type: number
format: double
description: Balance at the end of the day, on the balance lines.
example: 2500
cash_closed:
type: boolean
description: Whether the cash of that day is closed, on the balance lines.
example: true
account_movement:
"$ref": "#/components/schemas/entity_reference"
bill:
description: Entry of [Accounts Payable and Receivable](#tag/Accounts-Payable-and-Receivable)
of the movement; null on a transfer.
oneOf:
- "$ref": "#/components/schemas/entity_reference"
- type: 'null'
sale:
description: Sale of the entry, when it came from a sale.
oneOf:
- "$ref": "#/components/schemas/entity_reference"
- type: 'null'
number:
type: string
nullable: true
description: Number of the entry.
example: '1520'
description:
type: string
nullable: true
description: Description of the entry; on a transfer, the account on the
other side and its description.
example: Pacote Lisboa
document:
type: string
nullable: true
description: Document of the entry.
example: NF 3321
person:
type: object
nullable: true
description: Person of the entry, with the name and the CPF or CNPJ.
properties:
name:
type: string
example: Ana Souza
document:
type: string
nullable: true
example: '52998224725'
check:
type: object
nullable: true
description: 'Check of the movement: number and bank.'
properties:
number:
type: integer
example: 123
bank:
type: string
nullable: true
example: '341'
card:
type: object
nullable: true
description: 'Card of the movement: brand, last digits and ticket card.'
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: 'Bank slip of the entry: number.'
properties:
number:
type: integer
example: 4410
amount:
type: number
format: double
description: 'Amount of the movement: positive comes in, negative goes out.'
example: 500
required:
- type
- date
cash_closure_create:
type: object
description: Day to close and, optionally, the reviewed balance.
properties:
date:
type: string
format: date
description: Day up to which the cash is closed (ISO 8601, `YYYY-MM-DD`).
It cannot be in the future nor before the current closing.
example: '2026-10-15'
expected_balance:
type: number
format: double
description: Balance of the day reviewed by the integrator (the `balance`
of [Get account balance](#tag/Statement-and-Cash/paths/~1accounts~1{account_id}~1balance/get)
at the same date). When sent and the balance changed, the closing is refused
with 422.
example: 1849.75
required:
- date
cash_closure:
type: object
description: Cash situation of the account after the closing.
properties:
account:
"$ref": "#/components/schemas/entity_reference"
cash_closed_until:
type: string
format: date
description: Last day with the cash closed; null when the cash was never
closed.
example: '2026-10-15'
required:
- account
- cash_closed_until
category_group_detail:
type: object
description: Represents a financial category group.
properties:
id:
type: string
format: uuid
description: Unique group identifier
example: b2a6d7da-ff94-40e3-b069-812b2fd45b91
name:
type: string
description: Group name
example: Despesas Administrativas
kind:
type: string
enum:
- expense
- revenue
description: 'Group kind: `expense` or `revenue`.'
example: expense
required:
- id
- name
- kind
category_group_detail_create:
type: object
writeOnly: true
description: Data to register a category group.
required:
- name
- kind
properties:
name:
type: string
maxLength: 50
description: Group name, up to 50 characters. Required on creation.
example: Impostos
kind:
type: string
enum:
- expense
- revenue
description: 'Group kind: `expense` or `revenue`. Required.'
example: expense
category_group_detail_update:
type: object
writeOnly: true
description: Data to change a category group. Send only the fields that change.
properties:
name:
type: string
maxLength: 50
description: Group name, up to 50 characters. Required on creation.
example: Tributos
kind:
type: string
enum:
- expense
- revenue
description: 'Accepted only with the current kind of the group: another
kind is refused with 422.'
example: expense
category_group_exclusion:
type: object
description: Optional confirmation of the deletion.
properties:
delete_categories:
type: boolean
description: 'Confirms that deleting the group also deletes its categories.
Without it, a group with categories responds 409. Accepts only `true`
or `false`: another value responds 422.'
example: true
webhook:
type: object
description: The credential's webhook subscription.
properties:
id:
type: string
format: uuid
description: Webhook ID.
url:
type: string
format: uri
description: https address that receives the POST.
description:
type:
- string
- 'null'
description: Free description, up to 255 characters.
events:
type: array
items:
type: string
description: Subscribed events, formatted as `resource.action`.
active:
type: boolean
description: Whether the webhook receives deliveries.
consecutive_failures:
type: integer
description: Consecutive exhausted deliveries. Back to zero on the first
successful delivery.
disabled_at:
type:
- string
- 'null'
format: date-time
description: When the webhook was deactivated by consecutive failures.
last_error:
type:
- string
- 'null'
description: The last delivery error.
created_at:
type: string
format: date-time
description: Creation date and time.
updated_at:
type: string
format: date-time
description: Last update date and time.
webhook_created:
allOf:
- "$ref": "#/components/schemas/webhook"
- type: object
properties:
secret:
type: string
description: The secret generated by the API, returned only in this response.
Absent when the secret was sent.
webhook_write:
type: object
description: Webhook fields. On creation, `url` and `events` are required; on
update, all are optional.
properties:
url:
type: string
format: uri
description: https address that receives the POST. Internal, local or reserved
network addresses are refused.
description:
type:
- string
- 'null'
maxLength: 255
description: Free description, up to 255 characters.
events:
type: array
minItems: 1
items:
type: string
description: List of catalog events of resources the credential can read.
Cannot be empty.
active:
type: boolean
description: Whether the webhook receives deliveries.
secret:
type: string
minLength: 32
maxLength: 255
writeOnly: true
description: HMAC-SHA256 signing key, 32 to 255 characters. Write-only.
webhook_delivery:
type: object
description: Delivery of an event to the webhook.
properties:
id:
type: string
format: uuid
description: Delivery ID, the same as the `X-Monde-Delivery` header and
the body `id`.
event:
type: string
description: Delivered event.
status:
type: string
enum:
- pending
- delivered
- failed
description: "`pending` (waiting or retrying), `delivered` or `failed` (attempts
exhausted)."
attempts:
type: integer
description: Attempts made.
response_status:
type:
- integer
- 'null'
description: HTTP status of the last response, null when there was no response.
last_error:
type:
- string
- 'null'
description: Error of the last attempt.
payload:
"$ref": "#/components/schemas/webhook_payload"
delivered_at:
type:
- string
- 'null'
format: date-time
description: When the delivery was confirmed.
created_at:
type: string
format: date-time
description: When the event was dispatched.
updated_at:
type: string
format: date-time
description: Date and time of the last attempt.
webhook_payload:
type: object
description: Body of the POST delivered to the webhook address.
properties:
id:
type: string
format: uuid
description: Delivery ID.
event:
type: string
description: Event, formatted as `resource.action`.
resource:
type: string
description: API resource of the records.
occurred_at:
type: string
format: date-time
description: When the most recent change among the notice records happened.
data:
type: array
maxItems: 100
description: 'The records, up to 100: `id` for the query, `company_id` (null
for records that do not belong to a company) and, in business events,
`subresource_id`, the item that triggered the event.'
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: Catalog event.
properties:
name:
type: string
description: Event name, used in `events`.
resource:
type: string
description: API resource.
action:
type: string
description: 'Action: `changed`, `deleted` or a business event.'
description:
type: string
description: What the event notifies.
subscribable:
type: boolean
description: Whether the authenticated credential can subscribe to the event.
responses:
internal_server_error:
description: 'An internal server error occurred. Try again, and if the error
persists, contact our support via email: suporte@monde.com.br.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- An internal server error occurred. Try again, and if the error persists,
contact our support
unauthorized:
description: The access credentials are not valid. Request valid credentials
directly from the travel agency.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The access credentials are not valid.
forbidden:
description: The request was refused, and the message returned in errors
says why. There are five causes, each with a different remedy — the company
the credential works in has no active Monde license, the resource requires
the Monde Pro license (as guides do) and the company does not have it, the
company is read-only and the action writes, the company's Monde Pro license
is read-only and the action writes a guide, or the credential lacks the required
permission on the resource. On a read-only company, every read keeps answering.
A missing license is always reported before a missing permission.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The company does not have an active Monde license. Contact our support
team for more information.
bad_request:
description: The request could not be processed due to a syntax or formatting
error. Check if the request body is a valid JSON.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The request could not be processed due to a syntax or formatting error.
Ensure that all parameters, such as the request body, are correct before
trying again.
conflict:
description: Conflicting request. Returned when a request with the same idempotency
key is already being processed.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- A request with this idempotency key is already being processed.
Please wait for it to complete before retrying.
example:
errors:
- A request with this idempotency key is already being processed. Please
wait for it to complete before retrying.
too_many_requests:
description: Rate limit exceeded. Please wait a moment before trying again.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- Rate limit exceeded. Please wait a moment before trying again.
unsupported_media_type:
description: The request's Content-Type header specified a media type that is
not supported by the API. Make sure the request is using application/json.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The request's Content-Type header specified a media type that is not
supported by the API. Make sure the request is using application/json.
unprocessable_content:
description: 'A validation error occurred. Check the returned error messages
for more details. An error on a list item carries the item position in the
list sent, counted from 0, at every level: ''insurances[0] passengers[2]
person name'' refers to the third passenger of the first insurance.
A rule checked over the whole list, such as a repeated contact, comes on the
list name, without position. A null or blank item inside a list ([null],
[""]) is refused.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The 'custom_fields' field must be a list or an object, not a plain value.
Send it in the format described in the documentation.
not_found:
description: The requested resource was not found. Please verify that the provided
ID is correct.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
example:
errors:
- The requested resource was not found.
product:
description: Product returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/product"
examples:
product_detail:
summary: Product with supplies
"$ref": "#/components/examples/product_detail"
products:
description: Product list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of products with pagination information.
properties:
data:
type: array
description: Array containing the products from the current page.
items:
"$ref": "#/components/schemas/product_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_products:
summary: All products
"$ref": "#/components/examples/all_products"
filtered_products:
summary: Filtered products
"$ref": "#/components/examples/filtered_products"
paginated_products:
summary: Paginated products
"$ref": "#/components/examples/paginated_products"
supply:
description: Supplier returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/supply"
examples:
supply:
summary: Supply
"$ref": "#/components/examples/supply"
supplies:
description: Supplier list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of supplies with pagination information.
properties:
data:
type: array
items:
"$ref": "#/components/schemas/supply"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
supplies:
summary: Product supplies
"$ref": "#/components/examples/supplies"
representation:
description: Representative returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/representation"
examples:
representation:
summary: Representative
"$ref": "#/components/examples/representation"
representations:
description: Representative list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of representatives with pagination
information.
properties:
data:
type: array
items:
"$ref": "#/components/schemas/representation"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
representations:
summary: Supply representatives
"$ref": "#/components/examples/representations"
sale:
description: Sale returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/sale_detail"
examples:
all_products_sale:
summary: Sale with all products
"$ref": "#/components/examples/all_products_sale_single"
visa_only_sale:
summary: Sale with visa
"$ref": "#/components/examples/visa_only_sale_single"
sales:
description: Sales list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/sales_response"
examples:
all_products_sales:
summary: Sale with all products
"$ref": "#/components/examples/all_products_sale_list"
cabins:
description: Cabin list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of cabins with pagination information.
properties:
data:
type: array
description: Array containing the cabins from the current page.
items:
"$ref": "#/components/schemas/cabin"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_cabins:
summary: All cabins
"$ref": "#/components/examples/all_cabins"
paginated_cabins:
summary: Paginated cabins
"$ref": "#/components/examples/paginated_cabins"
cabin:
description: Cabin returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/cabin"
examples:
cabin:
summary: Cabin
"$ref": "#/components/examples/cabin"
ships:
description: Ship list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of ships with pagination information.
properties:
data:
type: array
description: Array containing the ships from the current page.
items:
"$ref": "#/components/schemas/ship"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_ships:
summary: All ships
"$ref": "#/components/examples/all_ships"
paginated_ships:
summary: Paginated ships
"$ref": "#/components/examples/paginated_ships"
ship:
description: Ship returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/ship"
examples:
ship:
summary: Ship
"$ref": "#/components/examples/ship"
packages:
description: Package list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of packages with pagination information.
properties:
data:
type: array
description: Array containing the packages from the current page.
items:
"$ref": "#/components/schemas/package"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_packages:
summary: All packages
"$ref": "#/components/examples/all_packages"
paginated_packages:
summary: Paginated packages
"$ref": "#/components/examples/paginated_packages"
package:
description: Package returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/package"
examples:
package:
summary: Package
"$ref": "#/components/examples/package"
cost_center:
description: Cost center returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/cost_center"
examples:
cost_center:
summary: Administrative cost center
"$ref": "#/components/examples/cost_center"
cost_centers:
description: Cost center list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of cost centers with pagination
information.
properties:
data:
type: array
description: Array containing the cost centers from the current page.
items:
"$ref": "#/components/schemas/cost_center"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_cost_centers:
summary: All cost centers
"$ref": "#/components/examples/all_cost_centers"
paginated_cost_centers:
summary: Paginated cost centers
"$ref": "#/components/examples/paginated_cost_centers"
currency:
description: Currency returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/currency"
examples:
currency:
summary: Real
"$ref": "#/components/examples/currency"
currencies:
description: Currency list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of currencies with pagination information.
properties:
data:
type: array
description: Array containing the currencies from the current page.
items:
"$ref": "#/components/schemas/currency"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_currencies:
summary: All currencies
"$ref": "#/components/examples/all_currencies"
paginated_currencies:
summary: Paginated currencies
"$ref": "#/components/examples/paginated_currencies"
exchange_rates:
description: Exchange rates returned successfully.
content:
application/json:
schema:
type: object
description: Response containing the currency's exchange rates with pagination
information.
properties:
data:
type: array
description: Array containing the exchange rates from the current
page.
items:
"$ref": "#/components/schemas/exchange_rate"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
exchange_rates:
summary: Currency exchange rates
"$ref": "#/components/examples/exchange_rates"
exchange_rate:
description: Exchange rate returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/exchange_rate"
examples:
exchange_rate:
summary: Exchange rate
"$ref": "#/components/examples/exchange_rate"
category:
description: Category returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/category"
examples:
category:
summary: Category
"$ref": "#/components/examples/category"
categories:
description: Category list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of categories with pagination information.
properties:
data:
type: array
description: Array containing the categories from the current page.
items:
"$ref": "#/components/schemas/category_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_categories:
summary: All categories
"$ref": "#/components/examples/all_categories"
paginated_categories:
summary: Paginated categories
"$ref": "#/components/examples/paginated_categories"
city:
description: City returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/city"
examples:
city:
summary: City
"$ref": "#/components/examples/city"
cities:
description: City list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of cities with pagination information.
properties:
data:
type: array
description: Array containing the cities from the current page.
items:
"$ref": "#/components/schemas/city_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_cities:
summary: All cities
"$ref": "#/components/examples/all_cities"
paginated_cities:
summary: Paginated cities
"$ref": "#/components/examples/paginated_cities"
person_role:
description: Role returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/person_role"
examples:
person_role:
summary: Role
"$ref": "#/components/examples/person_role"
person_roles:
description: Role list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of roles with pagination information.
properties:
data:
type: array
description: Array containing the roles from the current page.
items:
"$ref": "#/components/schemas/person_role_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_person_roles:
summary: All roles
"$ref": "#/components/examples/all_person_roles"
seller:
description: Seller returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/seller"
examples:
seller:
summary: Active seller
"$ref": "#/components/examples/seller"
sellers:
description: Seller list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of sellers with pagination information.
properties:
data:
type: array
description: Array containing the sellers from the current page.
items:
"$ref": "#/components/schemas/seller_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_sellers:
summary: All sellers
"$ref": "#/components/examples/all_sellers"
paginated_sellers:
summary: Paginated sellers
"$ref": "#/components/examples/paginated_sellers"
payment_method:
description: Payment method returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/payment_method"
examples:
payment_method:
summary: Cash
"$ref": "#/components/examples/payment_method"
payment_methods:
description: Payment method list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of payment methods with pagination
information.
properties:
data:
type: array
description: Array containing the payment methods from the current
page.
items:
"$ref": "#/components/schemas/payment_method"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_payment_methods:
summary: All payment methods
"$ref": "#/components/examples/all_payment_methods"
paginated_payment_methods:
summary: Paginated payment methods
"$ref": "#/components/examples/paginated_payment_methods"
account:
description: Account or card returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/account"
examples:
account:
summary: Credit card
"$ref": "#/components/examples/account"
accounts:
description: Account and card list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of accounts and cards with pagination
information.
properties:
data:
type: array
description: Array containing the accounts and cards from the current
page.
items:
"$ref": "#/components/schemas/account_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_accounts:
summary: All accounts and cards
"$ref": "#/components/examples/all_accounts"
paginated_accounts:
summary: Paginated accounts and cards
"$ref": "#/components/examples/paginated_accounts"
nf_rule:
description: Invoice (NF) rule returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/nf_rule"
examples:
nf_rule:
summary: Standard package rule
"$ref": "#/components/examples/nf_rule"
nf_rules:
description: Invoice rule list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of invoice rules with pagination
information.
properties:
data:
type: array
description: Array containing the rules from the current page.
items:
"$ref": "#/components/schemas/nf_rule_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_nf_rules:
summary: All invoice (NF) rules
"$ref": "#/components/examples/all_nf_rules"
paginated_nf_rules:
summary: Paginated invoice (NF) rules
"$ref": "#/components/examples/paginated_nf_rules"
task:
description: Task returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/task"
examples:
task_detail:
summary: Task with history and custom fields
"$ref": "#/components/examples/task_detail"
tasks:
description: Task list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of tasks with pagination information.
properties:
data:
type: array
description: Array containing the tasks from the current page.
items:
"$ref": "#/components/schemas/task_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_tasks:
summary: All tasks
"$ref": "#/components/examples/all_tasks"
paginated_tasks:
summary: Paginated tasks
"$ref": "#/components/examples/paginated_tasks"
task_categories:
description: Task category list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of task categories with pagination
information.
properties:
data:
type: array
description: Array containing the task categories from the current
page.
items:
"$ref": "#/components/schemas/task_category"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_task_categories:
summary: All task categories
"$ref": "#/components/examples/all_task_categories"
task_category:
description: Task category returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/task_category"
examples:
task_category:
summary: Task category
"$ref": "#/components/examples/task_category"
travels:
description: Travel list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of travels with pagination information.
properties:
data:
type: array
description: Array containing the travels from the current page.
items:
"$ref": "#/components/schemas/travel_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_travels:
summary: All travels
"$ref": "#/components/examples/all_travels"
paginated_travels:
summary: Paginated travels
"$ref": "#/components/examples/paginated_travels"
travel:
description: Travel returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/travel"
examples:
travel:
summary: Travel detail
"$ref": "#/components/examples/travel"
quote:
description: Quote returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/quote"
examples:
quote:
summary: Honeymoon quote
"$ref": "#/components/examples/quote"
quotes:
description: Quote list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of quotes with pagination information.
properties:
data:
type: array
description: Array containing the quotes from the current page.
items:
"$ref": "#/components/schemas/quote_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_quotes:
summary: All quotes
"$ref": "#/components/examples/all_quotes"
paginated_quotes:
summary: Paginated quotes
"$ref": "#/components/examples/paginated_quotes"
guide:
description: Guide returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/guide"
examples:
guide:
summary: Lisbon guide
"$ref": "#/components/examples/guide"
guides:
description: Guide list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing a list of guides with pagination information.
properties:
data:
type: array
description: Array containing the guides of the current page.
items:
"$ref": "#/components/schemas/guide_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_guides:
summary: All guides
"$ref": "#/components/examples/all_guides"
paginated_guides:
summary: Paginated guides
"$ref": "#/components/examples/paginated_guides"
invoice_rule:
description: Billing rule returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/invoice_rule"
examples:
invoice_rule:
summary: Weekly air billing
"$ref": "#/components/examples/invoice_rule"
invoice_rules:
description: Billing rule list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of billing rules with pagination
information.
properties:
data:
type: array
description: Array containing the rules from the current page.
items:
"$ref": "#/components/schemas/invoice_rule_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_invoice_rules:
summary: All billing rules
"$ref": "#/components/examples/all_invoice_rules"
paginated_invoice_rules:
summary: Paginated billing rules
"$ref": "#/components/examples/paginated_invoice_rules"
integration:
description: Integration returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/integration"
examples:
integration:
summary: Active integration
"$ref": "#/components/examples/integration"
integrations:
description: Integration list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing a list of integrations with pagination
information.
properties:
data:
type: array
description: Array containing the integrations of the current page.
items:
"$ref": "#/components/schemas/integration_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_integrations:
summary: All integrations
"$ref": "#/components/examples/all_integrations"
paginated_integrations:
summary: Paginated integrations
"$ref": "#/components/examples/paginated_integrations"
people:
description: People list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing list of people with pagination information.
properties:
data:
type: array
description: Array containing the people from the current page.
items:
"$ref": "#/components/schemas/person_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_people:
summary: All people
"$ref": "#/components/examples/all_people"
paginated_people:
summary: Paginated people
"$ref": "#/components/examples/paginated_people"
person:
description: Person returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/person_detail"
examples:
person_detail:
summary: Person by ID
"$ref": "#/components/examples/person_detail"
label:
description: Label returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/label"
examples:
label:
summary: VIP label
"$ref": "#/components/examples/label"
labels:
description: Label list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing a list of labels with pagination information.
properties:
data:
type: array
description: Array containing the labels of the current page.
items:
"$ref": "#/components/schemas/label"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_labels:
summary: All labels
"$ref": "#/components/examples/all_labels"
paginated_labels:
summary: Paginated labels
"$ref": "#/components/examples/paginated_labels"
company:
description: Company returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/company"
examples:
company:
summary: Company
"$ref": "#/components/examples/company"
companies:
description: Company list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing a list of companies with pagination information.
properties:
data:
type: array
description: Array containing the companies of the current page.
items:
"$ref": "#/components/schemas/company"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_companies:
summary: All companies
"$ref": "#/components/examples/all_companies"
bill:
description: Account payable or receivable returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/bill"
examples:
receivable_bill:
summary: Account receivable (customer invoice)
"$ref": "#/components/examples/receivable_bill_single"
vendor_invoice_bill:
summary: Account payable (vendor invoice)
"$ref": "#/components/examples/vendor_invoice_bill_single"
card_invoice_bill:
summary: Account payable (card invoice)
"$ref": "#/components/examples/card_invoice_bill_single"
commission_bill:
summary: Account payable (commission)
"$ref": "#/components/examples/commission_bill_single"
bills:
description: Accounts payable and receivable list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/bills_response"
examples:
receivable_bills:
summary: Receivable and payable accounts
"$ref": "#/components/examples/bills_list"
paginated_bills:
summary: Paginated accounts
"$ref": "#/components/examples/paginated_bills"
account_movements:
description: Account movement list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/account_movements_response"
examples:
all_account_movements:
summary: All account movements
"$ref": "#/components/examples/all_account_movements"
paginated_account_movements:
summary: Paginated account movements
"$ref": "#/components/examples/paginated_account_movements"
account_movement:
description: Account movement returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/account_movement"
examples:
settlement_account_movement:
summary: Card settlement
"$ref": "#/components/examples/settlement_account_movement"
transfer_account_movement:
summary: Transfer between accounts
"$ref": "#/components/examples/transfer_account_movement"
refunds:
description: Refund list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/refunds_response"
examples:
all_refunds:
summary: All refunds
"$ref": "#/components/examples/all_refunds"
paginated_refunds:
summary: Paginated refunds
"$ref": "#/components/examples/paginated_refunds"
refund:
description: Refund returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/refund"
examples:
vendor_refund:
summary: Supplier refund
"$ref": "#/components/examples/vendor_refund"
customer_refund:
summary: Customer refund
"$ref": "#/components/examples/customer_refund"
passenger_lists:
description: Passenger list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/passenger_list_response"
examples:
passenger_list:
summary: Passenger list
"$ref": "#/components/examples/passenger_list"
sales_by_products:
description: Sales by product returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/sales_by_product_response"
examples:
sales_by_product:
summary: Sales by product
"$ref": "#/components/examples/sales_by_product"
sales_by_sellers:
description: Sales by seller returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/sales_by_seller_response"
examples:
sales_by_seller:
summary: Sales by seller
"$ref": "#/components/examples/sales_by_seller"
cvc_statements:
description: Receipt list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/cvc_statements_response"
examples:
all_cvc_statements:
summary: All receipts
"$ref": "#/components/examples/all_cvc_statements"
paginated_cvc_statements:
summary: Paginated receipts
"$ref": "#/components/examples/paginated_cvc_statements"
cvc_statement:
description: Receipt returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/cvc_statement"
examples:
cvc_statement_with_sale:
summary: Receipt with a linked sale
"$ref": "#/components/examples/cvc_statement_with_sale"
manual_adjustment_cvc_statement:
summary: Manual adjustment without a sale
"$ref": "#/components/examples/manual_adjustment_cvc_statement"
nfs:
description: Invoice list returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/nfs_response"
examples:
all_nfs:
summary: All invoices
"$ref": "#/components/examples/all_nfs"
paginated_nfs:
summary: Paginated invoices
"$ref": "#/components/examples/paginated_nfs"
nf:
description: Invoice returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/nf"
examples:
issued_nf:
summary: Issued invoice
"$ref": "#/components/examples/issued_nf"
canceled_nf:
summary: Canceled invoice
"$ref": "#/components/examples/canceled_nf"
nf_generations:
description: Invoices to generate returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/nf_generations_response"
examples:
nf_generation_preview:
summary: Product with a payer invoice to generate
"$ref": "#/components/examples/nf_generation_preview"
nf_generation_created:
description: Invoices generated successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/nf_generation_created"
examples:
generated_nfs:
summary: Generated invoice
"$ref": "#/components/examples/generated_nfs"
logs:
description: List of logs returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/logs_response"
examples:
all_logs:
summary: Logs
"$ref": "#/components/examples/all_logs"
paginated_logs:
summary: Paginated logs
"$ref": "#/components/examples/paginated_logs"
log:
description: Log returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/log"
examples:
edition_log:
summary: Edition log
"$ref": "#/components/examples/edition_log"
system_log:
summary: Log written by the API
"$ref": "#/components/examples/system_log"
custom_fields:
description: List of custom fields returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/custom_fields_response"
examples:
all_custom_fields:
summary: Custom fields
"$ref": "#/components/examples/all_custom_fields"
custom_field:
description: Custom field returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/custom_field_definition"
examples:
custom_field:
summary: Custom field
"$ref": "#/components/examples/custom_field"
sale_product_additional_fields:
description: Additional fields returned successfully.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: The three additional fields, always all of them, in the
order they appear on the product screen in Monde.
items:
type: object
required:
- key
- label
- active
properties:
key:
type: string
enum:
- external_number
- additional1
- additional2
description: Name of the field on the sale product.
label:
type:
- string
- 'null'
description: Title the agency gave the field in Monde. Null
when the field has no title.
active:
type: boolean
description: Whether the field has a title and therefore appears
in Monde and is written and returned by the 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: Commission plan returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/commission_plan"
examples:
commission_plan:
summary: Commission plan
"$ref": "#/components/examples/commission_plan"
commission_plans:
description: Commission plans returned successfully.
content:
application/json:
schema:
type: object
description: Response with a list of commission plans and pagination information.
properties:
data:
type: array
description: Array with the commission plans of the current page.
items:
"$ref": "#/components/schemas/commission_plan_summary"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_commission_plans:
summary: All commission plans
"$ref": "#/components/examples/all_commission_plans"
goal:
description: Goal returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/goal"
examples:
goal:
summary: Goal
"$ref": "#/components/examples/goal"
goals:
description: Goals returned successfully.
content:
application/json:
schema:
type: object
description: Response with a list of goals and pagination information.
properties:
data:
type: array
description: Array with the goals of the current page.
items:
"$ref": "#/components/schemas/goal"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_goals:
summary: All goals
"$ref": "#/components/examples/all_goals"
bank:
description: Bank returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/bank"
examples:
bank:
summary: Banco do Brasil
"$ref": "#/components/examples/bank"
banks:
description: Bank list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing a list of banks with pagination information.
properties:
data:
type: array
description: Array containing the banks of the current page.
items:
"$ref": "#/components/schemas/bank"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_banks:
summary: All banks
"$ref": "#/components/examples/all_banks"
category_group_detail:
description: Group returned successfully.
content:
application/json:
schema:
"$ref": "#/components/schemas/category_group_detail"
examples:
category_group_detail:
summary: Expense group
"$ref": "#/components/examples/category_group_detail"
category_groups:
description: Group list returned successfully.
content:
application/json:
schema:
type: object
description: Response containing the list of groups with pagination information.
properties:
data:
type: array
description: Array containing the groups of the current page.
items:
"$ref": "#/components/schemas/category_group_detail"
pagination:
"$ref": "#/components/schemas/pagination"
examples:
all_category_groups:
summary: All groups
"$ref": "#/components/examples/all_category_groups"
webhooks:
description: The credential's webhooks.
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: Webhook deliveries.
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: Event catalog.
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: Attachment upload example.
value:
resource_type: sale
resource_id: c52a1c51-80e2-4a28-925e-2102a7b5d4e1
file: "@voucher.pdf"
description: voucher
upload_attachments_response:
summary: Attachment upload response example.
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: Product with supplies
description: Example response with a product and its supplies, suppliers and
representatives.
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: All products
description: Example response containing products of different kinds.
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: Filtered products
description: Example response filtered by specific kinds (insurance and 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: Paginated products
description: Example paginated response showing the second page of results.
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: Create a product
description: Example creating an Others product, with passengers and NBS code.
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: Deactivate the product
description: Example update that only deactivates the product, keeping the other
fields.
value:
active: false
written_product_reference:
summary: Record updated, without the read permission
description: 'Response when the credential does not have the "View" permission
on products: the change is saved, and only the `id` comes back.'
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
supply:
summary: Supply
description: Example response of a product supply.
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: Product supplies
description: Example list of supplies, with the representatives of each one.
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: Add a supplier
description: Example supplier with percentage commission and 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: Switch the commission to an amount
description: Example update that switches the commission to an amount; the commission
percentage is zeroed.
value:
commission_type: amount
commission_amount: 35.0
representation:
summary: Representative
description: Example response of a supply representative.
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: Supply representatives
description: Example list of representatives.
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: Add a representative
description: Example representative with an amount commission.
value:
representative:
id: c3b7e8eb-1199-5457-c170-923c3fe56c92
commission_type: amount
commission_amount: 50.0
update_representation:
summary: Change the over
description: Example update of the over percentage only.
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:47'
destination: JFK
arrival_date: '2026-11-21T00:00:47'
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:47'
arrival_date: '2026-11-24T00:00:47'
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:47'
arrival_date: '2026-11-24T00:00:47'
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:47'
arrival_date: '2026-11-21T00:00:47'
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:47'
arrival_date: '2026-12-08T00:00:47'
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:47'
arrival_date: '2026-11-23T00:00:47'
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:47'
destination: JFK
arrival_date: '2026-11-21T00:00:47'
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:47'
destination: Nice-Ville
arrival_date: '2026-11-21T06:00:47'
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:47'
destination: Terminal Rodoviário de Santos
arrival_date: '2026-11-19T06:00:47'
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:47'
destination: JFK
arrival_date: '2026-11-21T00:00:47'
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:47'
destination: Nice-Ville
arrival_date: '2026-11-21T06:00:47'
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:47'
destination: Terminal Rodoviário de Santos
arrival_date: '2026-11-19T06:00:47'
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:47'
destination: JFK
arrival_date: '2026-11-21T00:00:47'
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:47'
end_date: '2026-12-06T00:00:47'
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:47'
arrival_date: '2026-12-06T00:00:47'
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:47'
check_out: '2026-12-16T00:00:47'
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:47'
pickup_location: Aeroporto de Congonhas
dropoff_date: '2026-11-28T00:00:47'
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:47'
end_date: '2026-12-03T00:00:47'
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:47'
destination: JFK
arrival_date: '2026-11-21T00:00:47'
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: 'Only the fields sent change: products, passengers and payments
stay as they are. The approver is for travel agencies only: on a tour operator
(consolidator), send only the custom field.'
value:
approver: *764
custom_fields:
- id: 12345
value: Reunião anual
update_sale_products:
description: The insurance with id is changed with the data sent, the other
insurances of the sale are removed, and the payments become the ones in the
list.
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: The payment sent by its id stays as it is, the new one is added
pointing to the product by its id, and the other payments of the sale are
removed. The products stay as they are.
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: On a closed sale, the opened status reopens the sale before changing
the date, which a closed sale does not accept. If the update is refused, the
sale stays closed.
value:
status: opened
sale_date: '2026-10-10'
updated_sale_reference:
description: 'Response to a credential that cannot get the updated sale: the
sale id and the id and local_id of each product and payment sent.'
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: Cancels both passengers of the product, each with its own date,
and with them the whole product, and deletes the balance the customer still
owes in the product.
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: Cancels only one passenger, with its date. The product stays active
while there is an active passenger.
value:
passengers:
- person:
id: b2a6d7da-ff94-40e3-b069-812b2fd45b91
canceled_at: '2026-10-14'
sale_product_cancellation_rest_with_fine:
description: 'After canceling one passenger, cancels the one still active and
with it the whole product: deletes the customer balance and what would still
be invoiced to the supplier, and registers the fine charged by them.'
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: Reactivates only one canceled passenger, referenced by the person
`id`. The fine and the deleted balance stay while there is a canceled passenger.
value:
passengers:
- person:
id: c0d4b1e3-5a6f-4b7c-8d9e-0f1a2b3c4d5e
sale_product_reactivation_rest:
description: 'After reactivating one passenger, reactivates the one still canceled.
With it every passenger comes back, and the rest of the cancellation is undone:
the fine and the deleted balance go back to zero.'
value:
passengers:
- person:
id: b2a6d7da-ff94-40e3-b069-812b2fd45b91
sale_product_cancellation_partial_response:
description: 'Excerpt of the response when canceling one of the two passengers
with `delete_customer_balance`: the product stays `active`, and the canceled
passenger carries `canceled_at`. The other sale fields are those of the read
by 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: 'Excerpt of the response when the request leaves every passenger
canceled, with the supplier balance deleted and a fine: the product becomes
`canceled`, with the `canceled_at` of the day. The other sale fields are those
of the read by 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: 'Excerpt of the response when reactivating the last canceled passenger:
the product goes back to `active`, the passengers have no `canceled_at`, and
the fine and the deleted balance go back to zero. The other sale fields are
those of the read by 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 credential without permission to read sales receives only the
sale `id`.
value:
id: 212b54b8-27df-4859-80a9-79ad855bcd09
sale_vendor_item_due_date_and_description:
description: Changes the due date and the description of an item still to be
invoiced.
value:
due_date: '2026-12-15'
description: Faturar em dezembro
sale_vendor_item_description_only:
description: 'Changes only the description: the due date stays as it is.'
value:
description: Repasse do seguro
sale_vendor_item_sale_response:
description: 'Excerpt of the response: the updated item comes back in `financial.vendor_items`,
next to the item already in an entry. The other sale fields are those of the
read by 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 credential without permission to read sales receives only the
sale `id`.
value:
id: 212b54b8-27df-4859-80a9-79ad855bcd09
sale_vendor_invoice_advance:
description: Generates the standalone payment with the whole balance of the
item.
value:
kind: advance
items:
- id: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84
amount: 650.95
sale_vendor_invoice_deposit:
description: 'Generates the deposit of part of the item of the product: the
rest stays open.'
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 credential that cannot read the generated invoice receives only
its `id`.
value:
id: c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39
sale_to_invoice:
description: Invoices to the payer of the sale the customer balance of a product,
without a cost center.
value:
products:
- sale_product_id: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45
amount: 650.95
sale_to_invoice_with_cost_center:
description: Invoices to a legal entity, with one of the cost centers registered
on it. The product with a negative balance goes with a negative amount.
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: Returns to the customer, through the customer invoice, the negative
balance of a product.
value:
description: Reembolso do seguro
products:
- sale_product_id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968
amount: -150.0
sale_to_invoice_removal:
description: Removes the to-invoice line of the customer invoice that has no
cost center.
value:
bill_id: 4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819
cost_center:
sale_to_invoice_removal_confirmed:
description: 'Removes the line of a closed sale whose customer invoice is settled:
reopens the sale and undoes the settlement of the invoice.'
value:
bill_id: 4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819
cost_center: Diretoria
reopen_sale: true
remove_settlement: true
sale_to_invoice_sale_reference:
description: A credential without the permission to read sales receives only
the `id` of the sale.
value:
id: 212b54b8-27df-4859-80a9-79ad855bcd09
all_cabins:
summary: All cabins
description: Example response containing all registered cabins.
value:
data:
- name: Externa
- name: Interna
- name: Suíte
- name: Varanda
pagination:
size: 20
has_next_page: false
next_cursor:
paginated_cabins:
summary: Paginated cabins
description: Example paginated response showing the second page of results.
value:
data:
- name: Suíte
- name: Varanda
pagination:
size: 2
has_next_page: false
next_cursor:
cabin:
summary: Cabin
description: Example response of a cabin.
value:
name: Varanda
create_cabin:
summary: Create cabin
description: Example of a cabin creation.
value:
name: Varanda
update_cabin:
summary: Rename cabin
description: Example of an update that renames the cabin.
value:
name: Varanda Premium
all_ships:
summary: All ships
description: Example response containing all registered ships.
value:
data:
- name: Costa Diadema
- name: MSC Preziosa
- name: MSC Seaview
pagination:
size: 20
has_next_page: false
next_cursor:
paginated_ships:
summary: Paginated ships
description: Example paginated response showing the second page of results.
value:
data:
- name: MSC Seaview
pagination:
size: 2
has_next_page: false
next_cursor:
ship:
summary: Ship
description: Example response of a ship.
value:
name: MSC Preziosa
create_ship:
summary: Create ship
description: Example of a ship creation.
value:
name: MSC Preziosa
update_ship:
summary: Rename ship
description: Example of an update that renames the ship.
value:
name: MSC Preziosa II
all_packages:
summary: All packages
description: Example response containing all registered packages.
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: Paginated packages
description: Example paginated response showing the second page of results.
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: Package
description: Example response of a package.
value:
name: Disney 7 noites
services_included: Aéreo, hotel e ingressos para os parques
create_package:
summary: Create package
description: Example of a package creation.
value:
name: Disney 7 noites
services_included: Aéreo, hotel e ingressos para os parques
update_package:
summary: Rename package
description: Example of an update that renames the package.
value:
name: Disney 8 noites
all_cost_centers:
summary: All cost centers
description: Example response containing all registered cost centers.
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: Paginated cost centers
description: Example paginated response showing the second page of results.
value:
data:
- id: c3b7e8eb-1199-4457-9170-923c3fe56c92
description: Marketing
pagination:
size: 2
has_next_page: false
next_cursor:
cost_center:
summary: Administrative cost center
description: Example response for a specific cost center.
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
description: Administrativo
create_cost_center:
summary: New cost center
description: Marketing cost center.
value:
description: Marketing
update_cost_center:
summary: Rename cost center
description: Changes the description.
value:
description: Marketing digital
written_cost_center_reference:
summary: Only the id
description: Response to a credential that cannot read cost centers.
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
all_currencies:
summary: All currencies
description: Example response containing all registered currencies.
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: Paginated currencies
description: Example paginated response showing the second page of results.
value:
data:
- code: EUR
description: Euro
symbol: "€"
active: false
pagination:
size: 2
has_next_page: false
next_cursor:
currency:
summary: Real
description: Example response for a specific currency.
value:
code: BRL
description: Real
symbol: R$
active: true
deactivate_currency:
summary: Deactivate currency
description: Example of an update that deactivates the currency.
value:
active: false
exchange_rate:
summary: Exchange rate
description: Example response of an exchange rate.
value:
id: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10
currency:
code: USD
value: 5.4321
quoted_at: '2026-10-14T09:30:00'
exchange_rates:
summary: Currency exchange rates
description: Example response with the currency's exchange rate history.
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: Record exchange rate
description: Example of recording the currency's new exchange rate.
value:
value: 5.4321
update_exchange_rates:
summary: Update exchange rates
description: Example of updating the dollar and euro exchange rates.
value:
exchange_rates:
- currency_code: USD
value: 5.4321
- currency_code: EUR
value: 6.1234
exchange_rate_update_response:
summary: Recorded exchange rates
description: Example response in which only the dollar changed value and was
recorded.
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: All categories
description: Example response containing expense and revenue categories.
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: Paginated categories
description: Example paginated response showing the second page of results.
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: Category
description: Example response for a revenue category, with its group.
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: New category
description: Expense category in the Administrative Expenses group.
value:
description: Aluguel
group_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91
pass_through: false
update_category:
summary: Rename category
description: Changes only the description; the other fields stay as they are.
value:
description: Aluguel da loja
written_category_reference:
summary: Only the id
description: Response to a credential that cannot read categories.
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
all_cities:
summary: All cities
description: Example response containing Brazilian and foreign cities.
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: Paginated cities
description: Example paginated response showing the second page of results.
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: City
description: Example response for a Brazilian city, with its state and country.
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: All roles
description: Example response with an agency role and the two system roles.
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: Role
description: Example response for a role commissioned over a company, with one
linked person.
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: Register a role
description: Example registration of a role commissioned over a company, already
with a linked person.
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: Update the people of the role
description: Example update in which a link loses its plan and becomes not commissioned,
a new person comes in, and the links not in the list are undone.
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: Link a person to the Seller role
description: Example update of a system role, in which only the people list
changes.
value:
people:
- person:
id: 3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7
start_date: '2026-01-01'
update_person_goals:
summary: Update the goals of a person
description: Example update in which the 2026 goal of the person changes only
in June and the 2027 goal comes in, with the January amount in the omitted
months. Goals not in `goals` are deleted and, since `people` is the final
list, the links not in it are undone.
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: Role updated, without the read permission
description: 'Response when the credential cannot read roles: the update is
saved, and only the `id` comes back.'
value:
id: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e
all_sellers:
summary: All sellers
description: Example response containing active and inactive sellers.
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: Paginated sellers
description: Example paginated response showing the second page of results.
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: Active seller
description: Example response for a specific seller.
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: Register seller
description: Turns the given individual person into a seller, already active.
value:
person_id: f9d961b8-ea88-4346-8e52-afe94267417a
deactivate_seller:
summary: Deactivate seller
description: Deactivates the seller, which is no longer offered in new sales.
value:
active: false
written_seller_reference:
summary: Update without read permission
description: 'Response of the update when the credential lacks the "View" permission
on sellers: brings only the `id`.'
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
all_payment_methods:
summary: All payment methods
description: Example response containing system and user-registered payment
methods.
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: Paginated payment methods
description: Example paginated response showing the second page of results.
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: Cash
description: Example response for a specific payment method.
value:
id: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9
name: Dinheiro
system: true
create_payment_method:
summary: New payment method
description: Agency payment method.
value:
name: Vale-viagem
update_payment_method:
summary: Rename payment method
description: Changes the name.
value:
name: Voucher
written_payment_method_reference:
summary: Only the id
description: Response to a credential that cannot read payment methods.
value:
id: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9
all_accounts:
summary: All accounts and cards
description: Example response containing a checking account and a credit card.
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: Paginated accounts and cards
description: Example paginated response showing the second page of results.
value:
data:
- *815
pagination:
size: 1
has_next_page: false
next_cursor:
account:
summary: Credit card
description: Example response for a single account.
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: Checking account with billing
description: Registers a checking account available in one company, released
to a user group and with Monde Bancos billing.
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: Credit card
description: Registers a credit card with the invoice generated in the informed
company.
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: Update description and agreement
description: 'Updates the description, the Pix key and the agreement code of
an existing billing setup. The billing list sent is final: a billing setup
left out would be deleted.'
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: Update without read permission
description: 'Update response for a credential that cannot read accounts and
cards: only the `id`.'
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
all_nf_rules:
summary: All invoice (NF) rules
description: Example response containing a general rule and a rule restricted
to a product and supplier.
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: Paginated invoice (NF) rules
description: Example paginated response showing the second page of results.
value:
data:
- *817
pagination:
size: 1
has_next_page: false
next_cursor:
nf_rule:
summary: Standard package rule
description: Example response for a specific invoice (NF) rule.
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: All tasks
description: Example response containing pending and completed tasks.
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: Paginated tasks
description: Example paginated response showing the second page of results.
value:
data:
- *818
pagination:
size: 1
has_next_page: false
next_cursor:
task_detail:
summary: Task with history and custom fields
description: Example view of a task with its history and custom fields.
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: Task with every field
description: Example creation of a task with a linked person, an initial comment,
and a custom field.
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: Task with the required fields only
description: Example creation with the minimum Monde requires — title and assignee.
Without a due date, the task is never overdue.
value:
company_identifier: '46598887000162'
title: Cobrar segunda parcela
assignee_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91
update_task:
summary: Task update
description: Example update of the title, due date, assignee, and a custom field
of an existing task.
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: Task completion
description: Example completion of a task, without changing any other field.
value:
completed: true
written_task_reference:
summary: Task written, without read permission
description: 'Update and comment response for a credential without the "View"
permission on tasks in the task''s company, even on a task it created: returns
only the id of the task.'
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
create_task_historic:
summary: Comment on the task
description: Example comment appended to the history of an existing task.
value:
text: Cliente confirmou os dados do embarque.
create_task_historic_with_attachments:
summary: Comment with attachments
description: Example comment with two files already uploaded to the task through
Upload attachment.
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: All task categories
description: Example response containing task categories, two of them on the
board.
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: Task category
description: Example response with a specific task category.
value:
id: 42
name: Emissão
kanban: true
kanban_position: 2
create_task_category:
summary: Create as the second board column
description: Creates the category and puts it in the second column of the task
board.
value:
name: Emissão
kanban_position: 2
rename_task_category:
summary: Rename
description: Changes only the category name; its tasks follow.
value:
name: Emissão de bilhetes
move_task_category:
summary: Move to the first column
description: Takes the category column to the start of the task board.
value:
kanban_position: 1
hide_task_category:
summary: Take off the board
description: Takes the category off the task board, without touching its tasks.
value:
kanban: false
written_task_category_reference:
summary: Category updated, without read permission
description: 'Update response when the credential lacks the permission to read
task categories: only the `id`.'
value:
id: 42
all_travels:
summary: All travels
description: Example response containing upcoming and finished travels.
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: Paginated travels
description: Example paginated response showing the second page of results.
value:
data:
- *819
pagination:
size: 1
has_next_page: false
next_cursor:
travel:
summary: Travel detail
description: Example travel with references to the linked sales and passengers.
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: Created travel
description: 'Newly created travel, still without linked sales: no dates and
no situation.'
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: Create travel
description: Travel with description, customer, seller and observations.
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: Change the description and observations
description: Only the fields sent change.
value:
description: Lua de mel - Cancún e Tulum
observations: Incluir o passeio a Tulum.
written_travel_reference:
summary: Written travel, without read permission
description: Response to a credential that writes travels but lacks the "Read
all travels" permission in the company of the travel.
value:
id: f9d961b8-ea88-4346-8e52-afe94267417a
all_quotes:
summary: All quotes
description: Example response containing active and disabled quotes.
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: Paginated quotes
description: Example paginated response showing the second page of results.
value:
data:
- *820
pagination:
size: 1
has_next_page: false
next_cursor:
quote:
summary: Honeymoon quote
description: Example response for a specific quote.
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: Create a quote
description: Example of creating a quote with a person and internal notes.
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: Change subtitle and validity description: Example of an update that changes only the subtitle and the validity, keeping the other fields. value: subtitle: Lua de mel - 10 noites valid_until: '2035-06-15' unlink_quote_person: summary: Remove the person from the quote description: Example of an update that leaves the quote without a person. value: person_id: written_quote_reference: summary: Quote saved, without the read permission description: 'Response when the credential lacks the "Read all quotes" permission in the quote''s company: the write is done, and only the `id` comes back.' value: id: 42 duplicate_quote: summary: Duplicate a quote description: Example of a duplication with the new validity and another person. value: user_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 valid_until: '2035-07-31' person_id: 7f1c2d3e-4b5a-4c6d-8e9f-0a1b2c3d4e5f duplicated_quote: summary: Quote copy description: Example of a response with the created copy. 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: All guides description: Example response containing an active and a deactivated guide. 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: Paginated guides description: Example of a paginated response showing the second page of results. value: data: - *821 pagination: size: 1 has_next_page: false next_cursor: guide: summary: Lisbon guide description: Example response of a specific guide. 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: Create a guide description: Example of creating a guide with internal observations. 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: Change title and subtitle description: Example of an update that changes only the title and the subtitle, keeping the other fields. value: title: Lisboa e Sintra subtitle: Roteiro de 6 dias deactivate_guide: summary: Deactivate the guide description: Example of an update that deactivates the guide, taking the public link offline. value: active: false written_guide_reference: summary: Guide updated, without the read permission description: 'Response when the credential does not have the "Read all guides" permission in the guide''s company: the update is written, and only the `id` comes back.' value: id: 42 duplicate_guide: summary: Duplicate a guide description: Example of a duplication informing the copy owner. value: user_id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 duplicated_guide: summary: Guide copy description: Example of a response with the created copy. 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: All billing rules description: Example response containing supplier and client rules. 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: Paginated billing rules description: Example paginated response showing the second page of results. value: data: - *822 pagination: size: 1 has_next_page: false next_cursor: invoice_rule: summary: Weekly air billing description: Example response for a specific billing rule. 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: All integrations description: Example response containing vendor and searcher integrations. 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: Paginated integrations description: Example of a paginated response showing the second page of results. value: data: - *823 pagination: size: 1 has_next_page: false next_cursor: integration: summary: Active integration description: Example response of a specific integration, with the user and the password omitted. 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: All people description: Example query response containing an individual and a legal person. 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: Paginated people description: Example paginated response showing the second page of results. value: data: - *824 pagination: size: 1 has_next_page: false next_cursor: person_detail: summary: Person by ID description: Example of the complete individual person, with the grouped blocks and the weak entities. 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: Individual person registration description: Example of an individual person registration with address, place of birth, documents and parentage. 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: Legal person registration description: Example of a legal person registration with tax withholding and airline data. 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: Person updated, without read permission description: 'Update response for a credential without the "View" permission on people: returns only the id of the updated person.' value: id: f9d961b8-ea88-4346-8e52-afe94267417a update_person: summary: Person update description: Example of updating the contact details, address, labels and custom fields of a person already registered. 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: All labels description: Example response containing every registered label. 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: Paginated labels description: Example paginated response showing the second page of results. value: data: - id: c3b7e8eb-1199-4457-9170-923c3fe56c92 name: Lua de mel pagination: size: 2 has_next_page: false next_cursor: label: summary: VIP label description: Example response for a specific label. value: id: 2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50 name: VIP create_label: summary: Create label description: Creates the VIP label. value: name: VIP update_label: summary: Rename label description: Changes the label name. value: name: Cliente VIP written_label_reference: summary: Update without read permission description: 'Response of the update when the credential lacks the "View" permission on labels: brings only the `id`.' value: id: 2d0b3c4e-5f60-4172-9384-0b1c2d3e4f50 all_companies: summary: All companies description: Example response with the companies the credential reaches, one of them read only. 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: Company description: Example response for a specific company. 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: Receivable and payable accounts description: Example response containing an account receivable (customer invoice) and an account payable (card invoice). 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: Paginated accounts description: Example paginated response showing the second page of results. value: data: - *828 pagination: size: 1 has_next_page: false next_cursor: receivable_bill_single: summary: Account receivable (customer invoice) description: Example detail of a customer invoice, with categories, movements, apportionments, items, attachments and custom fields. 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: Account payable (card invoice) description: Example detail of a card invoice, with the charges in credit_card_items and items empty. 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: Account payable (vendor invoice) description: Example detail of a vendor invoice, with the items in items and credit_card_items empty. 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: Account payable (commission) description: Example detail of a commission bill, with the commission lines in commissions and the item arrays empty. 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: Full account payable description: Account payable with document, forecast account, two categories, cost center and company apportionments, and a custom field. 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: Account receivable with only the required fields description: Account receivable with one category; the issue date is today and the account is the company's default forecast account. 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: Account payable of a sale description: Account payable posted on a sale, withoutcompany_identifier.
The entry stays in the sale company, as a sale standalone entry, with no forecast
account.
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: Account payable already settled
description: Account payable created already paid, with the cash movement in
the cash account.
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: Account payable settled with a late fee
description: 'Account of R$ 420.00 paid with a R$ 12.60 late fee: the difference
goes to the category sent, and the final amount becomes 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: Account payable in installments
description: Account payable in 3 monthly installments. The response brings
the entry with `recurrence_group_id`; the 3 installments are fetched by it
in `GET /bills`, once generated in the background.
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: Recurring account payable
description: Monthly rent. The recurrence generates the bills for the next 5
years, as in 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: Account payable with a partial payment
description: A R$ 420.00 bill paid with R$ 300.00. The bill is settled with
what was paid, and the R$ 120.00 balance becomes a new open bill, referenced
in `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: Change of description, document, due date and observations
description: Changes only the fields sent; the others stay as they are.
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: Change of amount, categories and cost center apportionment
description: Replaces the categories and the amount, and the cost center apportionment;
the apportionment across companies stays as it is.
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: Change of the amount of a settled and reconciled entry
description: Changes the amount and the movement that pays it, along with the
settlement date. The entry is in the bank reconciliation, and the confirmation
in `undo_bank_reconciliation` lets the change be written, undoing the reconciliation
of the movement.
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: Settlement of the full amount
description: Account of R$ 420.00 paid in cash in the cash account.
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: Settlement with a late fee
description: 'Account of R$ 420.00 paid with a R$ 12.60 late fee: the difference
goes to the category sent, and the final amount becomes 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: Partial payment
description: Account of R$ 420.00 paid with R$ 300.00. The entry is settled
with what was paid, and the R$ 120.00 balance becomes a new open entry, referenced
in `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: Settlement of two entries in the same account
description: Two entries paid in cash in the cash account, each one for its
final amount.
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: Settlement with the sale data
description: Two sale payments settled in the checking account, each one with
the payment method and the card or check data of its own sale.
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: Entries settled, without read permission
description: 'Response for a credential without the "View" permission on accounts
payable and receivable in the entries'' company: returns only the id of each
one.'
value:
data:
- id: 212b54b8-27df-4859-80a9-79ad855bcd09
- id: 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f
written_bill_reference:
summary: Entry written, without read permission
description: 'Update response for a credential without the "View" permission
on accounts payable and receivable in the entry''s company, even on an entry
it created: returns only the id of the entry.'
value:
id: 212b54b8-27df-4859-80a9-79ad855bcd09
all_account_movements:
summary: All account movements
description: Example response with a card settlement and a transfer between
accounts.
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: Paginated account movements
description: Example of a paginated response showing the second page of results.
value:
data:
- *829
pagination:
size: 1
has_next_page: false
next_cursor:
settlement_account_movement:
summary: Card settlement
description: Example of a movement that settles an account payable by credit
card.
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 between accounts
description: Example of a transfer movement, with the reference to the movement
on the other side.
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: All refunds
description: Response example with a supplier refund and a customer refund.
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: Paginated refunds
description: Paginated response example showing the second page of results.
value:
data:
- *830
pagination:
size: 1
has_next_page: false
next_cursor:
vendor_refund:
summary: Supplier refund
description: Example of a supplier refund that already has an account payable
or receivable.
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: Customer refund
description: Example of a customer refund still without an account payable or
receivable.
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: Customer refund to invoice
description: Example of a customer refund that goes to the customer invoice.
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: Vendor refund with account payable
description: Example of a refund paid to the vendor, with the separate invoice
generated right away.
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: Passenger list
description: A passenger of an airline ticket with a connection in a closed
sale, within a travel, with a seat assigned only in the first segment.
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: Sales by product
description: An airline ticket with one passenger, one invoice and the commission,
on an agency without multicurrency.
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: Sales by seller
description: A seller with twelve closed sales in the month, in one company.
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: All receipts
description: Response example with a receipt entered as partial OPFAX, where
the consolidated balance of the pair differs from the movement amount, and
a settled receipt.
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: Paginated receipts
description: Paginated response example showing the second page of results.
value:
data:
- *831
pagination:
size: 1
has_next_page: false
next_cursor:
cvc_statement_with_sale:
summary: Receipt with a linked sale
description: Example of a settled receipt, with sale, sale product and fiscal
note.
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: Manual adjustment without a sale
description: 'Manual adjustment example: a movement with no receipt number,
no travel dates and no linked sale.'
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: Master Statement receipt
description: Typed receipt, without invoice.
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: Receipt with the generated invoice
description: The same receipt after generating the invoice, which shows in `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: Master Statement receipts
description: Example response with an imported receipt.
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: Invoice with a typed recipient
description: Creates an invoice with the recipient data sent, ISS withholding
and two items.
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: Invoice for a registered person
description: Creates an invoice whose recipient is a registered person; date,
operation nature and rates come from the settings.
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: Change the date and the items
description: Changes the issue date, changes the amount of one item, adds another
and removes the ones not sent.
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: Saved invoice
description: Unissued invoice, with the local_id of each item sent.
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: Response without read permission
description: For a credential that cannot read invoices in the company, the
write returns only the identifiers.
value:
id: a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35
items:
- id: f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13
local_id: linha-1
issuance_accepted:
summary: Invoice awaiting issuance
description: The invoice sent to e-Notas, awaiting the city hall's answer.
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: Number of the NFS-e issued at the city hall
value:
nfse_number: '4521'
amount_adjustment:
summary: Reduce the amount by 10%
description: Reduces the amount of each invoice item by 10%.
value:
percentage: -10
all_nfs:
summary: All invoices
description: Response example with a canceled invoice and an issued invoice.
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: Paginated invoices
description: Paginated response example showing the second page of results.
value:
data:
- *840
pagination:
size: 1
has_next_page: false
next_cursor:
issued_nf:
summary: Issued invoice
description: Example of an issued invoice, with one item and the references
to the sale that originated it.
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: Canceled invoice
description: Example of a canceled invoice, issued manually and without a link
to a sale product.
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: Returns the history with an edition, a report export and a record
creation written by an API request, with no author.
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: Paginated logs
description: Returns the second page of the history, with one log per page.
value:
data:
- *847
pagination:
size: 1
has_next_page: true
next_cursor: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9sb2dzI2luZGV4In19--5eba5fa50c894ec54e4c22226618cbcb0f7cf86b38dfcd77fdb701eaa23b8aa9
edition_log:
summary: Edition log
description: Returns a change made by a person, with the references to the author
and to the audited record.
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 written by the API
description: 'Returns a record creation written by an API request, with no author:
the credential that wrote it is named in the first line of the description.'
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: Custom fields
description: Returns the definitions of sales custom fields, with a list-kind
field and a text field.
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: Custom field
description: Returns the definition of a single list-kind custom field, with
its registered options.
value:
id: 123
resource: sales
name: Centro de custo
kind: choices
required: true
active: true
choices:
- Matriz
- Filial
all_commission_plans:
summary: All commission plans
description: Example response with two plans.
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: Commission plan
description: 'Example plan with two ranges: until 100% of the goal the seller
earns 3% (1.5% in a sale with an intermediary); from 100%, 5%, and R$ 50.00
per unit of a specific product.'
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: All goals
description: Example response with the goal of a seller.
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: Goal
description: Example goal of a seller, with their commission plan.
value: *848
all_banks:
summary: All banks
description: Example response containing banks from the reference table.
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: Example response for a specific bank.
value:
id: c3b7e8eb-1199-4457-9170-923c3fe56c92
number: '001'
name: Banco do Brasil S.A.
bank_reconciliation_list:
summary: Uploaded statements
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: Statement with the summary
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
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: List of transfers
value:
data:
- *851
pagination:
size: 20
has_next_page: false
next_cursor:
create_transfer:
summary: Transfer from the cash to the bank
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: Change only the amount
value:
amount: 200
delete_reconciled_transfer:
summary: Delete a reconciled transfer
value:
undo_bank_reconciliation: true
account_balance:
summary: Account balance
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: Statement with an entry and a transfer
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: Close the cash reviewing the balance
value:
date: '2026-10-15'
expected_balance: 1849.75
cash_closure:
summary: Cash closed
value:
account:
id: ddecf0c0-c13d-43e9-b14b-c394a8bbe853
cash_closed_until: '2026-10-15'
all_category_groups:
summary: All groups
description: Expense and revenue groups.
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: Expense group
description: Example of an expense category group.
value:
id: b2a6d7da-ff94-40e3-b069-812b2fd45b91
delete_category_group_with_categories:
summary: Delete the group with its categories
value:
delete_categories: true
name: Despesas Administrativas
kind: expense
create_category_group_detail:
summary: New group
description: Expense group.
value:
name: Impostos
kind: expense
update_category_group_detail:
summary: Rename group
description: Changes only the name.
value:
name: Tributos
written_category_group_detail_reference:
summary: Only the id
description: Response to a credential that cannot read categories.
value:
id: b2a6d7da-ff94-40e3-b069-812b2fd45b91
securitySchemes:
bearerAuthentication:
type: http
scheme: bearer
description: The credential must be sent in the request's Authorization header
using the Bearer scheme. See the [Authentication](#tag/Authentication) section
for more details.
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: Representative linked to a supply, with its own commercial terms.
properties: *852
supply_schema:
type: object
description: Product supply, with the supplier and the commercial terms negotiated
with it.
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:47'
arrival_date: '2026-11-24T00:00:47'
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:47'
arrival_date: '2026-11-24T00:00:47'
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:47'
arrival_date: '2026-11-21T00:00:47'
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:47'
arrival_date: '2026-11-23T00:00:47'
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:47'
arrival_date: '2026-12-08T00:00:47'
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: 'Welcome to the Monde API! This documentation provides details of available endpoints for integrating your system with us.https://web.monde.com.br/api/v3.
string, integer, float, boolean,
etc. .) as the decimal
separator, with only two decimal places. Example: 99999.99. required. "") is a text value: on a text field it is saved as sent, and
on a required text field it is refused (422). On a field of any other type (object,
list, number, boolean, date, option or reference by id), "" is refused
(422). PATCH), an omitted field stays as
it is, and a field sent as null has its value removed. A field the
record cannot be without refuses null (422).