--- 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: |- security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Response from a request that was already processed successfully before. The response is identical to the original, but with status 200 instead of 201, and includes the X-Idempotent-Replay: true header.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: "$ref": "#/components/schemas/sale_written" examples: all_products_sale: summary: Sale with all products "$ref": "#/components/examples/all_products_sale_single" '201': description: Sale created successfully. content: application/json: schema: "$ref": "#/components/schemas/sale_written" 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" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale" examples: all_products_sale: summary: Sale with all products "$ref": "#/components/examples/all_products_sale" sale_with_custom_fields: summary: Sale with custom fields "$ref": "#/components/examples/sale_with_custom_fields" required_fields_sale: summary: Sale with all products and their required fields "$ref": "#/components/examples/required_fields_sale" multiple_products_of_same_kind_sale: summary: Sale with multiple products of the same kind "$ref": "#/components/examples/multiple_products_of_same_kind_sale" insurance_only_sale: summary: Sale with travel insurance "$ref": "#/components/examples/insurance_only_sale" cruise_only_sale: summary: Sale with cruise "$ref": "#/components/examples/cruise_only_sale" hotel_only_sale: summary: Sale with hotel room nights "$ref": "#/components/examples/hotel_only_sale" airline_ticket_only_sale: x-ignore-on-postman: true summary: Sale with airline ticket "$ref": "#/components/examples/airline_ticket_only_sale" train_ticket_only_sale: x-ignore-on-postman: true summary: Sale with train ticket "$ref": "#/components/examples/train_ticket_only_sale" ground_transportation_only_sale: x-ignore-on-postman: true summary: Sale with ground transportation "$ref": "#/components/examples/ground_transportation_only_sale" car_rental_only_sale: x-ignore-on-postman: true summary: Sale with car rental "$ref": "#/components/examples/car_rental_only_sale" travel_package_only_sale: x-ignore-on-postman: true summary: Sale with travel package "$ref": "#/components/examples/travel_package_only_sale" excursion_only_sale: x-ignore-on-postman: true summary: Sale with excursion "$ref": "#/components/examples/excursion_only_sale" visa_only_sale: x-ignore-on-postman: true summary: Sale with visa "$ref": "#/components/examples/visa_only_sale" company_payer_sale: summary: Sale with company as payer "$ref": "#/components/examples/company_payer_sale" foreigner_payer_sale: summary: Sale with foreign payer "$ref": "#/components/examples/foreigner_payer_sale" datetime_products_sale: summary: Sale with dates and times in products "$ref": "#/components/examples/datetime_products_sale" foreign_sale: summary: Sale with foreign currency and supplier "$ref": "#/components/examples/foreign_sale" foreign_passenger_sale: summary: Sale with foreign passenger "$ref": "#/components/examples/foreign_passenger_sale" multiple_passengers_sale: summary: Sale with multiple passengers "$ref": "#/components/examples/multiple_passengers_sale" multiple_passengers_one_amount_sale: summary: Sale with multiple passengers but only one with amount "$ref": "#/components/examples/multiple_passengers_one_amount_sale" partial_payment_sale: summary: Sale with partial payment "$ref": "#/components/examples/partial_payment_sale" operation_only_sale: summary: Own operation sale with passengers "$ref": "#/components/examples/operation_only_sale" operation_no_passengers_sale: summary: Own operation sale without passengers "$ref": "#/components/examples/operation_no_passengers_sale" others_only_sale: summary: Other product sale with passengers "$ref": "#/components/examples/others_only_sale" others_no_passengers_sale: summary: Other product sale without passengers, in foreign currency "$ref": "#/components/examples/others_no_passengers_sale" own_operation_sale: summary: Own operation sale with every product "$ref": "#/components/examples/own_operation_sale" closed_sale_with_commissions: summary: Closed sale with commissions "$ref": "#/components/examples/closed_sale_with_commissions" "/sales/{id}": get: operationId: getSale summary: Get sale by ID x-badges: - name: Beta color: "#f5803e" tags: - Sales description: 'Returns complete data for a specific sale, including all associated products and information. As the columns and tabs Monde hides, commission, over and revenue (on the products and in `totals.revenue`) only come with the "View commission, over and revenue" permission; `payments` and `financial`, with "View financial tab"; and `commissions`, with "View commissions tab". Without the permission, the field is left out of the response. It also applies to the response of Create and Update sale: without "View financial tab", `payments` brings only the `id` and the `local_id` of the payments sent.' 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 sale identifier (UUID format). example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': "$ref": "#/components/responses/sale" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deleteSale summary: Delete sale x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |-

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.

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 sale identifier (UUID format). example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: Sale 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 sale cannot be deleted. The message gives the reason. Nothing was changed. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Closed sales cannot be deleted. - The sale is already deleted. example: errors: - Closed sales cannot be deleted. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateSale summary: Update a sale x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Unique sale identifier (UUID format). example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: Sale updated successfully. Brings the sale in the get by ID format, or only the id when the credential cannot read the sale. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_written" - "$ref": "#/components/schemas/sale_written_reference" examples: all_products_sale: summary: Sale with all products "$ref": "#/components/examples/all_products_sale_single" updated_sale_reference: summary: Updated sale, without read permission "$ref": "#/components/examples/updated_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_update" examples: update_sale_header: summary: Change the approver and a custom field "$ref": "#/components/examples/update_sale_header" update_sale_products: summary: Change a product and replace the payments "$ref": "#/components/examples/update_sale_products" update_sale_payments: summary: Keep a payment and add another "$ref": "#/components/examples/update_sale_payments" reopen_sale: summary: Reopen the closed sale and change the date "$ref": "#/components/examples/reopen_sale" "/sales/{sale_id}/products/{product_id}/cancellation": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Sale identifier (UUID), the `id` returned when reading and creating the sale. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: product_id required: true schema: type: string format: uuid description: Sale product identifier (UUID), the product `id` in `insurances`, `hotels`, `airline_tickets` and the other product nodes of the sale. example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 post: operationId: cancelSaleProduct summary: Cancel a sale product x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- > **The product is only canceled when every passenger of it is canceled.** Canceling only some of the passengers leaves the product `active`, with those passengers marked in `canceled_at`. A product without passengers is canceled right away. The options `calculate_commission`, `delete_supplier_balance` and `supplier_fine` only apply when the request leaves every passenger canceled, that is, when the list cancels the ones still missing. `delete_customer_balance` also applies when only some of the passengers are canceled. Cancels a sale product, or some of its passengers, when the customer gives up what was sold. Canceling is not deleting: a deleted product (left out of the product list in `PATCH /sales/{id}`) was registered by mistake and had no movement; a canceled one is a sale that happened and was undone. To undo the cancellation, use [Reactivate a sale product](#tag/Sales/paths/~1sales~1{sale_id}~1products~1{product_id}~1reactivation/post). **What changes and what does not** - The canceled product **still adds to the sale total**, on purpose, as history. Its values do not change and it can no longer be changed through the sale `PATCH`. - The financial records only change through the options sent: without any of them, the customer balance and what is still to be invoiced to the supplier stay as they are. - A sale with a canceled product cannot be deleted. To delete it, reactivate the product first. **Passengers and dates** The cancellation is always made through the `passengers` list: there is no default date and no canceling every passenger without listing them. No date can be earlier than the sale date. - A product with passengers without `passengers` is refused (`422`). To cancel the whole product, list every active passenger. - With `passengers`, only the people in the list are canceled, each with its own `canceled_at`, required in the item. The person is referenced by `person.id`, the person `id` in `passengers[].person` when reading the sale. - The product only becomes `canceled` when every passenger is canceled; until then it stays `active`, with the canceled passengers marked in `canceled_at`. - A product without passengers is canceled without `passengers` (body `{}` or only the options): its cancellation date is the current date, as in Monde. - `canceled_at` at the root is not accepted (`422`): the date goes in each passenger of the list. - The product cancellation date is the date the cancellation was registered in Monde, as in Monde Desktop. - Canceling a passenger does not adjust the supplier invoice by itself: the share of the passenger is settled on the invoice. **Options** - `delete_customer_balance`: the pending customer balance of this product is deleted and becomes **deleted balance**, which reduces the sale revenue. Only the balance that has not become a payment yet is deleted: if the customer will not pay a payment method already registered, delete it through the sale `PATCH` first. Requires a pending balance in the product. - `delete_supplier_balance`: the items still open for the supplier (without a financial entry or, with the automatic invoice, in an invoice neither settled nor closed), Lei Kandir included, are deleted. What was already settled or paid directly to the supplier stays. Only applies when the request leaves every passenger canceled, and requires an open item. Not available for own operation products. - `supplier_fine`: the fine charged by the supplier, as a positive amount **in the currency the supplier is paid in**. It becomes a fine item to settle with the supplier and reduces the revenue. Requires `delete_supplier_balance`. In an agency, the supplier is paid in the final currency of the sale, and the fine comes back in `supplier_fine` when reading. In an operator, the supplier is paid in the origin currency of the product: the fine sent comes back in `supplier_fine_origin_currency`, and `supplier_fine` brings the amount converted to the final currency by the exchange rate of the product. Example in an operator, product in USD with exchange rate 5: `supplier_fine: 30` in the cancellation comes back as `supplier_fine_origin_currency: 30` and `supplier_fine: 150`. - `calculate_commission`: the canceled product stays in the commission plan goal calculation, as the `calculate_commission` field when reading the product. Default `false`: the product leaves the goal. Only applies when the request leaves every passenger canceled. - In an agency with credit control, the supplier balance is not deleted on cancellation and there is no fine: the settlement is made on the supplier invoice, and `delete_supplier_balance` and `supplier_fine` are refused. **Closed sale** - The whole product can be canceled with the sale closed. Canceling only some of the passengers requires an open sale (`409`). **Response** - The whole sale, as in the read by ID, so the integration sees the product status and the balance. In the product, `canceled_at`, `calculate_commission`, `deleted_balance`, `delete_supplier_balance`, `supplier_fine` and `supplier_fine_origin_currency` show what the cancellation recorded; the fine sent in the currency the supplier is paid in comes back in `supplier_fine` in an agency and in `supplier_fine_origin_currency` in an operator. A credential without permission to read sales receives only the sale `id`. Requires, in the company of the sale, the permission to edit sales and the "Cancel product" permission, as in Monde; without it, the response is 403 with the Monde message. On a sale of another seller, it also requires "Edit sales of other sellers". The automatic connection credential, which only edits the sales it created, only cancels products of those sales, and only when the partner received "Cancel product" in the approval. The cancellation is recorded in the sale history, with the credential name. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_product_cancellation" examples: whole_product: summary: Cancel the whole product "$ref": "#/components/examples/sale_product_cancellation_whole_product" some_passengers: summary: Cancel one passenger "$ref": "#/components/examples/sale_product_cancellation_some_passengers" rest_with_fine: summary: Cancel the rest with a fine "$ref": "#/components/examples/sale_product_cancellation_rest_with_fine" responses: '200': description: Request recorded. Returns the whole sale, as in the read by ID, or only its `id` to whoever cannot read sales. The product `status` tells whether it became canceled (`canceled`, every passenger canceled) or stays active (`active`), and the `canceled_at` of each passenger tells who was canceled. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: partial_response: summary: 'Response: passenger canceled, product active' "$ref": "#/components/examples/sale_product_cancellation_partial_response" whole_response: summary: 'Response: every passenger canceled, product canceled' "$ref": "#/components/examples/sale_product_cancellation_whole_response" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_product_cancellation_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'The state of the sale or the product does not allow the cancellation: deleted sale, product already canceled, or canceling some of the passengers with the sale closed.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - The product is already canceled. To change the cancellation, reactivate the product and cancel it again. '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'The body does not match the product: a person who is not an active passenger of the product, a date that is missing, not expected or earlier than the sale date, an option that requires the whole product or a balance that does not exist, or a field in the wrong format.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - The person in 'passengers[0] person' is not an active passenger of this product. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/products/{product_id}/reactivation": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Sale identifier (UUID), the `id` returned when reading and creating the sale. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: product_id required: true schema: type: string format: uuid description: Sale product identifier (UUID), the product `id` in `insurances`, `hotels`, `airline_tickets` and the other product nodes of the sale. example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 post: operationId: reactivateSaleProduct summary: Reactivate a sale product x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- Undoes the product cancellation, for the whole product or only some of its passengers, as the uncancellation in Monde does. The product goes back to the `active` status and returns to the commission plan goal calculation. **Passengers** - The reactivation is always made through the `passengers` list, with the person of each canceled passenger that comes back. To reactivate the whole product, list every canceled passenger. A product with passengers without the list is refused (`422`). - A product without passengers is reactivated without the list (body `{}`). - Each person in the list, referenced by `person.id` as in the cancellation, must be a canceled passenger of the product. - The body does not accept `canceled_at` nor the cancellation options (`422`): the reactivation undoes the cancellation as it was recorded. **Financial records** - If the cancellation deleted the supplier balance, what is still to be invoiced to the supplier is registered again. - When every canceled passenger comes back, the rest of the cancellation is undone: the customer balance deleted on cancellation becomes a pending balance of the payer again, and the supplier fine is removed (if it was already invoiced, a reversal item cancels it out). - Reactivating only some of the passengers, the fine and the deleted balance stay as they are. - Refunds and credits already registered for the sale are not undone. - With the sale closed, the reactivation is accepted, for some of the passengers or the whole product, as in Monde, without reopening the sale. The exception is a product whose cancellation deleted customer balance: the reactivation that brings back every passenger still canceled, or the whole product, brings that balance back, and a closed sale has no balance (`409`). On that product, some of the passengers can still be reactivated, keeping the deleted balance; to bring the last ones back, reopen the sale first. - With the automatic supplier invoice, the cancellation fine is posted to the invoice a few seconds later. Meanwhile, the reactivation answers `409`: repeat the request in a few seconds. A fine that did not reach the invoice within 10 minutes no longer blocks the reactivation. Requires the same permissions as the cancellation: editing sales and "Cancel product", in the company of the sale, as the uncancellation in Monde. The response is the whole sale, or only its `id` to whoever cannot read sales. The reactivation is recorded in the sale history, with the credential name. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_product_reactivation" examples: reactivate_one_passenger: summary: Reactivate one passenger "$ref": "#/components/examples/sale_product_reactivation_one_passenger" reactivate_rest: summary: Reactivate the rest "$ref": "#/components/examples/sale_product_reactivation_rest" responses: '200': description: Product reactivated. Returns the whole sale, as in the read by ID, or only its `id` to whoever cannot read sales. The product `status` goes back to `active`, and the reactivated passengers have no `canceled_at`. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: reactivation_response: summary: 'Response: product reactivated' "$ref": "#/components/examples/sale_product_reactivation_response" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_product_cancellation_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'The state of the sale or the product does not allow the reactivation: deleted sale, product without cancellation, deleted balance with the sale closed, or the cancellation fine still being posted to the automatic supplier invoice (repeat in a few seconds).' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - The product is not canceled and has no canceled passenger. '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'The body does not match the product: a person who is not a canceled passenger of the product, a list that is missing for a product with passengers, empty or repeated, a cancellation field sent in the reactivation, or a field in the wrong format.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - The person in 'passengers[0] person' is not a canceled passenger of this product. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/vendor_items/{id}": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Sale identifier (UUID), the `id` returned when reading and creating the sale. example: 212b54b8-27df-4859-80a9-79ad855bcd09 - in: path name: id required: true schema: type: string format: uuid description: Vendor item identifier (UUID), the `id` of the item in `financial.vendor_items` when reading the sale. example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 patch: operationId: updateSaleVendorItem summary: Update vendor item of the sale x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- Updates the due date and the description of a vendor item of the sale, as the **Edit** of the item in the Financial tab of Monde. The items and their `id` come in `financial.vendor_items`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get). An omitted field stays as it is, and an unknown field is ignored. **What is edited here** - Only an item not yet in an entry nor paid directly to the vendor (`bill` and `payment` null). With the automatic vendor invoice, an item still to be invoiced is also edited, as in Monde. - An item already in an entry answers `409`: the due date and description that apply are those of the entry, which is changed in [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch). - An item paid directly to the vendor answers `409`: the due date is the one of the payment, which is changed in the payments of the sale, in [Update sale](#tag/Sales/paths/~1sales~1{id}/patch). - A credit generated for the vendor (`generated_credit`) answers `409`: it is handled in the credit of the person. - A deleted sale answers `409`. An item that is not a vendor item of this sale, including a customer item and one awaiting deletion, answers `404`. - As in Monde, a closed sale or one with a printed receipt does not prevent the update, and the update does not go into the history of the sale. **Response** - The whole sale, as in the read by ID, with the updated item in `financial.vendor_items`. A credential without permission to read sales receives only the sale `id`. It requires, in the company of the sale, the permission to edit sales and "Ver aba financeiro" (view the financial tab), as in Monde; without "Ver aba financeiro", the response is 403 with the Monde message. On a sale of another seller, it also requires "Editar vendas de outros vendedores" (edit sales of other sellers). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_vendor_item_update" examples: due_date_and_description: summary: Due date and description "$ref": "#/components/examples/sale_vendor_item_due_date_and_description" description_only: summary: Description only "$ref": "#/components/examples/sale_vendor_item_description_only" responses: '200': description: Item updated. Returns the whole sale, as in the read by ID, or only its `id` to whoever cannot read sales. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Response: the sale with the updated item' "$ref": "#/components/examples/sale_vendor_item_sale_response" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_vendor_item_sale_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'The item is not edited here: the sale is deleted, or the item is already in an entry, was paid directly to the vendor or is a generated credit.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - 'The item is already in an entry (its ''bill''): the due date and description that apply are those of the entry, which is edited there.' '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'The body does not match: a due date that is null, empty or out of the ISO 8601 format, or a description longer than 100 characters or that is not a text.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Informe o vencimento. '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/vendor_invoices": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Sale identifier (UUID), the `id` returned when reading and creating the sale. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: createSaleVendorInvoice summary: Generate a standalone payment or deposit to the vendor of the sale x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- Generates the invoice of the standalone payment or of the deposit to the vendor or representative, with the open vendor items of the sale, as the **Generate Standalone Payment or Deposit** of the Financial tab and the **Vendor Deposit** of the product menu, in Monde. The items and their `id` come in `financial.vendor_items`, when [reading the sale by ID](#tag/Sales/paths/~1sales~1{id}/get). Unknown fields are ignored. **How the invoice is generated** - With the automatic vendor invoice on, and outside a CVC sale, it is the automatic standalone invoice: the item leaves the automatic invoice it is in and goes to the new invoice. An item the automatic invoice has not processed yet answers `409`; try again later. - Without the automatic invoice, or on a CVC sale, it is the vendor invoice made by the sale. Its due date is the earliest due date of the generated items, and an item without a due date counts as today. - An invoice has only one person and one currency: all the items must be of the same vendor or representative and the same currency. **Refusals** - A deleted sale answers `409`, as does a closed or settled invoice the item is in. - An item of another sale, of another vendor or currency, that is not open, repeated, or of a product other than `product_id` answers `422`, pointing to the item. - As in Monde, a closed sale or one with a printed receipt does not prevent the generation, and the sale gets no history entry: the generated invoice has its own history. **Response** - The generated invoice, as in [Read account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get), with its address in the `Location` header. A credential that cannot read the invoice receives only its `id`. Requires, in the company of the sale, the permission to edit sales, and on the sale of another seller also "Editar vendas de outros vendedores" (edit sales of other sellers). It also requires "Ver aba financeiro" (view the financial tab), as the advance payment or deposit action of the Financial tab in Monde; only `deposit` with `product_id`, the vendor deposit of the product, does not. The invoice made by the sale, without the automatic invoice, also requires "Gerar Fatura" (generate invoice), of the accounts payable and receivable. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_vendor_invoice_create" examples: advance: summary: Standalone payment "$ref": "#/components/examples/sale_vendor_invoice_advance" deposit: summary: Deposit to the vendor of the product "$ref": "#/components/examples/sale_vendor_invoice_deposit" responses: '201': description: Invoice generated. Returns the invoice, as when reading it by ID, or only its `id` to whoever cannot read it. headers: Location: schema: type: string description: Address of the generated invoice in the API (`/api/v3/bills/{id}`). content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: bill_response: summary: 'Response: the generated invoice' "$ref": "#/components/examples/vendor_invoice_bill_single" bill_reference: summary: Response to whoever cannot read the invoice "$ref": "#/components/examples/sale_vendor_invoice_bill_reference" '200': description: 'Resend with the same `Idempotency-Key`: returns the response of the first generation, without generating again.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: bill_response: summary: 'Response: the generated invoice' "$ref": "#/components/examples/vendor_invoice_bill_single" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: The sale is deleted, the item has not been processed by the automatic invoice yet, or the invoice it is in is already closed or settled. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - The sale is deleted and generates no standalone payment or deposit to the vendor. '415': "$ref": "#/components/responses/unsupported_media_type" '422': description: 'The body does not match: `kind` missing or out of the list, empty `items`, amount missing or not greater than zero, `transaction_kind` out of the list, item of another sale, of another vendor or currency, not open, repeated or of another product, or an own operation or deleted product.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - 'O campo ''items[0] id'' não está em aberto: já está num lançamento ou foi pago direto ao fornecedor' '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/to_invoice": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Sale identifier (UUID), the `id` returned when reading and creating the sale. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: createSaleToInvoice summary: To invoice (Faturar) x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- Adds the to-invoice payment to the sale, as the **Faturar** of the Financial tab of the sale in Monde: the payer pays the customer balance through the customer invoice. Unknown fields are ignored; so is the description, which the to-invoice payment does not have. **How it is recorded** - It records one customer item to invoice per product, without a bill of its own. The automatic invoicing takes the items to the customer invoice of the payer, in the background, right after. That is why the response is `202`. - The amount of each product goes with the sign of its customer balance, as the Monde screen shows it: negative on a product with a negative balance, positive on the others. - Once the item enters the invoice, the payment shows in `payments.agency.to_invoice` when [reading the sale](#tag/Sales/paths/~1sales~1{id}/get), in one line per customer invoice and cost center. Until then, it does not show in the sale. - The sale update does not change the to-invoice payment: the `payments` list neither keeps nor removes it. It leaves through the [to-invoice removal](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice~1removal/post). **Refusals** - A closed or deleted sale answers `409`: the to-invoice payment is only added to an open sale. - Without a customer balance to invoice on any product, the response is `422`, as Monde only offers the to-invoice payment when there is a balance. - A product that is not of the sale, repeated, without a customer balance, with the opposite sign or of another sale currency answers `422`, pointing to the product, as do a zero sum and a cost center the payer does not have. **Response** - The whole sale, as when [reading the sale by ID](#tag/Sales/paths/~1sales~1{id}/get). A credential that cannot read sales receives only its `id`. Requires, in the company of the sale, the permission to edit sales, and on a sale with a printed receipt also "Alterar vendas com recibo impresso" (change sales with a printed receipt). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_to_invoice_create" examples: to_invoice: summary: Invoice the balance of a product "$ref": "#/components/examples/sale_to_invoice" to_invoice_with_cost_center: summary: Invoice to another payer, with a cost center "$ref": "#/components/examples/sale_to_invoice_with_cost_center" responses: '202': description: To-invoice payment added. The items to invoice are recorded, and the automatic invoicing takes them to the customer invoice right after. Returns the sale, as when reading it by ID, or only its `id` to whoever cannot read sales. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Response: the sale' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_to_invoice_sale_reference" '200': description: 'Resend with the same `Idempotency-Key`: returns the response of the first request, without adding again.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Response: the sale' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_to_invoice_sale_reference" '409': description: The sale is closed or deleted. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Payments can only be added to open sales. Reopen the sale first. '422': description: 'The body does not match: no product with a customer balance to invoice, empty `products`, amount missing or zero, a product that is not of the sale, repeated, without a customer balance, with the opposite sign or of another sale currency, a zero sum, a payer that does not exist, or a cost center that is too long, that the payer does not have, or with an individual payer.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: unavailable: value: errors: - No product of the sale has a customer balance to invoice. sign: value: errors: - 'O campo ''products[0] sale_product_id'' tem saldo do cliente positivo: o valor dele vai positivo' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/to_invoice_returns": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Sale identifier (UUID), the `id` returned when reading and creating the sale. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: createSaleToInvoiceReturn summary: To-invoice return (Devolução Faturar) x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- Adds the to-invoice return to the sale, as the **Devolução › Faturar** of the Financial tab of the sale in Monde: the amount the agency returns to the customer through the customer invoice. The body is the one of the [to-invoice payment](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice/post), with the description (`description`) instead of the cost center, which is ignored. Unknown fields are ignored. **How it is recorded** - As the to-invoice payment: one customer item to invoice per product, without a bill of its own, which the automatic invoicing takes to the customer invoice right after. That is why the response is `202`. - The amount of each product goes with the sign of its customer balance: negative on a product with a negative balance, positive on the others. - Once the item enters the invoice, the return shows in `payments.agency.to_invoice` when [reading the sale](#tag/Sales/paths/~1sales~1{id}/get), in the line of the customer invoice, summed with its sign: the negative amount is the return. It leaves through the [to-invoice removal](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice~1removal/post), together with the line. **Refusals** - A closed or deleted sale answers `409`. - It is only accepted when some product of the sale has a negative customer balance, as Monde only offers the return in that case: without it, the response is `422`. - The rules of the products and of the sum are those of the to-invoice payment (`422`). **Response** - The whole sale, as when [reading the sale by ID](#tag/Sales/paths/~1sales~1{id}/get). A credential that cannot read sales receives only its `id`. Requires, in the company of the sale, the permission to edit sales, and on a sale with a printed receipt also "Alterar vendas com recibo impresso" (change sales with a printed receipt). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_to_invoice_return_create" examples: to_invoice_return: summary: To-invoice return "$ref": "#/components/examples/sale_to_invoice_return" responses: '202': description: To-invoice return added. The items to invoice are recorded, and the automatic invoicing takes them to the customer invoice right after. Returns the sale, as when reading it by ID, or only its `id` to whoever cannot read sales. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Response: the sale' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_to_invoice_sale_reference" '200': description: 'Resend with the same `Idempotency-Key`: returns the response of the first request, without adding again.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Response: the sale' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_to_invoice_sale_reference" '409': description: The sale is closed or deleted. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - Payments can only be added to open sales. Reopen the sale first. '422': description: 'The body does not match: no product with a negative customer balance, empty `products`, amount missing or zero, a product that is not of the sale, repeated, without a customer balance, with the opposite sign or of another sale currency, a zero sum, a payer that does not exist, or a description that is too long.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: unavailable: value: errors: - A return is only accepted when a product of the sale has a negative customer balance. sign: value: errors: - 'O campo ''products[0] sale_product_id'' tem saldo do cliente positivo: o valor dele vai positivo' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sales/{sale_id}/to_invoice/removal": parameters: - in: path name: sale_id required: true schema: type: string format: uuid description: Sale identifier (UUID), the `id` returned when reading and creating the sale. example: 212b54b8-27df-4859-80a9-79ad855bcd09 post: operationId: removeSaleToInvoice summary: Remove a to-invoice line x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- Removes a to-invoice line of the sale, as the **Excluir** (delete) of the payments grid of the Financial tab in Monde. The line is the one in `payments.agency.to_invoice` when [reading the sale](#tag/Sales/paths/~1sales~1{id}/get), pointed by the customer invoice (`bill_id`) and the cost center (`cost_center`). **What is removed** - The whole line: every to-invoice payment and to-invoice return item of the sale in that customer invoice and cost center. The items leave the invoice, and the customer balance of the products comes back. **Refusals** - A deleted sale answers `409`. - A closed sale answers `409`, unless `reopen_sale` comes as `true`: then the sale is reopened, and the credential also needs the permission "Reabrir venda" (reopen sale), `403` without it. - A closed customer invoice always answers `409`: reopen the invoice first, through [Reopen a client invoice](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1invoice_closure/delete). - A settled customer invoice answers `409`, unless `remove_settlement` comes as `true`: then the settlement of the invoice is undone. - A line the sale does not have, with that invoice and that cost center, answers `422`, as does a confirmation that is neither `true` nor `false`. **Response** - The whole sale, as when [reading the sale by ID](#tag/Sales/paths/~1sales~1{id}/get). A credential that cannot read sales receives only its `id`. Requires, in the company of the sale, the permission to edit sales, and on a sale with a printed receipt also "Alterar vendas com recibo impresso" (change sales with a printed receipt). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/sale_to_invoice_removal" examples: removal: summary: Remove the line without a cost center "$ref": "#/components/examples/sale_to_invoice_removal" removal_confirmed: summary: Remove reopening the sale and undoing the settlement "$ref": "#/components/examples/sale_to_invoice_removal_confirmed" responses: '200': description: To-invoice line removed. Returns the sale, as when reading it by ID, or only its `id` to whoever cannot read sales. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/sale_detail" - "$ref": "#/components/schemas/entity_reference" examples: sale_response: summary: 'Response: the sale' "$ref": "#/components/examples/all_products_sale_single" sale_reference: summary: Response to whoever cannot read sales "$ref": "#/components/examples/sale_to_invoice_sale_reference" '409': description: The sale is deleted, the sale is closed without `reopen_sale`, the customer invoice is closed, or the invoice is settled without `remove_settlement`. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - The invoice is settled. To remove the to-invoice payment, send 'remove_settlement' as true, which undoes the settlement of the invoice. '422': description: 'The body does not match: `bill_id` missing, a line the sale does not have with that invoice and that cost center, a cost center that is not a text, or a confirmation that is neither `true` nor `false`.' content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - O campo 'bill_id' não corresponde a nenhuma linha do Faturar da venda com esta fatura e este centro de custo '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/attachments": post: operationId: uploadAttachment summary: Upload attachment x-badges: - name: Beta tags: - Attachments description: |- security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_multipart" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: multipart/form-data: schema: "$ref": "#/components/schemas/attachment" examples: upload_attachments: summary: Attachment upload example. "$ref": "#/components/examples/upload_attachments" responses: '200': description: 'Response from a request that was already processed successfully before. The response is identical to the original, but with status 200 instead of 201, and includes the X-Idempotent-Replay: true header.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Indicates that this response is a replay of a previous successfully processed request. content: application/json: schema: "$ref": "#/components/schemas/attachments_response" examples: upload_attachments: summary: Attachment upload response example. "$ref": "#/components/examples/upload_attachments_response" '201': description: Attachment uploaded successfully. content: application/json: schema: "$ref": "#/components/schemas/attachments_response" examples: upload_attachments: summary: Attachment upload response example. "$ref": "#/components/examples/upload_attachments_response" '400': description: The request could not be processed due to a syntax or formatting error. Check that the form-data fields are present and valid. 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 fields, such as resource_type, resource_id, and file, are correct before trying again. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': description: The request's Content-Type header specified a media type that is not supported by the API. Make sure the request is using multipart/form-data. 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 multipart/form-data. '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 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.

As in Monde, deleting only asks the "Delete attachments" permission of the resource that owns the attachment, in the company of the record (a person, which belongs to no company, counts in any company that writes), and the same reach as attaching: The attachment of a record outside the reach of the credential answers 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.

The download requires the read permission of the record that owns the attachment, granted in its company when it has one: Downloading the attachment follows the get of its owner record: downloading requires the "View" permission of the resource, also for what the credential itself created, and the attachment of another user's record also requires the reach with which the credential gets the record.

The address comes ready in the download_url field of the attachments, when getting each of these records by ID. 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: '302': description: Redirect to the temporary link to the file. headers: Location: schema: type: string format: uri description: Temporary link to the file. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/products": get: operationId: listProducts summary: List products x-badges: - name: Beta color: "#f5803e" tags: - Products description: Returns the list of available products in the system, with the ability to filter by product kind. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: kind required: false schema: type: array items: type: string enum: - insurance - cruise - hotel - airline_ticket - train_ticket - ground_transportation - excursion - visa - car_rental - travel_package - cvc_package - operation - others style: form explode: false description: " Filters products by kind. For multiple kinds, separate values with commas (e.g., insurance,cruise,hotel). " example: - insurance - cruise examples: single_kind: summary: Filter by single kind value: - insurance multiple_kinds: summary: Filter by multiple kinds value: - insurance - cruise - hotel - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/products" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createProduct summary: Create product x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Adds a product to the catalog. As on the Monde Products screen, only products of the `others` and `operation` (own operation) kinds can be created: the other kinds are system products. Own operation is an agency feature and is refused in an operator (consolidator) base. The kind and `passengers` are chosen on creation and do not change afterwards. Suppliers are added afterwards, at `/products/{id}/supplies`. Requires the permission to create and edit products in a company whose license allows writing.' 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 product.' 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/product" examples: product_detail: summary: Product with supplies "$ref": "#/components/examples/product_detail" '201': description: Product created successfully. content: application/json: schema: "$ref": "#/components/schemas/product" examples: product_detail: summary: Product with supplies "$ref": "#/components/examples/product_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/product_create" examples: create_product: summary: Create a product "$ref": "#/components/examples/create_product" "/products/{id}": get: operationId: getProduct summary: Get product by ID x-badges: - name: Beta color: "#f5803e" tags: - Products description: Returns the complete data for a specific product, including its supplies with the supplier, the commission data and the representatives. 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 product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/product" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateProduct summary: Update product x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Changes an existing product, system products included. Send only the fields that should change: a field omitted stays as it is, and a field sent as null is removed. The included services (`included_services`) and the NBS code (`nbs_code`) sent as null are cleared; `name`, `kind`, `passengers` and `active` cannot be removed, and sending them as null is refused (422). The kind and `passengers` do not change after creation: sending the value the product already has is accepted, and another value is refused. CVC products are maintained by the CVC integration and cannot be changed (409). The response carries the updated product in the same format as the get by ID when the credential also has the "View" permission on products; without it, the change is saved anyway and the response carries only the `id`. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Product 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/product" - "$ref": "#/components/schemas/entity_reference" examples: product_detail: summary: Product with supplies "$ref": "#/components/examples/product_detail" written_product_reference: summary: Record updated, without the read permission "$ref": "#/components/examples/written_product_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/product_update" examples: update_product: summary: Deactivate the product "$ref": "#/components/examples/update_product" delete: operationId: deleteProduct summary: Delete product x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Deletes the product for good. System products cannot be deleted, and neither can a product with related records (suppliers, sales, billing or invoice rules, commission plans, integrations): to take it out of the catalog, deactivate it through PATCH (`active: false`) or merge it into another product on the Monde Products screen. Both cases answer 409. Requires the permission to delete products.' 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 product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Product deleted successfully. The response has no body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/products/{product_id}/supplies": get: operationId: listProductSupplies summary: List product suppliers x-badges: - name: Beta color: "#f5803e" tags: - Products description: Returns the suppliers (supplies) of the product, each with its commercial terms and representatives. Requires the permission to read products. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/supplies" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createProductSupply summary: Add supplier to product x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Adds a supplier to the product. The supplier person (`supplier`) is required and is referenced by its UUID. The same supplier may be added more than once, as long as the descriptions differ. The commission is either a percentage or an amount: the field of the other type is zeroed and, if sent, must be zero. Omitted fields take the Monde defaults: percentage commission, zero values and over on 100%. `restitutes_kandir_law` applies only to products with Kandir Law retention (airline ticket, travel insurance and ground transportation), and is refused on the others. Own operation products and CVC products have no suppliers (409). Requires the "Add supplier" permission on products.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: 'Request repeated with the same `Idempotency-Key`: returns the original response, without adding another supplier.' 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/supply" examples: supply: summary: Supply "$ref": "#/components/examples/supply" '201': description: Supplier added successfully. content: application/json: schema: "$ref": "#/components/schemas/supply" examples: supply: summary: Supply "$ref": "#/components/examples/supply" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/supply_create" examples: create_supply: summary: Add a supplier "$ref": "#/components/examples/create_supply" "/products/{product_id}/supplies/{id}": get: operationId: getProductSupply summary: Get product supplier by ID x-badges: - name: Beta color: "#f5803e" tags: - Products description: Returns a supply of the product, with its commercial terms and representatives. The ID of a supply of another product answers 404. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '200': "$ref": "#/components/responses/supply" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateProductSupply summary: Update product supplier x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Changes a supply of the product. Send only the fields that should change: a field omitted stays as it is, and a field sent as null is removed. The description sent as null is cleared; the supplier (`supplier`), `restitutes_kandir_law` and the commission fields cannot be removed, and sending them as null is refused (422). When `commission_type` changes, the commission field of the other type is zeroed. Representatives are maintained through their own path. Requires the "Edit supplier" permission on products. The response carries the updated supply when the credential also has the "View" permission on products; without it, only the `id`. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '200': description: Supplier 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/supply" - "$ref": "#/components/schemas/entity_reference" examples: supply: summary: Supply "$ref": "#/components/examples/supply" written_product_reference: summary: Record updated, without the read permission "$ref": "#/components/examples/written_product_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/supply_update" examples: update_supply: summary: Switch the commission to an amount "$ref": "#/components/examples/update_supply" delete: operationId: deleteProductSupply summary: Remove supplier from product x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Removes the supply from the product, together with its representatives. A supply used in sales cannot be removed (merge it into another supplier on the Monde Products screen), and neither can a supplier that has a billing rule for the product: both cases answer 409. Requires the "Delete supplier" permission on products.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '204': description: Supplier removed successfully. The response has no body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/products/{product_id}/supplies/{supply_id}/representations": get: operationId: listSupplyRepresentations summary: List supplier representatives x-badges: - name: Beta color: "#f5803e" tags: - Products description: Returns the representatives of a supply of the product, each with its own commercial terms. Requires the permission to read products. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/representations" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createSupplyRepresentation summary: Add representative to supplier x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Adds a representative to the supply of the product. The representative person (`representative`) is required, referenced by its UUID, and cannot repeat in the same supply. The commission follows the same rules as the supply: percentage or amount, with the field of the other type zeroed, and the omitted fields with the Monde defaults. Requires the "Add representative" permission on products.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b responses: '200': description: 'Request repeated with the same `Idempotency-Key`: returns the original response, without adding another representative.' 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/representation" examples: representation: summary: Representative "$ref": "#/components/examples/representation" '201': description: Representative added successfully. content: application/json: schema: "$ref": "#/components/schemas/representation" examples: representation: summary: Representative "$ref": "#/components/examples/representation" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/representation_create" examples: create_representation: summary: Add a representative "$ref": "#/components/examples/create_representation" "/products/{product_id}/supplies/{supply_id}/representations/{id}": get: operationId: getSupplyRepresentation summary: Get supplier representative by ID x-badges: - name: Beta color: "#f5803e" tags: - Products description: Returns a representative of the supply. The ID of a representative of another supply answers 404. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - in: path name: id required: true schema: type: string format: uuid description: Unique identifier of the supply representative (UUID format). example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a responses: '200': "$ref": "#/components/responses/representation" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateSupplyRepresentation summary: Update supplier representative x-badges: - name: Beta color: "#f5803e" tags: - Products description: 'Changes a representative of the supply. Send only the fields that should change: a field omitted stays as it is. The representative (`representative`) and the commission fields cannot be removed, and sending them as null is refused (422). Requires the "Edit representative" permission on products. The response carries the updated representative when the credential also has the "View" permission on products; without it, only the `id`. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - in: path name: id required: true schema: type: string format: uuid description: Unique identifier of the supply representative (UUID format). example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a responses: '200': description: Representative 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/representation" - "$ref": "#/components/schemas/entity_reference" examples: representation: summary: Representative "$ref": "#/components/examples/representation" written_product_reference: summary: Record updated, without the read permission "$ref": "#/components/examples/written_product_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/representation_update" examples: update_representation: summary: Change the over "$ref": "#/components/examples/update_representation" delete: operationId: deleteSupplyRepresentation summary: Remove supplier representative x-badges: - name: Beta color: "#f5803e" tags: - Products description: Removes the representative from the supply. A representative used in sales cannot be removed (409). Requires the "Delete representative" permission on products. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: product_id required: true schema: type: string format: uuid description: Unique product identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: supply_id required: true schema: type: string format: uuid description: Unique identifier of the product supply (UUID format). example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b - in: path name: id required: true schema: type: string format: uuid description: Unique identifier of the supply representative (UUID format). example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a responses: '204': description: Representative removed successfully. The response has no body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cabins": get: operationId: listCabins summary: List cabins x-badges: - name: Beta color: "#f5803e" tags: - Cabins description: Returns the list of cabin types 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/cabins" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCabin summary: Create cabin x-badges: - name: Beta color: "#f5803e" tags: - Cabins description: 'Creates a cabin. The name is the cabin key: the cabin is read, updated and deleted by it, and it is what the sale''s cruise product sends in cabin_kind.

Requires the "Edit" permission on cabins in a company that is not read-only. The response brings the created cabin.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Replay of a request already completed with the same Idempotency-Key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/cabin" examples: cabin: summary: Cabin "$ref": "#/components/examples/cabin" '201': description: Cabin created successfully. content: application/json: schema: "$ref": "#/components/schemas/cabin" examples: cabin: summary: Cabin "$ref": "#/components/examples/cabin" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cabin_write" examples: create_cabin: summary: Create cabin "$ref": "#/components/examples/create_cabin" "/cabins/{name}": get: operationId: getCabin summary: Get cabin by name x-badges: - name: Beta color: "#f5803e" tags: - Cabins description: Returns the cabin by its name, sent in the path URL-encoded (space as %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.

Resending with the same Idempotency-Key after changing the name returns 404: the old path no longer exists.

Requires the "Edit" permission on cabins in a company that is not read-only. The response brings the cabin to whoever can also read cabins; to the others, only the name. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: name required: true schema: type: string maxLength: 30 description: Current cabin name, URL-encoded example: Varanda responses: '200': description: Cabin updated successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/cabin" examples: cabin: summary: Cabin "$ref": "#/components/examples/cabin" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cabin_write" examples: update_cabin: summary: Rename cabin "$ref": "#/components/examples/update_cabin" delete: operationId: deleteCabin summary: Delete cabin x-badges: - name: Beta color: "#f5803e" tags: - Cabins description: 'Deletes the cabin by its current name, sent in the path URL-encoded. A cabin used in any sale product cannot be deleted: the response is 409, as in Monde.

Requires the "Delete" permission on cabins in a company that is not read-only.' 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: '204': description: Cabin 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" "/ships": get: operationId: listShips summary: List ships x-badges: - name: Beta color: "#f5803e" tags: - Ships description: Returns the list of ships 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/ships" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createShip summary: Create ship x-badges: - name: Beta color: "#f5803e" tags: - Ships description: 'Creates a ship. The name is the ship key: the ship is read, updated and deleted by it, and it is what the sale''s cruise product sends in ship_name.

Requires the "Edit" permission on ships in a company that is not read-only. The response brings the created ship.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Replay of a request already completed with the same Idempotency-Key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/ship" examples: ship: summary: Ship "$ref": "#/components/examples/ship" '201': description: Ship created successfully. content: application/json: schema: "$ref": "#/components/schemas/ship" examples: ship: summary: Ship "$ref": "#/components/examples/ship" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ship_write" examples: create_ship: summary: Create ship "$ref": "#/components/examples/create_ship" "/ships/{name}": get: operationId: getShip summary: Get ship by name x-badges: - name: Beta color: "#f5803e" tags: - Ships description: Returns the ship by its name, sent in the path URL-encoded (space as %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.

Resending with the same Idempotency-Key after changing the name returns 404: the old path no longer exists.

Requires the "Edit" permission on ships in a company that is not read-only. The response brings the ship to whoever can also read ships; to the others, only the name. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: name required: true schema: type: string maxLength: 30 description: Current ship name, URL-encoded example: MSC Preziosa responses: '200': description: Ship updated successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/ship" examples: ship: summary: Ship "$ref": "#/components/examples/ship" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ship_write" examples: update_ship: summary: Rename ship "$ref": "#/components/examples/update_ship" delete: operationId: deleteShip summary: Delete ship x-badges: - name: Beta color: "#f5803e" tags: - Ships description: 'Deletes the ship by its current name, sent in the path URL-encoded. A ship used in any sale product cannot be deleted: the response is 409, as in Monde.

Requires the "Delete" permission on ships in a company that is not read-only.' 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: '204': description: Ship 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" "/packages": get: operationId: listPackages summary: List packages x-badges: - name: Beta color: "#f5803e" tags: - Packages description: Returns the list of packages registered in the system, ordered by name. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/packages" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createPackage summary: Create package x-badges: - name: Beta color: "#f5803e" tags: - Packages description: 'Creates a package. The name is the package key: the package is read, updated and deleted by it, and it is what the sale''s tour package product sends in package_name.

Requires the "Edit" permission on packages in a company that is not read-only. The response brings the created package.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Replay of a request already completed with the same Idempotency-Key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/package" examples: package: summary: Package "$ref": "#/components/examples/package" '201': description: Package created successfully. content: application/json: schema: "$ref": "#/components/schemas/package" examples: package: summary: Package "$ref": "#/components/examples/package" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/package_write" examples: create_package: summary: Create package "$ref": "#/components/examples/create_package" "/packages/{name}": get: operationId: getPackage summary: Get package by name x-badges: - name: Beta color: "#f5803e" tags: - Packages description: Returns the package by its name, sent in the path URL-encoded (space as %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.

Resending with the same Idempotency-Key after changing the name returns 404: the old path no longer exists.

Requires the "Edit" permission on packages in a company that is not read-only. The response brings the package to whoever can also read packages; to the others, only the name. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: name required: true schema: type: string maxLength: 50 description: Current package name, URL-encoded example: Disney 7 noites responses: '200': description: Package updated successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/package" examples: package: summary: Package "$ref": "#/components/examples/package" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/package_write" examples: update_package: summary: Rename package "$ref": "#/components/examples/update_package" delete: operationId: deletePackage summary: Delete package x-badges: - name: Beta color: "#f5803e" tags: - Packages description: 'Deletes the package by its current name, sent in the path URL-encoded. A package used in any sale product cannot be deleted: the response is 409, as in Monde.

Requires the "Delete" permission on packages in a company that is not read-only.' 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: '204': description: Package 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" "/cost_centers": get: operationId: listCostCenters summary: List cost centers x-badges: - name: Beta color: "#f5803e" tags: - Cost Centers description: Returns the list of cost centers 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/cost_centers" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCostCenter summary: Create cost center x-badges: - name: Beta color: "#f5803e" tags: - Cost Centers description: 'Registers a cost center. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repeat of a request already processed with the same idempotency key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: "$ref": "#/components/schemas/cost_center" examples: cost_center: summary: Administrative cost center "$ref": "#/components/examples/cost_center" '201': description: Cost center created. content: application/json: schema: "$ref": "#/components/schemas/cost_center" examples: cost_center: summary: Administrative cost center "$ref": "#/components/examples/cost_center" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cost_center_create" examples: create_cost_center: summary: New cost center "$ref": "#/components/examples/create_cost_center" "/cost_centers/{id}": get: operationId: getCostCenter summary: Get cost center by ID x-badges: - name: Beta color: "#f5803e" tags: - Cost Centers description: Returns a specific cost center 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 cost center identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/cost_center" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCostCenter summary: Update cost center x-badges: - name: Beta color: "#f5803e" tags: - Cost Centers description: 'Changes the description of the cost center. An omitted field stays as it is; `description` cannot be removed, and sent as null it is refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the `id`. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' 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 cost center identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Cost center updated. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/cost_center" - "$ref": "#/components/schemas/entity_reference" examples: cost_center: summary: Administrative cost center "$ref": "#/components/examples/cost_center" written_cost_center_reference: summary: Only the id "$ref": "#/components/examples/written_cost_center_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cost_center_update" examples: update_cost_center: summary: Rename cost center "$ref": "#/components/examples/update_cost_center" delete: operationId: deleteCostCenter summary: Delete cost center x-badges: - name: Beta color: "#f5803e" tags: - Cost Centers description: Deletes the cost center. A cost center used in the apportionment of any financial entry responds 409. Does not require `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: Unique cost center identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Cost center deleted. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies": get: operationId: listCurrencies summary: List currencies x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: Returns the list of currencies 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/currencies" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies/{code}": get: operationId: getCurrency summary: Get currency by code x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: Returns a specific currency by its ISO 4217 code. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Currency code in ISO 4217 format example: BRL responses: '200': "$ref": "#/components/responses/currency" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCurrency summary: Update currency x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: 'Activates or deactivates the currency by its code. The currency list is internal and fixed: code, description and symbol do not change, and sending a value different from the current one in those fields is rejected with 422. An omitted field stays as it is.

Requires the "Edit currencies and record exchange rates" permission on currencies in a company that is not read-only. The response brings the currency to whoever can also read currencies; to the others, only the code.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: code required: true schema: type: string description: Currency code in ISO 4217 format example: USD responses: '200': description: Currency updated successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/currency" examples: currency: summary: Real "$ref": "#/components/examples/currency" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/currency_update" examples: deactivate_currency: summary: Deactivate currency "$ref": "#/components/examples/deactivate_currency" delete: operationId: deleteCurrency summary: Delete currency x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: 'No currency is deleted: the currency list is internal and fixed, and the response is always 409. To stop using a currency, deactivate it with [Update currency](#tag/Currencies/paths/~1currencies~1{code}/patch).

Requires the "Delete" permission on currencies in a company that is not read-only.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Currency code in ISO 4217 format example: USD responses: '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies/{code}/exchange_rates": get: operationId: listCurrencyExchangeRates summary: List currency exchange rates x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: Returns the currency's exchange rate history, latest first. The exchange rate is how many reais one unit of the currency is worth; the current one is the latest. Requires the "View" permission on currencies. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Currency code in ISO 4217 format example: USD - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/exchange_rates" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCurrencyExchangeRate summary: Record currency exchange rate x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: 'Records the currency''s new exchange rate, dated at the moment of recording, as Monde''s Update Exchange Rates tool. The value is how many reais one unit of the currency is worth, greater than zero, and is recorded with 4 decimal places.

Only active currencies, except the real (BRL), take exchange rates. When the value equals the current exchange rate, nothing is recorded and the response brings the current one, with 200.

Recording exchange rates is exclusive to tour operators: for travel agencies the response is 403. Requires the "Edit currencies and record exchange rates" permission on currencies in a company that is not read-only.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: code required: true schema: type: string description: Currency code in ISO 4217 format example: USD responses: '200': description: 'Value equal to the current exchange rate: nothing was recorded, and the response brings the current one. It is also the response to the replay of a request already completed with the same Idempotency-Key.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate" examples: exchange_rate: summary: Exchange rate "$ref": "#/components/examples/exchange_rate" '201': description: Exchange rate recorded successfully. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate" examples: exchange_rate: summary: Exchange rate "$ref": "#/components/examples/exchange_rate" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_create" examples: create_exchange_rate: summary: Record exchange rate "$ref": "#/components/examples/create_exchange_rate" "/currencies/{code}/exchange_rates/{id}": get: operationId: getCurrencyExchangeRate summary: Get exchange rate by ID x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: Returns an exchange rate of the currency by its ID. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: code required: true schema: type: string description: Currency code in ISO 4217 format example: USD - in: path name: id required: true schema: type: string format: uuid description: Exchange rate ID example: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 responses: '200': "$ref": "#/components/responses/exchange_rate" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/currencies/exchange_rates": post: operationId: updateExchangeRates summary: Update exchange rates x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: 'Records at once the new exchange rate of several currencies, as Monde''s Update Exchange Rates tool. Each item carries the currency code and the value, how many reais one unit of it is worth; only active currencies, except the real (BRL), take exchange rates, and the same currency cannot repeat in the list.

Recording is all or nothing: an invalid item rejects the whole request with 422, and the error carries its position in the list, counted from 0. A currency whose value equals the current exchange rate is left out, and the response brings only the recorded exchange rates: 201 when at least one was recorded, and 200 with an empty list when every value equals the current exchange rate.

Exclusive to tour operators: for travel agencies the response is 403. Requires the "Edit currencies and record exchange rates" permission on currencies in a company that is not read-only.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Every value equals the current exchange rate: nothing was recorded, and the response brings an empty list. It is also the response to the replay of a request already completed with the same Idempotency-Key, which returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value "true", when the response is the replay of a previous request with the same Idempotency-Key. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_update_response" examples: exchange_rate_update_response: summary: Recorded exchange rates "$ref": "#/components/examples/exchange_rate_update_response" '201': description: Exchange rates recorded successfully. content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_update_response" examples: exchange_rate_update_response: summary: Recorded exchange rates "$ref": "#/components/examples/exchange_rate_update_response" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/exchange_rate_update" examples: update_exchange_rates: summary: Update exchange rates "$ref": "#/components/examples/update_exchange_rates" "/categories": get: operationId: listCategories summary: List categories x-badges: - name: Beta color: "#f5803e" tags: - Categories description: Returns the list of financial categories 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/categories" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCategory summary: Create category x-badges: - name: Beta color: "#f5803e" tags: - Categories description: 'Registers a financial category in a group. The kind (`expense` or `revenue`) is the one of the group given in `group_id`. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repeat of a request already processed with the same idempotency key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: "$ref": "#/components/schemas/category" examples: category: summary: Category "$ref": "#/components/examples/category" '201': description: Category created. content: application/json: schema: "$ref": "#/components/schemas/category" examples: category: summary: Category "$ref": "#/components/examples/category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_create" examples: create_category: summary: New category "$ref": "#/components/examples/create_category" "/categories/{id}": get: operationId: getCategory summary: Get category by ID x-badges: - name: Beta color: "#f5803e" tags: - Categories description: Returns a specific financial category 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 category example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCategory summary: Update category x-badges: - name: Beta color: "#f5803e" tags: - Categories description: 'Changes the description, the pass through flag or the group of the category. The category only moves to another group of the same kind: changing the kind of a category is not allowed, as in Monde, and a group of another kind is refused with 422. An omitted field stays as it is; `description`, `group_id` and `pass_through` cannot be removed, and sent as null they are refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the `id`. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' 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 category example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Category updated. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/category" - "$ref": "#/components/schemas/entity_reference" examples: category: summary: Category "$ref": "#/components/examples/category" written_category_reference: summary: Only the id "$ref": "#/components/examples/written_category_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_update" examples: update_category: summary: Rename category "$ref": "#/components/examples/update_category" delete: operationId: deleteCategory summary: Delete category x-badges: - name: Beta color: "#f5803e" tags: - Categories description: Deletes the category. A category used in any financial entry, or chosen as the default in a Monde setting, responds 409. As in Monde, a group left without categories is deleted along with it. Does not require `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: Unique identifier of the category example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Category deleted. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cities": get: operationId: listCities summary: List cities x-badges: - name: Beta color: "#f5803e" tags: - Cities description: 'Returns the cities the agency can use, the ones registered in it and the ones in Monde''s city list. No permission is required: every credential can read them.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: name required: false schema: type: string description: 'Filters by name, case- and accent-insensitive, like Monde''s City field: matches the start of the words of the name (e.g. `Miguel` finds São Miguel do Oeste), the city''s other names in Monde''s city list (e.g. `New York` and `Nova York` find Nova Iorque), the state and the country (e.g. `Paraná` also brings the cities of Paraná). With the filter, the city whose name is the one sent comes first, then the one that has it among its other names, the one whose name starts with it, the one that contains it and, last, the ones found by the state, the country or part of another name; within each group, the largest first.' example: sao paulo - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/cities" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/cities/{id}": get: operationId: getCity summary: Get city by ID x-badges: - name: Beta color: "#f5803e" tags: - Cities description: 'Returns a specific city by its identifier. No permission is required: every credential can read it.' 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 city identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/city" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/person_roles": get: operationId: listPersonRoles summary: List person roles x-badges: - name: Beta color: "#f5803e" tags: - Person roles description: Returns the list of registered roles, by name, with the own fields of the role. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/person_roles" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createPersonRole summary: Register person role x-badges: - name: Beta color: "#f5803e" tags: - Person roles description: Registers a role. A role registered here is not a seller or intermediary role, so it needs at least one company or active seller in `commissioned_over`. Each person appears once in the role, and a commissioned person needs the start date. Each person can already come with their goals, in `goals`. Requires the "Edit" permission on roles. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/person_role_write" examples: create_person_role: summary: Register a role "$ref": "#/components/examples/create_person_role" responses: '200': description: 'Request repeated with the same `Idempotency-Key`: returns the response of the original registration, without registering another role.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous write. content: application/json: schema: "$ref": "#/components/schemas/person_role" examples: person_role: summary: Role "$ref": "#/components/examples/person_role" '201': description: Role registered successfully. content: application/json: schema: "$ref": "#/components/schemas/person_role" examples: person_role: summary: Role "$ref": "#/components/examples/person_role" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/person_roles/{id}": get: operationId: getPersonRole summary: Get person role by ID x-badges: - name: Beta color: "#f5803e" tags: - Person roles description: Returns a specific role by its identifier, with the companies or sellers over whose sales it is commissioned and the linked people, each one with their goals in the role, per year. 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 role identifier example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '200': "$ref": "#/components/responses/person_role" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updatePersonRole summary: Update person role x-badges: - name: Beta color: "#f5803e" tags: - Person roles description: 'Updates a registered role. Send only what should change: an omitted field 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). What the role cannot be without is refused (422): `description`, and in each `people` item the `person` and `not_commissioned`. The `commission_plan` and `start_date` of an item sent as null are removed. A list sent as null counts as the empty list. The lists sent are final: in `commissioned_over`, a company or seller left out leaves the role; in `people`, an item with `id` keeps and updates that link (only the fields sent in it), an item without `id` links a new person, and a link left out is undone, along with the goals of the person in the role. In the `goals` of an item, the list sent is also final: a goal with `id` stays and changes only the fields sent in it, a goal without `id` comes in, and a goal left out is deleted; an omitted `goals` keeps the goals, and a null `goals` deletes them all. Swapping the years of two goals in the same update is refused (422): make the swap in two updates, going through a free year first. In a system role (Seller, Intermediary) only `people` changes. Requires the "Edit" permission on roles. The response brings the updated role in the same format as the get by ID when the credential can also read roles; otherwise, the update is saved and the response brings only the `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 role identifier example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/person_role_update" examples: update_person_role: summary: Update the people of the role "$ref": "#/components/examples/update_person_role" link_person_to_system_role: summary: Link a person to the Seller role "$ref": "#/components/examples/link_person_to_system_role" update_person_goals: summary: Update the goals of a person "$ref": "#/components/examples/update_person_goals" responses: '200': description: Role updated successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous write. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/person_role" - "$ref": "#/components/schemas/entity_reference" examples: person_role: summary: Role "$ref": "#/components/examples/person_role" written_person_role_reference: summary: Role updated, without the read permission "$ref": "#/components/examples/written_person_role_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deletePersonRole summary: Delete person role x-badges: - name: Beta color: "#f5803e" tags: - Person roles description: 'Deletes the role for good, with its person links and their goals. A system role and a role that already has a commission calculated in a sale are not deleted: the response is `409`. Requires the "Delete" permission on roles.' 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 role identifier example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '204': description: Role deleted successfully. The response has no body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sellers": get: operationId: listSellers summary: List sellers x-badges: - name: Beta color: "#f5803e" tags: - Sellers description: Returns the list of sellers registered in the system (active and inactive). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/sellers" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createSeller summary: Register seller x-badges: - name: Beta color: "#f5803e" tags: - Sellers description: Turns an individual person already registered, given in `person_id` (the `id` of the [People](#tag/People) read), into a seller. The seller gets the same identifier as the person. As in Monde, only an individual becomes a seller, and each person only once. The seller is born active, unless `active` is sent as `false`. To register the person and the seller in a single call, along with the sale, use the `seller` of [Create a sale](#tag/Sales/paths/~1sales/post). Requires the "Edit" permission on sellers. 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 registration, without registering again.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous registration. content: application/json: schema: "$ref": "#/components/schemas/seller" examples: seller: summary: Active seller "$ref": "#/components/examples/seller" '201': description: Seller registered successfully. content: application/json: schema: "$ref": "#/components/schemas/seller" examples: seller: summary: Active seller "$ref": "#/components/examples/seller" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/seller_create" examples: create_seller: summary: Register seller "$ref": "#/components/examples/create_seller" "/sellers/{id}": get: operationId: getSeller summary: Get seller by ID x-badges: - name: Beta color: "#f5803e" tags: - Sellers description: Returns a specific seller 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 seller identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/seller" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateSeller summary: Update seller x-badges: - name: Beta color: "#f5803e" tags: - Sellers description: 'Activates or deactivates a seller. An inactive seller stays in the sales where it already is, but is no longer offered in new sales in Monde. The person of the seller does not change: sending another person in `person_id` is rejected with `422`. A field omitted stays as it is; `person_id` and `active` cannot be removed, and sending them as null is rejected (`422`). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (`422`). Requires the "Edit" permission on sellers. The response brings the changed seller when the credential also has the "View" permission on sellers; without it, the change is saved all the same and the response brings only the seller `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 seller identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Seller 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/seller" - "$ref": "#/components/schemas/entity_reference" examples: seller: summary: Active seller "$ref": "#/components/examples/seller" written_seller_reference: summary: Update without read permission "$ref": "#/components/examples/written_seller_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/seller_update" examples: deactivate_seller: summary: Deactivate seller "$ref": "#/components/examples/deactivate_seller" delete: operationId: deleteSeller summary: Delete seller x-badges: - name: Beta color: "#f5803e" tags: - Sellers description: 'Deletes the seller. The person stays registered; it just stops being a seller. A seller that is already in a sale cannot be deleted and answers `409`: deactivate it with `active: false`. Requires the "Delete" permission on sellers.' 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 seller identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Seller deleted successfully. The response has no body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/payment_methods": get: operationId: listPaymentMethods summary: List payment methods x-badges: - name: Beta color: "#f5803e" tags: - Payment Methods description: Returns the list of payment methods registered in the system. Internal system payment methods 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': "$ref": "#/components/responses/payment_methods" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createPaymentMethod summary: Create payment method x-badges: - name: Beta color: "#f5803e" tags: - Payment Methods description: 'Registers an agency payment method. It is created outside the system (`system` equal to `false`) and shows in the list. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repeat of a request already processed with the same idempotency key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: "$ref": "#/components/schemas/payment_method" examples: payment_method: summary: Cash "$ref": "#/components/examples/payment_method" '201': description: Payment method created. content: application/json: schema: "$ref": "#/components/schemas/payment_method" examples: payment_method: summary: Cash "$ref": "#/components/examples/payment_method" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/payment_method_create" examples: create_payment_method: summary: New payment method "$ref": "#/components/examples/create_payment_method" "/payment_methods/{id}": get: operationId: getPaymentMethod summary: Get payment method by ID x-badges: - name: Beta color: "#f5803e" tags: - Payment Methods description: Returns a specific payment method 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 payment method example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/payment_method" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updatePaymentMethod summary: Update payment method x-badges: - name: Beta color: "#f5803e" tags: - Payment Methods description: 'Changes the name of the payment method. A system payment method (`system` equal to `true`) cannot be changed and responds 409, as in Monde; an internal one, which does not show in the list, responds 404. An omitted field stays as it is; `name` cannot be removed, and sent as null it is refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the `id`. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' 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 payment method example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 responses: '200': description: Payment method updated. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/payment_method" - "$ref": "#/components/schemas/entity_reference" examples: payment_method: summary: Cash "$ref": "#/components/examples/payment_method" written_payment_method_reference: summary: Only the id "$ref": "#/components/examples/written_payment_method_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/payment_method_update" examples: update_payment_method: summary: Rename payment method "$ref": "#/components/examples/update_payment_method" delete: operationId: deletePaymentMethod summary: Delete payment method x-badges: - name: Beta color: "#f5803e" tags: - Payment Methods description: Deletes an agency payment method. A system payment method responds 409, as does one used in entries, account movements or rate rules; an internal one responds 404. Does not require `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: Unique identifier of the payment method example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 responses: '204': description: Payment method deleted. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts": get: operationId: listAccounts summary: List accounts and cards x-badges: - name: Beta color: "#f5803e" tags: - Accounts and Cards description: Returns the list of accounts and cards available in the companies where the credential has permission. Active and inactive accounts are 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/accounts" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createAccount summary: Create account or card x-badges: - name: Beta color: "#f5803e" tags: - Accounts and Cards description: 'Registers a cash account (`cashier_account`), checking account (`checking_account`) or credit card (`card_account`), with the same rules as the Monde form. Each kind saves only its own fields: a field of another kind (such as `agency` or `initial_balance` on a card, or `billing_accounts` outside a checking account) is ignored, like a field that does not exist, and is not saved. The account becomes available in the companies of `companies`, and the credential needs the permission to create and edit accounts and cards in each of them. For a credit card, the invoice is generated in `invoice_company`, which must be one of the account companies; with a single company, it is that one. Billing (`billing_accounts`) only exists on checking accounts.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Replay of a request already processed with the same idempotency key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value `true`, when the response is a replay of the original. content: application/json: schema: "$ref": "#/components/schemas/account" examples: account: summary: Credit card "$ref": "#/components/examples/account" '201': description: Account or card created successfully. content: application/json: schema: "$ref": "#/components/schemas/account" examples: account: summary: Credit card "$ref": "#/components/examples/account" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/account_create" examples: create_account: summary: Checking account with billing "$ref": "#/components/examples/create_account" create_card_account: summary: Credit card "$ref": "#/components/examples/create_card_account" "/accounts/{id}": get: operationId: getAccount summary: Get account or card by ID x-badges: - name: Beta color: "#f5803e" tags: - Accounts and Cards description: Returns a specific account or card by its identifier, as long as it is available in a company where the credential has permission. 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 account identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/account" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateAccount summary: Update account or card x-badges: - name: Beta color: "#f5803e" tags: - Accounts and Cards description: 'Updates the account or card. An omitted field stays as it is, a field sent as `null` is removed, and the kind does not change. `description`, `currency`, `active` and `initial_balance` sent as `null` answer 422. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A field of another account kind is ignored, as on creation: sending back what the get returned is not refused. Each list sent becomes the final list of the account: in `companies` and `user_groups`, an item left out is unlinked; in `billing_accounts`, a billing setup with `id` is updated (only in the fields sent), one without `id` is created and one left out is deleted. Linking or unlinking a company requires the permission to edit accounts in it. A company with open entries on the account, or the one that generates the card invoice, cannot be unlinked. Changing the initial balance reopens the closed cash of the account and, as in Monde, also requires the **Reopen Cash** permission of Accounts and Cards in one of the account companies; without it, the response is 403 and nothing is saved. Sending back the saved balance does not require the permission. Changing the card invoice company or due day moves the open invoices along, and changing the company requires the permission to edit accounts in both companies. The response brings the account only to credentials that can also read it; to the others, only the `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 account identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Account or card updated successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present, with the value `true`, when the response is a replay of the original. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/account" - "$ref": "#/components/schemas/entity_reference" examples: account: summary: Credit card "$ref": "#/components/examples/account" written_account_reference: summary: Update without read permission "$ref": "#/components/examples/written_account_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/account_update" examples: update_account: summary: Update description and agreement "$ref": "#/components/examples/update_account" delete: operationId: deleteAccount summary: Delete account or card x-badges: - name: Beta color: "#f5803e" tags: - Accounts and Cards description: Deletes the account or card from every company, so it requires the permission to delete accounts and cards in each company where the account is available. As in Monde, an account with movements, with a billing setup, released to a user group or set as the default receipt account cannot be deleted (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: Unique account identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Account or card 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" "/banks": get: operationId: listBanks summary: List banks x-badges: - name: Beta color: "#f5803e" tags: - Banks description: Returns the list of banks, ordered by bank name, as in the bank choice of the checking account form. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/banks" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/banks/{id}": get: operationId: getBank summary: Get bank by ID x-badges: - name: Beta color: "#f5803e" tags: - Banks description: Returns a specific bank 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 bank example: c3b7e8eb-1199-4457-9170-923c3fe56c92 responses: '200': "$ref": "#/components/responses/bank" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nf_rules": get: operationId: listNfRules summary: List invoice (NF) rules x-badges: - name: Beta color: "#f5803e" tags: - Invoice (NF) Rules description: Returns the list of invoice (nota fiscal) rules registered in the system. Null product, supplier, and payer mean the rule applies to all. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/nf_rules" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nf_rules/{id}": get: operationId: getNfRule summary: Get invoice (NF) rule by ID x-badges: - name: Beta color: "#f5803e" tags: - Invoice (NF) Rules description: Returns a specific invoice (NF) rule 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 invoice (NF) rule example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/nf_rule" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/tasks": get: operationId: listTasks summary: List tasks x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: 'Returns the list of tasks from the companies where the credential has permission (tasks without a company are visible in all of them), from the task without due date to the one due furthest away. The filters are those of the Monde Tasks screen and combine with each other: assignee, who created it, person, category, situation, overdue, period (by due, creation or completion date) and the link to a sale, travel or bill. Without `status`, deleted tasks are not returned. A filter with an invalid value answers 400.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" - in: query name: assignee_id required: false schema: type: string format: uuid description: Returns only the tasks of this assignee, by the person identifier. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: created_by_id required: false schema: type: string format: uuid description: Returns only the tasks created by this person (the task `created_by`). example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: person_id required: false schema: type: string format: uuid description: Returns only the tasks linked to this person. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 - in: query name: category_id required: false schema: type: string description: Returns only the tasks of this category, by the identifier obtained from [List task categories](#tag/Task-Categories/paths/~1task_categories/get). `uncategorized` returns the tasks without a category. example: '11' - in: query name: status required: false schema: type: array items: type: string enum: - pending - completed - deleted style: form explode: false description: 'Situations to return, comma-separated: `pending` (not completed), `completed` and `deleted`. The informed situations add up, and a deleted task only comes when `deleted` is among them. Without the parameter, returns the pending and the completed tasks.' example: - pending - in: query name: overdue required: false schema: type: boolean description: "`true` returns only the overdue tasks: not completed and with the due date already past. `false` returns the ones that are not overdue. A task without due date is never overdue." example: true - in: query name: date_field required: false schema: type: string enum: - due - created_at - completed_at description: 'Date used by the period filter: `due`, `created_at` or `completed_at`. Required when `date_from` or `date_to` is informed.' example: due - in: query name: date_from required: false schema: type: string format: date description: Start of the period (inclusive), in the YYYY-MM-DD format. example: '2024-04-01' - in: query name: date_to required: false schema: type: string format: date description: End of the period (inclusive, the whole day), in the YYYY-MM-DD format. example: '2024-04-30' - in: query name: sale_id required: false schema: type: string format: uuid description: Returns only the tasks linked to this sale. example: 8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 - in: query name: travel_id required: false schema: type: string format: uuid description: Returns only the tasks linked to this travel. example: 1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 - in: query name: bill_id required: false schema: type: string format: uuid description: Returns only the tasks linked to this bill (account payable or receivable). example: 5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 responses: '200': "$ref": "#/components/responses/tasks" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTask summary: Create task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: 'Creates a task with title and assignee; category and due date are optional, and a task without a due date is never overdue. The task''s company is optional, but stating it is not: send `company_identifier` with the company''s CNPJ, or as null for the task to apply to every company; empty is rejected. Omitting the field is rejected, because the company is not inferred. Accepts, in `history`, the comments the task is born with. The task can be born linked to a sale (`sale_id`), a travel (`travel_id`) and a bill (`bill_id`), each one optional and with no required relation to the task person (`person_id`). When sent together, they must match each other: the sale must belong to the travel sent, and the bill to the sale sent. Only records the credential can read are accepted; the others answer 422 as not found. The assignee is notified by email, and the task is created as pending.' 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 response of the original creation, without creating another task.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is a replay of a previous creation. content: application/json: schema: "$ref": "#/components/schemas/task" examples: task_detail: summary: Task with history and custom fields "$ref": "#/components/examples/task_detail" '201': description: Task created successfully. content: application/json: schema: "$ref": "#/components/schemas/task" examples: task_detail: summary: Task with history and custom fields "$ref": "#/components/examples/task_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_create" examples: create_task: summary: Task with every field "$ref": "#/components/examples/create_task" create_required_fields_task: summary: Task with the required fields only "$ref": "#/components/examples/create_required_fields_task" "/tasks/{id}": get: operationId: getTask summary: Get task by ID x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: Returns the data of a specific task, including its history, custom fields and attachments. 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 task identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/task" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTask summary: Update task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: 'Updates an existing task. Send only the fields that should change: a field that is omitted stays as it is, and a field sent as null is removed from the task — the description, the due date, the category, the person and the links. `title`, `assignee_id` and `completed` cannot be removed: a task must have a title and an assignee, and sending them as null or empty is rejected (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). To complete the task send `completed` as `true`, and to reopen it, as `false`. `company_identifier` omitted keeps the task''s company; with a CNPJ, it moves the task to that company and also requires the "Edit" permission on tasks there; sent as null, it leaves the task without a company, applying to every company. Custom fields are not replaced: each one sent overwrites its current value, the one sent with a null or empty `value` is cleared (a required one cannot be cleared: the response is 422), and the others stay. The links to a sale, travel and bill (`sale_id`, `travel_id`, `bill_id`) follow the creation rules: omitted, the link stays; sent as null, it is removed from the task. A task person already filled in is not replaced or removed while the task has a link: remove the links first, or in the same request. Filling in the person of a task that has none is allowed, even with a link. Comments are sent through [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post). Requires the "Edit" permission on tasks. A deleted task cannot be updated: the response is 409. The task participants are notified of the change by email, as when the change is made in Monde. The response returns the updated task in the same format as the query by ID when the credential also has the "View" permission on tasks in the task''s company; without it, the update is written all the same and the response returns only the `id` of the task. This also applies to a task 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 task identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Task successfully updated. 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/task" - "$ref": "#/components/schemas/entity_reference" examples: task_detail: summary: Task with history and custom fields "$ref": "#/components/examples/task_detail" written_task_reference: summary: Task written, without read permission "$ref": "#/components/examples/written_task_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Conflicting request: a request with the same idempotency key is already being processed, or the task is deleted and cannot be updated.' 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 task is deleted and cannot be changed. example: errors: - A request with this idempotency key is already being processed. Please wait for it to complete before retrying. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_update" examples: update_task: summary: Task update "$ref": "#/components/examples/update_task" complete_task: summary: Task completion "$ref": "#/components/examples/complete_task" delete: operationId: deleteTask summary: Delete task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: 'Deletes the task. A deleted task no longer appears in [List tasks](#tag/Tasks/paths/~1tasks/get), but it is still available in the query by ID, with `deleted` set to `true`, and it can no longer be updated or take comments. A completed task cannot be deleted: reopen it first by sending `completed` as `false` in [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch). Requires the delete tasks permission in the task''s company. The task participants are notified of the deletion by email, as when the deletion is made in Monde. Does not require `Idempotency-Key`: repeating the request after the task is deleted responds 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: Unique task identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Task 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 task cannot be deleted: it is completed or already deleted. Nothing was changed.' content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - The task is completed and cannot be deleted. Reopen the task before deleting it. - The task is already deleted. example: errors: - The task is completed and cannot be deleted. Reopen the task before deleting it. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/tasks/{task_id}/history": post: operationId: addTaskComment summary: Comment on the task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: 'Appends a comment to the task history and returns the task with the updated history — or only the `id` of the task, when the credential does not have the "View" permission on tasks in the task''s company, even on a task it created. The task participants are notified of the comment by email, as when the comment is made in Monde. Requires the "Edit" permission on tasks. A deleted task does not take comments: the response is 409. The comment can carry files: send each one first through [Upload attachment](#tag/Attachments/paths/~1attachments/post), with `resource_type` `task` and the task id, and send the returned `id`s in `attachment_ids`. Each attachment is linked to the comment and shows inside it in Monde. With attachments, the text is optional. The history is append-only: a recorded comment is neither changed nor deleted, and the change logs Monde generates are not sent through here.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: task_id required: true schema: type: string format: uuid description: Unique task identifier (UUID format). example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: 'Repeated request with the same `Idempotency-Key`: returns the response of the original record, without recording another comment.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is a replay of a previous record. content: application/json: schema: "$ref": "#/components/schemas/task" examples: task_detail: summary: Task with history and custom fields "$ref": "#/components/examples/task_detail" '201': description: Comment recorded successfully. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/task" - "$ref": "#/components/schemas/entity_reference" examples: task_detail: summary: Task with history and custom fields "$ref": "#/components/examples/task_detail" written_task_reference: summary: Task written, without read permission "$ref": "#/components/examples/written_task_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: 'Conflicting request: a request with the same idempotency key is already being processed, or the task is deleted and does not take comments.' 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 task is deleted and cannot be changed. example: errors: - A request with this idempotency key is already being processed. Please wait for it to complete before retrying. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_comment_create" examples: create_task_historic: summary: Comment on the task "$ref": "#/components/examples/create_task_historic" create_task_historic_with_attachments: summary: Comment with attachments "$ref": "#/components/examples/create_task_historic_with_attachments" "/task_categories": get: operationId: listTaskCategories summary: List task categories x-badges: - name: Beta color: "#f5803e" tags: - Task Categories description: Returns the list of task categories registered in the system, with the task board flag and the position of each column. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/task_categories" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTaskCategory summary: Create task category x-badges: - name: Beta color: "#f5803e" tags: - Task Categories description: Creates a task category. As on Monde's Categories screen, the new category joins the task board as the last column; send `kanban` as `false` to keep it off the board, or `kanban_position` to put it in another position, shifting the other columns. The name is unique, case-insensitive, and surrounding spaces are discarded. Requires the "Edit" permission on task categories. 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 category.' 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/task_category" examples: task_category: summary: Task category "$ref": "#/components/examples/task_category" '201': description: Task category created successfully. content: application/json: schema: "$ref": "#/components/schemas/task_category" examples: task_category: summary: Task category "$ref": "#/components/examples/task_category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_category_create" examples: create_task_category: summary: Create as the second board column "$ref": "#/components/examples/create_task_category" "/task_categories/{id}": get: operationId: getTaskCategory summary: Get task category by ID x-badges: - name: Beta color: "#f5803e" tags: - Task Categories description: Returns the data of a specific task category. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Unique task category identifier. example: 42 responses: '200': "$ref": "#/components/responses/task_category" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTaskCategory summary: Update task category x-badges: - name: Beta color: "#f5803e" tags: - Task Categories description: 'Updates a task category. Send only the fields that must change: an omitted field stays as it is. The name and `kanban` cannot be removed: sent as null they are refused (422), as are an empty name and `kanban` or `kanban_position` sent as an empty text. `kanban_position` is null only off the board: sent as null for a category that stays on the board, it is refused (422). Renaming the category takes its tasks along. With `kanban_position`, the column moves to that position of the board and the others shift; with `kanban` as `false`, the category leaves the board, and its tasks stay in the category. Requires the "Edit" permission on task categories. The response brings the updated category in the same format as the query by ID when the credential also has the "View" permission on task categories; without it, the change is saved anyway and the response brings only the `id`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Unique task category identifier. example: 42 responses: '200': description: Task category 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/task_category" - "$ref": "#/components/schemas/numeric_entity_reference" examples: task_category: summary: Task category "$ref": "#/components/examples/task_category" written_task_category_reference: summary: Category updated, without read permission "$ref": "#/components/examples/written_task_category_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/task_category_update" examples: rename_task_category: summary: Rename "$ref": "#/components/examples/rename_task_category" move_task_category: summary: Move to the first column "$ref": "#/components/examples/move_task_category" hide_task_category: summary: Take off the board "$ref": "#/components/examples/hide_task_category" delete: operationId: deleteTaskCategory summary: Delete task category x-badges: - name: Beta color: "#f5803e" tags: - Task Categories description: 'Deletes the task category for good, and its column leaves the board. As in Monde, only a category without tasks can be deleted, counting completed and deleted tasks too: move the tasks to another category first. Requires the "Delete" permission on task categories.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Unique task category identifier. example: 42 responses: '204': description: Task category 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 category has tasks and was not deleted. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - The category cannot be deleted because it has tasks, including completed or deleted ones. Move the tasks to another category before deleting it. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/travels": get: operationId: listTravels summary: List travels x-badges: - name: Beta color: "#f5803e" tags: - Travels description: Returns the list of travels from the companies where the credential has permission. Dates and situation are calculated from the active products of the linked non-canceled sales. Supports filtering by date on the trip start or end through the date_field, date_from and date_to parameters. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_field required: false schema: type: string enum: - start_date - end_date description: 'Date field used by the filter. Accepted values: start_date (trip start) and end_date (trip end), both calculated from the linked sales. Required when date_from or date_to is provided.' example: start_date - in: query name: date_from required: false schema: type: string format: date description: Filter travels 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 travels whose field chosen in date_field is on or before this date, in ISO 8601 format (YYYY-MM-DD). example: '2024-12-31' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/travels" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTravel summary: Create travel x-badges: - name: Beta color: "#f5803e" tags: - Travels description: 'Creates a travel in the company given in `company_identifier`, with the same rules as Monde: description (up to 60 characters), customer (`customer_id`, a person) and seller (`seller_id`, an active seller) are required. The seller comes in the body because the API credential is not a Monde user. The travel number is generated on save. The travel is created without sales: link them afterwards with `POST /travels/{id}/sales/{sale_id}`. Requires the "Edit" permission of Travels in the company. The travel created by the credential is its own: it updates, deletes and links sales to it without the Consult sales of other sellers permission. A travel created by another credential follows that permission, like those of other sellers.' 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 travel.' 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/travel" examples: travel: summary: Created travel "$ref": "#/components/examples/created_travel" '201': description: Travel created successfully. content: application/json: schema: "$ref": "#/components/schemas/travel" examples: travel: summary: Created travel "$ref": "#/components/examples/created_travel" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/travel_create" examples: create_travel: summary: Create travel "$ref": "#/components/examples/create_travel" "/travels/{id}": get: operationId: getTravel summary: Get travel by ID x-badges: - name: Beta color: "#f5803e" tags: - Travels description: Returns a specific travel with its scalar fields, its attachments and the references to the linked sales and passengers. The amounts per passenger belong to each sale, retrieved through the sale endpoint. 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 travel to retrieve example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/travel" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTravel summary: Update travel x-badges: - name: Beta color: "#f5803e" tags: - Travels description: 'Updates an existing travel. Send only the fields that should change: an omitted field stays as it is. The description, customer, seller and company, which a travel cannot be without, answer 422 when sent as null or as an empty text, as in tasks. Observations are the exception: sent as null, they are cleared. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). The company does not change after the travel is created, as in Monde: `company_identifier` is only accepted with the travel''s own CNPJ. Requires the "Edit" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission; without it, the travel answers 404. The response brings the updated travel in the same format as the get by ID when the credential can also query it; otherwise, the change is saved all the same and the response brings only the travel `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 travel example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': description: Travel updated successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous write. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/travel" - "$ref": "#/components/schemas/entity_reference" examples: travel: summary: Travel detail "$ref": "#/components/examples/travel" written_travel_reference: summary: Written travel, without read permission "$ref": "#/components/examples/written_travel_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/travel_update" examples: update_travel: summary: Change the description and observations "$ref": "#/components/examples/update_travel" delete: operationId: deleteTravel summary: Delete travel x-badges: - name: Beta color: "#f5803e" tags: - Travels description: 'Deletes the travel for good. The linked sales leave the travel first, and each one records the unlinking in its log. A travel with attachments, including the ones already deleted, is not deleted (409), as in Monde: permanently delete the attachments in Monde first. When the company of the travel is set to accept only sales registered within a travel, a travel with linked sales cannot be deleted through the API (409): in Monde, only the administrator deletes it. Requires the "Delete" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission; without it, the travel answers 404.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Unique identifier of the travel example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '204': description: Travel deleted successfully. The response has no body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/travels/{id}/sales/{sale_id}": post: operationId: linkTravelSale summary: Link sale to travel x-badges: - name: Beta color: "#f5803e" tags: - Travels description: 'Links the sale to the travel, like the Link sale button in Monde. As in Monde, the credential must be able to open the sale: one it created or, for a sale of another seller, with the View and Open sales of other sellers permissions of Sales. A sale the credential cannot open, or of another company, answers 404, as nonexistent. A deleted sale, or one without any active product, answers 422. A sale already in this travel answers 409. A sale in another travel is moved to this one, as in Monde, without checking the credential access to the origin travel, and its leaving is recorded in the origin travel log. The link is recorded in the travel log and in the sale log. Requires the "Edit" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission. The response brings the travel with the updated list of sales, or only its `id` to a credential that cannot query it.' 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 travel example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: sale_id required: true schema: type: string format: uuid description: Unique identifier of the sale example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: Sale linked successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous write. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/travel" - "$ref": "#/components/schemas/entity_reference" examples: travel: summary: Travel detail "$ref": "#/components/examples/travel" written_travel_reference: summary: Written travel, without read permission "$ref": "#/components/examples/written_travel_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: unlinkTravelSale summary: Unlink sale from travel x-badges: - name: Beta color: "#f5803e" tags: - Travels description: 'Removes the sale from the travel, and the unlinking is recorded in the travel log and in the sale log. A sale that is not in this travel, or that the credential cannot open (as in the link), answers 404. When the travel''s company is set to accept only sales registered within a travel, the sale cannot be unlinked through the API (409): in Monde, only the administrator unlinks it; link it to another travel to move it. Requires the "Edit" permission of Travels in the company of the travel and, for a travel of another seller, the Consult sales of other sellers permission.' 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 travel example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: sale_id required: true schema: type: string format: uuid description: Unique identifier of the sale example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: Sale unlinked successfully. The response has no body. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/quotes": get: operationId: listQuotes summary: List quotes x-badges: - name: Beta color: "#f5803e" tags: - Quotes description: Returns the list of quotes from the companies where the credential has permission. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/quotes" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createQuote summary: Create quote x-badges: - name: Beta color: "#f5803e" tags: - Quotes description: 'Creates a quote in the company given in `company_identifier`, with the rules of the Quotes screen of Monde Web. The quote owner (`user_id`) is required, because the API credential is not a Monde user: the owner is who sees, changes and deletes the quote in Monde, besides the administrators. Title and validity (`valid_until`) are required, and the validity cannot be in the past. Without a cover, the quote is created with the `color` cover, in the primary color of the company''s Quote Settings, showing the title and the subtitle. Without `details`, the content starts from the content template of the company, the one saved by the administrator on the Quote Settings screen of Monde Web or, when the company never saved its settings, the default template. The quote is created active, unless `active` is sent as `false`, and already has the public link in `public_url`. Requires the create/edit quotes permission in the company.' 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 quote.' 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/quote" examples: quote: summary: Honeymoon quote "$ref": "#/components/examples/quote" '201': description: Quote created successfully. content: application/json: schema: "$ref": "#/components/schemas/quote" examples: quote: summary: Honeymoon quote "$ref": "#/components/examples/quote" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/quote_create" examples: create_quote: summary: Create a quote "$ref": "#/components/examples/create_quote" "/quotes/{id}": get: operationId: getQuote summary: Get quote by ID x-badges: - name: Beta color: "#f5803e" tags: - Quotes description: Returns a specific quote 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: integer description: Unique identifier of the quote example: 42 responses: '200': "$ref": "#/components/responses/quote" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateQuote summary: Update quote x-badges: - name: Beta color: "#f5803e" tags: - Quotes description: 'Changes an existing quote. Send only the fields that must change: a field omitted stays as it is, and a field sent as null is removed. The optional person (`person_id`), subtitle (`subtitle`), content (`details`) and internal notes (`internal_observations`) sent as null are cleared. A null cover color (`cover_color`) is only accepted outside the `color` cover. What a quote cannot be without — `title`, `valid_until`, `active`, `user_id`, `company_identifier`, `cover_kind`, `cover_show_title` and `cover_show_subtitle` — cannot be removed: sent as null, it is refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). As in the Monde Web screen, the quote is only saved with a validity from today on: an expired quote needs a new `valid_until` in any change. An image taken out of the content (`details`) no longer belongs to the quote and is deleted one hour later. With `company_identifier`, the quote moves to that company, which also requires the create/edit quotes permission there. The owner must have access to the target company: without `user_id`, the quote only moves when the current owner also has access to it; otherwise the change is refused (422), and an owner with access must be sent in `user_id`. Requires the create/edit quotes permission in the quote''s company. The response brings the changed quote in the same format as the read by ID when the credential also has the "Read all quotes" permission in its company; without it, the change is saved the same way and the response brings only the `id`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Unique identifier of the quote example: 42 responses: '200': description: Quote 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/quote" - "$ref": "#/components/schemas/entity_reference" examples: quote: summary: Honeymoon quote "$ref": "#/components/examples/quote" written_quote_reference: summary: Quote saved, without the read permission "$ref": "#/components/examples/written_quote_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/quote_update" examples: update_quote: summary: Change subtitle and validity "$ref": "#/components/examples/update_quote" unlink_quote_person: summary: Remove the person from the quote "$ref": "#/components/examples/unlink_quote_person" delete: operationId: deleteQuote summary: Delete quote x-badges: - name: Beta color: "#f5803e" tags: - Quotes description: Deletes the quote for good, with its images. The public link stops working and the quote cannot be recovered. Requires the delete quotes permission in the quote's company. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Unique identifier of the quote example: 42 responses: '204': description: Quote 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" "/quotes/{id}/duplication": post: operationId: duplicateQuote summary: Duplicate quote x-badges: - name: Beta color: "#f5803e" tags: - Quotes description: 'Creates a copy of the quote, like the Duplicate action of the Quotes screen of Monde Web. The copy is created in the same company, with the same subtitle, content, images, cover, status and internal notes, the title prefixed with "(cópia)" and a new public link. The person and the validity are not copied: the validity (`valid_until`) is required and the person (`person_id`) is optional. The copy owner (`user_id`) is also required. Requires the create/edit quotes permission in the quote''s company. The response brings the copy in the same format as the read by ID when the credential also has the "Read all quotes" permission in the company; without it, the copy is created the same way and the response brings only its `id`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Unique identifier of the quote example: 42 responses: '200': description: 'Request repeated with the same `Idempotency-Key`: returns the original duplication response, without creating another copy.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous duplication. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/quote" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_quote: summary: Quote copy "$ref": "#/components/examples/duplicated_quote" '201': description: Quote duplicated successfully. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/quote" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_quote: summary: Quote copy "$ref": "#/components/examples/duplicated_quote" written_quote_reference: summary: Quote saved, without the read permission "$ref": "#/components/examples/written_quote_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/quote_duplication" examples: duplicate_quote: summary: Duplicate a quote "$ref": "#/components/examples/duplicate_quote" "/guides": get: operationId: listGuides summary: List guides x-badges: - name: Beta color: "#f5803e" tags: - Guides description: Returns the list of guides from the companies where the credential has permission, from the most recently updated to the oldest. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/guides" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createGuide summary: Create guide x-badges: - name: Beta color: "#f5803e" tags: - Guides description: 'Creates a guide in the company given in `company_identifier`. The guide owner (`user_id`) is required, because the API credential is not a Monde user: the owner is who updates and deletes the guide in Monde, besides the administrators. Only the title is required. Without a cover, the guide gets the `color` cover, in `#5f6777`, with the title and the subtitle. The guide is created active, unless `active` is sent as `false`, and already with the public link in `public_url`. Requires the create/edit guides permission in the company.' 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 response of the original creation, without creating another guide.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is a replay of a previous creation. content: application/json: schema: "$ref": "#/components/schemas/guide" examples: guide: summary: Lisbon guide "$ref": "#/components/examples/guide" '201': description: Guide created successfully. content: application/json: schema: "$ref": "#/components/schemas/guide" examples: guide: summary: Lisbon guide "$ref": "#/components/examples/guide" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/guide_create" examples: create_guide: summary: Create a guide "$ref": "#/components/examples/create_guide" "/guides/{id}": get: operationId: getGuide summary: Get guide by ID x-badges: - name: Beta color: "#f5803e" tags: - Guides description: Returns a specific guide 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: integer description: Unique guide identifier example: 42 responses: '200': "$ref": "#/components/responses/guide" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateGuide summary: Update guide x-badges: - name: Beta color: "#f5803e" tags: - Guides description: 'Updates an existing guide. Send only the fields that should change: a field that is omitted stays as it is, and a field sent as null is removed. The optional subtitle (`subtitle`), content (`details`) and internal observations (`internal_observations`) sent as null are cleared. A null cover color (`cover_color`) without `cover_kind` is refused on a guide with the `color` cover; with `cover_kind` `color`, it becomes the default `#5f6777` tone. What a guide cannot be without — `title`, `active`, `user_id`, `company_identifier`, `cover_kind`, `hide_cover_text`, `cover_show_title` and `cover_show_subtitle` — cannot be removed: sent as null, it is rejected (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). An image taken out of the content (`details`) no longer belongs to the guide and is deleted one hour later. With `company_identifier`, the guide moves to that company, which also requires the create/edit guides permission there. The owner must have access to the target company: without `user_id`, the guide only moves when the current owner also has access to it; otherwise the change is refused (422), and an owner with access must be sent in `user_id`. Requires the create/edit guides permission in the guide''s company. The response returns the updated guide in the same format as the query by ID when the credential also has the "Read all guides" permission in the guide''s company; without it, the update is written all the same and the response returns only the `id` of the guide.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Unique guide identifier example: 42 responses: '200': description: Guide successfully updated. 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/guide" - "$ref": "#/components/schemas/entity_reference" examples: guide: summary: Lisbon guide "$ref": "#/components/examples/guide" written_guide_reference: summary: Guide updated, without the read permission "$ref": "#/components/examples/written_guide_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/guide_update" examples: update_guide: summary: Change title and subtitle "$ref": "#/components/examples/update_guide" deactivate_guide: summary: Deactivate the guide "$ref": "#/components/examples/deactivate_guide" delete: operationId: deleteGuide summary: Delete guide x-badges: - name: Beta color: "#f5803e" tags: - Guides description: Deletes the guide permanently, along with its images. The public link stops working, the guide leaves the trips that show it in the passenger app, and it cannot be recovered. Requires the delete guides permission in the guide's company. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Unique guide identifier example: 42 responses: '204': description: Guide 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" "/guides/{id}/duplication": post: operationId: duplicateGuide summary: Duplicate guide x-badges: - name: Beta color: "#f5803e" tags: - Guides description: Creates a copy of the guide, like the Duplicate action of the Guides screen of Monde Web. The copy is created in the same company, with the same subtitle, content, images, cover, status and internal notes, the title prefixed with "(cópia)" and a new public link. The copy owner (`user_id`) is required. Requires the create/edit guides permission in the guide's company. The response brings the copy in the same format as the read by ID when the credential also has the "Read all guides" permission in the company; without it, the copy is created the same way and the response brings only its `id`. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: integer description: Unique guide identifier example: 42 responses: '200': description: 'Request repeated with the same `Idempotency-Key`: returns the original duplication response, without creating another copy.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous duplication. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/guide" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_guide: summary: Guide copy "$ref": "#/components/examples/duplicated_guide" '201': description: Guide duplicated successfully. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/guide" - "$ref": "#/components/schemas/entity_reference" examples: duplicated_guide: summary: Guide copy "$ref": "#/components/examples/duplicated_guide" written_guide_reference: summary: Guide updated, without the read permission "$ref": "#/components/examples/written_guide_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/guide_duplication" examples: duplicate_guide: summary: Duplicate a guide "$ref": "#/components/examples/duplicate_guide" "/invoice_rules": get: operationId: listInvoiceRules summary: List billing rules x-badges: - name: Beta color: "#f5803e" tags: - Billing Rules description: Returns the list of billing rules registered in the system. Each rule belongs to a person (or to all, when null) of one of the kinds client, supplier, or representative. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/invoice_rules" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/invoice_rules/{id}": get: operationId: getInvoiceRule summary: Get billing rule by ID x-badges: - name: Beta color: "#f5803e" tags: - Billing Rules description: Returns a specific billing rule 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 billing rule example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/invoice_rule" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/integrations": get: operationId: listIntegrations summary: List integrations x-badges: - name: Beta color: "#f5803e" tags: - Integrations description: Returns the list of integrations from the companies where the credential has permission (integrations without a company apply to all of them). The additional fields, with the vendor access data, are only in the query by ID. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/integrations" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/integrations/{id}": get: operationId: getIntegration summary: Get integration by ID x-badges: - name: Beta color: "#f5803e" tags: - Integrations description: 'Returns a specific integration by its identifier, with the additional fields the vendor declares. Only the service address and the agency''s identification at the vendor come back with a value. The other fields, such as user, password, token, API keys and PIN, are never returned: `filled` says whether they are filled.' 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: Integration unique identifier example: f9d961b8-ea88-4346-8e52-afe94267417a responses: '200': "$ref": "#/components/responses/integration" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/people": get: operationId: listPeople summary: List people x-badges: - name: Beta color: "#f5803e" tags: - People description: 'Returns the list of people registered in the system. It is a lean listing: it carries only own scalars and the references ({id, name}) of the strong entities (birthplace, seller, promoter, registered by, and the address city). Weak entities (contacts, labels, custom fields, attachments, credit cards, and Kandir Law tax withholding) appear only when getting the person by ID (GET /people/{id}).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: name required: false schema: type: string description: Filters by name, case-, accent- and position-insensitive (substring match). example: Maria da Silva - in: query name: cpf_cnpj required: false schema: type: string description: Filters by CPF or CNPJ (matches either one). Provide digits only, without dots, slashes, dashes or spaces. example: '38107867807' - in: query name: passport_number required: false schema: type: string description: Filters by passport number, case- and accent-insensitive (substring match). example: FG225776 - in: query name: phone required: false schema: type: string description: Filters by any of the phone numbers (landline, business or mobile). Provide digits only; matches any part of the stored number, regardless of formatting. example: '11934567890' - in: query name: kind required: false schema: type: string enum: - individual - company description: 'Filters by person kind: 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. ' example: customer_invoice - in: query name: status required: false schema: type: array items: type: string enum: - open - overdue - settled - canceled style: form explode: false description: 'Filters by status. Accepts one or more comma-separated values: When not provided, the API returns only 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 and final amount. The signed sum of the 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. Travel agencies only. The cost center apportionment (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. To create the entry already settled, send 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 fee. On an account receivable paid by credit or debit card into a checking account, send the card operator fee in 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.

Card refund. An account receivable can also be settled in a credit card account, only with the credit card payment method: it is the refund, which goes into the card invoice and lowers its total, as in Monde. In installments, each installment goes into the invoice of its month.

Installments and recurrence. Send 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.

Company locks. Apply as configured in the company: the due date and movement date locks on accounts receivable, and the surcharge and discount lock. Only a credential with the "Ignore locks" permission in the company of the entry goes through them, as in Monde.

Defaults. Without 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.

Errors. An error on a field of a list item (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 entry. To post an account payable or receivable on a sale, like the button on the sale Financial tab in Monde, send 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.

Requires the "Edit" permission on accounts payable and receivable in the company, which cannot be read-only; through an automatic connection authorized before the "of others" permissions, the permission to create and edit own accounts also works. The created entry belongs to the credential. The response brings the created entry, the same as Get account payable or receivable by ID, even for a credential without the "View" permission, and in 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).

What changes. Person, description, document, issue date, due date, forecast account, own operation, observations, custom fields, amount, categories, apportionments, company and, on a settled entry, the settlement date and the movements. This operation does not settle or unsettle: for that, use Settle account payable or receivable and Undo the settlement. The nature (transaction_kind) does not change: when sent, it is ignored like any field outside the contract.

Which entries. Every entry that is not deleted, open or settled, with the locks Monde applies to each type (kind). A deleted entry and an invalid invoice answer 409.In all of them, a category generated by the system (the sale''s, the invoice''s) is not removed and its amount does not change: send it back as it is, with the same category_id. The own operation is accepted only on a standalone entry (normal) without an invoice number, as in Monde.

Settled entry. Also requires the "Edit settled entry" permission on accounts payable and receivable. 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.

Bank reconciliation. A change to the amount, date or account of a reconciled movement undoes its reconciliation and answers 409, with the same warning as Monde, unless the request brings 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.

Amount and categories. The 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. Agencies only. Each apportionment sent replaces that of the entry, and the one not sent stays as it is: 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. 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.

Rules. The issue date cannot be later than the due date. The description has up to 50 characters, as in the creation. The forecast account must be active and linked to the entry''s company, and the own operation must be active and is accepted only in agencies. In accounts receivable, a changed due date is subject to the company''s due date block. Only a credential with "Ignore locks" in the company of the entry goes through the locks.

Installments and recurrence. On an entry of a series, the change applies to that entry only, unless 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.

Requires the "Edit" permission on accounts payable and receivable in the entry''s company, which cannot be read-only; a settled entry also requires "Edit settled entry". The credential changes 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 updated entry, the same as Get account payable or receivable by ID, when the credential also has the "View" permission on accounts payable and receivable in the entry''s company; without it, the change is written all the same and the response brings only the 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:

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.

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: '204': description: Entry 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 entry cannot be deleted, or it asks for a confirmation, which only goes in the POST of the deletion with confirmation. The message says why. Nothing was changed. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - '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}/removal": post: operationId: removeBill summary: Delete account payable or receivable with confirmation x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: '

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.

' 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 requestBody: required: true content: application/json: schema: type: object properties: recurrence_scope: type: string enum: - only_this - this_and_following description: 'Only for an installment or recurrence entry: 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:

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.

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 requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/bill_settlement" examples: settle_bill: summary: Settlement of the full amount "$ref": "#/components/examples/settle_bill" settle_bill_with_fine: summary: Settlement with a late fee "$ref": "#/components/examples/settle_bill_with_fine" settle_bill_partially: summary: Partial payment "$ref": "#/components/examples/settle_bill_partially" responses: '200': description: Account payable or receivable settled successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous settlement. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/bill_settled" - "$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: 'Conflicting request: a request with the same idempotency key is already being processed, or the entry cannot be settled: it is already settled, deleted or an invalid invoice. 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 already settled. To change the settlement, update the financial entry; to redo it, undo the settlement first. - The financial entry is deleted and cannot be changed. - An invalid invoice cannot be changed. example: errors: - The financial entry is already settled. To change the settlement, update the financial entry; to redo it, undo the settlement first. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: reopenBill summary: Undo the settlement of account payable or receivable x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: '

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.

' 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: '204': description: Settlement undone 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 settlement cannot be undone, or it asks for the confirmation to undo the reconciliation, which only goes in the POST of the undo with confirmation. The message says why. Nothing was changed. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - 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.' 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" "/bills/{id}/settlement/removal": post: operationId: removeBillSettlement summary: Undo the settlement with confirmation x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: '

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.

' 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 requestBody: required: true content: application/json: schema: type: object properties: recurrence_scope: type: string enum: - only_this - this_and_following description: 'Only for an installment or recurrence entry: 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.

' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/bill_batch_settlement" examples: settle_bills_in_batch: summary: Settlement of two entries in the same account "$ref": "#/components/examples/settle_bills_in_batch" settle_sale_payments_in_batch: summary: Settlement with the sale data "$ref": "#/components/examples/settle_sale_payments_in_batch" responses: '200': description: Accounts payable and receivable settled successfully. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of a previous batch settlement. content: application/json: schema: type: object required: - data properties: data: type: array description: 'The settled entries, in due date order: each one whole, or only the id for a credential that does not read entries in its company.' items: anyOf: - "$ref": "#/components/schemas/bill" - "$ref": "#/components/schemas/entity_reference" examples: batch_settled_bills_references: summary: Entries settled, without read permission "$ref": "#/components/examples/batch_settled_bills_references" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': description: Some requested entry does not exist or is outside the credential's reach. The message brings the ids, and nothing was settled. content: application/json: schema: type: object properties: errors: type: array items: type: string example: errors: - 'No financial entry was settled: these financial entries were not found: 6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f.' '409': description: 'Conflicting request: a request with the same idempotency key is already being processed, or one of the entries cannot be settled: it is already settled, deleted or an invalid invoice. The message says which one, and nothing was settled.' 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. - Financial entry No. 71 cannot be settled. The financial entry is already settled. To change the settlement, update the financial entry; to redo it, undo the settlement first. example: errors: - Financial entry No. 71 cannot be settled. The financial entry is already settled. To change the settlement, update the financial entry; to redo it, undo the settlement first. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/restoration": post: operationId: restoreBill summary: Restore a deleted account payable or receivable x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: '

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.

' 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': description: Entry restored. The response brings the entry, or only its id to a credential that cannot read accounts. 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" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': description: The entry cannot be restored. The message says why. Nothing was changed. content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - The financial entry is not deleted. - This financial entry was generated by a sale and must be restored from the sale. - Deleted invoices and commission entries cannot be restored. - 'This type of financial entry is not restored through the API: restore it in Monde.' example: errors: - The financial entry is not deleted. '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{id}/billet": post: operationId: issueBillBillet summary: Generate the bank slip of a receivable x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: '

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 in billing_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.

' 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 ID. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '200': description: The closed invoice, 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. - Only client invoices are closed and reopened. - The invoice is already closed. example: errors: - The invoice is already closed. '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: reopenBillInvoice summary: Reopen a client invoice x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: '

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.

' 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 ID. example: 212b54b8-27df-4859-80a9-79ad855bcd09 responses: '204': description: The invoice was reopened. '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. - Only client invoices are closed and reopened. - The invoice is not closed. example: errors: - The invoice is not closed. '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bills/{bill_id}/items/{id}": patch: operationId: updateBillItem summary: Change the checked status or cost center of an invoice item x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: '

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.

' 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, the 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, the 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: 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 the bill 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.

' 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 responses: '200': description: The invoice as it ended up after the action, or only its id to a credential that does not read bills, with 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.

' 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: 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. due_date: type: string format: date description: Due date of the separate invoice. Without it, it is due today. example: '2026-12-10' examples: separate_items: summary: Bill one item separately, due today value: item_ids: - 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 responses: '201': description: The new separate invoice, 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': *3 '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/account_movements": get: operationId: listAccountMovements summary: List account movements x-badges: - name: Beta color: "#f5803e" tags: - Account movements description: Returns the movements of the accounts of the companies the credential has permission for. Each movement is summarized, with the data of the movement itself only; the references to the account, the payment method, the settled account payable or receivable, the credit card invoice and the account on the other side of the transfer come in 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. example: debit - in: query name: date_field required: false schema: type: string enum: - movement_date description: 'Date field used by the filter. Accepted value: movement_date. Required when date_from or date_to is provided.' example: movement_date - in: query name: date_from required: false schema: type: string format: date description: Filter movements dated on or after this date, in ISO 8601 format (YYYY-MM-DD). example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: Filter movements dated on or before this date, in ISO 8601 format (YYYY-MM-DD). example: '2026-10-31' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/account_movements" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/account_movements/{id}": get: operationId: getAccountMovement summary: Get account movement by ID x-badges: - name: Beta color: "#f5803e" tags: - Account movements description: Returns the full detail of an account movement by its identifier, with the references to the account, the payment method, the settled account payable or receivable, the credit card invoice and the account on the other side of the transfer. This is the endpoint that resolves the account movement references returned by other resources, such as the settlements of an account payable or receivable. 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: Account movement identifier. example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 responses: '200': "$ref": "#/components/responses/account_movement" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/balance": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID of the checking or cash account, the same as in [Accounts and Cards](#tag/Accounts-and-Cards). example: f9d961b8-ea88-4346-8e52-afe94267417a get: operationId: getAccountBalance summary: Get account balance x-badges: - name: Beta color: "#f5803e" tags: - Statement and Cash description: 'Balance of the account at the end of the given day: the initial balance of the account plus every movement up to the date, inclusive. It is the same balance the statement closes that day with.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date required: false schema: type: string format: date description: 'Date of the balance (ISO 8601, `YYYY-MM-DD`). Default: today.' example: '2026-10-15' responses: '200': description: Account balance content: application/json: schema: "$ref": "#/components/schemas/account_balance" examples: account_balance: "$ref": "#/components/examples/account_balance" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/statement": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID of the checking or cash account, the same as in [Accounts and Cards](#tag/Accounts-and-Cards). example: f9d961b8-ea88-4346-8e52-afe94267417a get: operationId: getAccountStatement summary: Get account statement x-badges: - name: Beta color: "#f5803e" tags: - Statement and Cash description: 'Statement of the account in the period, line by line as in Monde: the previous balance, the movements of each day (entries and transfers, in the order they were saved) and the balance at the end of each day with movements, telling whether the cash is closed. Not paginated: the period has at most 45 days. Since it brings the name and document of people, each query is recorded in the History as an export of the Account Statement.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: date_from required: true schema: type: string format: date description: First day of the statement (ISO 8601, `YYYY-MM-DD`). Required. example: '2026-10-01' - in: query name: date_to required: true schema: 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' responses: '200': description: Account statement content: application/json: schema: "$ref": "#/components/schemas/account_statement" examples: account_statement: "$ref": "#/components/examples/account_statement" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/cash_closures": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID of the checking or cash account, the same as in [Accounts and Cards](#tag/Accounts-and-Cards). example: f9d961b8-ea88-4346-8e52-afe94267417a post: operationId: closeAccountCash summary: Close cash x-badges: - name: Beta color: "#f5803e" tags: - Statement and Cash description: 'Closes the cash of the account up to the given day, with the Monde rules: it does not close a future day nor a day already closed (reopen it first). When `expected_balance` is sent, the closing is refused if the balance of the day changed since it was read, like the screen review. Only active checking or cash accounts; a read-only company does not close. The closing is logged on the account with the credential. Requires `Idempotency-Key`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cash_closure_create" examples: close_cash: "$ref": "#/components/examples/close_cash" responses: '200': description: Cash closed headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response is the repetition of a request already processed. content: application/json: schema: "$ref": "#/components/schemas/cash_closure" examples: cash_closure: "$ref": "#/components/examples/cash_closure" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/accounts/{account_id}/cash_closures/{date}": parameters: - in: path name: account_id required: true schema: type: string format: uuid description: ID of the checking or cash account, the same as in [Accounts and Cards](#tag/Accounts-and-Cards). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: path name: date required: true schema: type: string format: date description: Day to reopen (ISO 8601, `YYYY-MM-DD`). The cash becomes open again on it and on the following days. example: '2026-10-10' delete: operationId: reopenAccountCash summary: Reopen cash x-badges: - name: Beta color: "#f5803e" tags: - Statement and Cash description: 'Reopens the cash from the given day: it and the following days accept movements again. It only moves the closing back; reopening a day already open answers 422. The reopening is logged on the account with the credential. Does not require `Idempotency-Key`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '204': description: Cash reopened '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/transfers": get: operationId: listTransfers summary: List transfers x-badges: - name: Beta color: "#f5803e" tags: - Transfers between Accounts description: Lists the transfers whose two accounts belong to companies where the credential can read transfers, newest first. Each transfer appears once, by its origin movement. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" - in: query name: account_id required: false schema: type: string format: uuid description: Filters the transfers leaving or entering this account (UUID). example: f9d961b8-ea88-4346-8e52-afe94267417a - in: query name: date_from required: false schema: type: string format: date description: Start date of the transfer (ISO 8601, `YYYY-MM-DD`). example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: End date of the transfer (ISO 8601, `YYYY-MM-DD`). example: '2026-10-31' responses: '200': description: List of transfers content: application/json: schema: type: object properties: data: type: array items: "$ref": "#/components/schemas/transfer" pagination: "$ref": "#/components/schemas/pagination" examples: transfers: "$ref": "#/components/examples/transfers" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createTransfer summary: Create transfer x-badges: - name: Beta color: "#f5803e" tags: - Transfers between Accounts description: 'Creates the transfer with the rules of the Monde screen: active checking or cash accounts, different from each other, amount greater than zero and description up to 100 characters. Both accounts must belong to companies where the credential inserts and edits transfers, outside read-only companies. The insertion is logged with the credential. The response brings the transfer only to whoever can also read it; others get only the `id`. Requires `Idempotency-Key`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/transfer_create" examples: create_transfer: "$ref": "#/components/examples/create_transfer" responses: '200': description: 'Repetition of a request already processed with the same `Idempotency-Key`: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response is the repetition of a request already processed. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/transfer" - "$ref": "#/components/schemas/entity_reference" examples: transfer: "$ref": "#/components/examples/transfer" '201': description: Transfer created content: application/json: schema: anyOf: - "$ref": "#/components/schemas/transfer" - "$ref": "#/components/schemas/entity_reference" examples: transfer: "$ref": "#/components/examples/transfer" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/transfers/{id}": parameters: - in: path name: id required: true schema: type: string format: uuid description: ID of the transfer, which is the ID of the origin movement. The ID of the destination movement is also accepted and returns the same transfer. example: 857569b5-2721-4756-a27a-748168e00606 get: operationId: getTransfer summary: Get transfer x-badges: - name: Beta color: "#f5803e" tags: - Transfers between Accounts description: Returns the transfer. It can be opened by the ID of either movement, and always answers by the origin one. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '200': description: Transfer found content: application/json: schema: "$ref": "#/components/schemas/transfer" examples: transfer: "$ref": "#/components/examples/transfer" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateTransfer summary: Update transfer x-badges: - name: Beta color: "#f5803e" tags: - Transfers between Accounts description: 'Changes only the fields sent; an omitted field stays as is, and a `description` sent as null is cleared. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). The accounts are still checked when not sent: a transfer whose account is no longer an active checking or cash account is only saved by choosing another one. When one of the movements is in a bank reconciliation, changing its date, amount or account undoes the reconciliation, and that change asks for `undo_bank_reconciliation` as `true`, as the Monde warning does: without it, the response is 409. Changing only the description keeps the reconciliation and is saved without the confirmation. The change is logged with the credential. The response brings the transfer only to whoever can also read it; others get only the `id`. Requires `Idempotency-Key`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/transfer_update" examples: update_transfer: "$ref": "#/components/examples/update_transfer" responses: '200': description: Transfer updated content: application/json: schema: anyOf: - "$ref": "#/components/schemas/transfer" - "$ref": "#/components/schemas/entity_reference" examples: transfer: "$ref": "#/components/examples/transfer" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deleteTransfer summary: Delete transfer x-badges: - name: Beta color: "#f5803e" tags: - Transfers between Accounts description: 'Deletes both movements of the transfer, without confirmation: the DELETE has no body, and a body sent is ignored. When one of the movements is in a bank reconciliation, the deletion undoes the reconciliation, so the response is 409. In that case, to delete anyway, use [Delete transfer with confirmation](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}~1removal/post). The deletion is not logged, as in Monde. Requires the **Excluir** (delete) permission of Transfers between Accounts in the companies of both accounts, which cannot be read-only. Does not require `Idempotency-Key`: repeating answers 404.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '204': description: Transfer deleted '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/transfers/{id}/removal": parameters: - in: path name: id required: true schema: type: string format: uuid description: ID of the transfer, which is the ID of the origin movement. The ID of the destination movement is also accepted and returns the same transfer. example: 857569b5-2721-4756-a27a-748168e00606 post: operationId: removeTransfer summary: Delete transfer with confirmation x-badges: - name: Beta color: "#f5803e" tags: - Transfers between Accounts description: 'Deletes both movements of the transfer with the confirmation Monde asks for when one of them is in a bank reconciliation. It is the same deletion as [Delete transfer](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}/delete), 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. When one of the movements is in a bank reconciliation, the deletion undoes the reconciliation: without `undo_bank_reconciliation` as `true`, the response is 409; with the confirmation, the reconciliation is undone and will have to be redone. A value that is not a boolean answers 422. The deletion is not logged, as in Monde. Requires the **Excluir** (delete) permission of Transfers between Accounts in the companies of both accounts, which cannot be read-only. Requires `Idempotency-Key`: without it, the response is 400. As the deleted transfer no longer exists, a resend after the deletion answers 404.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/transfer_exclusion" examples: delete_reconciled_transfer: "$ref": "#/components/examples/delete_reconciled_transfer" responses: '204': description: Transfer deleted headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response is the repetition of a request already processed. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/refunds": get: operationId: listRefunds summary: List refunds x-badges: - name: Beta color: "#f5803e" tags: - Refunds description: Returns the refunds of the companies the credential has permission for. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: refund_type required: false schema: type: string enum: - customer - vendor description: |- Filters by the refund side. example: customer - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/refunds" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/refunds/{id}": get: operationId: getRefund summary: Get refund by ID x-badges: - name: Beta color: "#f5803e" tags: - Refunds description: Returns a refund by its identifier. It is the endpoint that resolves the refund 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: Refund identifier. example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 responses: '200': "$ref": "#/components/responses/refund" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: deleteRefund summary: Delete refund x-badges: - name: Beta color: "#f5803e" tags: - Refunds description: 'Deletes the refund, like deleting the refund on the sale in Monde. A refund not invoiced yet goes away alone; one on an invoice leaves it, and the invoice left empty goes away too. The product refund and the sale revenue go back to what they were.

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

A vendor refund that has already become an account payable/receivable is not deleted through the sale in Monde: it is the one on the account generated for it alone (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.

In Monde, deleting a refund is editing the sale, with no permission of its own: requires the Edit permission on Sales in the refund company, which cannot be read-only, and, on a sale the credential did not create, Edit sales of other sellers. The vendor refund, which in Monde leaves through the Financial tab of the sale, also requires View financial tab. On a sale with a printed receipt, both the customer and the vendor refund also require Change sales with a printed receipt.

Requires the 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.

A refund not invoiced yet goes away alone; one on an invoice leaves it, and the invoice left empty goes away too. The product refund and the sale revenue go back to what they were. The 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.

A vendor refund that has already become an account payable/receivable is not deleted through the sale in Monde: it is the one on the account generated for it alone (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.

In Monde, deleting a refund is editing the sale, with no permission of its own: requires the Edit permission on Sales in the refund company, which cannot be read-only, and, on a sale the credential did not create, Edit sales of other sellers. The vendor refund, which in Monde leaves through the Financial tab of the sale, also requires View financial tab. On a sale with a printed receipt, both the customer and the vendor refund also require Change sales with a printed receipt. Deleting the whole account with 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.

Requires the 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. In 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.

As in Monde, the sale may be open or closed, but not deleted (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.

In Monde, recording a refund is editing the sale, with no permission of its own: requires the Edit permission on Sales in the sale company, which cannot be read-only, and, on a sale the credential did not create, Edit sales of other sellers. On a sale with a printed receipt, both the customer and the vendor refund also require Change sales with a printed receipt, since they change the sale revenue. The response carries the full refund only for those who can also read refunds in that company; for the others, just the 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. example: issued - in: query name: period_start required: false schema: type: string format: date description: Filters the invoices issued from this date on, in ISO 8601 format (YYYY-MM-DD). example: '2023-01-01' - in: query name: period_end required: false schema: type: string format: date description: Filters the invoices issued up to this date, in ISO 8601 format (YYYY-MM-DD). example: '2023-12-31' - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/nfs" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createNf summary: Create standalone invoice x-badges: - name: Beta color: "#f5803e" tags: - Invoices description: Creates a standalone, unissued invoice in the company of 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.

Each item may carry a 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.

As in the edit screen, saving recalculates the amount and the taxes, and a registered recipient is refreshed with the person''s current data. To change the issue date, send only 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.

Before sending, the invoice clears previous errors, takes the ISS rate from the settings, refreshes a registered recipient and recalculates the taxes. The company must be set up in e-Notas, and the invoice must be unissued (409 in both cases). An invoice with a negative amount is not sent (422).' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Invoice identifier. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '202': description: Invoice sent for issuance. 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: issuance_accepted: "$ref": "#/components/examples/issuance_accepted" written_nf_reference: "$ref": "#/components/examples/written_nf_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/nfs/{id}/cancellation": post: operationId: cancelNf summary: Cancel invoice x-badges: - name: Beta color: "#f5803e" tags: - Invoices description: 'Cancels an issued invoice; an invoice in another status answers 409. When the company issues through e-Notas and also cancels at the city hall, and the invoice was not issued manually, the response is 202 and the invoice awaits the cancellation (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. example: sale_date - in: query name: date_from required: false schema: type: string format: date description: Start of the period, in ISO 8601 format (YYYY-MM-DD). example: '2026-10-01' - in: query name: date_to required: false schema: type: string format: date description: End of the period, in ISO 8601 format (YYYY-MM-DD). example: '2026-10-31' - in: query name: supplier_representative_id required: false schema: type: string format: uuid description: Brings only the products where this person is the supplier or the representative. example: 0f3c1d52-7f0a-4a55-9a2e-1b6d1c2f3a4b - in: query name: include_without_revenue required: false schema: type: boolean default: false description: 'Includes the products without revenue, with the zero-valued invoices the rules build for them. Default: `false`.' example: false - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/nf_generations" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createNfGeneration summary: Generate invoices x-badges: - name: Beta color: "#f5803e" tags: - Generate Invoices description: 'Generates the invoices chosen in the list of invoices to generate, identified by the sale product (`sale_product_id`) and the recipient (`recipient_kind`). The invoices are built again at generation time, with the same rules, and saved all or none: if a requested invoice cannot be generated (it already exists, has an error or the rule does not build it), nothing is saved and the response is 422. If another generation saved an invoice for any of these products after the given `previewed_at`, the response is 409 and the list has to be queried again. A product the list would not show (a sale the credential does not reach, invoices that already cover the revenue or, without `include_without_revenue`, a product without revenue) also refuses the whole request with 422. The credential needs the **Gerar Notas Fiscais** permission in the reference company and in the company of each sale. The response brings the full generated invoices to whoever can also read invoices in their company; to the others, only the `id`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/nf_generation_create" examples: generate_nfs: summary: Generate the payer invoice of a product "$ref": "#/components/examples/generate_nfs" responses: '200': description: 'Replay of a generation already completed with the same idempotency key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response is the replay of an earlier generation. content: application/json: schema: "$ref": "#/components/schemas/nf_generation_created" examples: generated_nfs: summary: Generated invoice "$ref": "#/components/examples/generated_nfs" '201': "$ref": "#/components/responses/nf_generation_created" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/logs": get: operationId: listLogs summary: List logs x-badges: - name: Beta color: "#f5803e" tags: - Logs description: 'Returns the system change history, with filters by author, audited record, action and origin. The list brings only the fields of the entry itself; for the author and the audited record, use Get log by ID. The history is scoped by record type, as in Monde: the log of each record type comes to whoever has its "View log" permission (sales, people, accounts payable and receivable, travels, accounts, transfers between accounts, invoices, invoice rules and CVC statement) or, for a record type without that permission, to whoever reads it. The log of the cities, which no longer have a permission, only comes to whoever reads the whole log. In the log of a sale, an entry, an invoice and a task, the permission counts in the company of the record. In the log of the accounts and of the transfers between accounts, the permission in any company shows the log of all of them, as in Monde, which checks "View log" in the company the user logged into, not in the companies of the accounts. The log of a sale, an entry or a task of another user only comes to whoever also reaches the record, as in its get: for a sale, whoever opens it ("Open sales of other sellers/intermediaries"); for an entry, whoever accesses the entries of other users (whole or the slice); for a task, whoever sees the tasks of other users. In Monde the log sits on the record''s tab, which only opens with those permissions; that is why the log of a sale, an entry or a task already deleted only comes to whoever reads the whole log. Exports are left out. An entry the credential does not see answers 404 in Get log by ID.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: person_id required: false schema: type: string format: uuid description: Filters by the identifier of the author of the change. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 - in: query name: resource_id required: false schema: type: string format: uuid description: Filters by the identifier of the audited record. example: 9a1f7c30-1d55-4e0a-9a3b-77b0c2e4f118 - in: query name: kind required: false schema: type: string enum: - insertion - edition - deletion - custom - export - email description: |- Filters by the recorded action. example: edition - in: query name: origin required: false schema: type: string description: Filters by the origin of the change, using the exact value recorded in the log. One value per call. example: financeiro_categoria - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/logs" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/logs/{id}": get: operationId: getLog summary: Get log by ID x-badges: - name: Beta color: "#f5803e" tags: - Logs description: Returns a history entry by its identifier, with the references to the author of the change and to the audited record. 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: Identifier of the history entry. example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 responses: '200': "$ref": "#/components/responses/log" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/custom_fields": get: operationId: listCustomFields summary: List custom fields x-badges: - name: Beta color: "#f5803e" tags: - Custom Fields description: 'Returns the custom field definitions, optionally filtered by resource. Each entry brings the identifier, the resource, the name, the kind, whether it is required, whether it is active and, on list-kind fields, the registered options. The definitions are not scoped by company: a credential with the permission reads them all.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: resource required: false schema: type: string enum: - sales - travels - people - bills - tasks description: |- Filters by the custom field resource (origin). One value per call; absent lists every resource. example: sales - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/custom_fields" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/custom_fields/{id}": get: operationId: getCustomField summary: Get custom field by ID x-badges: - name: Beta color: "#f5803e" tags: - Custom Fields description: Returns the definition of a single custom field by its identifier. Use it to resolve the name, kind and options of a field from the id returned on the other API queries. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: integer description: Identifier of the custom field to fetch. example: 123 responses: '200': "$ref": "#/components/responses/custom_field" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/sale_product_additional_fields": get: operationId: listSaleProductAdditionalFields summary: List product additional fields x-badges: - name: Beta color: "#f5803e" tags: - Sales description: 'Returns the three additional fields of the sale product (`external_number`, `additional1` and `additional2`) with the title the agency gave each one in Monde, such as "Nº Pedido". On the sale, send and read the field by its `key`: the title only tells which field is which, and renaming it in Monde does not change the `key`. A field without a title (`active` false) does not appear in Monde, and the API ignores the value sent to it. Requires the permission to read sales.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '200': "$ref": "#/components/responses/sale_product_additional_fields" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/commission_plans": get: operationId: listCommissionPlans summary: List commission plans x-badges: - name: Beta color: "#f5803e" tags: - Commission Plans description: Returns the commission plans, by name. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/commission_plans" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/commission_plans/{id}": get: operationId: getCommissionPlan summary: Get a commission plan by ID x-badges: - name: Beta color: "#f5803e" tags: - Commission Plans description: Returns a commission plan with its goal ranges, the products of each range and the values of each role. Ranges come by percentage, the all-products entry comes first in each range, and the field of the type not in use (the fixed amount in a percentage commission, and vice versa) comes as zero. 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 commission plan example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '200': "$ref": "#/components/responses/commission_plan" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/goals": get: operationId: listGoals summary: List goals x-badges: - name: Beta color: "#f5803e" tags: - Goals description: Returns the goals, from the most recent year to the oldest, with optional filters by year, role and person. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: year required: false schema: type: integer description: Year of the goal, with four digits example: 2026 - in: query name: person_role_id required: false schema: type: string format: uuid description: Identifier of the role example: f453b283-750d-4c5d-a493-a6bf8064090e - in: query name: person_id required: false schema: type: string format: uuid description: Identifier of the person example: 3f2e1d0c-9b8a-4765-a4b3-c2d1e0f9a8b7 - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/goals" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/goals/{id}": get: operationId: getGoal summary: Get a goal by ID x-badges: - name: Beta color: "#f5803e" tags: - Goals description: Returns a specific goal 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 goal example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e responses: '200': "$ref": "#/components/responses/goal" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bank_reconciliations": get: operationId: listBankReconciliations summary: List uploaded statements x-badges: - name: Beta color: "#f5803e" tags: - Bank Reconciliation description: Returns the statements uploaded to the active checking accounts of the companies where the credential has the Bank Reconciliation permission, newest first. Filter by account with `account_id`. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: query name: account_id required: false schema: type: string format: uuid description: Only the statements of this checking account (UUID). - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': description: Statements returned successfully. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliations_response" examples: list: summary: Uploaded statements "$ref": "#/components/examples/bank_reconciliation_list" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: uploadBankStatement summary: Upload statement x-badges: - name: Beta color: "#f5803e" tags: - Bank Reconciliation description: 'Uploads the OFX statement (`.ofx` or `.qfx`, up to 5 MB) of an active checking account, as `multipart/form-data`, and runs the automatic matching. The import is the one of the screen: a line is identified by the account and the FITID, so uploading a period again does not duplicate lines, and the bank correction (CORRECTFITID) is applied when possible. Bank, branch and account number that do not match the account only produce a warning in `warnings`; a currency other than the account''s and a file without transactions are refused with 422. An unknown account, or one that is not an active checking account, also answers 422. It does not take `company_identifier`: the statement belongs to the checking account, which may be of more than one company, and the Bank Reconciliation permission in one of them is enough.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_multipart" - "$ref": "#/components/parameters/idempotency_key_header" requestBody: required: true content: multipart/form-data: schema: "$ref": "#/components/schemas/bank_statement_upload" responses: '200': description: 'Replay of a request already completed with the same Idempotency-Key: the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response replays the original one. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliation" examples: detail: summary: Statement with the summary "$ref": "#/components/examples/bank_reconciliation_detail" '201': description: Statement imported successfully. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliation" examples: detail: summary: Statement with the summary "$ref": "#/components/examples/bank_reconciliation_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/bank_reconciliations/{id}": get: operationId: getBankReconciliation summary: Get statement by ID x-badges: - name: Beta color: "#f5803e" tags: - Bank Reconciliation description: 'Returns the statement with the reconciliation summary: how many lines are in each situation and the bank balance compared with the system balance on the same date.' 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: Identifier (UUID) of the uploaded statement. example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 responses: '200': description: Statement returned successfully. content: application/json: schema: "$ref": "#/components/schemas/bank_reconciliation" examples: detail: summary: Statement with the summary "$ref": "#/components/examples/bank_reconciliation_detail" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" delete: operationId: discardBankStatement summary: Discard statement x-badges: - name: Beta color: "#f5803e" tags: - Bank Reconciliation description: 'Discards the statement: deletes the lines it inserted (a line that already existed from a previous upload stays) and undoes the verification of the entries linked to them. With a verified entry on a closed cash day nothing is deleted and the answer is 422. Does not require `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: Identifier (UUID) of the uploaded statement. example: 6b1f0c3e-2a51-4f0e-9a8d-2d6c1b7e9f10 responses: '204': description: Statement discarded successfully. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/category_groups": get: operationId: listCategoryGroups summary: List category groups x-badges: - name: Beta color: "#f5803e" tags: - Category Groups description: Returns the category groups, expense groups before revenue groups, by name. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" responses: '200': "$ref": "#/components/responses/category_groups" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createCategoryGroup summary: Create category group x-badges: - name: Beta color: "#f5803e" tags: - Category Groups description: 'Registers an expense or revenue category group. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Repeat of a request already processed with the same idempotency key: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: "$ref": "#/components/schemas/category_group_detail" examples: category_group_detail: summary: Expense group "$ref": "#/components/examples/category_group_detail" '201': description: Group created. content: application/json: schema: "$ref": "#/components/schemas/category_group_detail" examples: category_group_detail: summary: Expense group "$ref": "#/components/examples/category_group_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_group_detail_create" examples: create_category_group_detail: summary: New group "$ref": "#/components/examples/create_category_group_detail" "/category_groups/{id}": get: operationId: getCategoryGroup summary: Get category group by ID x-badges: - name: Beta color: "#f5803e" tags: - Category Groups description: Returns a category group 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 group identifier example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 responses: '200': "$ref": "#/components/responses/category_group_detail" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateCategoryGroup summary: Update category group x-badges: - name: Beta color: "#f5803e" tags: - Category Groups description: 'Changes the group name. The kind does not change after creation: the group''s categories were already posted with that sign, and a different kind is refused with 422. An omitted field stays as it is; `name` and `kind` cannot be removed, and sent as null they are refused (422). Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). A credential without the read permission receives only the `id`. Requires the `Idempotency-Key` header. The registry is one for the whole system, with no company: the permission in one active company that is not read only is enough. A field the endpoint does not document is ignored.' 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 group identifier example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 responses: '200': description: Group updated. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. content: application/json: schema: anyOf: - "$ref": "#/components/schemas/category_group_detail" - "$ref": "#/components/schemas/entity_reference" examples: category_group_detail: summary: Expense group "$ref": "#/components/examples/category_group_detail" written_category_group_detail_reference: summary: Only the id "$ref": "#/components/examples/written_category_group_detail_reference" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_group_detail_update" examples: update_category_group_detail: summary: Rename group "$ref": "#/components/examples/update_category_group_detail" delete: operationId: deleteCategoryGroup summary: Delete category group x-badges: - name: Beta color: "#f5803e" tags: - Category Groups description: 'Deletes the group without confirmation: the DELETE has no body, and a body sent is ignored. An empty group is deleted. As in Monde, deleting a group with categories also deletes its categories and asks for a confirmation, so here a group with categories responds 409. In that case, to delete the group with its categories, use [Delete category group with confirmation](#tag/Category-Groups/paths/~1category_groups~1{id}~1removal/post). Requires the **Excluir** (delete) permission of Categories in an active company that is not read only. Does not require `Idempotency-Key`: repeating responds 404.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Unique group identifier example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 responses: '204': description: Group deleted. '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/category_groups/{id}/removal": post: operationId: removeCategoryGroup summary: Delete category group with confirmation x-badges: - name: Beta color: "#f5803e" tags: - Category Groups description: 'Deletes the group with the confirmation Monde asks for before deleting its categories. It is the same deletion as [Delete category group](#tag/Category-Groups/paths/~1category_groups~1{id}/delete), 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. As in Monde, deleting a group with categories also deletes its categories, so it asks for the confirmation in `delete_categories`: without it, it responds 409. If any category is used in a financial entry or in a Monde setting, nothing is deleted and the response is 409. An empty group is deleted without the confirmation. A value other than `true` or `false` responds 422. Requires the **Excluir** (delete) permission of Categories in an active company that is not read only. Requires `Idempotency-Key`: without it, the response is 400. As the deleted group no longer exists, a resend after the deletion responds 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: Unique group identifier example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/category_group_exclusion" examples: delete_category_group_with_categories: "$ref": "#/components/examples/delete_category_group_with_categories" responses: '204': description: Group deleted. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present with the value `true` when the response repeats a request already processed. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/webhooks": get: operationId: listWebhooks summary: List webhooks x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: Lists the authenticated credential's webhooks, newest first. The secret is never 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/webhooks" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" post: operationId: createWebhook summary: Create webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: 'Registers a webhook for the authenticated credential. Send the `secret` (32 to 255 characters; an empty one is refused) or omit it so the API generates one: the generated secret comes only once, in this response, in the `secret` field. Each event must be in the catalog and belong to a resource the credential can read. Requires `Idempotency-Key`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" responses: '200': description: 'Replay of a request already completed with the same `Idempotency-Key`: returns the original response.' headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of an already completed request. content: application/json: schema: "$ref": "#/components/schemas/webhook_created" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' secret: aZ3kP9qX7mL2nB8vC4tY6wR1sD5fG0hJ7kL9mN3pQ2rS8tU4 '201': description: Webhook created. The `secret` field comes only when the API generated the secret. content: application/json: schema: "$ref": "#/components/schemas/webhook_created" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' secret: aZ3kP9qX7mL2nB8vC4tY6wR1sD5fG0hJ7kL9mN3pQ2rS8tU4 '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook_write" example: url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed "/webhooks/{id}": get: operationId: getWebhook summary: Get webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: Returns a webhook of the authenticated credential. Another credential's webhook responds 404. security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - in: path name: id required: true schema: type: string format: uuid description: Webhook ID. responses: '200': description: Webhook. content: application/json: schema: "$ref": "#/components/schemas/webhook" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" patch: operationId: updateWebhook summary: Update webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: 'Changes only the fields sent: `{"active": true}` re-enables a deactivated webhook without resending the secret. The `events` list sent replaces the previous one. A `secret` sent replaces the secret and is not returned. Empty text is saved as sent; on a required field, and on a field that is not text, it is refused (422). Requires `Idempotency-Key`.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/idempotency_key_header" - in: path name: id required: true schema: type: string format: uuid description: Webhook ID. responses: '200': description: Webhook updated. For a credential that writes without the permission to read webhooks, the response carries only the `id`. headers: X-Idempotent-Replay: schema: type: string enum: - 'true' description: Present when the response is the replay of an already completed request. content: application/json: schema: "$ref": "#/components/schemas/webhook" example: id: 0f1c6a9e-3b7d-4b58-9d55-6f2a8c1d4e01 url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed active: true consecutive_failures: 0 disabled_at: last_error: created_at: '2026-10-16T10:00:00-03:00' updated_at: '2026-10-16T10:00:00-03:00' '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '415': "$ref": "#/components/responses/unsupported_media_type" '422': "$ref": "#/components/responses/unprocessable_content" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook_write" example: url: https://erp.example.com/monde/webhook description: ERP do cliente events: - sales.changed - sales.closed delete: operationId: deleteWebhook summary: Delete webhook x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: Deletes the webhook and its delivery history. Pending deliveries are not made. 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: Webhook ID. responses: '204': description: Webhook deleted. '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/webhooks/{webhook_id}/deliveries": get: operationId: listWebhookDeliveries summary: List webhook deliveries x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: 'Delivery history of the last 30 days, newest first: the body sent, the number of attempts, the last response code and the last error.' security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" - "$ref": "#/components/parameters/cursor" - "$ref": "#/components/parameters/size" - in: path name: webhook_id required: true schema: type: string format: uuid description: Webhook ID. responses: '200': "$ref": "#/components/responses/webhook_deliveries" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/webhook_events": get: operationId: listWebhookEvents summary: List webhook events x-badges: - name: Beta color: "#f5803e" tags: - Webhooks description: Catalog of the events a webhook can subscribe to, with the description and whether the authenticated credential can subscribe to them (`subscribable`, when it can read the resource). security: - bearerAuthentication: [] parameters: - "$ref": "#/components/parameters/authorization_header" - "$ref": "#/components/parameters/content_type_json" responses: '200': "$ref": "#/components/responses/webhook_events" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/unauthorized" '403': "$ref": "#/components/responses/forbidden" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" tags: - name: Endpoint availability description: " Each endpoint has a badge indicating whether you can already use it: " - name: Authentication description: " To access the endpoints, you must include a valid credential in the request's Authorization header, using the Bearer scheme.

Example of an authentication header:
Authorization: Bearer bW9uZGV8dXNlcjpwYXNzMTIz

About authentication:

" - name: Idempotency description: " Some endpoints in this API use an idempotency key (Idempotency-Key) to ensure duplicate requests (for example, due to timeouts or automatic retries) are not processed more than once.

How to use

Behavior

" - name: Rate limits description: " To keep the service stable for everyone, this API limits how many requests each client can make in a short time window.

Limit

When the limit is exceeded

Recommendation

" - name: Pagination description: " List queries return one page of records at a time. The pagination node in the response tells the page size, whether a next page exists and which cursor to send to reach it.

Walking through the whole query

  1. Make the first request without cursor.
  2. While has_next_page is true, repeat the request sending cursor with the next_cursor value from the previous response.
  3. When has_next_page is false, next_cursor comes back null and the walk is over.

Page size

The cursor

" - name: Attachments description: Operations for uploading, downloading and deleting attachments associated with resources. - name: Sales description: 'A sale is an object that represents the commercialization of one or more products between a travel agency and its clients. To sell the product to the client, the agency may acquire it directly from a supplier or through a representative.

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.

You can also create, edit and delete a standalone invoice and run the actions on it: issue the NFS-e, cancel, record an issuance made at the city hall, adjust the amount, remove the numbering, create a copy for reissue and download the XML. The permissions are the Monde ones: writing and the actions that only change the invoice require **Edit**, deleting requires **Delete**, issuing the NFS-e and canceling through e-Notas require **Issue NFS-e**, and creating the copy for reissue requires **Create copy for reissue**. Invoices do not exist on an operator (consolidator) installation: there, writing answers 403.' - name: Generate Invoices description: 'Generate the service invoices (NFs) of sold products from the invoice (NF) rules, as in Monde''s Gerar Notas Fiscais screen. The flow has two steps: [List invoices to generate](#tag/Generate-Invoices/paths/~1nf_generations/get) returns, for each product of a closed sale, the invoices it already has and the ones the generation would save, with the recipient, the amount, the taxes, the rule and the formula; then [Generate invoices](#tag/Generate-Invoices/paths/~1nf_generations/post) saves the chosen ones, all or none. The reference company (`company_identifier`) plays the role of the company the user logs into in Monde: it supplies the operation nature, the CFOP, the tax rates, the issue date and the item template of every invoice, and each invoice belongs to the company of the sale. Generated invoices are unissued and show up in [List invoices](#tag/Invoices/paths/~1nfs/get). The resource does not exist on operator installations.' - name: Logs description: 'Query the system change history: the recorded action, the origin, the description of the change, when it was recorded and, when getting the entry by ID, the references to the author and to the audited record.' - name: Custom Fields description: 'Query the definitions of the system''s custom fields by resource (sales, travels, people, accounts payable/receivable and tasks): the identifier, the name, the kind, whether it is required and the registered options. The value of each field is sent on the sale, the person and the bill.' - name: Commission Plans description: 'List commission plans, as in the Commission Plans registry of Monde. A plan has goal ranges (the percentage of the month goal a person must reach for the range to apply); each range has the all-products entry and, optionally, entries for specific products; and each entry has the commission values of each role: a percentage over sale fields or a fixed amount, and optionally other values for sales with an intermediary. When commissions are closed, the highest range the person reached applies, with the entry of the sold product (without it, the all-products entry) and the rule of the role of the person (without it in the product entry, the one in the all-products entry). Plans are linked to people in the Monde roles registry. The resource exists only for agencies: in an operator installation, every call returns `403`. Reading requires the "Visualizar" permission of Commission Plans.' - name: Goals description: 'List the sales goals, as in the Goals screen of Monde. A goal belongs to a person in a role, per year, with the amount of each month; when commissions are closed, what the person sold in the month is compared with the month goal to find the range of the commission plan. This resource is read only: as in Monde, a goal is written through the role, in the "Plan and Goals" of the person. To create, update or delete a goal, send the `goals` list of the person in `people` when [updating the role](#tag/Person-roles/paths/~1person_roles~1{id}/patch), with the "Editar" permission of Person roles. The resource exists only for agencies: in an operator installation, every call returns `403`. Reading requires the "Visualizar" permission of Goals.' - name: Bank Reconciliation description: 'Bank reconciliation of a checking account: upload the OFX statement exported from internet banking, read the uploaded statements with the summary of what is already reconciled, and discard a statement uploaded by mistake. Linking the lines and verifying the entries are done in the Bank Reconciliation screen of Monde Web. The permission is the Monde one, **Bank Reconciliation**, in one of the companies of the checking account. Through the automatic connection, the reconciliation is an exception granted by Monde at approval: it reaches the statement and the account movements of the whole account, from any origin.' - name: Webhooks description: | Get notified when records change instead of polling the lists. A subscription (webhook) belongs to the credential that registered it and is managed through this API. **How it works.** Every write to the API records — made by Monde Desktop, Monde Web or the API itself — stores the event in the database, in the same transaction. Every minute the events are grouped and delivered: one `POST` per event and subscription, with up to 100 records; beyond that, more than one `POST` is sent. The notice is thin: it carries the event and the ids, and the current state comes from querying the resource. The same record saved several times within a minute is listed once. ```json { "id": "7d1e9a52-0c3f-4a8e-b6d1-2f4c5a6b7c8d", "event": "sales.changed", "resource": "sales", "occurred_at": "2026-10-16T14:32:10-03:00", "data": [ { "id": "b71a4c58-2f0e-4c1e-9a63-1c9a0f0b9e21", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" }, { "id": "c92f0d13-6b1a-4f7e-8d2c-3e4f5a6b7c8d", "company_id": "5be3f11b-0707-4ad1-be88-4f07f01327ab" } ] } ``` **Events.** The catalog is in [List webhook events](#tag/Webhooks/paths/~1webhook_events/get): `changed` (record created or updated) and `deleted` for each resource, plus business events (sale closed and reopened, product canceled, commission closed and paid, sale imported from an integration queue, invoice issued and canceled, task overdue, integration import completed and CVC statement import completed). Creation and update are a single event: the notice only carries the id, and the query tells how the record is; if your system does not have the record yet, it is new. A change to an item that is part of the record (product, passenger, segment, commission, attachment and payment of the sale; items, categories and apportionment of the bill; the group of a financial category) generates the record `changed` event. In business events each item also carries `subresource_id`, the item that triggered the event (the canceled product, the commission, the imported sale). `company_id` is null for records that do not belong to a company. `tasks.overdue` is a time event: it is sent once per due date, about a minute after the due date passes without the task being completed. A task saved already overdue, or that became overdue while no webhook subscribed to the event, does not generate it. In `cvc_statements.import_completed`, the item `id` is the import run, available in [Get log by ID](#tag/Logs/paths/~1logs~1{id}/get) to credentials with the **Logs** permission; the statements it created or changed send their own events. `integrations.import_completed` says the imported sales queue of the integration was updated. `cvc_statements.import_completed` is not sent for an import that failed or found no new file. A currency only generates `changed`, when it is activated or deactivated. Ships and cabins are identified by their name: changing it generates the `deleted` of the old id and the `changed` of the new one. **Order and repetition.** The order between notices is not guaranteed: if querying an id returns 404, the record was deleted. The credential also receives notices of what it wrote itself: an integration that writes back to Monde when it receives a notice must ignore its own change, or it loops. **Who receives.** Only events of resources the credential can read can be subscribed, and a notice is only sent for a record the get-by-ID would return to the credential: the company must grant read access to the resource and have an active license. A deactivated credential stops receiving. **Headers and signature.** Each delivery carries `X-Monde-Event`, `X-Monde-Delivery` (the delivery `id`, the same in every attempt: use it to discard repeated notices), `X-Monde-Timestamp` (seconds since 1970) and `X-Monde-Signature`, formatted as `sha256=`: the HMAC-SHA256 of `"."` with the subscription secret. Verify the signature against the body exactly as received and reject old timestamps. **Retries.** A 2xx response confirms the delivery. Any other response, connection error or a wait above 10 seconds is retried with increasing waits (1, 2, 4, 8, 16, 32 and 64 minutes), 8 attempts in total. Redirects are not followed. A 410 response means the address no longer exists: the delivery gives up at once, without retrying, and counts as exhausted. After 10 consecutive exhausted deliveries the subscription is deactivated: `active` becomes `false` and `disabled_at` and `last_error` tell when and why; sending `active` as `true` re-enables it. While the webhook is deactivated there are no notices: the deliveries that were pending are recorded as failed, and re-enabling does not resend what changed in that period. After re-enabling, query the resource list to catch up on what changed. Each delivery's history is kept for 30 days in [List webhook deliveries](#tag/Webhooks/paths/~1webhooks~1{webhook_id}~1deliveries/get). **Address.** Only `https`, and never an internal, local or reserved network address; the check is repeated before each delivery. Requires the credential's **Webhooks** permission: read to query, create and edit to register and change, delete to remove. - name: FAQ description: | The most common questions about the v3 API, with a short answer and a link to the section that covers the subject in detail. # Access and credentials ## What is the difference between the v2 and the v3 API? v2 still works, but it is legacy and no longer receives updates: every integration should use v3, which is the one in this documentation. v3 authenticates with the credential the agency generates; v2 uses the login and password of a Monde user and has its own documentation. ## How do I access the API? Does the token expire? Send the credential in the `Authorization` header with the `Bearer` scheme, as shown in [Authentication](#tag/Authentication). The credential does not expire, but the agency can revoke it at any time. ## Where does the agency generate the credential? In Monde, under **Cadastros > Integrações**, in the **API Monde** integration. That is where the agency picks the credential permissions, per company and per resource, and from there it hands the credential to whoever is integrating. ## Can I have read-only access? Yes. When generating the credential, the agency grants only the read permissions of the resources it wants to share. Writes answer `403`. ## Does one credential serve several companies or stores? Yes. One credential accesses every company of the agency that was granted permission on it. Every company with an active Monde license can be used by the API, with no separate license. A read-only company is only read: writes to it answer `403` with "The company is read-only: its records can be read through the API, but not written.". ## Does the credential see and change the records of other users? As in Monde, each permission applies to what the credential itself created, and the "of others" permissions extend the reach to the rest: in sales, **Consult**, **Open** and **Edit sales of other sellers**; in accounts payable and receivable, **Access entries of all users and of the system** or one of its slices (client invoices, supplier invoices, credit card invoices, entries with an own operation and with a sale); in tasks, **See tasks of other users**. A travel belongs to the credential when the credential created it or created one of its sales, and the other travels follow **Consult sales of other sellers**. Listing and getting require the "View" permission of the resource also for what the credential itself created, as in Monde, where the record does not open without it; without that permission the update response brings only the identifiers, and the creation response brings the whole created record. A record of another user outside the reach answers `404`; one it reads but cannot change answers `403` with the Monde message. A credential generated before these permissions keeps reaching every record, as before. ## I got a 403 error. What is missing? Either the credential lacks the permission for that resource, the company has no active Monde license or is read-only on a write, or the resource requires the Monde Pro license, as [Guides](#tag/Guides) do. The response message says which cause it is. When it is the permission, there is no need to generate a new credential: the agency only has to grant the permission on the existing one. ## I am a partner system serving several agencies. How do I connect? Through [Automatic connection](#tag/Automatic-connection). The agency authorizes the partner inside Monde, without sharing a credential, and the permissions are the ones set when the partner was approved. # Usage and limits ## Is there a test environment (sandbox)? Not for now: the API serves the production data of the agency. While developing, start with queries, using a read-only credential, and use [idempotency](#tag/Idempotency) on writes so that repeating a request does not duplicate records. ## What is the request limit? Is there a daily quota? The limit applies to a short time window, counted per IP, and there is no daily or monthly quota. The values and what to do on a `429` are in [Rate limits](#tag/Rate-limits). ## How does pagination work? By cursor, with up to 50 records per page. Repeat the query sending the `next_cursor` of the previous response while `has_next_page` is `true`. See [Pagination](#tag/Pagination). ## Is the data real time? Yes. The API reads and writes the same database the agency uses in Monde, with no copy or sync delay. ## Does the API notify me of changes (webhooks)? Yes, with the credential created by the agency itself: register an https address in [Webhooks](#tag/Webhooks) and receive a signed `POST` when records change. The **Webhooks** permission is not offered through the [Automatic connection](#tag/Automatic-connection): there, the integration queries the API periodically. For sales, the `updated_since` filter brings only what changed since the last query, including a change to a part of the sale, such as a product, passenger or payment. ## How am I told about changes to the API? Through the [Changelog](#tag/Changelog), which records every change with its date and highlights the ones that alter the contract. The API is in beta, so fields and endpoints may still change. The badge on each endpoint tells whether it can already be used: see [Endpoint availability](#tag/Endpoint-availability). ## Can I use the API with Power BI, spreadsheets or AI agents? Yes. Any tool that makes HTTP requests with the authentication header can consume the API. For AI agents that write code, the documentation is also available as text at `https://web.monde.com.br/llms.txt`. # Querying sales ## How do I filter sales by period? In [List sales](#tag/Sales/paths/~1sales/get), pick the date in `date_field` (sale, departure or return date) and send the range in `date_from` and `date_to`. ## How do I fetch only what changed since the last query? Use `updated_since` in [List sales](#tag/Sales/paths/~1sales/get), with a date or a date and time. It also brings a sale entered with a past date, because it looks at when the sale was changed, not at its date, and it brings the sale when one of the parts shown in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) changes, such as products, passengers, payments and linked bills. The full list is in the filter description. 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. Upsert each sale by id, and send `status=opened,closed,canceled` to also receive deletions. Today this filter exists only for sales. ## How do I filter the sales of a customer or a seller? Use `people_id` with the person ID, which you can look up in [List people](#tag/People/paths/~1people/get). The filter brings every sale in which the person appears in any role: payer, passenger, seller, supplier. To split by seller or by company, use the `seller` and the `company` that come in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get). ## Why does the list not bring the sale products? [List sales](#tag/Sales/paths/~1sales/get) brings the main data and the totals of each sale. Products, payments, commissions, attachments and custom fields come in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get). ## Why are deleted sales missing? By default, the query brings only open and closed sales. For deleted ones, send `status=canceled`. ## The sale brings only the supplier ID. How do I get the name? Suppliers, representatives, payers and passengers are person records. Look them up in [Get person by ID](#tag/People/paths/~1people~1{id}/get) and keep the result so you do not repeat the same query for every sale. ## Are there revenue, markup or profitability fields? Not under those names. The sale brings the value of each product, the fees, the commissions and the over, the revenue and the totals, and each integration builds its own indicators from those values. ## Does the API have ready-made reports, such as sales per seller or per product? No. The API delivers the records, and the report is built on the integration side, from the queried sales. ## How do I read the finance data (accounts payable and receivable)? In [Accounts Payable and Receivable](#tag/Accounts-Payable-and-Receivable), [Account movements](#tag/Account-movements), [Refunds](#tag/Refunds) and [Invoices](#tag/Invoices). The sale detail also brings the bills it generated. # Writing ## Can I create sales through the API? Yes, in [Create a sale](#tag/Sales/paths/~1sales/post), one sale per request. The accepted products and the required fields are in the operation description. ## Can I send or change several sales in a single request? No. Each request writes one sale. For volume, send them one after the other, within the [rate limits](#tag/Rate-limits). ## How do I avoid a duplicate sale when repeating a request? Send the `Idempotency-Key` header, required in [Create a sale](#tag/Sales/paths/~1sales/post). While the key is valid, repeating it returns the response of the first request, without writing again. The key expires after at least one day. See [Idempotency](#tag/Idempotency). ## How do I avoid registering the same supplier or customer twice? In the sale, each person is looked up by the `external_id` your integration sent before and, without that link, by the CPF or CNPJ. The person is registered only when neither finds it. Always send the CPF or CNPJ to reuse the record that already exists in Monde. ## What else can I write besides sales? People, tasks, attachments and accounts payable and receivable. The badge on each operation tells whether it is already available, and the [Changelog](#tag/Changelog) records every new operation. ## Can I create travels through the API? Yes. In [Travels](#tag/Travels), the integration creates, updates and deletes travels and links or unlinks their sales, with the **Edit** and **Delete** permissions of Travels. The travel created by the credential is its own: updating, deleting and linking sales to it do not require **Consult sales of other sellers**, which the travels of other sellers and of other credentials require. - name: Changelog description: | The v3 API is in **beta**: already available for use, but still in a testing and adjustment phase — fields and endpoints may change. Follow this section for changes. ## 2026-11-15 ### Quotes and guides: three columns - The `details` of [guides](#tag/Guides) and [quotes](#tag/Quotes) now accepts columns with two or three `
`. Before, only with two. ## 2026-11-13 ### Quotes and guides: thumbnails in the carousel - The `details` of [guides](#tag/Guides) and [quotes](#tag/Quotes) now accepts `data-carousel="thumbnails"` on the paragraph of the carousel images, which shows thumbnails below instead of dots. Any other value, or the attribute on another tag, is dropped. - Images in a row in the same paragraph form the carousel even with a space (` `) between them. ## 2026-11-12 ### Quotes: cover and optional fields - [Quotes](#tag/Quotes) now return the public link cover: `cover_kind` (`color`, `image`, or `none`), `cover_color`, `cover_show_title`, `cover_show_subtitle`, and `cover_image_url`. - [Create quote](#tag/Quotes/paths/~1quotes/post) and [Update quote](#tag/Quotes/paths/~1quotes~1{id}/patch) accept `cover_kind`, `cover_color`, `cover_show_title`, and `cover_show_subtitle`. The cover image can only be chosen in Monde Web. Without a cover, a new quote gets the `color` cover, in the primary color of the company's Quote Settings. - `subtitle` and `details` are no longer required: they can be omitted on creation, and null clears them on update. ### Sales: inactive seller - In [Create sale](#tag/Sales/paths/~1sales/post) and [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), a `seller` who is an inactive seller in Monde is now rejected with 422, as in Monde, instead of answering 500. A credential without the permission to edit Sellers still receives 403, as for a seller not yet registered. On update, the seller the sale already has is still accepted, even if inactive. ### Guides: new cover and optional content - The [guide](#tag/Guides) cover is now `color`, `image`, or `none`, like the quote cover, and guides also return `cover_show_title`, `cover_show_subtitle`, and `cover_image_url`. Guides that had the `default` cover moved to `color`, in `#5f6777`. - [Create guide](#tag/Guides/paths/~1guides/post) and [Update guide](#tag/Guides/paths/~1guides~1{id}/patch) accept `cover_show_title` and `cover_show_subtitle`. `hide_cover_text` is still accepted and stands for both, and the `default` cover is still accepted and works as `color` in `#5f6777`. Without a cover, a new guide gets the `color` cover in that color. - `details` is no longer required: it can be omitted on creation, and null clears it on update. ## 2026-11-11 ### Quotes: blocks in the content - The `details` of [quotes](#tag/Orcamentos) now accepts the three guide blocks: highlight box, section with a background image, and two columns, as `
`. Before, they became plain text. ## 2026-11-10 ### Guides: image in the highlight box and in the section with a background image - In the `details` of [guides](#tag/Guias), the highlight box is now text only: an image goes to a paragraph right after it, and a table, quote, code, or horizontal rule goes after it. The section with a background image keeps only the first image, and the others are discarded. ### Logs: e-mail sending has its own action - The `kind` of [List logs](#tag/Logs/paths/~1logs/get) and [Get log by ID](#tag/Logs/paths/~1logs~1{id}/get) now returns `email` for an 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. The `kind` filter of [List logs](#tag/Logs/paths/~1logs/get) now accepts `email`. - **Attention, contract change:** these entries used to come with a free-text `kind`, outside the documented set (`Enviado por e-mail`). Whoever read that value now receives `email`. ### Invoices: the item added to another one and the destination of a removed item - **Attention, contract change:** [Remove items from the invoice or recalculate the due date](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1item_reprocessing/post) now brings `reprocessed_items`: for each item sent, the invoice it ended up on (`bill`) and the item on it (`item`), which is another one when the destination invoice already had an equal item and both were added together. When all items leave and the invoice is deleted, the response is no longer `204` without a body: it is `200` with only `reprocessed_items`. - The documentation of the actions on invoice items now says what happens to the `id` of an item that is added to an equal one, in [Change the checked status or cost center of an invoice item](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1items~1{id}/patch): it ceases to exist, and the valid `id`s are those in `items` of the response. Nothing changes in the behavior of these actions. - **Attention, contract change:** when the action takes the last item and the invoice is deleted, repeating with the same `Idempotency-Key` now returns the original response, with `X-Idempotent-Replay: true`, instead of `404`. It applies to [Remove items from the invoice or recalculate the due date](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1item_reprocessing/post) and to [Bill the invoice items separately](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1separate_invoice/post). A new key on the deleted invoice still answers `404`. ## 2026-11-09 ### Sales: overpayment return in the payments - New field `overpayment_return` in the agency Outros payment (`payments[].agency.others`), in [Create sale](#tag/Sales/paths/~1sales/post) and when adding a payment through [Update sale](#tag/Sales/paths/~1sales~1{id}/patch): with `true`, the payment is the Return › Generate Account Payable of Monde (Devolução › Gerar Conta a Pagar), which gives back to the customer what was paid in excess. It is only accepted when some product has a negative customer balance before it. The `amount` of each product carries the sign of the customer balance of that product (negative on a product with a negative balance, positive on the others), and a sign that does not match is refused with 422. It writes an open bill, a debit when the sum is negative, with the customer payment and receipt categories. It does not accept `description` nor `details`. Also valid on an operator installation. It requires the same permission to edit sales. ### Deletions with confirmation become action POSTs - New endpoints to delete with confirmation: [Delete account payable or receivable with confirmation](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1removal/post) (`recurrence_scope`, `remove_settlement`, `undo_bank_reconciliation`), [Undo the settlement with confirmation](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement~1removal/post) (`recurrence_scope`, `undo_bank_reconciliation`), [Delete refund with confirmation](#tag/Refunds/paths/~1refunds~1{id}~1removal/post) (`remove_from_bill`), [Delete transfer with confirmation](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}~1removal/post) (`undo_bank_reconciliation`) and [Delete category group with confirmation](#tag/Category-Groups/paths/~1category_groups~1{id}~1removal/post) (`delete_categories`). - Each one has the same rules, permissions and responses as the matching DELETE: `204` without a body on success, `409` without the confirmation, `422` with a confirmation out of format. All of them require `Idempotency-Key`. - **Attention, contract change:** the DELETE of an [account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/delete), of the [settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete), of a [refund](#tag/Refunds/paths/~1refunds~1{id}/delete), of a [transfer](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}/delete) and of a [category group](#tag/Category-Groups/paths/~1category_groups~1{id}/delete) no longer read the body: the confirmation only counts on the POST. Whoever sent the confirmation in the body of the DELETE now receives `409`, and the message points to the POST to use. A `recurrence_scope` sent in the DELETE answers `422`, pointing to the POST: ignored, it would make deleting or reopening a single entry look like the whole series. Without a confirmation, the DELETE stays the same. - Why: HTTP (RFC 9110) gives no meaning to the body of a DELETE, and proxies and HTTP clients may drop it along the way. So the confirmation could be lost without notice. ## 2026-11-06 ### Sales: to-invoice payment and to-invoice return as actions of the sale - New endpoint [To invoice (Faturar)](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice/post), the Faturar of the Financial tab of the sale in Monde: the payer (`payer_id`, or the one of the sale), the cost center and the amount of each product, with the sign of its customer balance. It answers `202`: the items to invoice are recorded, and the automatic invoicing takes them to the customer invoice right after. - New endpoint [To-invoice return (Devolução Faturar)](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice_returns/post), the Devolução › Faturar of Monde: the amount the agency returns to the customer through the customer invoice, with a description. It is only accepted when some product has a negative customer balance. - New endpoint [Remove a to-invoice line](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice~1removal/post), the Excluir (delete) of the payments grid of Monde: removes the whole line from the customer invoice, and the customer balance comes back. A closed sale only with `reopen_sale` and the permission "Reabrir venda" (reopen sale); a settled invoice only with `remove_settlement`; a closed invoice, reopened first. - The three require the permission to edit sales in the company of the sale, and on a sale with a printed receipt also "Alterar vendas com recibo impresso" (change sales with a printed receipt). - **Attention, contract change:** `payments[].agency.to_invoice` leaves the [creation](#tag/Sales/paths/~1sales/post) and the [update](#tag/Sales/paths/~1sales~1{id}/patch) of the sale and is now ignored, as an unknown field. On the update, the `payments` list neither keeps nor removes the to-invoice payment and the to-invoice return: they only change through the endpoints above. - **Attention, contract change:** `payments.agency.to_invoice` when [reading the sale](#tag/Sales/paths/~1sales~1{id}/get) is read only and changes shape. Each item is a to-invoice line that already entered a customer invoice, per invoice and cost center: `bill`, `cost_center`, `amount` (with the sign; negative is a to-invoice return) and `products` (`sale_product` and `amount`). Out go `id`, `due_date`, `description`, `payer`, `bills` and the `id` of the products: the payer and the due date are those of the invoice. A to-invoice payment that has not entered an invoice yet does not show. The to-invoice return, before only referenced by the invoice in `payments.agency.bills`, now shows in the line. ## 2026-11-05 ### Sales: Visa product - New **Visa** product (`visas[]`) in [Create a sale](#tag/Sales/paths/~1sales/post), [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) and [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get). It is a system product, like the Excursion: there is no need to inform the product, and it becomes active on its first sale. Own fields: `visa_type` (visa type, required, up to 50 characters, such as "Turismo") and `destination_country` (visa country, required, ISO 3166-1 alpha-2 code, such as "US"; a code outside the country list is rejected with 422). - There is no dedicated field for the consular fee nor for the service fee: each applicant's consular fee goes in `passengers[].fees`, and the agency service fee in the product's `agency_service_fee`. - The `kind` filter of [List sales](#tag/Sales/paths/~1sales/get) and [Products](#tag/Products/paths/~1products/get) now accepts `visa`, and the product `kind` now returns `visa`. ### Invoices: item breakdown and movements by period - The invoice items, in [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) and in the items that can join the invoice, now carry the item side (`side`: `customer` or `vendor`), the kind (`kind`), the sale product document (`document`), the issue date (`issue_date`) and the person (`person`). With them, a supplier invoice payment breaks down into each sale: what was paid to the supplier and what was received from the customer. - [List account movements](#tag/Account-movements/paths/~1account_movements/get) now filters by the movement date, with `date_field=movement_date` and `date_from`/`date_to`. ### Invoices: items of all invoices - New endpoint [List invoice items](#tag/Accounts-Payable-and-Receivable/paths/~1bill_items/get): the items of the invoices and of the accounts payable and receivable in a single listing, each with its entry, the entry settlement and the sale. Filters by entry (`bill_id`), account, person, side (`side`) and period (`date_field` = `settlement_date`, `due_date` or `issue_date`). With it, the breakdown of the month's payments comes in one query, without a call per invoice. Requires the "Visualizar" permission of accounts payable and receivable, already granted to whoever reads the entries. ### Accounts Payable and Receivable: credit card invoice apportionments - [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch) now accepts `apportionments` on a credit card invoice (`credit_card_invoice`), like the Rateios tab of Monde. The apportionments split the final amount of the invoice, which is the sum of the card purchases. Categories are still refused. - A credit card invoice with apportionments saved in Monde is no longer refused as an invalid apportionment when updated. When the invoice amount changes after the apportionment, because a purchase came in or out, the next update answers 422 until the apportionments are sent again, as in Monde. ### Reports: Sales by Seller - New endpoint [Get sales by seller](#tag/Reports/paths/~1reports~1sales_by_sellers/get), the Vendas por Vendedor report of Monde: one row per seller and company, with the number of sales and products, the summed amounts, the commission, the over and the revenue. Requires the sale period (`date_from` and `date_to`) and also filters by sale and product status, seller and company. - New credential permissions, the ones of Monde, in the Vendas por Vendedor resource: "Vendas por Vendedor" (`sales_by_sellers.read_all`) and "Consultar vendas de outros vendedores/intermediários" (`sales_by_sellers.read_from_other_sellers`), unchecked on existing credentials. ## 2026-11-04 ### Rate limits: IPv6 counted per /64 network - Over IPv6, the [rate limit](#tag/Rate-limits) is now counted per `/64` network, not per address: every address in the same `/64` network adds up to the same limit. Nothing changes over IPv4. ### Accounts Payable and Receivable: surcharge and discount block on the difference - In the [settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) and in [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post) already settled, the difference sent with `balance_resolution: category` now goes through the company's surcharge and discount block, as in Monde. Above the limit, the request is rejected with 422. ### Reports: Sales by Product - New endpoint [Get sales by product](#tag/Reports/paths/~1reports~1sales_by_products/get), the Vendas por Produto report of Monde: one row per product sold, with the people of the sale, the product details, amounts and commission, the passengers, the invoices, the air segments and the custom fields. Filters by date, sale and product status, seller, product, supplier or representative, own operation and company. - New credential permissions, the ones of Monde, in the Vendas por Produto resource: "Vendas por Produto" (`sales_by_products.read_all`), "Consultar vendas de outros vendedores/intermediários" (`sales_by_products.read_from_other_sellers`) and "Visualizar comissão, over e receitas" (`sales_by_products.view_commission_columns`), unchecked on existing credentials. - The reports are now together, in the [Reports](#tag/Reports) section. The Passenger List left its own section and moved into it; the endpoint did not change. ### Reports and Generate Invoices: no free text filter - **Contract change:** [Get passenger list](#tag/Reports/paths/~1reports~1passenger_lists/get) and [List invoices to generate](#tag/Generate-Invoices/paths/~1nf_generations/get) no longer accept `search`. The parameter is ignored and the list comes without it; to narrow the list, use the other filters of each one. ### Bank reconciliation: confirmation only when the change undoes it - In [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch) and [Update transfer](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}/patch), `undo_bank_reconciliation` is now required only when the change alters the amount, date or account of a reconciled movement, like the Monde warning. A change that does not touch the reconciled movements (categories, apportionments, description and other data) is written without the confirmation and keeps the reconciliation. Requests that already send the confirmation keep working as before. ### Sales - **Contract change:** in [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch), `external_id` is no longer accepted on the sale products or on the `products[]` of the payments. A product is identified only by `local_id` (required, up to 50 characters and unique within the sale), and a payment points to the product by `sale_product_local_id` or `sale_product_id`. A product without `local_id` and a payment item without a product reference are rejected with 422. ### Accounts Payable and Receivable: credit card invoice - [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch), [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post), [Settle accounts payable and receivable in batch](#tag/Accounts-Payable-and-Receivable/paths/~1bill_batch_settlements/post) and [Undo the settlement of account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete) now accept the credit card invoice (`credit_card_invoice`) in every agency, with the Monde locks. It no longer answers `409` for not having its edition released. ## 2026-11-03 ### Guides: blocks in the content - The `details` of [guides](#tag/Guias) accepts three blocks: highlight box, section with a background image, and two columns, as `
`. The format is in the field description. Nothing changes for quotes. ### Guides: cover and optional subtitle - [Guides](#tag/Guias) now return the public link cover: `cover_kind` (`default`, `image`, or `color`), `cover_color`, `hide_cover_text`, and `cover_image_url`. - [Create guide](#tag/Guias/paths/~1guides/post) and [Update guide](#tag/Guias/paths/~1guides~1{id}/patch) accept `cover_kind`, `cover_color`, and `hide_cover_text`. The cover image can only be chosen in Monde Web. - `subtitle` is no longer required. On update, sending it as null removes the subtitle. Nothing changes for integrations that already send the subtitle. ### Sales: additional fields of the product - Every sale product now accepts and returns the three additional fields Monde shows on the product screen: `external_number`, `additional1` and `additional2`, with up to 20 characters each. Each agency gives these fields its own title (for example, "Nº Pedido"). - New endpoint [List product additional fields](#tag/Sales/paths/~1sale_product_additional_fields/get), which tells the title of each field. It requires the permission to read sales. - A field without a title does not appear in Monde: the API ignores the value sent to it and leaves it out of the reading. ### Passenger List - New endpoint [Get passenger list](#tag/Reports/paths/~1reports~1passenger_lists/get), the Passenger List report of Monde: one row per passenger of a product sold, with contact data, documents, address, the air segments with the passenger's seat, the product details and amounts, the people of the sale and the custom fields. Filters by date, sale status, people, product, supplier, representative, city, label, company and free text. - New credential permissions, the ones of Monde, in the Passenger List resource: "Lista de Passageiros" (`passenger_lists.read_all`) and "Consultar passageiros de outros vendedores/intermediários" (`passenger_lists.read_from_other_sellers`), unchecked in the existing credentials. ### Commission Plans: new revenue parts in `calculated_on` - In the [commission plans](#tag/Commission-Plans), `calculated_on` can bring `customer_refund`, `vendor_refund`, `agency_card_rate`, `supplier_fine` and `deleted_balance`, when the plan is calculated over these values. ### Accounts Payable and Receivable: batch settlement - New endpoint [Settle accounts payable and receivable in batch](#tag/Accounts-Payable-and-Receivable/paths/~1bill_batch_settlements/post), which settles up to 100 entries in one call, each one for its final amount, on the same date and in the same account, like settling the entries checked in Monde. It is all or nothing. With `use_sale_data`, each sale payment takes the payment method and the check or card data of its own sale. - It requires, on each entry, the same permissions as the settlement of one entry. Nothing changes for the credentials that already settle. ### Currencies: only activate and deactivate, on every agency - [Update currency](#tag/Currencies/paths/~1currencies~1{code}/patch) only activates or deactivates the currency, on every agency: code, description and symbol do not change (`422`). Before, this applied only with multicurrency. - [Delete currency](#tag/Currencies/paths/~1currencies~1{code}/delete) now always answers `409`: deactivate the currency you do not use. ## 2026-10-30 ### Removal: system settings, administration and internal processes - **Attention:** the v3 API stops offering what does not fit an integration API. The routes below now answer `404`: - Settings: the whole `/settings` (the tabs, e-mail, e-Notas and the certificate, Blocks, Security, CVC, licenses, quote and guide settings, and the company registration in `/settings/company`, which [Update person](#tag/People/paths/~1people~1{id}/patch) already covers) and `/payment_method_details`. - Integrations: creating, updating and deleting in `/integrations`, `/integration_vendors`, the product and person links, `/integration_credentials` and `/supplier_authorizations`. [Reading the integrations](#tag/Integrations) stays. - Invoice (NF) and billing rules: creating, updating and deleting. Reading stays. - Custom fields: creating and updating the definitions. Reading stays, and the field value is still sent on the sale, the person and the bill. - Bank reconciliation: the matching, the lines with the candidates and the links, and the verification. Uploading the OFX statement, the list, the detail and the discard stay. - Commissions: `/commissions`, `/commission_closings` and `/commission_payments`, and creating, updating and deleting commission plans. Reading the plans stays. - CVC: in `/cvc_statements` and `/cvc_master_statements`, everything but the list and the detail; and the statement closings, `/cvc_imports` and `/cvc_deposit_checks`. - The credential permissions that only served these routes are no longer offered. A credential that already has them keeps working for the rest, and saving the credential in Monde removes them. ### Accounts Payable and Receivable: entry currency - In [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post), the entry now accepts the currency (`currency`), among the active ones, when Monde works with more than one: on a tour operator or with multicurrency. When omitted, it stays in Real. The movements of the settlement made on creation now accept `exchange_rate` and `reference_exchange_rate`, as the [settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) does. - The bill detail and list now return the currency (`currency`). ### Invoices: NFS-e PDF - New endpoint [Download NFS-e PDF](#tag/Invoices/paths/~1nfs~1{id}~1pdf/get), which redirects to the PDF of an issued or canceled invoice at e-Notas, as Monde opens it. ### Accounts payable and receivable: new movement on update and attachment rename - In [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch), an item of `movements` without `id` now adds a new movement to a settled entry, like Monde's Adicionar, with installments (`installments`) on a credit card account. Before, every movement needed the `id`. - New endpoint [Rename attachment](#tag/Attachments/paths/~1attachments~1{id}/patch), with the attach permission of the owner record. ### Accounts payable and receivable: bank slip and billing account - In [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post) and [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch), receivables now take the billing account (`billing_account_id`) and the bank slip demonstrative (`billet_demonstrative`), like Monde's Boleto tab. On an open client invoice, the billing account answers 409 until the request brings `close_invoice` as `true`, which closes the invoice along. - New endpoints: [Generate the bank slip of a receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1billet/post), which issues the bank slip and returns the digitable line, the barcode and, on PJBank, the Pix code (on an open client invoice, with `close_invoice` as `true`, which closes it first, as Monde does), and [Download the bank slip PDF](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1billet.pdf/get). - New credential permissions, Monde's own: "Imprimir boleto" (`sales.print_billet`) and "Gerar boletos" (`bills.generate_billet`), unchecked on existing credentials. ### Accounts payable and receivable: close and reopen the client invoice - New endpoints, like Monde's Fechar Fatura and Reabrir Fatura buttons: [Close a client invoice](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1invoice_closure/post) and [Reopen a client invoice](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1invoice_closure/delete). - New credential permissions, Monde's own: "Fechar Fatura" (`bills.close_invoice`) and "Reabrir Fatura" (`bills.reopen_invoice`), unchecked on existing credentials. ### Accounts payable and receivable: actions on the invoice items - Each item of `items` in [Get payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) now brings its `id`, which the actions below take. - New endpoints, like the actions of Monde's invoice Itens tab: [Change the checked status or cost center of an invoice item](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1items~1{id}/patch), [Correct the values of an invoice item](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1items~1{id}~1value_correction/post), [Items that can enter the invoice](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1item_candidates/get), [Add items to the invoice](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1items/post), [Remove items from the invoice or recalculate the due date](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1item_reprocessing/post) and [Bill the invoice items separately](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{bill_id}~1separate_invoice/post). - New credential permissions, Monde's own: "Alterar taxa CC" (`bills.change_card_fee`), for correcting values, and "Alterar dados do produto em vendas fechadas" (`sales.edit_product_closed_sale`), when the correction changes the product of a closed sale. ### Accounts payable and receivable: settle the sale standalone entry and the commission - In [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) and [Undo the settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete), the sale standalone entry (`sale_standalone`) and the commission (`commission`) are now settled and reopened like the standalone entry, as in Monde. Before, they answered 409. The permissions are the same as for the standalone entry. - The sale standalone entry asks for the payment method: the sale payment data apply only to the sale payment. In a partial payment, the balance goes to a new entry of the same kind, tied to the same sale for the standalone entry; for the commission, the paid commissions stay in the original entry. - The [bank reconciliation](#tag/Bank-Reconciliation) now offers and settles both kinds. ## 2026-10-29 ### Sales: passenger document on hotels, cruises and car rentals - In [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get), the passenger of `hotels`, `cruises` and `car_rentals` now returns `document`, the passenger's identification in the product, such as the room or cabin number. - In [Create sale](#tag/Sales/paths/~1sales/post) and [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), these passengers now accept `document` (up to 30 characters). Before, it was discarded. **Attention:** on update, a passenger sent without `document` is left without it, as in the other products; send back the value read to keep it. ### Creates and updates: empty text is a text value - In every create (`POST`) and update (`PATCH`), empty text (`""`) now follows a single rule: on a text field it is saved as sent; 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) it is refused (422). To remove a value on an update, send `null`. The rule is in the introduction of this documentation. - **Attention:** before, `""` varied by endpoint. On a create, it counted as a field not sent. On an update, depending on the field, it cleared the value like `null`, was ignored (including objects and lists, such as the sale `seller` and `payer`, which answered 200 without changing anything) or left the value as it was. An integration that sends `""` expecting nothing to happen now saves the empty text or receives 422. ### People: invalid document on update - [Update a person](#tag/People/paths/~1people~1{id}/patch) now returns 422 on the `cpf_cnpj` field when the CPF/CNPJ stored on the person is not valid, whatever field is being changed, as in Monde, which checks the document on every save. To unlock it, send the corrected `cpf_cnpj`, or null to remove it. Previously the update raised an internal error (500). ### Sales: standalone payment and deposit to the vendor - New endpoint [Generate a standalone payment or deposit to the vendor of the sale](#tag/Sales/paths/~1sales~1{sale_id}~1vendor_invoices/post): generates the invoice of the standalone payment (`advance`) or of the deposit (`deposit`) with the open vendor items of `financial.vendor_items`, each with the amount to generate, as the Generate Standalone Payment or Deposit and the Vendor Deposit of Monde. An amount smaller than the item splits the item, and the rest stays open. It answers `201` with the generated invoice. It requires the permission to edit sales, "Ver aba financeiro" (view the financial tab), except on `deposit` with `product_id` (the vendor deposit of the product), and "Gerar Fatura" (generate invoice) when the automatic vendor invoice is off or the sale is a CVC one. - New permission "Gerar Fatura" (`bills.generate_supplier_invoice`) in the credential. ### Sales: vendor items - In [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get), new field `financial.vendor_items`: the vendor items of the sale, as in the Financial tab of Monde, each with `id`, `kind`, `description`, `due_date`, `amount`, `currency`, the product (`sale_product`), the vendor or representative (`person`), the entry it is in (`bill`) and the direct payment to the vendor that settles it (`payment`). It comes with "Ver aba financeiro" (view the financial tab), as the rest of `financial`. - New endpoint [Update vendor item of the sale](#tag/Sales/paths/~1sales~1{sale_id}~1vendor_items~1{id}/patch): changes the due date and the description of an item not yet in an entry nor paid directly, as the Edit of the item in Monde, and answers with the whole sale. An item in an entry, paid directly or of a generated credit, and a deleted sale, answer 409; a null or empty due date answers 422. It requires the permission to edit sales and "Ver aba financeiro". ### Accounts Payable and Receivable: account payable or receivable of a sale - In [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post), new field `sale_id`: it posts the account payable or receivable on the sale, like the button on the sale Financial tab in Monde. The entry is created as a sale standalone entry (`kind` equal to `sale_standalone`), in the sale company, and shows up in `financial.standalone_bills` of [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get). With `sale_id`, `company_identifier` may be omitted and, when sent, it must be the CNPJ of the sale company. It also requires the "View financial tab" permission on sales, in the sale company. A closed sale accepts the entry, and a deleted one answers 409. `operation_id` and `recurrence_kind` are rejected with 422 on a sale entry, and without `account_id` it has no forecast account, as in Monde. - In the description of [Update](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch), [Delete](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/delete) and [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post), the entry kinds now show the values `kind` returns: `sale_standalone`, `vendor_standalone` and `customer_invoice`. The API did not change. ### Tasks: attachments in the comment - In [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post), new field `attachment_ids`: the attachments already uploaded to the task through [Upload attachment](#tag/Attachments/paths/~1attachments/post) are linked to the comment and show inside it in Monde. With attachments, the text is optional. An attachment of another task, deleted or already linked to another comment answers 422. It requires the same permission as commenting. - In [Get task by ID](#tag/Tasks/paths/~1tasks~1{id}/get), each `history` entry now returns its attachments in `attachments`. **Attention:** the `text` of a comment with an attachment made in Monde now comes without the `(att:)` markup Monde stores in place of the file. ### Accounts and Cards: next bank slip number - In [Get account or card by ID](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get), new field `next_bank_slip_number`: the number of the next bank slip the checking account issues. It is null on other accounts. - In [Update account or card](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/patch), the same field changes the bank slip numbering of the checking account, as the **Change** button of the account registration in Monde, and the change goes into the account log. The numbering only moves forward: a number lower than the current one, or not greater than the last issued bank slip, answers 422. On other accounts, the field is ignored. It requires the **Edit** permission of Accounts and Cards. ### Billing Rules: recalculate open due dates - In [Update billing rule](#tag/Billing-Rules/paths/~1invoice_rules~1{id}/patch), new field `recalculate_open_invoices`. With `true`, after saving the update, the due dates of open invoices that fall under the rules of the person are recalculated in the background, like the Monde "Recalcular vencimentos" button. Omitted or `false`, nothing changes: only the rule is saved. A value that is not a boolean answers 422. ### Category Groups: delete the group with its categories - [Delete category group](#tag/Category-Groups/paths/~1category_groups~1{id}/delete) now deletes a group with categories together with its categories, as in Monde, when the request confirms with `delete_categories: true`. Without the confirmation, the response is still 409. If any category is used in a financial entry or in a Monde setting, nothing is deleted (409). A value other than `true` or `false` responds 422. - [Delete category](#tag/Categories/paths/~1categories~1{id}/delete) now also deletes the group left without categories, as in Monde. ### Sales: the passenger is the person in the product - In [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), the `passengers` list of a product now changes the same passenger, as in Monde, instead of deleting and recreating the list. The passenger is identified by the person: an active passenger has that same passenger changed, a new person is added and an active passenger not sent is removed. - A canceled passenger stays, sent or not. Resent as read, nothing changes; before, it came back as a new active passenger and was charged again. With any different value, the response is 422: a canceled passenger only changes through the [reactivation](#tag/Sales/paths/~1sales~1{sale_id}~1products~1{product_id}~1reactivation/post). A list with only canceled passengers also answers 422. - In [Create sale](#tag/Sales/paths/~1sales/post) and [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), the same person twice in the passengers of a product now answers 422. **Attention:** before, the person was added twice. - A passenger now accepts a registered person by `person.id` alone, as the sale get returns it, besides the person data with the `external_id`. The person pointed to by the `id` is not changed, and the `id` requires the permission to read people; without it, or with a legal person, the response is 422. ## 2026-10-28 ### Sales: change a payment of the sale - In [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), a payment sent with its `id` and the method it was added with is now changed, as in Monde, instead of refused. The payer, the due date, the description and the method data (card, check, `details`, `observations` and the `cost_center` of the to-invoice payment) change, and only what was sent; the payment `id` stays the same. - The amount and the method do not change: `products`, the account and the settlement in a change are refused with 422, and so is another method. To change them, remove the payment from the list and add a new one, as before. - The locks are those of Monde: a settled or invoiced payment is not changed (422), and a closed sale is only changed after reopening (409). The retained-by-intermediary payment is not changed here (422). ### Invoices: CVC original data - In [List invoices](#tag/Invoices/paths/~1nfs/get) and [Get invoice by ID](#tag/Invoices/paths/~1nfs~1{id}/get), new read-only field `cvc_original_data`: the original data of the invoice imported from the CVC file, which Monde shows in the CVC tab of the invoice. It is null when the invoice did not come from that file. It also comes in every response that returns the invoice, such as the writes on `/nfs` and the invoice generation, and requires the same permission as reading invoices. ### Sales: Cash, Check and Others - New payment methods in [Create sale](#tag/Sales/paths/~1sales/post) and when adding a payment through [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), as in Monde: in `agency`, `cash`, `check` and `others`; in `vendor`, `check` (check paid directly to the vendor). Each check payment is one check, with a required `check_number`, `bank_code` and the CPF/CNPJ in `document`. - Cash and Check create the bill in the Cash or Check account of the Sales settings, which is not sent in the payload, and follow the automatic settlement set there. Others creates an open bill, without account, with `details` in its observations. The check paid to the vendor does not create a bill. - The due date of the four methods cannot be earlier than the sale date. None of them is accepted on an operator (422), as in Monde. ### Attachments: travels, tasks and deletion - [Upload attachment](#tag/Attachments/paths/~1attachments/post) now accepts `resource_type` `travel` and `task`. As in Monde, attaching asks **Add attachments** and the permission to edit the travel or the task, in its company. - New endpoint [Delete attachment](#tag/Attachments/paths/~1attachments~1{id}/delete), for the attachments of sales, accounts payable and receivable, people, travels and tasks: the attachment goes to the trash of the record, where Monde restores it. As in Monde, it only asks **Delete attachments** on the resource, with the same reach as attaching. - New permissions **Add attachments** on Travels and Tasks and **Delete attachments** on Sales, Accounts Payable and Receivable, People, Travels and Tasks, the Monde ones. The credential reaches the travel and the task it created; the others ask **Read sales of other sellers/intermediaries** (travel) or **See tasks of other users** (task). Existing credentials do not get them: they must be checked. ### Commission Plans and Goals - New resource [Commission Plans](#tag/Commission-Plans), with list, get, create, update (PATCH) and delete, following the rules of the Monde plan registry. A plan brings its goal ranges, the products of each range and the values of each role. On update, as in Monde, only what is sent changes: the range, product and rule with an `id` stay the same records, the ones without `id` are added and the ones left out of the list are removed. A plan in use by someone in a role is not deleted (`409`). - New resource [Goals](#tag/Goals), read only. As in Monde, a goal is written through the role: the `goals` list of each person in `people` of [Person roles](#tag/Person-roles), with the **Edit** permission of Roles. The [person role query](#tag/Person-roles/paths/~1person_roles~1{id}/get) now brings the goals of each person. - Both resources exist only for agencies: in an operator installation, they return `403`. - New permission resources **Planos de Comissão** (commission plans: **Visualizar**, **Editar** and **Excluir**, from Monde) and **Metas** (goals: **Visualizar**). Through the automatic connection, writing and deleting commission plans is an exception granted by Monde on approval, highlighted on the consent screen: a plan applies to the whole agency. ### Webhooks - New events in the [Webhooks](#tag/Webhooks) catalog: `changed` and `deleted` for ships, cabins, task categories and financial categories; `currencies.changed` (currencies only notify the update); the overdue task (`tasks.overdue`); and the completed import (`integrations.import_completed` and `cvc_statements.import_completed`). ### Integrations: undocumented fields are ignored - **Behavior change:** when writing [Integrations](#tag/Integrations) (the integration and its product and person links) and [Integration Credentials](#tag/Integration-Credentials), a field the endpoint does not document is now ignored, as in the rest of the API. Previously the write was refused with 422. On update, the integration `vendor_id` and the credential `user_id` and `integration_id`, which do not change after creation, are ignored as well. ## 2026-10-27 ### Settings: Blocks, Security and CVC - New endpoint `/settings/payment_blocks`, to read and update the Blocks of Payables and receivables (surcharge and discount, movement and due days), with the **Configurar bloqueios** permission, the same as in Monde, which the Payables and receivables tab permission does not open. Every change goes to the company log, field by field. - New endpoints for the tabs that only the administrator opens in Monde, read-only and with an API permission of their own: `/settings/security`, which tells whether Monde asks for the e-mail code when signing in on a new computer (**Settings - Security**); and `/settings/cvc`, with the CVC features and the statements FTP, without the password (only `ftp_password_configured`), whose update is always refused (409), because in Monde only a user with full access changes the CVC tab (**Settings - CVC**). - Like the other Settings permissions, these are not offered through the [Automatic connection](#tag/Automatic-connection). ### Sales: `updated_since` considers the parts of the sale - In [List sales](#tag/Sales/paths/~1sales/get), the `updated_since` filter also brings the sale when one of its parts changes, not only the header: products, passengers, segments and seats, commissions, attachments, payments and the addition, cancellation or deletion of the linked bills. This applies to changes made in Monde, through the API or by any other means. Settling a bill only brings the sale back when it changes the agency card fee of the products or when it is partial and creates the balance bill. **Attention:** the sync starts receiving sales that used to be left out. - New recommendation on the filter: keep the instant the query started, before the first page, start the next query from it with an overlap of a few minutes before it, and upsert each sale by id. To also follow deletions, send `status=opened,closed,canceled` along. ### Invoices - New endpoints [Create standalone invoice](#tag/Invoices/paths/~1nfs/post), [Edit standalone invoice](#tag/Invoices/paths/~1nfs~1{id}/patch) and [Delete invoice](#tag/Invoices/paths/~1nfs~1{id}/delete), with the rules of the Invoices screen. The recipient is the registered person (`person_id`) or the data sent in `recipient`; the amount is the sum of the items, and the taxes are calculated on save. Only an unissued invoice is edited or deleted (409 otherwise). On edit, the `items` list sent is the final one: an item with `id` stays, one without `id` is added and one not sent is removed. Each new item may carry a `local_id`, returned in the response next to the generated `id`. - New actions on the invoice: [Issue NFS-e](#tag/Invoices/paths/~1nfs~1{id}~1issuance/post), asynchronous (answers 202 with the invoice awaiting issuance; follow it with Get invoice by ID), [Cancel](#tag/Invoices/paths/~1nfs~1{id}~1cancellation/post) (202 when the cancellation goes to the city hall through e-Notas), [Record manual issuance](#tag/Invoices/paths/~1nfs~1{id}~1manual_issuance/post), [Adjust amount](#tag/Invoices/paths/~1nfs~1{id}~1amount_adjustment/post), [Remove numbering](#tag/Invoices/paths/~1nfs~1{id}~1numbering/delete), [Create copy for reissue](#tag/Invoices/paths/~1nfs~1{id}~1reissue_copy/post) and [Download NFS-e XML](#tag/Invoices/paths/~1nfs~1{id}~1xml/get). The issue date is changed through the edit. - New permissions in Invoices, the Monde ones: **Edit** (writing, manual issuance, amount adjustment, numbering and canceling only in Monde), **Delete**, **Issue NFS-e** (issuing and canceling through e-Notas) and **Create copy for reissue**. Through the automatic connection, they are an exception granted by Monde on approval, shown highlighted on the consent screen: an invoice applies to the whole agency. Downloading the XML requires only the read permission. On an operator (consolidator) installation, where invoices do not exist, writing answers 403. - Get invoice by ID now brings the `id` of each item, used to keep the item on edit. - On edit of an invoice linked to a registered person, `recipient` only applies with `person_id` sent as `null`, the explicit choice of a typed recipient, as in Monde; without it, it is ignored, and resending the body that was read does not unlink the person. - An invoice created, copied or canceled through the API does not record the credential person in `created_by` or `canceled_by`: it was written by the credential, recorded in the log. ### Generate Invoices - New [Generate Invoices](#tag/Generate-Invoices) resource, the same as the Gerar Notas Fiscais screen of Monde: [List invoices to generate](#tag/Generate-Invoices/paths/~1nf_generations/get) shows, for each product of a closed sale, the invoices the invoice (NF) rules build, and [Generate invoices](#tag/Generate-Invoices/paths/~1nf_generations/post) saves the chosen ones, all or none. The request accepts only the products the list would show. - The credential got the **Gerar Notas Fiscais** permission (`nf_generations.access`), the same as in Monde, which lists and generates. As in Monde, it reaches the sales the credential itself created; the sales of the other sellers also require **Consultar vendas de outros vendedores/intermediários** in Sales. - In the [Automatic connection](#tag/Automatic-connection), **Gerar Notas Fiscais** is an exception: the partner only receives it with the reason given in the approval, highlighted in the consent. ### Invoice (NF) Rules - New endpoints [Create invoice (NF) rule](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules/post), [Update invoice (NF) rule](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules~1{id}/patch) and [Delete invoice (NF) rule](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules~1{id}/delete), with the rules of the Monde registration. The body follows the reading format: `product`, `payer`, `supplier` and `representative` as `{ "id": ... }`, `representative_scope`, and the invoice of each recipient in `payer_rule`, `supplier_rule` and `representative_rule`, with `recipient`, `revenues` and `discounts`. The update changes only what was sent, and a list sent is the final list. The same application has only one rule and the same value goes into the invoice of only one recipient (422). An operator installation, which has no rule registration, answers 403 to writes. - Sending back on update what the query returned does not answer 422: a value the rule already has and the recipient cannot take, saved outside the screen, is accepted and leaves the rule, as on the screen. - A rule written through the API has no author (`created_by` null); the rule log tells which credential wrote it. - Sending a product or a person in the rule requires the "View" permission of Products or of People; without it, the response is the one for an id that does not exist. What the rule already uses can be sent back without that permission. - New **Edit** and **Delete** permissions in Invoice (NF) Rules, offered in the API credential. In the [Automatic connection](#tag/Automatic-connection), both are an exception (extended access): the rule applies to the whole agency. - Fields that are lists of plain values, such as `revenues` and `discounts`, refuse with 422 a list sent as text or object and an item that is a list or an object, like the other fields. - **Contract change:** in [List invoice (NF) rules](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules/get) and [Get invoice (NF) rule by ID](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules~1{id}/get), `representative_scope` now comes as the Monde screen opens the rule: a rule saved without the representative mark and without a representative, which reaches no sale, comes as `none` (before, `any`), and one with the chosen representative comes as `specific` even without the mark (before, it could come as `none`). ### Billing Rules - Billing rules can now be written through the API: [Create billing rule](#tag/Billing-Rules/paths/~1invoice_rules/post), [Update billing rule](#tag/Billing-Rules/paths/~1invoice_rules~1{id}/patch) and [Delete billing rule](#tag/Billing-Rules/paths/~1invoice_rules~1{id}/delete). The rule carries the kind and the owner person (`person_kind` and `person_id`), and saving follows the same rules as the Monde screen. As in Monde, creating, updating and removing the rule of a person who has other rules require the Billing Rules **Edit** permission; deleting the last rule of a person, which also removes the rule set of that person, requires **Delete**. In the [Automatic connection](#tag/Automatic-connection), writing and deleting billing rules is an exception granted by Monde on approval, because they apply to the whole agency. ### Financial registries - [Categories](#tag/Categories): new endpoints to create, update and delete categories. A category only moves to another group of the same kind, and one used in entries or in a Monde setting cannot be deleted (409). - New resource [Category Groups](#tag/Category-Groups), with list, creation, update and deletion. The group kind (`expense` or `revenue`) does not change after creation, and a group with categories cannot be deleted (409). Uses the Categories permissions. - [Cost Centers](#tag/Cost-Centers): new endpoints to create, update and delete. A cost center used in the apportionment of an entry cannot be deleted (409). - [Payment Methods](#tag/Payment-Methods): new endpoints to create, update and delete an agency payment method. A system payment method cannot be changed or deleted (409), and an internal one responds 404. - New resource [Payment Method Details](#tag/Payment-Method-Details): the pre-registered texts the sale payment copies, with list, creation, update and deletion, and Monde's own permissions: **Edit**, which also allows reading, and **Delete**. - New **Edit** and **Delete** permissions in Categories, Cost Centers, Payment Methods and Payment Method Details, offered in the API credential. In the [Automatic connection](#tag/Automatic-connection), writing and deleting these registers is an exception, because they apply to the whole agency. Every write requires `Idempotency-Key`, and a field the endpoint does not document is ignored, as in the rest of the API. ### Commission Closing - New resource [Commission Closing](#tag/Commission-Closing), with the calculation and rules of the Monde screens Close Commissions and Pay Commissions: [Calculate commissions](#tag/Commission-Closing/paths/~1commissions/get), [Close commissions](#tag/Commission-Closing/paths/~1commission_closings/post) (with the commission seen per person: if it changed, the closing is refused), list and delete closed commissions, [Pay commissions](#tag/Commission-Closing/paths/~1commission_payments/post) and delete the payment. - New credential permissions, the Monde ones: **Close Commissions** (with Close commissions of Sellers, of Intermediaries and of Other Roles) and **Pay Commissions** (with Delete). Paying also needs the Edit of Bills, and deleting the payment, the Delete of Bills. - In the [Automatic connection](#tag/Automatic-connection), the Close Commissions and Pay Commissions permissions are exceptions: they reach the commissions of every seller of the agency and are only granted with the reason. ### CVC Statement - The CVC statement now accepts writes, in CVC agencies: [Create a receipt](#tag/CVC-Statement/paths/~1cvc_statements/post) (`POST /cvc_statements`), [Update a receipt](#tag/CVC-Statement/paths/~1cvc_statements~1{id}/patch) (`PATCH`, an omitted field stays), [Delete a receipt](#tag/CVC-Statement/paths/~1cvc_statements~1{id}/delete) (logical deletion) and [Restore a receipt](#tag/CVC-Statement/paths/~1cvc_statements~1{id}~1restoration/post). The receipt actions became sub-resources: [link](#tag/CVC-Statement/paths/~1cvc_statements~1{id}~1sale_link/post) and [unlink](#tag/CVC-Statement/paths/~1cvc_statements~1{id}~1sale_link/delete) the sale by the receipt number, [process the OPFAX settlement](#tag/CVC-Statement/paths/~1cvc_statements~1{id}~1opfax_processing/post) and [close the sale](#tag/CVC-Statement/paths/~1cvc_statements~1{id}~1sale_closing/post). The permissions are Monde's: creating a receipt, linking the sale, processing OPFAX and closing the sale only require reading the CVC statement (the last two also the one to close sales); updating requires the new Edit records or Edit imported records, and deleting, restoring and unlinking the sale require Delete, Restore and Unlink Sale from Receipt, the company with the CVC store features turned on, and does not exist in an operator database. - In [Get CVC statement receipt by ID](#tag/CVC-Statement/paths/~1cvc_statements~1{id}/get), the movement kind (`movement_kind`) now also returns the CVC code (`code`), which is what the creation gives in `movement_kind_code`. - In the [Automatic connection](#tag/Automatic-connection), the **CVC Statement** permissions, reading included, since it creates receipts and links sales, are an exception granted by Monde on approval, and the "Read only" template leaves reading out: the receipt has no author (it comes from the import or is entered in Monde), and whoever writes it reaches the ones the agency registered. ### CVC Master Statement - New [CVC Master Statement](#tag/CVC-Master-Statement) resource, with the "Master Franchise Transfer" receipts: [list](#tag/CVC-Master-Statement/paths/~1cvc_master_statements/get), [get by ID](#tag/CVC-Master-Statement/paths/~1cvc_master_statements~1{id}/get), [create](#tag/CVC-Master-Statement/paths/~1cvc_master_statements/post), [update](#tag/CVC-Master-Statement/paths/~1cvc_master_statements~1{id}/patch), [delete](#tag/CVC-Master-Statement/paths/~1cvc_master_statements~1{id}/delete) and [generate the invoice](#tag/CVC-Master-Statement/paths/~1cvc_master_statements~1{id}~1nf/post) of a receipt, with the rules of Monde's Master Statement. It applies only to the company enabled as a master franchise agency, in Settings › CVC. - Permissions, as in Monde: reading and deleting require **View** and **Delete** of **CVC Master Statement**, new in the credential; creating and updating also require **Edit records** of **CVC Statement** (an imported receipt, **Edit imported records**), and generating the invoice, **Edit** of **Invoices**, the three new in the credential. - In the [Automatic connection](#tag/Automatic-connection), the whole **CVC Master Statement**, including reading it, **Edit records** and **Edit imported records** of **CVC Statement** and **Edit** of **Invoices** are exceptions (extended access): these records apply to the whole agency. ### CVC Statement Closing - New [CVC Statement Closing](#tag/CVC-Statement-Closing) resource, with the rules of Monde's Fechamento de Extrato, for one company (`company_identifier`) and one period at a time: [Get the closing summary](#tag/CVC-Statement-Closing/paths/~1cvc_statement_closings~1summary/get), [List the closing movements](#tag/CVC-Statement-Closing/paths/~1cvc_statement_closings~1movements/get), each one with `valid`, [Mark a movement as checked](#tag/CVC-Statement-Closing/paths/~1cvc_statement_closings~1movements~1{id}/patch) and [Close the statement](#tag/CVC-Statement-Closing/paths/~1cvc_statement_closings/post), which creates the vendor invoices and returns their `id`. To reopen, delete the generated invoice with [Delete account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/delete). - The same closing for master franchise transfers in [Master - CVC Statement Closing](#tag/Master-CVC-Statement-Closing), at `/cvc_master_statement_closings`. - New permissions **CVC Statement Closing** and **Master - CVC Statement Closing**, one per screen, as in Monde: the same permission reads, marks as checked and closes. Closing requires `expected_total`, the reviewed total amount, and is refused with `422` when the invoiced amount differs. The company must have the CVC store features enabled (or the master franchise agency, for Master); without them, the response is `403` telling what to enable. ### CVC Deposit Check - New read-only CVC Deposit Check resource, like Monde's Conferência Depósito screen: `GET /cvc_deposit_checks` and `GET /cvc_deposit_checks/{id}`, with each statement movement's deposit next to what was invoiced, retained and received from the client and the balance. Filters `period_start`, `period_end` and `only_closed_sales` (default `true`, as in Monde). Requires the new **CVC Deposit Check** permission. - In the [Automatic connection](#tag/Automatic-connection), the **CVC Statement Closing**, **Master - CVC Statement Closing** and **CVC Deposit Check** permissions are extended access, reading included: they reach the whole agency statement, and Monde only grants them to a partner with the reason. ### CVC Statement Import - New resource [CVC Statement Import](#tag/CVC-Statement-Import), with [Import CVC statements](#tag/CVC-Statement-Import/paths/~1cvc_imports/post), [Get CVC import status](#tag/CVC-Statement-Import/paths/~1cvc_imports~1status/get), [List CVC imports](#tag/CVC-Statement-Import/paths/~1cvc_imports/get), [Get CVC import by ID](#tag/CVC-Statement-Import/paths/~1cvc_imports~1{id}/get) and [Turn the CVC automatic import on or off](#tag/CVC-Statement-Import/paths/~1cvc_imports~1automation/patch). The import fetches the files from the CVC FTP, like the Import button of the screen, and is asynchronous: it answers `202`, and the status tells when it finished. Requires the new **Importação de Extratos** (statement import) permission, as in Monde, where the same permission opens the screen and imports: it covers reading, importing and turning the automatic import on or off. - Through the [Automatic connection](#tag/Automatic-connection), **Importação de Extratos** is an exception granted by Monde on approval, highlighted on the consent: the import writes the sales and registers of the company that come from CVC, of any origin. ### Webhooks - New [Webhooks](#tag/Webhooks) resource: register an https address and receive a signed `POST` (HMAC-SHA256) when records change: one notice per event, with up to 100 ids and the company of each. Endpoints to list, create, get, update (PATCH) and delete webhooks, the delivery history (`GET /webhooks/{webhook_id}/deliveries`) and the event catalog (`GET /webhook_events`): `changed` (created or updated) and `deleted` for each resource plus the sale and invoice business events. Delivery with retries and increasing waits, and deactivation after consecutive failures. - New **Webhooks** permission (read, create and edit, delete) on the API credential. - The **Webhooks** permission is not offered through the [Automatic connection](#tag/Automatic-connection): only a credential created by the agency itself can receive it. ### Integrations - [Integrations](#tag/Integrations) can now be written through the API: [Create integration](#tag/Integrations/paths/~1integrations/post), [Update integration](#tag/Integrations/paths/~1integrations~1{id}/patch) and [Delete integration](#tag/Integrations/paths/~1integrations~1{id}/delete), with the rules of the Integrations screen. Each vendor's additional fields go in `additional_fields`, and the [query by ID](#tag/Integrations/paths/~1integrations~1{id}/get) now brings them, with a value only in the service address and the agency's identification; user, password, token, API keys and PIN are never returned (`filled` says whether they are filled). The query now also brings the `vendor_id`. - New [List integration vendors](#tag/Integrations/paths/~1integration_vendors/get), with the vendor catalog and the fields each one asks for. - New product and person links of the integration, in `/integrations/{integration_id}/product_links` and `/integrations/{integration_id}/person_links`, with query, creation, update and deletion. Since the link applies to every integration of the vendor, writing and deleting require the permission to create and edit integrations in each of them. - New **Edit** and **Delete** permissions in Integrations, offered in the API credential. ### Integration Credentials - New [Integration Credentials](#tag/Integration-Credentials) resource, with each user's login and password at the vendor of the integrations that authenticate per user: query, creation, update and deletion. The password is never returned (`password_filled` says whether it is filled). Reading requires the new **Ver Aba Usuário** (User tab) permission in People, like the User tab of the person record in Monde; creating, updating and deleting also require **Edit** in People. - The **Edit** and **Delete** permissions in Integrations and **Ver Aba Usuário** (User tab) in People are not offered through the [Automatic connection](#tag/Automatic-connection): only a credential created by the agency itself can receive them. ## 2026-10-26 ### Partner integrations - New endpoints [List partner integrations](#tag/Partner-integrations/paths/~1supplier_authorizations/get), [Get partner integration by ID](#tag/Partner-integrations/paths/~1supplier_authorizations~1{id}/get), [Rename partner integration](#tag/Partner-integrations/paths/~1supplier_authorizations~1{id}/patch) and [Delete partner integration](#tag/Partner-integrations/paths/~1supplier_authorizations~1{id}/delete), for the authorizations given to partners through the [Automatic connection](#tag/Automatic-connection), like the Integrations screen in Monde. Deleting cuts the partner's access immediately, and the integration stays in the query with `active` equal to `false`. There is no creation through the API. - [Get partner integration by ID](#tag/Partner-integrations/paths/~1supplier_authorizations~1{id}/get) and [Rename partner integration](#tag/Partner-integrations/paths/~1supplier_authorizations~1{id}/patch) return `delivery`, the delivery of the access to the partner on a connection started by the agency: pending, delivered or expired, as the Integrations screen shows. - New permission **Partner integrations** (read, rename and delete), offered on the API credential. The credential of an automatic connection does not access the resource, and a partner cannot be granted it. ### Automatic connection - New way to connect: the agency starts the connection on the Monde Integrations screen, and the partner receives each new connection, already with its token, by polling `POST /oauth/connections` with the `client_id` and the `client_secret`. The response carries the connections in `data` and the API `pagination` node. Each connection is delivered only once and waits for the poll for 72 hours; after that, the integration is deleted in the agency account. The partner is only listed for the agency after checking **Connection started by the agency** in the partner area. See step 7 of [Automatic connection](#tag/Automatic-connection). ### Settings - New Settings resource, with the tabs of the Monde Settings screen per company: read and update at `/settings/{tab}` for General, Sales, Receivement, Payables and receivables, Commission, Goals, Customer invoice, Supplier invoice, Fiscal notes and Travel card export. An update writes only the fields sent, with the screen rules, and goes to the company log. Each tab requires the Monde permission for it (such as **Configurações - Geral**), which allows reading and updating the tab. - New endpoint `/settings/email`, to read and update the server and the sender of the company e-mails, with the Monde permission **Configurações - E-mail (Geral)**. The server password can only be set. - New endpoint `/settings/company`, to read and update the company registration (name, legal name, registrations, contacts and address; the CNPJ does not change), and `/settings/licenses`, to read the licenses of the companies. They require the new **Company registration and licenses** permission. - New endpoint `/settings/enotas`, to read and update the company NFS-e issuance through e-Notas (regime, rates, series and RPS, test environment and city hall access), and `/settings/enotas/certificate`, to send the digital certificate as multipart. Username, password, token and certificate can only be set: reading tells only whether they are configured and the certificate expiration. Requires the permission of the Fiscal notes tab, the NF configuration of Monde. - The permissions of the **Settings** tabs and the **Company registration and licenses** one are not offered through the [Automatic connection](#tag/Automatic-connection): only a credential created by the agency itself can receive them. ## 2026-10-24 ### Cities: search by the other names - The `name` filter of [List cities](#tag/Cities/paths/~1cities/get) now also finds the city by its other names in Monde's city list: `?name=New York` and `?name=Nova York` find Nova Iorque, `?name=Asunción` finds Assunção. It also finds by the start of the words, by the state and by the country, like Monde's City field. A part anywhere in the name still matches. - **Contract change:** with the `name` filter, the list is no longer in alphabetical order: the city whose name is the one sent comes first, then the one that has it among its other names, the one whose name starts with it, the one that contains it and, last, the others; within each group, the largest first. Without the filter, the order is still by name. The `cursor` of a search is only valid for the same `name`. ## 2026-10-23 ### Error messages: position of the list item - In [Create sale](#tag/Sales/paths/~1sales/post), [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), [Create person](#tag/People/paths/~1people/post), [Update person](#tag/People/paths/~1people~1{id}/patch), [Create task](#tag/Tasks/paths/~1tasks/post) and [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch), an error on a list item now carries the item position in the list sent, counted from 0, at every level. Before, `'insurances passengers person name'` did not say which insurance or which passenger; now it comes as `'insurances[0] passengers[2] person name'`. It applies to the sale products, `passengers`, `segments`, `seats`, `payments` and their `products`, `commissions`, `contacts`, `history` and `custom_fields`. Two items with the same error now get one message each. **Note:** integrations that compare the message text need to account for the position. - A format error on a list item field, in every route, also carries the position now: `The 'movements[0] check' field must be a list or an object…`. An item that is not an object is now pointed at by its position: `The 'labels[1]' field must be an object…`. - A general error of an item that is a full sentence comes with the item path before it: `'credit_cards[1]': `, instead of being appended to the field name. It applies to the person's `credit_cards`, `cost_centers` and `kandir_law`. - Commissions: a sale that does not end up closed answers once, on the list (`'commissions'`), instead of one message per commission. An intermediary commission on a sale without an intermediary now answers on `'commissions[0]'`, with a message that reads as a continuation of the field name. - A null or blank item inside a list (`"contacts": [null]` or `[""]`) now answers `422`. Before, it was ignored, and the items after it shifted position. A whole list sent as `null` keeps working as before. ### Cities: no permission required - [List cities](#tag/Cities/paths/~1cities/get) and [Get city by ID](#tag/Cities/paths/~1cities~1{id}/get) no longer require the Cities permission: every credential can read them. Cities come from Monde's city list and no longer have a permission in Monde. - The Cities permissions (read and read the history) are no longer offered in the credential. One already saved is still accepted and has no effect. The history of the cities in [List logs](#tag/Logs/paths/~1logs/get) is only visible to the credential that reads the whole history. ### People: the city is no longer created - In [Create a person](#tag/People/paths/~1people/post), [Update a person](#tag/People/paths/~1people~1{id}/patch) and in the people sent with the sale ([Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch)), the city of the address and of the birthplace (`birthplace`) is no longer created. Without `city_ibge`, `city_name` is looked up among the agency's cities and the ones in Monde's city list ([List cities](#tag/Cities/paths/~1cities/get)), ignoring accents and case: in Brazil, in the state of `state_code`; abroad, in the country of `country_code`. - A city abroad sent with `state_code` is first looked up as "Name, ST", the form in which the API used to register these cities, and then by name alone in the country. - A name that matches no city responds `422` on `city_name`, and nothing is saved. Before, the city was created with the name sent. ### Sales: agency card fee - In [Create sale](#tag/Sales/paths/~1sales/post) and [Update sale](#tag/Sales/paths/~1sales~1{id}/patch), the agency credit card payment (`agency.credit_card`) now records the card fee, as in Monde. Without a fee in the payload, the "Taxa cartão de crédito" Sales setting applies. To send another one, use `card_rate_percentage` (%) or `card_rate` (amount), one of the two. The fee is split into the `agency_card_rate` of the paid products and reduces the bill final amount in the company card fee category. Without that category set, a fee above zero answers `422`. **Note:** integrations that already send this payment now get the company default fee when it is set; to keep the bill with no fee, send `card_rate_percentage` equal to `0`. - In the sale update, a payment that is removed takes its fee with it: the `agency_card_rate` of the products is recalculated from the payments that stay. ### Sales - New endpoint [Cancel a sale product](#tag/Sales/paths/~1sales~1{sale_id}~1products~1{product_id}~1cancellation/post), with the cancellation rules of Monde: cancels the whole product or some of its passengers, with the options to delete the pending customer balance, delete the open supplier balance with a fine and keep the product in the commission plan goals. The cancellation is always made through the `passengers` list, with the person (`person.id`) and the cancellation date of each passenger; the product is canceled when the list cancels the ones still missing. A product without passengers is canceled without the list, on the current date. The canceled product still adds to the sale total. Requires, in the company of the sale, the permission to edit sales and the "Cancel product" permission, new in the credential, as in Monde; existing credentials start without it. - New endpoint [Reactivate a sale product](#tag/Sales/paths/~1sales~1{sale_id}~1products~1{product_id}~1reactivation/post), which undoes the cancellation of the whole product or only some of its passengers, as the uncancellation in Monde does, through the `passengers` list with the person of each passenger that comes back. Reactivating every canceled passenger brings back to the financial records what the cancellation had deleted; reactivating only some, the fine and the deleted balance stay. With the automatic supplier invoice, it answers 409 while the cancellation fine is still being posted to the invoice: repeat in a few seconds. Requires the same permissions as the cancellation. - In [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch), an empty (or null) passenger list on a product whose passengers are not required and that has a canceled passenger now answers 422: it would remove every active passenger and leave the product active with only canceled passengers. Send at least one active passenger, or cancel the passengers through the product cancellation. - In the agency, the amount to invoice to the product supplier, in [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) now follows the same calculation as Monde, which is also the one of the uncancellation: the products, the fees and the DU and RAV card fees, minus the commission, the over and the deductions. Before, the over, the deductions and the DU card fee were left out. Sales already created through the API do not change on their own: on an update, only the difference of what changed goes to the invoice, and a supplier change recalculates the whole amount. - [List sales](#tag/Sales/paths/~1sales/get) gains the `kind` filter, by product kind: a sale is returned when it has a non-deleted product of one of the given kinds. - The airline ticket (`airline_tickets`) now accepts `observations` on create and update, and now rejects the `cruise` destination with 422: as in Monde, it is `national` or `international`. An airline ticket the API recorded earlier with `cruise` still comes that way when read, and can only be updated with the destination changed to `national` or `international`: `cruise` is rejected also when the destination is omitted. - **Value change:** in agencies, [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) now keeps the deductions a product already had in Monde out of the customer total, the total amount, the billing and the commission base, as Monde does. Before, the update through the API recalculated the product as if it had no deduction, and the total went up. - **Value change:** [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) now withhold the Lei Kandir taxes (IR, CSLL, PIS and COFINS) and, on airline tickets, the ISS when the payer has a withholding registered for the product, as Monde does: the withheld amount comes out of the product total amount and becomes an entry to receive from the supplier. Example: a R$ 1,000.00 insurance for a payer with 4.65% withholding now has a total amount of R$ 953.50 and R$ 46.50 to receive from the supplier; before, it had R$ 1,000.00 and no entry. Changing the payer recalculates the withholding of every product of the sale, and updating a product that already had a withholding no longer adds the withheld amount back to the total. - On tour operators (consolidators), [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) now store the sale promoter (`promoter`) as Monde does: it is the promoter registered on the intermediary, copied when the sale is created and whenever the intermediary changes. The promoter is not sent in the payload. - New `reservation_due_date` field (reservation due date) on the sale products, tour operators only: stored by [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) and returned by the get. On a travel agency, it is rejected with 422 and returns null. - On tour operators, the own operation (`operation` and `operation_id`) is now rejected with 422, as in Monde, where it is exclusive to travel agencies. - On tour operators, the approver (`approver`) sent with a value to [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) is now rejected with 422, as in Monde, where a tour operator sale has no approver. Sent as `null` on the update, it is removed from the sale. - [Create sale](#tag/Vendas/paths/~1sales/post) and [Update sale](#tag/Vendas/paths/~1sales~1{id}/patch) now accept three agency payment methods without a bill: `agency.credit` (agency credit), `agency.to_invoice` (to invoice, with due date, cost center and description, which enters the customer invoice through automatic invoicing) and `agency.retained_by_intermediary` (retained by the intermediary, agency only and on a sale with an intermediary). Agency credit and retained by the intermediary respond 422 on an operator installation. Without `payer`, the to-invoice payment falls to the sale payer, on an operator installation too, as in Monde. - With Monde's credit control on, agency credit and supplier credit (`vendor.credit`) now check the payer's balance, adding up the credit payments of the request, and consume it when the sale is saved; without enough balance, the response is 422 with the available balance. When the update takes them out of the sale, the used credit goes back to the payer. As in Monde, a supplier credit payment uses the balance of a single supplier and representative for its whole amount: those of the first product of the payment, in alphabetical order of the representative and then of the supplier, even when the payment also pays products of another supplier. - The sale update now removes the agency credit left out of `payments`, giving the used credit back. Before, it could only be removed in Monde. - **Contract change:** in the sale get, the to-invoice payment comes in the new `payments.agency.to_invoice` list, with an `id` of its own, and the invoices in `bills`. The customer invoice of the to-invoice payment no longer shows in `payments.agency.bills`, and its `id` no longer keeps the payment in the update: use the to-invoice `id`. A to-invoice payment not invoiced yet now shows up. - In the sale get, each product of the to-invoice and retained-by-intermediary payments (`products[]`) gets the `id` of the item recorded for it. The update keeps the line by its `id` or by the `id` of any of those items: when an identical payment included later joins the same line and changes its `id`, the `id` stored before still works. - **Contract change:** the retained-by-intermediary payment (`payments.agency.retained_by_intermediary`) gets an `id`, and both are now kept or removed by the update `payments` list: an update that sends `payments` without their `id` removes them, which it did not do before. A to-invoice payment in a closed or settled customer invoice is not removed. - When an item of a to-invoice payment enters the customer invoice, it takes the invoice due date, and the part that entered may become another line, with another `id`, as in Monde. As in Monde, which only removes that part when the user deletes that line, the update does not remove it for being left out of `payments` while the list keeps another line of the same to-invoice payment (same payer, cost center and description); it is removed when no line of the payment stays in the list. To keep the whole payment after the split, send the `id` of each of its lines (or of each item in `products`). - **Contract change:** as in Monde, the sale payer cannot change while a to-invoice or retained-by-intermediary payment stays in the sale: the update that changes `payer` without taking them out of `payments` answers 422. Before, the payer changed and the items stayed in the name of the former payer. - The sale observations (`observations`) are now accepted on create and update, also on a closed sale, as in Monde. The change goes to the sale log. ### Refunds - New endpoint [Record a refund on the sale](#tag/Refunds/paths/~1sales~1{id}~1refunds/post), for the refund of a sale product to the customer (`customer`) or with the vendor (`vendor`), with the rules of the Customer Refund and Vendor Refund actions in Monde: the refund goes to the invoice by the billing rules (`invoice`) or generates right away a separate invoice with it alone (`bill`), and goes into the product refund and the sale revenue. The customer refund exists only for agencies: on an operator base, it answers `403`. As in Monde, recording a refund is editing the sale: requires the **Edit** permission on Sales (on a sale the credential did not create, also **Edit sales of other sellers**; on a sale with a printed receipt, also **Change sales with a printed receipt**, for both the customer and the vendor refund) and the `Idempotency-Key`. - New endpoint [Delete refund](#tag/Refunds/paths/~1refunds~1{id}/delete), which takes the refund out of the sale and of the invoice it is on. A settled or closed invoice answers `409`, and so does a customer refund on a closed sale. A vendor refund that has already become an account payable/receivable (the account generated for it alone or, with the automatic vendor invoice off, any invoice) is deleted only with `remove_from_bill` as `true`, like the confirmation Monde asks for when deleting the account: without it, it answers `409`; with it, the whole account is deleted, as in Monde: the refund leaves, and the other items of the account go back to pending, without an invoice. Requires the same permissions as recording (including **Change sales with a printed receipt** on a sale with a printed receipt), plus **View financial tab** on a vendor refund, and the `Idempotency-Key`. Deleting the whole account with `remove_from_bill` also requires **Edit** and **Delete** on Accounts Payable and Receivable over it (and, on another user's account, the access to the entries of other users), like deleting the entry in Monde; without them, `403`. ### Travels - New endpoints [Create travel](#tag/Travels/paths/~1travels/post), [Update travel](#tag/Travels/paths/~1travels~1{id}/patch) and [Delete travel](#tag/Travels/paths/~1travels~1{id}/delete), with the Monde rules: description (up to 60 characters), customer and active seller required, number generated on save and a company that does not change after the travel is created. On update, description, customer, seller and company sent as null or empty answer 422, as in tasks, and the current seller sent back is accepted even if inactive. They require the **Edit** and **Delete** permissions of Travels, the same as in Monde, new in the API credential and in the automatic connection. The travel the credential created, or with a sale it created, is its own. For a travel of another seller or of another credential, updating and deleting also require **Consult sales of other sellers**, as the query does; outside that reach, the travel answers 404. A travel with attachments is not deleted (409), as in Monde. - New endpoints [Link sale to travel](#tag/Travels/paths/~1travels~1{id}~1sales~1{sale_id}/post) and [Unlink sale from travel](#tag/Travels/paths/~1travels~1{id}~1sales~1{sale_id}/delete), with the **Edit** permission of Travels. As in Monde, the credential must be able to open the sale: one it created or, for a sale of another seller, with **Open sales of other sellers**; a sale outside that reach, or of another company, answers 404. The linked sale cannot be deleted and must have an active product; one in another travel is moved, without checking the access to the origin travel, as in Monde. In a company set to accept only sales registered within a travel, the API does not unlink a sale nor delete a travel with sales (409): in Monde, only the administrator does that. - [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get) now brings the custom fields in `custom_fields`. ### Bank Reconciliation - New [Bank Reconciliation](#tag/Bank-Reconciliation) resource, with the rules of the Bank Reconciliation screen of Monde Web: upload the OFX statement of a checking account (`POST /bank_reconciliations`, as `multipart/form-data`), read and discard the uploaded statements, run the automatic matching again, read the reconciliation lines with the situation of each one, read the candidates of a line, link the line (`PATCH`, with the final list of account movements and the open bills to settle on the line date), reject a suggestion and verify or undo the verification of each account movement. - New **Bank Reconciliation** permission on the API credential, the same as in Monde: it allows reading, uploading and discarding statements and linking the lines, in a company of the checking account. Verifying an account movement, including in a link that is saved already verified, also requires **Edit entry**, as in Monde. - Settling an open bill through a link follows [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post): it accepts the same bills (the sale payment included), refuses the others, such as the commission, with the same message and requires the same permissions, **Edit entry** and **Settle account payable** or **Settle account receivable**. - Through the automatic connection, the reconciliation is an exception granted by Monde at approval, shown highlighted on the consent screen: it reaches the statement and the account movements of the whole account, from any origin. ### Accounts Payable and Receivable: entries in another currency - [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) now settles an entry in another currency, as Monde does. The movement `amount` is in the currency of the entry; in an account in another currency, it goes in converted by the latest exchange rate, and without a registered rate the movement answers `422`. Before, an entry outside BRL answered `422`. Through a bank reconciliation link, an open bill in the currency of the checking account is settled as well. - A movement saved in an account outside BRL (on settlement, on creation already settled, on an account change in the update and on a bank reconciliation link) keeps the reference exchange rate, which converts the account currency into BRL, by the latest rate of the account currency, as Monde does. Before, it kept 1. **The saved value changes**: in a dollar account with a rate of 5.25, the movement now keeps the reference exchange rate 5.25 instead of 1. An account in BRL, or a currency without a registered rate, still keeps 1. - As in Monde, the suggested rate can be corrected by the one used at the bank. In [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post), each movement accepts `exchange_rate`, which converts the entry currency into the account currency (only in an account in another currency; with it, a missing registered rate no longer answers `422`), and `reference_exchange_rate`, the reference exchange rate of an account outside BRL. In a [bank reconciliation](#tag/Bank-Reconciliation) link, each open bill in `open_bills` accepts `reference_exchange_rate` in a checking account outside BRL. Both are optional, greater than zero and saved with 6 decimal places; when omitted, the latest rates apply, and when sent where they do not apply they are ignored. ### Statement and Cash - New endpoint [Get account balance](#tag/Statement-and-Cash/paths/~1accounts~1{account_id}~1balance/get): the balance of a checking or cash account at the end of a date, the same the statement closes the day with. - New endpoint [Get account statement](#tag/Statement-and-Cash/paths/~1accounts~1{account_id}~1statement/get): the statement of up to 45 days, line by line as in Monde, with the previous balance, the movements and the balance of each day telling whether the cash is closed. - New endpoints [Close cash](#tag/Statement-and-Cash/paths/~1accounts~1{account_id}~1cash_closures/post) and [Reopen cash](#tag/Statement-and-Cash/paths/~1accounts~1{account_id}~1cash_closures~1{date}/delete), with the Monde rules. - New permission resource **Saldo e Extrato** (balance and statement), with the Monde permission **Extrato de Conta**. Closing and reopening the cash ask for the Monde permissions **Fechar Caixa** (close the cash) and **Reabrir Caixa** (reopen the cash), in **Contas e Cartões** (accounts and cards). Through the automatic connection, reading the balance and the statement and closing and reopening the cash is an exception granted by Monde on approval, highlighted on the consent screen: the statement brings every movement of the account and the closing applies to the whole account, including what the agency recorded. ### Transfers between Accounts - New endpoints to [list](#tag/Transfers-between-Accounts/paths/~1transfers/get), [get](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}/get), [create](#tag/Transfers-between-Accounts/paths/~1transfers/post), [update](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}/patch) and [delete](#tag/Transfers-between-Accounts/paths/~1transfers~1{id}/delete) transfers between accounts, with the rules of the Monde Transfer screen. - New permission resource **Transferências entre Contas** (transfers between accounts), with the Monde permissions: **Transferência entre Contas** (read), **Editar** (create and update), **Excluir** (delete) and **Visualizar Log** (view log). The log of the transfers in [Logs](#tag/Logs) (origin `conta_movimento`) now asks for **Visualizar Log** of Transfers between Accounts, as in Monde, instead of reading the Account movements. Through the automatic connection, reading, editing, deleting and viewing the log of transfers is an exception granted by Monde on approval, highlighted on the consent screen: a transfer does not record who created it, so whoever reads or writes transfers also reaches the ones the agency recorded. ### Quotes - New endpoints [Create quote](#tag/Quotes/paths/~1quotes/post), [Update quote](#tag/Quotes/paths/~1quotes~1{id}/patch), [Delete quote](#tag/Quotes/paths/~1quotes~1{id}/delete) and [Duplicate quote](#tag/Quotes/paths/~1quotes~1{id}~1duplication/post), with the rules of the Quotes screen of Monde Web. They require the new quote permissions of the credential: **Create and edit** (create, update and duplicate) and **Delete**. - New endpoint [Get quote settings](#tag/Quotes/paths/~1settings~1quotes/get), per company (`company_identifier`): color, social networks, general conditions, content template and logo. [Update quote settings](#tag/Quotes/paths/~1settings~1quotes/patch) always answers `409`, writing nothing: as in Monde, only the administrator changes the settings, on the Monde Web screen. - The quotes read now brings `updated_at`, and the read by ID also the quote owner in `user`. - Sending the person (`person_id`) when creating, updating or duplicating a quote requires the **Read all people** permission. Without it, the person is refused (`422`) with the same message as a person that does not exist. - Sending the travel customer (`customer_id`) when creating or updating a travel, and the person of a customer refund (`person_id`), also requires **Read all people**, with the same refusal. ### Guides - New endpoint [Duplicate guide](#tag/Guides/paths/~1guides~1{id}~1duplication/post), with the create and edit guides permission. - New endpoint [Get guide settings](#tag/Guides/paths/~1settings~1guides/get), per company (`company_identifier`): the footer of the public page of the guides. [Update guide settings](#tag/Guides/paths/~1settings~1guides/patch) always answers `409`, writing nothing: as in Monde, only the administrator changes the settings, on the Monde Web screen. - [Update guide](#tag/Guides/paths/~1guides~1{id}/patch) that moves the guide to another company (`company_identifier`) without sending the owner (`user_id`) now answers `422` when the current owner has no access to the target company, asking for an owner that has. Before, the guide moved and kept an owner that cannot reach it. When the current owner has access to both companies, nothing changes. ### Accounts and Cards - [Accounts and Cards](#tag/Accounts-and-Cards) now accepts writes, with [Create account or card](#tag/Accounts-and-Cards/paths/~1accounts/post), [Update account or card](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/patch) and [Delete account or card](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/delete): cash account, checking account and credit card, with the companies where the account is available (`companies`), the user groups with access (`user_groups`) and the billing setup of the checking account (`billing_accounts`, Monde Bancos and CobreBem). They require the new **Edit** and **Delete** permissions of Accounts and Cards, as in Monde. - A field that does not belong to the account kind (such as `agency` or `initial_balance` on a card, or `billing_accounts` outside a checking account) is ignored, like a field that does not exist: it is not saved and does not answer `422`. - In [Update account or card](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/patch), changing the initial balance (`initial_balance`) reopens the closed cash of the account and also requires the new **Reopen Cash** permission of Accounts and Cards, as in Monde; without it, the response is 403 with the Monde message. Sending back the saved balance does not require the permission. - On CobreBem billing, `registered` is saved as the screen allows; on Monde Bancos, it comes from the chosen portfolio, and the value sent is ignored. - [Get account or card by ID](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get) gains the `invoice_company`, `user_groups` and `billing_accounts` fields. - Through the automatic connection, writing and deleting accounts and cards and reopening their cash is an exception granted by Monde on approval, shown highlighted on the consent screen: accounts apply to the whole agency, like products. ### Banks - New [Banks](#tag/Banks) resource, with [List banks](#tag/Banks/paths/~1banks/get) and [Get bank by ID](#tag/Banks/paths/~1banks~1{id}/get): the bank table used in the checking account form. Requires the new **View** permission of Banks, as in Monde. ### Accounts payable and receivable: partial payment with items - In [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) with `balance_resolution` as `partial`, on an entry with items (such as the sale payment), the item split between the paid entry and the balance now divides its agency card fee in proportion to the amount of each part. Before, the part that went to the balance took the whole fee of the item, and the agency card fee of the product was counted twice until the balance was settled. - In the same settlement, a company without the default invoice categories, from which the balance entry takes its categories, now answers 422 with the Monde message, and nothing is written. Before, the answer was 500. ## 2026-10-22 ### Accounts payable and receivable: sale payment - [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) and [Undo the settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete) now accept the sale payment (`sale_payment`), whose `id` comes in `payments.agency.bills` of the sale. The settlement uses the sale's payment method and data: `payment_method_id` becomes optional in the movement, and the card fee calculated in the sale moves to the movement without sending `card_rate`. As in every movement with a fee, `amount` is what the customer paid, and the account receives `amount` less the fee. On undoing it, the card fee stays on the entry. - [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post), [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch) and [Undo the settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete) now prorate the card fee of the movements among the sale products, in their agency card fee, and recalculate the sale revenue, as in Monde. Before, the fee changed only the entry, and the sale revenue did not deduct it. Undoing the settlement sets the agency card fee of the products back to zero. ### Packages, Ships and Cabins - New [Packages](#tag/Packages) resource: list, get, create, update and delete the packages used in the tour package product (`package_name`), with the included services. - [Ships](#tag/Ships) and [Cabins](#tag/Cabins) now have get by name, create, update and delete. The name is the record key and goes in the path URL-encoded (`/ships/MSC%20Preziosa`). Renaming carries the new name to the sale products that use the record, and a record used in a sale product is not deleted (`409`). - Each resource got the **Edit** and **Delete** permissions in the API credential. ### Currencies - [Update currency](#tag/Currencies/paths/~1currencies~1{code}/patch) and [Delete currency](#tag/Currencies/paths/~1currencies~1{code}/delete), with the rules of the Currencies screen: with the internal currency list (multicurrency) a currency can only be activated or deactivated, and none is deleted. Outside it, as in Monde, a currency with recorded exchange rates is not deleted (`409`): deactivate it. - [List currency exchange rates](#tag/Currencies/paths/~1currencies~1{code}~1exchange_rates/get) and [Get exchange rate by ID](#tag/Currencies/paths/~1currencies~1{code}~1exchange_rates~1{id}/get). - Tour operators: [Record currency exchange rate](#tag/Currencies/paths/~1currencies~1{code}~1exchange_rates/post) and [Update exchange rates](#tag/Currencies/paths/~1currencies~1exchange_rates/post), which records the exchange rate of several currencies at once, as Monde's Update Exchange Rates tool. Both answer `201` when they record and `200` when the value equals the current exchange rate and nothing is recorded (an empty list, in the batch). For travel agencies, both answer `403`. - **Currencies** got the **Edit currencies and record exchange rates** and **Delete** permissions in the API credential. ### Updates (PATCH): a null field is removed - In every update, a field omitted stays as it is, and a field sent as `null` is now **removed** from the record instead of counting as omitted. What the record cannot be without, sent as `null`, answers `422`. A list sent as `null` counts as an empty list, and a `custom_fields` item with a null or empty `value` clears that field (a required one answers `422`). Creation does not change. [Update sale](#tag/Sales/paths/~1sales~1{id}/patch) already followed this rule. - [Update person](#tag/People/paths/~1people~1{id}/patch): text fields, `address`, `birthplace`, `additional_data`, `airline`, `seller`, `promoter` and the lists are cleared. `name`, `person_kind`, `external_id`, `foreigner`, `charge_billet_fee`, the withholdings, a Monde user's email, the required card data and the Kandir law percentages answer `422`. - [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch): the description and the person are cleared, as the due date, category and links already were; `title`, `assignee_id` and `completed` answer `422`. - [Update guide](#tag/Guides/paths/~1guides~1{id}/patch): `internal_observations` is cleared; `title`, `subtitle`, `details`, `active`, `user_id` and `company_identifier` answer `422`. - [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch): a null `apportionments` empties the apportionments, and a null `per_cost_center` or `per_company` empties only that one; a null `company_identifier` answers `422`. - [Update person role](#tag/Person-roles/paths/~1person_roles~1{id}/patch): a null `people` removes every link; a null `person` or `not_commissioned` in a `people` item answers `422`. - [Update label](#tag/Labels/paths/~1labels~1{id}/patch), [Update seller](#tag/Sellers/paths/~1sellers~1{id}/patch), [Update task category](#tag/Task-Categories/paths/~1task_categories~1{id}/patch) and [Update custom field](#tag/Custom-Fields/paths/~1custom_fields~1{id}/patch): no field can be removed, and null answers `422`. The exceptions are `kanban_position`, accepted as null when the category leaves the board, and `choices`, where null counts as an empty list. ### Products - [Products](#tag/Products) can now be written through the API: create (`POST /products`, kinds `others` and `operation`), update (`PATCH /products/{id}`) and delete (`DELETE /products/{id}`). A CVC product cannot be changed, and a system product or one with related records cannot be deleted: both cases answer `409`. They require the new **Edit** and **Delete** permissions on products. - Product suppliers at `/products/{product_id}/supplies` and the representatives of each supplier at `/products/{product_id}/supplies/{supply_id}/representations`, with list, get by ID, create, update (`PATCH`) and delete. Reading uses the permission to read products; writing and deleting have their own permissions, as in Monde: **Add supplier**, **Edit supplier**, **Delete supplier**, **Add representative**, **Edit representative** and **Delete representative**. - When updating a product, a supplier or a representative, a field omitted stays as it is and a field sent as `null` is removed. A field that cannot be empty (such as `name`, `active`, `supplier` and the commission fields) sent as `null` answers `422`. - Get product by ID now carries the `id` of each supply and each representative. - Through the automatic connection, writing and deleting products, suppliers and representatives is an exception granted by Monde on approval, shown highlighted on the consent screen: these registers apply to the whole agency, like custom fields, task categories, labels and roles. ### Sales - [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) now reopens a closed sale with `status: opened`, as Monde does: the sale reopens before the rest of the request is applied, and the update applies as a whole or nothing changes. Reopening only changes the sale status; commissions and financial entries stay as they are. It requires the "Reopen sale" permission, new in the credential and checked in the company of the sale, as in Monde; "Close sale" does not reopen. A deleted sale still answers 409. ### Permissions mirrored from Monde - In [Create a person](#tag/People/paths/~1people/post) and [Update a person](#tag/People/paths/~1people~1{id}/patch), sending `credit_cards` or `kandir_law` with some item, or removing the person's ones, now requires the "View financial tab" permission on people, as in Monde, where the cards and the Kandir law sit on the Financial tab of the person. Each card operation also asks its own permission: adding a card (item without `id`), "Register credit card"; changing a card (item with `id` and some field to change), "View credit card data" and "Edit credit card"; leaving out of the list a card the person has, "Remove credit card". Without the permission, the answer is 403 with the Monde message, and nothing is written. - In [Get person by ID](#tag/People/paths/~1people~1{id}/get) and in the response of the creation and the update, `credit_cards` and `kandir_law` only come with "View financial tab", and `credit_cards`, also with "View credit card data". Without the permission, the field does not come: it is left out, not sent as null. - In [Update a person](#tag/People/paths/~1people~1{id}/patch), removing the seller or the promoter (null `seller` or `promoter`, on a person that has one) now requires "Change seller" or "Change promoter", as changing them already did. - In [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch), changing the `settlement_date` of a settled entry to a date different from the stored one now also requires "Settle account payable" or "Settle account receivable", depending on the nature of the entry, as in Monde. Sending the same date again asks no permission. - In [Create a sale](#tag/Sales/paths/~1sales/post), `commissions` with any commission now requires "View commissions tab" and "Add commissions". In [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch), sending `commissions`, even empty or null, now also requires "View commissions tab", besides "Add commissions" and "Delete commissions". - [Upload attachment](#tag/Attachments/paths/~1attachments/post) on a sale, an account payable or receivable and a person now requires, besides the permission to add attachments, the "Edit" one on the resource (sales, accounts payable and receivable, people), as in Monde, where attaching saves the record. - Product suppliers and representatives have separate permissions to add, change and delete, with the Monde names: [Add supplier to product](#tag/Products/paths/~1products~1{product_id}~1supplies/post) requires "Add supplier", [Update product supplier](#tag/Products/paths/~1products~1{product_id}~1supplies~1{id}/patch) requires "Edit supplier" and [Remove supplier from product](#tag/Products/paths/~1products~1{product_id}~1supplies~1{id}/delete) requires "Delete supplier"; on the [representatives](#tag/Products/paths/~1products~1{product_id}~1supplies~1{supply_id}~1representations/post), "Add representative", "Edit representative" and "Delete representative". - In [List logs](#tag/Logs/paths/~1logs/get) and [Get log by ID](#tag/Logs/paths/~1logs~1{id}/get), the city log (`cidade`) now comes to whoever has the "View log" permission on cities, instead of whoever reads the cities. - Getting and listing [sales](#tag/Sales), [accounts payable and receivable](#tag/Accounts-Payable-and-Receivable), [tasks](#tag/Tasks) and [travels](#tag/Travels) now require the "View" permission of the resource also for the record the credential itself created, as in Monde, where the record does not open without "View". A record of another origin still requires the "of others" permission as well. Without "View", the update response brings only the identifiers, even for the record the credential created: the `id` and, in the sale, also the `id` and the `local_id` of the products and payments sent; the same applies to the settlement and the restoration of the entry and to the comment on the task. An update without any field does not serve as a get. The creation still returns the whole created record, with the protected fields hidden according to the field permissions. The attachment download follows the get of its owner record, with the same rule. - A credential still saved in the previous catalog, from before the permissions mirrored from Monde, keeps doing what it did: on it, "View financial tab" and "View credit card data" count as "View" or "Edit" on people, the ones to register, edit and remove cards and to remove the seller and the promoter, as "Edit" on people; the settle one, as "Edit" on accounts payable and receivable; and "View commissions tab", as "View" or "Edit" on sales. Creating a sale with commissions and uploading an attachment keep working without the new requirement, and it keeps getting, updating with the whole response and downloading the attachments of what it created itself with any permission of the resource, as the automatic connection did. ## 2026-10-21 ### "Of others" permissions, as in Monde - Each permission of [sales](#tag/Sales), [accounts payable and receivable](#tag/Accounts-Payable-and-Receivable), [tasks](#tag/Tasks) and [travels](#tag/Travels) applies to what the credential itself created, and the Monde "of others" permissions extend the reach to the other records: **Consult**, **Open** and **Edit sales of other sellers**; **Access entries of all users and of the system** and its slices; **See tasks of other users**. The travel of other sellers follows **Consult sales of other sellers**. - The credential always reads what it created: any permission of the resource in the company is enough to list and get its own record. This also applies through the automatic connection, which now lists and gets the sales, entries and tasks the partner created. - A record of another user outside the reach answers 404. One the credential reads but cannot change answers 403 with the Monde message, also through the automatic connection, which used to get 404 on the sale and 403 without a message on the entry. - [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) now requires **Settle account payable** or **Settle account receivable**, according to the nature of the entry. - The [attachment download](#tag/Attachments/paths/~1attachments~1{id}~1download/get) follows the get of its owner record, and the [attachment upload](#tag/Attachments/paths/~1attachments/post) to a sale or entry of another user requires the same reach. - [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch) that moves an entry of another user to another company now also requires, in the target company, access to the entries of other users, as a sale requires "Edit sales of other sellers" there. The same applies to [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch) moving a task of another user to another company: it requires "See tasks of other users" in the target. - [List logs](#tag/Logs/paths/~1logs/get) applies the same reach: the log of a sale, an entry or a task of another user only comes to whoever reaches the record (open the sales of other sellers, access the entries of other users, see the tasks of other users), as in Monde, where the log sits on the record's tab. - A credential generated before these permissions keeps working as before: the action itself (read, edit, delete, settle, attach) reaches any record of the company. - The credential screen now offers every permission, named as in Monde, and a credential saved there follows the rules above. When an older credential is opened, the screen already checks the permissions that give it the same reach it had, so saving takes no access away. The screen refuses a permission it does not offer. - An automatic connection authorized from now on follows the rules above too: the partner reaches only what it created, and access to records of other origins is an exception granted at homologation, shown highlighted on the consent screen. ### Accounts Payable and Receivable - In [Create an account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post), creating the entry already settled now requires the "Settle account payable" or "Settle account receivable" permission, as in Monde; without it, the answer is 403. A credential that already existed keeps creating settled entries with "Edit". - New permission "Ignore locks" on Accounts Payable and Receivable: the credential that has it in the entry's company goes through the due date, movement date and surcharge and discount locks, as the Monde user does. Without it, the locks keep applying as before. - New endpoint [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post), to settle an open entry with the Monde settlement rules: the settlement date and the movements, as in the creation already settled. When what was paid does not match the final amount, `balance_resolution` says what to do with the difference: `category` posts it to a discount or surcharge category (the one in `balance_category_id` or the company's default), and `partial` settles what was paid and creates an open entry with the balance, which comes in `generated_bills`. It settles the standalone entry, the customer and supplier invoices and the credit card invoice with its edition released; the sale payment, the sale standalone entry and the commission answer 409. Requires an `Idempotency-Key`, the "Edit" permission on accounts payable and receivable and the "Settle account payable" or "Settle account receivable" one, according to the nature of the entry, the same as the creation already settled. - New endpoint [Undo the settlement of account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete), as removing the settlement in Monde: the movements leave the accounts and the entry is open again, keeping the surcharge and discount posted in the settlement. An invoice whose balance was taken to another entry answers 409, and a reconciled entry is only reopened with `undo_bank_reconciliation` as `true`. Also requires the **Edit settled entry** permission. It does not require an `Idempotency-Key`. - Through the automatic connection, a partner only settles and undoes the settlement of the entry it created itself, save for the exception granted at homologation: one from another origin answers 404, or 403 when the partner can read it. ### Sales - In [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch), what Monde protects with a permission of its own now requires that permission, in the company of the sale: changing the sale date, the company, the seller (on an open and on a closed sale), the requester and the custom fields of a closed sale, taking a product out of the list, sending commissions and changing a sale with a printed receipt. Without the permission, the answer is 403 with its name, and nothing is changed; a field resent equal to the stored one asks no permission, except `commissions`, whose list always replaces the manual commissions. Commissions now require "Add commissions" and "Delete commissions", instead of "Close sale". [Delete sale](#tag/Sales/paths/~1sales~1{id}/delete) with a printed receipt now also requires "Change sales with a printed receipt". A credential that already existed keeps doing what it did: "Edit" also counts as the new permissions of the update, "Close sale" as the ones of the commissions, and "Delete" as the one of the printed receipt. - In [Create sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch), the person, the seller, the ship and the cabin the sale creates along now require the "Edit" permission on People, Sellers, Ships and Cabins, as in Monde, where each one is created in its own screen. Swapping the person of a passenger in a sale with a printed receipt now requires "Swap passenger in closed sales or sales with a printed receipt". - In [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get), commission, over and revenue only come with "View commission, over and revenue"; `payments` and `financial`, with "View financial tab"; and `commissions`, with "View commissions tab". Without the permission, the field is left out. In the response of the creation and the update, without "View financial tab", `payments` brings only the `id` and the `local_id` of the payments sent. - A credential that already existed keeps doing what it did: "Edit" also counts for the records the sale creates along and for swapping passengers, and reading sales counts for the columns and tabs. ### Logs - [List logs](#tag/Logs/paths/~1logs/get) now scopes the history by record type, as in Monde: the log of each record type comes to whoever has its "View log" permission or, for a record type without that permission, to whoever reads it; in the log of a sale, an entry, an invoice and a task, the permission counts in the company of the record, and exports are left out. An entry the credential does not see answers 404 in [Get log by ID](#tag/Logs/paths/~1logs~1{id}/get). A credential that already read the whole log keeps seeing everything. ### People - In [Create a person](#tag/People/paths/~1people/post) and [Update a person](#tag/People/paths/~1people~1{id}/patch), setting or changing the seller (`seller`) now requires the "Change seller" permission, and the promoter (`promoter`), the "Change promoter" one, as in Monde; without it, the answer is 403. A credential that already existed keeps doing what it did: "Edit" also counts as those permissions. - [Update a person](#tag/People/paths/~1people~1{id}/patch) now refuses, with 403 and the Monde message, what Monde reserves to administrators: changing a person that is a company of the system and changing the email of a person that is an active Monde user. The other fields of the user can still be changed, and an email resent equal to the stored one is not refused. ### Tasks - In [Create task](#tag/Tasks/paths/~1tasks/post) and [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch), the assignee must have access to the tasks of the task's company, as in Monde; without it, the answer is 422 on `assignee_id`. The check applies to every change, not only when the assignee or the company changes. A task without a company is not checked. ### Automatic connection - The [Automatic connection](#tag/Automatic-connection) section opens with a three-step summary of the flow and makes clear that it is OAuth 2.0 authorization, not single sign-on (SSO) or OpenID Connect: the token grants access to the agency's API and does not identify who authorized it. ### Accounts Payable and Receivable - The movement of the settled [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post), of [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) and of [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch) gets `card_rate`, the card fee, with the rules of Monde: only on accounts receivable, in a checking account and with the credit or debit card payment method. `amount` is what the customer paid, the account receives `amount` less the fee, and the sum of the fees becomes the card fee category configured in the company, which lowers the final amount; without that category, the fee answers `422`. On the update, changing only the fee keeps what the customer paid. - The same operations now accept the credit card account on accounts receivable, only with the credit card payment method: it is the card refund, which goes into the card invoice as in Monde. Before, the card account was refused in the movements of accounts receivable. ### Account movements - [Get account movement by ID](#tag/Account-movements/paths/~1account_movements~1{id}/get) now returns `card_rate`, the card fee of the movement. - New [Restore a deleted account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1restoration/post) (`POST /bills/{id}/restoration`), with the rules of Restore in Monde: only the standalone entry comes back, open, and the settlement removed by the deletion does not come back. A sale's entry, an invoice and a commission answer `409`. Requires the **Restore** and **Edit** permissions of accounts payable and receivable in the entry's company. Another user's entry also needs **Access other users' data**, as in the other actions. - [Undo the settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete) gets `recurrence_scope`, like the update and the deletion: on an entry of a series, `this_and_following` also undoes the settlement of the following settled entries, with the same refusals and the same permission for each one. If one of them cannot be reopened, no settlement is undone, and the `409` response says which one blocked it. The default is still to undo only the entry sent. ## 2026-10-20 ### Companies, Sellers and Labels - New [Companies](#tag/Companies) resource, with [List companies](#tag/Companies/paths/~1companies/get) and [Get company by ID](#tag/Companies/paths/~1companies~1{id}/get): the active companies the credential reaches, with name, legal name, CNPJ (the `company_identifier` value in writes) and whether the company is read only. Requires the new "Read all companies" permission, granted in each company that should be listed. - [Sellers](#tag/Sellers) get [Register seller](#tag/Sellers/paths/~1sellers/post), [Update seller](#tag/Sellers/paths/~1sellers~1{id}/patch) and [Delete seller](#tag/Sellers/paths/~1sellers~1{id}/delete). As in Monde, only an individual person already registered becomes a seller, the person of a seller does not change and a seller that is in a sale cannot be deleted (`409`): deactivate it with `active: false`. They require the new seller permissions "Edit" and "Delete". - [Labels](#tag/Labels) get [Create label](#tag/Labels/paths/~1labels/post), [Update label](#tag/Labels/paths/~1labels~1{id}/patch) and [Delete label](#tag/Labels/paths/~1labels~1{id}/delete). The name has up to 38 characters and does not repeat another label's, and deleting removes the label from every person. They require the new label permissions "Edit" and "Delete". ### Cities - [List cities](#tag/Cities/paths/~1cities/get) and [Get city by ID](#tag/Cities/paths/~1cities~1{id}/get) now also return the cities of Monde's city list that the agency does not use yet, with 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. - In [Create person](#tag/People/paths/~1people/post), [Update person](#tag/People/paths/~1people~1{id}/patch) and [Create sale](#tag/Sales/paths/~1sales/post), the `city_ibge` and the city name of the address and of the birthplace now also find the city of the list. When the name repeats, the larger city comes. Before, a city abroad the agency did not have was created again, unrelated to the one in the list. A city abroad sent with `state_code` is still looked up as "Name, UF" and, with no match, created with that name. ### Custom Fields - New [Create custom field](#tag/Custom-Fields/paths/~1custom_fields/post) and [Update custom field](#tag/Custom-Fields/paths/~1custom_fields~1{id}/patch), with the same rules as the Custom Fields screen: name unique within the resource, options (`choices`) only on the list kind, and resource and kind fixed after creation. There is no deletion: a field no longer in use is deactivated with `active: false`. Requires the new **Create and edit** permission of custom fields. ### Task Categories - [List task categories](#tag/Task-Categories/paths/~1task_categories/get) and [Get task category by ID](#tag/Task-Categories/paths/~1task_categories~1{id}/get) now bring `kanban`, which says whether the category is a column of the task board, and `kanban_position`, the position of the column on the board (null off it). - New [Create task category](#tag/Task-Categories/paths/~1task_categories/post), [Update task category](#tag/Task-Categories/paths/~1task_categories~1{id}/patch) and [Delete task category](#tag/Task-Categories/paths/~1task_categories~1{id}/delete). A new category joins the board as the last column, and `kanban_position` takes it to another position, shifting the others. A category with tasks, including completed or deleted ones, is not deleted: the response is `409`. They require the new **Edit** and **Delete** permissions of task categories. ### Person roles - New resource [Person roles](#tag/Person-roles), with [List person roles](#tag/Person-roles/paths/~1person_roles/get), [Get person role by ID](#tag/Person-roles/paths/~1person_roles~1{id}/get), [Register person role](#tag/Person-roles/paths/~1person_roles/post), [Update person role](#tag/Person-roles/paths/~1person_roles~1{id}/patch) and [Delete person role](#tag/Person-roles/paths/~1person_roles~1{id}/delete): the roles of the commissions module, with the companies or sellers over whose sales the role is commissioned and the people linked to it. Agencies only, and it requires the new **Roles** permissions of the credential. Creating, updating and deleting the role, its linked people and the companies and sellers in `commissioned_over` are logged on the role, under the credential. ### People - [Create person](#tag/People/paths/~1people/post) and [Update person](#tag/People/paths/~1people~1{id}/patch) now write `credit_cards` (credit cards), `cost_centers` (cost centers of the corporate client) and `kandir_law` (Lei Kandir withholdings), in the same format as the get by ID. On update, the list sent replaces the current one, like `contacts` and `labels`: a card the person already has is cited by its `id`, a cost center by its name and a withholding by its product. The card number and security code are stored encrypted and never come back in the response, which shows only the last four digits. Cost centers and withholdings apply only to legal persons, and the withholding only to Airfare, Travel Insurance and Ground Transportation, with the total of each group computed as the sum of IR, CSLL, PIS and COFINS. Every addition, update and deletion is recorded in the history of the person. - [Get person by ID](#tag/People/paths/~1people~1{id}/get) now returns the `id` of each card in `credit_cards` and the `cost_centers` list. ## 2026-10-19 ### People - [List people](#tag/People/paths/~1people/get) gains the birthday filter, which replaces Monde's Birthdays report: `birthday_from` and `birthday_to` (YYYY-MM-DD, together, up to 366 days) return whoever has a birthday in the window, ignoring the year and crossing the turn of the year. It also gains the `label_id` filter, for the people of a label. - New [Convert an individual into a company, or the reverse](#tag/People/paths/~1people~1{person_id}~1conversion/post) (`POST /people/{person_id}/conversion`), with the rules of Monde's conversion: it erases the data only the original kind has and refuses the system user and the system company. Requires the permission to edit people. - New [Download person photo](#tag/People/paths/~1people~1{person_id}~1photo/get), [Upload person photo](#tag/People/paths/~1people~1{person_id}~1photo/post) and [Remove person photo](#tag/People/paths/~1people~1{person_id}~1photo/delete). The photo (the logo, for a company) is a JPEG of up to 150 KB, as in Monde. - [Get person by ID](#tag/People/paths/~1people~1{id}/get) gains the `photo` (type and size of the photo, or null) and `invoice_rules` (the invoice rules that belong to the person) fields. ### People and Sales - In [Update person](#tag/People/paths/~1people~1{id}/patch), a person who is a Monde user and receives the `email` of another user now responds with 422 on `email`, and nothing is written. Before, the response was 500. The same goes for an already registered person cited in [Create sale](#tag/Sales/paths/~1sales/post) or in [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) who is a user without an email and would receive the one of another user. A person who is not a user still accepts any email, including the one of a user, and [Create person](#tag/People/paths/~1people/post) does not change: the person created is not a user yet. ### Tasks - [List tasks](#tag/Tasks/paths/~1tasks/get) got the filters of the Monde Tasks screen: `assignee_id`, `created_by_id` (who created it), `person_id`, `category_id` (or `uncategorized`, for tasks without a category), `status` (`pending`, `completed` and `deleted`, comma-separated), `overdue`, the period by `date_field` (`due`, `created_at` or `completed_at`) with `date_from` and `date_to`, and the link to a sale, travel and bill (`sale_id`, `travel_id`, `bill_id`). Without `status`, the list still leaves out deleted tasks. A filter with an invalid value answers 400. - A task can be linked to a sale, a travel and a bill (account payable or receivable): `sale_id`, `travel_id` and `bill_id` in [Create task](#tag/Tasks/paths/~1tasks/post) and [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch), and `sale`, `travel` and `bill` in [Get task by ID](#tag/Tasks/paths/~1tasks~1{id}/get). The links have no required relation to the task person; when sent together, they must match each other: the sale must belong to the travel sent, and the bill to the sale sent. On update, a link sent as null is removed, and a task person already filled in is not replaced while the task has a link; filling in the person of a task that has none is allowed. ### Accounts Payable and Receivable - In [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch) with `recurrence_scope` set to `this_and_following`, each following entry of the series only receives the change when the credential could change it directly: with the "Edit" permission in its company, which cannot be read-only; for an entry of another user, also the access to the entries of other users (whole or in the slice of the entry); and, for an entry already settled, also "Edit settled entry". A following entry that does not meet this stays as it is, and the response is still 200. - With the same `this_and_following`, a following entry that was deleted (`canceled` set to `true`) stays as it is and no longer receives the change of the series. - In [Delete account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/delete) with `recurrence_scope` set to `this_and_following`, each following entry of the series is only erased when the credential could delete it directly: with the "Delete" permission in its company, which cannot be read-only; on an entry of another user, also access to the other users' entries (whole or in the entry's slice); and, on a settled one, also "Edit settled entry". A following entry that does not meet this stays, out of the series, and the response is still 204. ## 2026-10-17 ### Cities - **Contract change:** [List cities](#tag/Cities/paths/~1cities/get) and [Get city by ID](#tag/Cities/paths/~1cities~1{id}/get) no longer return the `setec` field. Monde did not use the SETEC code in any invoice issuing, and it was removed from the city registration. ### Accounts Payable and Receivable - [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post) now accepts `balance_resolution` and `balance_category_id` in an entry created already settled, as the [settlement](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post) does: with `category`, the difference between what was paid and the final amount goes to the category sent or, without it, to the company's default category; with `partial`, the balance becomes an open entry. `partial_payment: true` is still accepted and is the same as `balance_resolution: partial`; a `partial_payment` that contradicts `balance_resolution` is rejected with 422. `balance_resolution` cannot be combined with installments or recurrence. ## 2026-10-16 ### Accounts Payable and Receivable - New endpoint [Settle account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/post), to settle an open entry with the Monde settlement rules: the settlement date and the movements, as in the creation already settled. When what was paid does not match the final amount, `balance_resolution` says what to do with the difference: `category` posts it to a discount or surcharge category (the one in `balance_category_id` or the company's default), and `partial` settles what was paid and creates an open entry with the balance, which comes in `generated_bills`. It settles the standalone entry, the customer and supplier invoices and the credit card invoice with its edition released; the sale payment, the sale standalone entry and the commission answer 409. Requires an `Idempotency-Key` and the permission to create and edit accounts payable and receivable, the same as the creation already settled. - New endpoint [Undo the settlement of account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}~1settlement/delete), as removing the settlement in Monde: the movements leave the accounts and the entry is open again, keeping the surcharge and discount posted in the settlement. An invoice whose balance was taken to another entry answers 409, and a reconciled entry is only reopened with `undo_bank_reconciliation` as `true`. Also requires the **Edit settled** permission. It does not require an `Idempotency-Key`. - Through the automatic connection, a partner only settles and undoes the settlement of the entry it created itself: one from another origin answers 403, or 404 when the partner has no permission to read accounts payable and receivable. - The movements of accounts payable and receivable are now recorded in the entry's log, on behalf of the credential, when they are created, changed or removed through the API. ## 2026-10-15 ### Accounts Payable and Receivable - New endpoint [Delete account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/delete), with the Monde rules. The deletion is logical: the entry gets `canceled` equal to `true` and stays in the query by ID. It deletes the standalone entry and the client and vendor invoice, whose items are invoiced again; an entry generated by a sale, a credit card invoice, a commission entry and an invoice generated by Monde with items answer 409 with the reason. A settled entry is only deleted with `remove_settlement` as `true`, which removes the settlement, and a reconciled one with `undo_bank_reconciliation` as `true`. On installments or recurrence, `recurrence_scope` with `this_and_following` also erases the following entries with no movement, like the "Delete this and following" option in Monde. It does not require `Idempotency-Key`. - New permission **Delete** on Accounts Payable and Receivable, offered on the API credential; a settled entry also requires **Edit settled**, and without it answers 403 before any 409 refusal. Through the automatic connection, a partner gets **Delete own accounts** and only deletes the entry it created itself: one from another origin answers 403, or 404 when the partner has no permission to read accounts payable and receivable. ## 2026-10-14 ### Sales - **Contract change:** in [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch), each paid product in `payments[].*.products[]` now points to the product by `sale_product_local_id` (a product sent in the same request) or by `sale_product_id` (a product the sale already has, update only), instead of `local_id`, `external_id` and `id`. The amount allocated to the product is now called `amount`, instead of `payment_amount`, as in the sale get. For now, `local_id`, `external_id` and `payment_amount` are still accepted, so as not to break those who already send them: migrate to the new names. Since `sale_product_local_id` carries only the value, two products of the sale can no longer share the same key value, not even one in `local_id` and the other in `external_id`. - **Contract change:** each `payments` item now has a single payment method: `agency` or `vendor`, with only one method inside. To pay with two methods, send two payments. This way each payment sent comes back with a single `id`. - **Contract change:** in [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch), `local_id` is now required on each new `payments` item and unique among the new payments of the request; a payment without it is refused with 422. It comes back in the response, inside the payment, next to the generated `id`, which you use to keep the payment in the next update. A payment kept by its `id` does not need it. ### License and permission - The API no longer requires the API license: every company with an active Monde license can be used, as long as the credential has the permissions granted on it. A company without an active Monde license answers `403` with "The company does not have an active Monde license. Contact our support team for more information.". - Writes follow the company's own license: on a company with a read-only license, reads keep answering and writes answer `403`. - [Guides](#tag/Guides) now require the Monde Pro license on the guide's company. Without it, the response is `403` with "This feature requires the Monde Pro license. Contact our support team for more information."; with a read-only Monde Pro license, guides are read, but not written. `public_url` is null when the company is read-only, does not have the Monde Pro license, or has a read-only Monde Pro license. - The [Automatic connection](#tag/Automatic-connection) no longer requires a license for any permission: the consent offers every active company of the agency, and none is refused for license. - Writing to a read-only company now answers `403` with its own message, "The company is read-only: its records can be read through the API, but not written.", instead of "Your license does not grant access to this action.". It applies to every write: sales, tasks and their history, people, accounts payable and receivable, attachments and guides, also through the [Automatic connection](#tag/Automatic-connection), and to moving a task or a guide to a read-only company. "Your license does not grant access to this action." remains only for the read-only Monde Pro license, on guides. Reads stay allowed. ### Accounts Payable and Receivable - [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post): the forecast account (`account_id`) now accepts any active account linked to the company, including a credit card account on accounts receivable, as in Monde. The credit card account stays out of the movements of accounts receivable. - [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post) now refuses an inactive own operation (`operation_id`). - New endpoint [Update account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/patch), for every kind of entry, open or settled, with the rules of the manual entry in Monde. Only the fields sent change: person, description, document, issue date, due date, forecast account, own operation, observations, custom fields, amount (`amount`), categories, apportionments per cost center and per company, and the company of the entry (`company_identifier`). The categories and each apportionment sent replace the current ones; an amount sent without the categories follows the Monde rule: with a single category, it follows the new amount; with more than one, it must equal their sum. Moving the entry to another company requires the create and edit permission there too, and an entry with a registered or issued bank slip does not change company. In an installment or recurring series, `recurrence_scope` with `this_and_following` takes the change to the following entries of the series too, in the background, like the "Update this and next" option in Monde. - Locks per kind, as in Monde: on an entry generated by a sale, person, company and amount do not change; on a client or vendor invoice, person, company and original amount do not change; on a credit card invoice, due date, company and amount do not change, and it accepts no categories or apportionments. A category generated by the system is sent back as it is. The own operation is accepted only on a standalone entry without an invoice number. A deleted entry and an invalid invoice answer 409, and so does a credit card invoice while its edition is not released for the agency. - On a settled entry, the settlement date (`settlement_date`) and the movements it already has (`movements`, each one by its `id`) change too, without adding or removing movements, settling or unsettling. The movements must add up to the final amount, and the company of a settled entry does not change. Besides **Create and edit**, it requires the new **Edit settled** permission on Accounts Payable and Receivable, offered on the API credential. 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 of the changed movement is undone. - Through the automatic connection, a partner gets **Create and edit own accounts** instead of **Create and edit** and only creates and changes the entries it created itself: one from another origin answers 403, or 404 when the partner has no permission to read accounts payable and receivable. When it changes an entry it created, the response brings the whole entry even without the read permission. ### Attachments - [Upload attachment](#tag/Attachments/paths/~1attachments/post) now accepts `bill` in `resource_type`: send the `resource_id` of the target account payable or receivable and the attachment is stored on it, showing up in the account query by ID and in the download. It requires, on **Accounts Payable and Receivable**, the **Add attachments** permission — now offered on the API credential — granted on the company of the account, which cannot be read-only. The rest of the upload is unchanged: one file per request, the same extensions, the same 12 MB limit and the same `Idempotency-Key`. - Through the automatic connection, a partner only [uploads attachments](#tag/Attachments/paths/~1attachments/post) to a sale or an account payable or receivable it created itself: one from another origin answers 422 as a record not found when it has no permission to read the resource, and 403 when it has. On sales, one from another origin always answered 403. In return, it [downloads the attachment](#tag/Attachments/paths/~1attachments~1{id}~1download/get) of the sale and the account it created with only **Add attachments**, without the read permission. ### Sales - The documentation of the product `exchange_rate` and of the payment `payment_amount` in [Create sale](#tag/Sales/paths/~1sales/post) now explains how the exchange rate is applied: each amount is converted and rounded to 2 decimal places separately, and the product total is the sum of these amounts. The calculation did not change; summing in the origin currency and converting once may differ by cents and have the closing refused for pending balance. ## 2026-10-13 ### Guides - New [Guides](#tag/Guides) resource, with [List guides](#tag/Guides/paths/~1guides/get), [Get guide by ID](#tag/Guides/paths/~1guides~1{id}/get), [Create guide](#tag/Guides/paths/~1guides/post), [Update guide](#tag/Guides/paths/~1guides~1{id}/patch), and [Delete guide](#tag/Guides/paths/~1guides~1{id}/delete). A guide is HTML content with a public link, without a linked person and without a validity date, and exists only in the companies with the Monde API license. Requires the new guide permissions of the credential. ### Accounts Payable and Receivable - [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post) now creates more than one entry from a single call: installments (`recurrence_kind: installment`, with `periodicity` and the total of `installments`), recurrence (`recurrence_kind: recurrent`, for the next 5 years) and partial payment (`partial_payment: true`), where the balance becomes a new open entry. The series is generated in the background, as in Monde: the response brings `recurrence_group_id`, and the series entries are fetched by the new `recurrence_group_id` filter of [List accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get). The partial payment's balance comes right away, in `generated_bills`. - [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) gets the `recurrence_status` field: `pending` while the installment or recurrence series is not generated yet, `generated` once it is, and `retrying` when the last attempt failed and Monde will try again. ### OpenAPI specification - Every operation got a stable `operationId` (for example `listSales`, `createSale` and `getPerson`), which SDK generators and AI agent tools use as the function name. - The availability of each endpoint stays only in the badge (**Beta** or **In development**, in `x-badges`): the notice repeated at the start of every description was removed. - Every JSON response, error ones included, carries an example of the body. - The specification is also at `https://web.monde.com.br/api/v3/openapi.yaml`, with `Content-Type: application/yaml`. The `/api/v3/documentation/file` address still works. ## 2026-10-12 ### Quotes - [List quotes](#tag/Quotes/paths/~1quotes/get) and [Get quote by ID](#tag/Quotes/paths/~1quotes~1{id}/get) no longer return the `details_format` field: every quote has its details (`details`) in HTML, with the images in ``. ## 2026-10-09 ### FAQ - New [FAQ](#tag/FAQ) section, with the most common questions about access, limits, querying sales and writing, each with a short answer and a link to the section that covers the subject in detail. ### Queries by ID, Labels and Task Categories - The queries by ID that still carried the **In development** badge moved to **Beta**: they already answered and are now marked as available. They are the ones of [Travels](#tag/Travels/paths/~1travels~1{id}/get), [Tasks](#tag/Tasks/paths/~1tasks~1{id}/get), [Products](#tag/Products/paths/~1products~1{id}/get), [Sellers](#tag/Sellers/paths/~1sellers~1{id}/get), [Quotes](#tag/Quotes/paths/~1quotes~1{id}/get), [Accounts and Cards](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get), [Payment Methods](#tag/Payment-Methods/paths/~1payment_methods~1{id}/get), [Categories](#tag/Categories/paths/~1categories~1{id}/get), [Cost Centers](#tag/Cost-Centers/paths/~1cost_centers~1{id}/get), [Cities](#tag/Cities/paths/~1cities~1{id}/get), [Currencies](#tag/Currencies/paths/~1currencies~1{code}/get), [Integrations](#tag/Integrations/paths/~1integrations~1{id}/get), Invoice (NF) Rules and [Billing Rules](#tag/Billing-Rules/paths/~1invoice_rules~1{id}/get). - For the same reason, [Labels](#tag/Labels) and [Task Categories](#tag/Task-Categories), in both the list and the by-ID query, moved to **Beta**. ### Accounts Payable and Receivable - In [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post), a refusal raised by the database, such as a closed cash day, now comes as Monde shows it: without the `ValidationError:` mark and with the date formatted (`O caixa do dia "10/10/2026" da conta "Caixa" está fechado.` instead of `ValidationError: O caixa do dia "#Date(2026-10-10)#"…`). ## 2026-10-08 ### Sales - **Behavior change:** [Create a sale](#tag/Sales/paths/~1sales/post) now respects the **Do not allow registering sales outside trips** setting, per company. With it on for the company of `company_identifier`, the creation is rejected with 422 and the message names the company, as in Monde, which does not allow registering a sale outside a trip in that company. Before, the sale was created standalone. The API cannot yet create a sale within a trip; integrations using that company must turn the setting off or use another company. ### Categories - [List categories](#tag/Categories/paths/~1categories/get) and [Get category by ID](#tag/Categories/paths/~1categories~1{id}/get) now return the category kind (`kind`): `expense` or `revenue`, inherited from its group. In a financial entry, a `revenue` category adds to the amount of a `credit` entry (accounts receivable) and is deducted from a `debit` entry (accounts payable); an `expense` category does the opposite. ### Accounts Payable and Receivable - New operation [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post) (`POST /bills`), open, with the rules of Monde's manual entry: the signed sum of the categories makes the final amount, the cost center apportionment stays between 0 and 100%, the split between companies totals 100%, and the company's due date and surcharge and discount locks always apply. Requires the new permission to create and edit accounts payable and receivable and the idempotency key. - [Create account payable or receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/post) also creates the entry already settled, with `settlement_date` and the `movements`: the movements add up to the final amount, the payment method follows the account kind, and the movement date lock and the closed cash day apply as in Monde. Partial settlement is not accepted yet. Without `issue_date`, the issue date is now today, or the due date or the settlement date when they are earlier, instead of rejecting a past due date. An error on a list item of the entry carries the item position, from 0, as in `'movements[1] account_id'`. ### All writes - A list sent as an object keyed by numbered positions (such as `"labels": { "0": { "id": "" } }` instead of `"labels": [{ "id": "" }]`) now returns 422, naming the field, and nothing is saved. Before, it could return 500. ### Sales - **Contract change:** in [Create a sale](#tag/Sales/paths/~1sales/post), the recipient of each commission in the `commissions` array now comes in the `person` object, with the same fields as the intermediary, instead of `external_id`. As with passengers, the person is looked up by `external_id` and, when not linked, by CPF/CNPJ; when not found, it is created. Previously the `external_id` had to be already linked to a person, and the commission created no one. As in Monde, `kind` does not restrict who receives it: a seller commission may go to any person. Without `description`, `seller` and `intermediary` record "Comissão Vendedor" and "Comissão Intermediário". A commission that still sends only `external_id` is rejected with 422. ## 2026-10-07 ### Sales - **Tour operators:** sales now follow the tour operator calculation rules, as in Monde. On creation, the commission, the over and the intermediary commission are kept in the product's origin currency, calculated over the products total in that currency, and the product revenue and billing follow the tour operator formulas. The intermediary (`intermediary`) is now required, whether the sale is open or closed, and it owes the customer invoice, for the customer total net of the intermediary commission. When the [sale is deleted](#tag/Sales/paths/~1sales~1{id}/delete), the balance that becomes due again also stays with the intermediary, not with the payer. The amount owed to the supplier stays in the product's origin currency. Converted amounts are rounded to 2 decimal places. A payment to the supplier (`payments.vendor`) of a product whose origin currency is not BRL is rejected with 422. Nothing changes for travel agencies. - **Change when reading, for tour operators:** in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get), `commission_amount`, `over_amount`, `intermediary_commission_amount` and `intermediary_over_amount` came in the product's origin currency, without any indication. They now come in the final currency of the sale, like the other amounts, and so does the sale revenue (`totals.revenue`). Nothing changes for travel agencies. - Sale products now return `commission_amount_origin_currency`, `over_amount_origin_currency`, `intermediary_commission_amount_origin_currency` and `intermediary_over_amount_origin_currency`, the amount in the origin currency, as already happened with the service fee and the discount. - **Tour operators:** [Create a sale](#tag/Sales/paths/~1sales/post) now accepts the sale currency per product, in the new `sale_currency` field (default BRL). As in Monde, `currency` is the origin currency, in which the supplier is paid, and `exchange_rate` converts the origin into the sale currency: with equal currencies the rate is 1, with different currencies it is required, even when the origin is BRL. The customer invoice and the payments (`payments`) are issued in the sale currency, and each payment only groups products with the same sale currency. A payment to the supplier (`payments.vendor`) is now rejected with 422 when the origin currency differs from the sale currency, instead of when it differs from BRL. On read, `currency` returns the product sale currency. For travel agencies, a sale currency other than BRL is rejected with 422. - In the agency payment (`payments.agency`) with `settlement_date`, the bank account may be in a currency other than the payment's, as in Monde. The settlement converts by the new `settlement_exchange_rate` field, from the payment currency to the account currency, or, when it is omitted, by the ratio between the latest rates of both currencies; without the rate of either one, the response is 422. Before, the amount entered the account unconverted. With the account in the payment currency, `settlement_exchange_rate` must be 1 or omitted. The bank slip (`bank_slip`) now only accepts products whose sale currency is BRL, with 422 for the others. ## 2026-10-06 ### Sales - New operation [Delete sale](#tag/Sales/paths/~1sales~1{id}/delete) (`DELETE /sales/{id}`). As in Monde, the sale is not removed: its `status` becomes `canceled`, and Monde undoes right after what it generated in the finances. The same rules as in Monde prevent the deletion (closed sale, canceled product, settled financial entry, item already invoiced to the supplier, refund, closed client invoice), with a 409 response and the reason. A sale with a printed receipt is deleted. Requires the new permission to delete sales. In the automatic connection, a partner with the permission to delete own sales deletes only the sales the integration created. - New [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) operation (`PATCH /sales/{id}`). Updates an open sale: a field left out stays as it is, and each list sent replaces the current one (the products of each kind, the passengers and segments of each product sent, `payments` and `commissions`). A field sent as `null` is removed from the sale (`intermediary`, `approver`, `requester`, `operation_id` and `operation`; `operation_id` only goes away along with the own operation product that holds it), and a custom field sent blank is cleared, unless it is required. In a changed product, what the payload does not bring, including passengers and segments, stays as it is, and a passengers or segments list sent empty is refused. In ground transportation and train tickets, whose segments live in the included services text, `segments` sent again require `included_services` along with them, which is saved as sent. A list sent as `null` is the same as an empty list, with the same rules; in custom fields, which are not replaced, it changes nothing. This also applies to the lists inside an item: the `seats` of a segment sent can be left out, empty or `null`, and a new payment with `products` empty or `null` is refused. A product the sale already has is pointed to by the `id` of the get by ID; a product without `id` is added, and one left out of the list of its kind is removed. In `payments`, a payment sent with only its `id` stays as it is, one without `id` is added and one left out is removed; in a new payment, the paid product is pointed to by `sale_product_local_id`, for a product in the same request, or by `sale_product_id`, for a product the sale keeps. The totals are recalculated, and the payer balance and the amount to invoice to the supplier are adjusted by the difference. What was already reconciled in the financial module is not removed: removing a settled payment or one in a closed customer invoice answers 422, as does a supplier amount in a closed, settled or separate invoice and a paid commission. A deleted sale cannot be changed (409). In a closed sale, as in Monde, only the seller, the requester, the approver, the custom fields and the commissions change, and `status` only accepts `closed` (the rest answers 409). Commissions come in the same format as on creation, with the recipient in the `person` object. The sale can move to another company where the credential can also update sales, with the Monde locks. Each changed field goes to the sale log. Requires the "Create and edit" permission in the sale company, or "Create and edit own sales" for a sale the credential itself created. - [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) now bring, in each product and payment sent, the `local_id` it came with next to the generated `id`. A credential without read permission gets only these identifiers, in the same format as the sale, instead of only the sale `id`. In the sale get, the supplier payments and the agency payments in `credit` and `legacy` now bring their `id`. - [Create a sale](#tag/Sales/paths/~1sales/post) and [Update a sale](#tag/Sales/paths/~1sales~1{id}/patch) now store the sale seller as the responsible seller in the payer registration, as the Monde sales screen does. ### Sales, Accounts Payable and Receivable, and Invoices - In [List sales](#tag/Sales/paths/~1sales/get), [List accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get) and [List invoices](#tag/Invoices/paths/~1nfs/get), the `status` filter sent as a list or a nested value (such as `?status[]=open`) still answers 400, but the message now says the parameter does not accept lists or nested values, as in pagination. Before, the message only said the value was not valid. In sales and in accounts payable and receivable, to filter by more than one status, send the values separated by commas (such as `?status=open,overdue` in accounts). ## 2026-10-05 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts the passenger cost center (`passengers[].cost_center`, up to 50 characters) in every product with passengers. As in Monde, when the payer is a legal person the cost center must be one of those registered for that payer, case-insensitive, and is stored with the name as registered; any other value returns 422 and nothing is saved. With an individual payer, or when the sales setting **Enter the cost center as free text** is on, any text is accepted. Before, the field was only returned when reading and was ignored on creation. - [Create a sale](#tag/Sales/paths/~1sales/post) now records the seat per segment of the airline ticket, in `airline_tickets[].segments[].seats`. Each seat points to the passenger by the `ticket_number`, which must be the ticket of exactly one of the passengers of the product: a ticket that belongs to no passenger, or to more than one, returns 422 and nothing is recorded. The same passenger cannot have two seats on the same segment. The `seat_number` accepts up to 3 characters and is recorded in uppercase. Before, the field was only documented and was not processed by the API. - [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) now returns the seats on each segment of the airline ticket (`segments[].seats`), in the same format as the creation. A seat entered in Monde for a passenger who has no ticket yet comes with a null `ticket_number`. The passenger still has no `seat`. ### Idempotency - The [idempotency](#tag/Idempotency) key now expires: at least one day after the first request, it is discarded by the next cleanup, which runs once a day, and sending the same key again is processed as a new request. Before, the key of a completed request returned the cached response (`X-Idempotent-Replay: true`) forever. ### Sales and Tasks - In [Create a sale](#tag/Sales/paths/~1sales/post), [Create task](#tag/Tasks/paths/~1tasks/post) and [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch), a `company_identifier` of a company where the credential has no permission at all is now answered as a CNPJ not found (422, with a field error), the same as a CNPJ that is not a company of the agency. It used to answer 403, which let any credential find out which CNPJs are active companies of the agency. In a company where the credential has some permission, but not the one for the operation, the answer is still 403. ## 2026-10-02 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts the **Other** product in the `others` field (a list; a sale can have several). The product is informed by `product_id`, among the Other products of the agency catalog (`GET /products?kind=others`). Depending on the product configuration, the values go through `passengers` or through `quantity` × `unit_price` (with `unit_fee` and the hidden service fee `agency_fee`). The supplier (`supplier`) is required and the representative (`representative`) is optional. It also accepts `destination` (`national` or `international`). - In products without passengers (Other and own operation), `unit_fee` is now in Brazilian reais (BRL), as in Monde: the total fees are `quantity` × `unit_fee`, without applying the product exchange rate. Before, the unit fee was multiplied by the exchange rate. Products in BRL are not affected. - The Other product and the own operation (`operation.product_id` and `operation_id`) must be active in the catalog, as in Monde, which only offers active products in a sale. An inactive product, listed in `GET /products` with `active: false`, is rejected with 422. Before, an inactive own operation was accepted. - In Other and own operation products, `quantity` accepts at most 2147483647. Above that the response is 422, with the field name, and nothing is saved. Before, such a quantity returned 500. The line total that the quantity produces is not checked yet, as with the other calculated values. - [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) now returns, for Other products, `agency_fee` and `agency_fee_origin_currency`, the hidden service fee of the line, as in own operation products. They are null in the product with passengers, where the fee comes in each passenger. - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts excursions in the `excursions` array, one or more per sale. The excursion is a system product, so there is no need to inform which product is being sold. The `document` (up to 40 characters), the departure date (`departure_date`), the currency, the supplier and at least one passenger are required. The arrival date (`arrival_date`) is optional and cannot be earlier than the departure. The observations (`observations`), the included services, the representative and the product values (commission, intermediary commission, service fee, discount and exchange rate) are also accepted. The passenger takes amount, fees, RAV fee and its discount, hidden service fee and document. If the Excursion product is inactive in Monde, it is activated when the sale is created, as happens when it is sold through the system. ## 2026-10-01 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts airline tickets in the `airline_tickets` array, with the flight legs in `segments` and the passengers. The airline is identified by its IATA/ICAO code in `airline_code` or by its CNPJ: when an airline with that code already exists it is reused, otherwise it is created. Each passenger's DU fee (`du_fee`), minus its discount (`du_fee_discount`), is included in the passenger and product totals. The DU discount can only be informed when `du_fee` is greater than zero, as in Monde. The CC DU and CC RAV fees (`cc_du_fee`, `cc_rav_fee`) are stored on the product and deducted from the agency revenue. Each leg's origin and destination must be a registered airport; an unknown IATA code is rejected. Spaces before or after airline and airport codes are discarded, and the maximum length applies to the code without them. `flight_number` accepts digits only, and `emission_name` accepts up to 50 characters. The seat per leg (`segments[].seats`), which points to the passenger by `ticket_number`, and the passenger `original_ticket_number` are only documented, since the system does not process them yet. - In the sale lookup, the airline ticket passenger no longer returns `seat`. The seat belongs to each leg, not to the passenger, and will be returned in the legs once the system stores it per leg. - In the sale lookup, the airline leg `class` no longer comes with a trailing space when the class has a single letter (`"A"` instead of `"A "`). ## 2026-09-30 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now honors the **Validate payer registration** setting: with it on, a `payer` lacking the fields Monde requires to save the sale (full address, document, contact and, depending on the person kind, birthdate or legal name) is refused with 422, one error per missing field, and nothing is saved. The registration counts as it stands after the request, including what the request creates or completes. Before, the sale was created even with an incomplete registration. With the setting off, the default, nothing changes. ### Tasks - [Get task by ID](#tag/Tasks/paths/~1tasks~1{id}/get) now returns `attachments`, with the task attachments, including the ones sent in comments. Each attachment has `id`, `description`, `extension`, `content_type` and `download_url`, in the same format as the sale. [Create task](#tag/Tasks/paths/~1tasks/post), [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch) and [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post) also return the field when they return the full task. ### Travels - [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get) now returns `attachments`, with the travel attachments, in the same format as the sale. An attachment that also belongs to a task or to a sale is not listed, because its download requires the permission of that other record. ### Attachments - [Download attachment](#tag/Attachments/paths/~1attachments~1{id}~1download/get) is now documented. It is the address returned in `download_url`. It requires the read permission of the record that owns the attachment: "Read all tasks", "Read all sales", "Read all travels", "Read all accounts payable and receivable" or "Read all people". ### People and Sales - In [Create a person](#tag/People/paths/~1people/post), [Update a person](#tag/People/paths/~1people~1{id}/patch) and [Create a sale](#tag/Sales/paths/~1sales/post), the `city_ibge` of the address and of the birthplace (`birthplace`) now defines the city, which must already be registered. A code that matches no city responds 422 on `city_ibge`, even with name, state and country provided, and nothing is saved. Before, the response was a success: the person was left without the birthplace, or the city was created with the invalid code. To register a new city, send `city_name`, `state_code` and `country_code` without `city_ibge`: the city is created without an IBGE code. - With `city_ibge`, a `state_code` different from the state of the city responds 422 on `state_code`, and a `country_code` other than `BR` responds 422 on `country_code`. `city_name` is not checked. - In the sale, refusing the address of the payer or of another person refuses the whole sale, like the other person validations. ## 2026-09-29 ### Sales - [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) now brings the origin currency of each product. `currency` is the final currency of the sale (BRL in sales created by the API), and the amounts stay in it, unchanged. `origin_currency` was added with the currency in which the product is originally sold, and `exchange_rate` now brings the exchange rate stored in the product instead of a fixed 1. - Each amount that Monde stores in both currencies got a pair with the `_origin_currency` suffix, in the origin currency: in the products (`agency_service_fee`, `deductions`, `discount_amount`), in `totals` and in the passengers (e.g. `amount` and `amount_origin_currency`). Commission, over and the intermediary amounts have no pair. This fixes the rule of the 2026-08-11 entry, where `currency` and `exchange_rate` always returned BRL and 1. - In the own operation without passengers, `agency_fee` now comes in the final currency of the sale, like the other amounts, and got the `agency_fee_origin_currency` pair. Before, it came in the origin currency. Nothing changes on create: `agency_fee` is still provided in the origin currency. ## 2026-09-28 ### Automatic connection - The [Automatic connection](#tag/Automatic-connection) section now has the full request and response examples for the approval check, the code exchange and the revocation, what reaches the `redirect_uri` when the agency approves or refuses (with the `state`), and the errors of each step. - Revocation by the partner, at `POST /oauth/revoke`, is now documented: it deletes the connection with the agency immediately. ### People, Sales, Tasks and Cities - In [Create a person](#tag/People/paths/~1people/post), [Update a person](#tag/People/paths/~1people~1{id}/patch), [Create a sale](#tag/Sales/paths/~1sales/post), [Create task](#tag/Tasks/paths/~1tasks/post), [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch) and [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post), a field sent in a format other than the documented one now answers 422, naming the field, and nothing is written. Before, the field was ignored and the request succeeded without that data. This applies to a list or object sent as text, number or boolean (such as `"labels": "..."`), to a list item that is not an object (such as `"labels": [""]` instead of `"labels": [{ "id": "" }]`) and to a plain value sent as a list or object. A null field or one with empty text still counts as not sent. - In [List people](#tag/People/paths/~1people/get) and [List cities](#tag/Cities/paths/~1cities/get), a filter sent as a list or a nested value (such as `?name[]=Ana`) now answers 400, naming the parameter. Before, the filter was ignored and the query returned the list without it. ## 2026-09-25 ### Cities - [List cities](#tag/Cities/paths/~1cities/get) now accepts the `name` filter, which searches by a part of the city name, case-, accent- and position-insensitive (e.g. `?name=sao paulo`). The filter works with pagination and the ordering by name. ### Tasks - [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch) is now available: updates `title`, `description`, `due`, `category_id`, `assignee_id`, `person_id`, and `custom_fields` of an existing task. Send only what should change — a field that is omitted, or sent as null or as an empty string, stays as it is. `title` is the exception: a task must have a title, and sending it as an empty string is rejected. The custom fields sent overwrite the current ones, and the others stay. - `completed` completes the task (`true`) or reopens it (`false`), and `company_identifier` moves the task to another company, which also requires the **Create and edit** permission on Tasks in the destination company. - The update requires the **Create and edit** permission on Tasks and the `Idempotency-Key` header. The task participants are notified by email, as when the change is made in Monde. - [Delete task](#tag/Tasks/paths/~1tasks~1{id}/delete) is now available: deletes the task, which no longer appears in [List tasks](#tag/Tasks/paths/~1tasks/get) and is still available in the query by ID, with `deleted` set to `true`. A completed or already deleted task responds 409, and nothing is changed. Responds 204 with no body and does not require `Idempotency-Key`. Requires the **Delete** permission on Tasks, now offered on the API credential, granted in the task's company with an API license that writes. The task participants are notified by email. - A deleted task cannot be updated or take comments: [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch) and [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post) respond 409. - [Update task](#tag/Tasks/paths/~1tasks~1{id}/patch) and [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post) respond with only the `id` of the task when the credential does not have the **Read all tasks** permission in the task's company. The write happens all the same, with the same status. A credential with the read permission keeps receiving the full task, in the same format as the get by ID. ### People - [Update a person](#tag/People/paths/~1people~1{id}/patch) now responds with only the `id` of the person when the credential does not have the "Read all people" permission. The update is written all the same, with the same 200 status. A credential with the read permission keeps receiving the full person, in the same format as the get by ID. ## 2026-09-24 ### Tasks - [Create task](#tag/Tasks/paths/~1tasks/post) is now available: send `company_identifier`, `title`, `due`, `category_id` and `assignee_id`, and optionally `description`, `person_id` and `custom_fields`. The assignee must be an active Monde user and is notified by email. The task is created as pending. Accepts `Idempotency-Key` for safe retries. - A task can be created with its first comments: send `history`, a list of `{ "text": "..." }`, in the same creation body. - [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post) appends a comment to the history of an existing task and returns the task with the updated history. The task participants are notified by email. The history is append-only: a recorded comment can be neither changed nor deleted. - Both writes require the **Create and edit** permission on Tasks, now offered on the credential. - In the task queries, `due` and `completed_at` are now returned without the time zone offset, in the same format as `created_at` and every other date-time field in the API: `2026-04-01T09:00:00` instead of `2026-04-01T09:00:00-03:00`. The time itself is unchanged. ### People - In the people queries, `last_contacts.last_task_update_at` is now returned without the time zone offset, in the same format as the other `last_contacts` dates and the other date-time fields of the API: `2026-07-01T15:12:00` instead of `2026-07-01T15:12:00-03:00`. The time is the same. ### Automatic connection - The Supplier credentialing section is now called [Automatic connection](#tag/Automatic-connection) and applies to any partner, not only to those that create sales. - The partner permissions are now set during approval, and the agency sees that list on the consent screen before authorizing. Partners approved before this keep sale creation. - Creating sales through the integration needs no API license. Permissions outside Sales need an API license on the picked company. - A partner with sale creation does not read sales: the created sale comes back in full in the `POST /sales` response. Attachments only go to the sale the partner itself created. ## 2026-09-22 ### People - [Delete a person](#tag/People/paths/~1people~1{id}/delete) is now available: permanently deletes a person that has no related records (sales, financial entries, invoices, quotes, tasks, attachments, among others) and that is neither a system user nor a system company. In those cases the response is 409, with the reason, and nothing is changed. It responds 204 without a body and does not require `Idempotency-Key`. It requires the "Delete" permission on People, now offered on the API credential, granted in a company whose API license allows writing. ### Logs - The description of every log written by an API request now starts with the action and the label of the credential that made it: `Inserido via API pela credencial "..."`, `Editado via API pela credencial "..."` or `Excluído via API pela credencial "..."`. The following lines, with the changed fields, are unchanged. It covers everything the request writes: the record, the links written along with it (such as a person's labels and contacts) and the bills a sale generates, including those of the supplier invoice. In [List logs](#tag/Logs/paths/~1logs/get) the `person` of these logs is still null, because the credential is not a person. - The separate log with the description `Registro cadastrado via API`, written by the API alongside every record creation, is gone: who created the record is now the first line of the log of the record itself. In [List logs](#tag/Logs/paths/~1logs/get) a creation made through the API now brings one log less. ## 2026-09-21 ### People - [Update person](#tag/People/paths/~1people~1{id}/patch) is now available: it updates a person already registered with the same fields as [Create person](#tag/People/paths/~1people/post). Send only what must change — a field left out, or sent as null or as empty text, stays as it is, and a text field is not emptied by this operation. The kind of the person does not change, the `external_id` starts identifying them as long as it does not identify another person, and the CPF/CNPJ and the airline code cannot belong to another person. Labels and contacts work by replacement: the list sent becomes the list of the person, an empty 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 and the remaining ones stay. It requires the "Insert and edit" permission on People and the `Idempotency-Key` header. ### Sales - Sale totals now account for the passenger's RAV fee discount and second fee (`other_fees`, `tip`). Previously the discount sent on the passenger was stored but did not reduce any total, and the second fee did not reach the fee total. Product amount, total discount, revenue, billing and the sale balance now match what Monde calculates on screen. - `rav_fee_discount` is only accepted when `rav_fee` is greater than zero. Sending the discount without the fee now answers 422, the same way Monde refuses it on screen. ### Attachments - [Upload attachment](#tag/Attachments/paths/~1attachments/post) refused with a 422 now releases the `Idempotency-Key`: sending the same attachment again with the same key is processed again, instead of answering 409 indefinitely. ## 2026-09-18 ### License and permission - The 403 responses now point at the right cause across the whole API. The API license is charged on the company where the credential works — the company of the record being read, or the company where the permission was granted — and no longer on any company in the database. A credential holding the permission in a company without an API license now gets "You do not have an API license" in place of "You do not have permission to perform this action". A missing license is always reported before a missing permission. ### Attachments - [Upload attachment](#tag/Attachments/paths/~1attachments/post) now accepts `person` in `resource_type`: send the `resource_id` of the target person and the attachment is stored on their record, showing up in the person query by ID and in the download. It requires, on **People**, the **Add attachments** permission — now offered on the API credential — granted on a company holding a writable API license. The rest of the upload is unchanged: one file per request, the same extensions, the same 12 MB limit and the same `Idempotency-Key`. - [Upload attachment](#tag/Attachments/paths/~1attachments/post) no longer requires permission to read the target resource: attaching to a sale only asks for the sale attachment permission. The response changes with it: a sale the credential cannot attach to now answers 403, in place of the 422 "Resource not found" that came back when the read-sales permission was missing. The 422 is now for a `resource_id` that does not exist. - The attachment upload limit of 10 requests every 3 seconds now counts every attempt, including the ones refused by authentication, permission, license, oversized file or malformed request. A run of refused attempts now reaches the 429. ### People - [Create a person](#tag/People/paths/~1people/post) is now available: it creates an individual or a legal person with address, place of birth, documents and parentage, municipal registration, tax identification, notes, bank slip fee charging, tax withholding, airline data, salesperson, promoter, labels, contacts and custom fields. The `external_id` is optional and, when provided, must be free; the CPF/CNPJ cannot belong to any person already registered. It requires the "Insert and edit" permission on People and the `Idempotency-Key` header. - In [Get person by ID](#tag/People/paths/~1people~1{id}/get), each `custom_fields` item now brings the definition `id` and no longer brings the `name`, as sales and bills already did. The name, the kind and the options come from [Get custom field by ID](#tag/Custom-Fields/paths/~1custom_fields~1{id}/get). ### Sales - The `installments` (credit card and bank slip) and `installment_period` (bank slip) fields were removed from the payments made to the **agency** in [Create sale](#tag/Sales/paths/~1sales/post). They split nothing: the sale was always created with a single entry, on the due date informed. They are still accepted in the request body and ignored, so anyone already sending them keeps creating sales the same way. - To split a payment to the agency, send **one payment per installment** in the `payments` array, all with the same payment method, bank account and payer, each with its own `due_date` and its share of the amount in `products[].payment_amount`. Each payment becomes one financial entry. - In `vendor.credit_card` the `installments` field did not change: it is still informed on creation and returned when reading the sale. - The person nodes of the sale creation (`payer`, `intermediary`, `approver`, `requester`, `supplier`, `representative`, the `person` of each passenger and the `payer` of each payment) now accept the same fields as the person registration: `business_phone`, `website`, `city_inscription`, `tax_identification_number`, `observations`, `charge_billet_fee`, `birthplace`, `additional_data`, `tax_withholding` and `airline`. Each field is accepted on the person kind it belongs to, and the payload you already send does not change. `charge_billet_fee` describes the whole registration and only applies when the sale creates the person: when the `external_id` or the document already identifies somebody, it is ignored. The person's salesperson, promoter, labels, contacts and custom fields are accepted only on [Create a person](#tag/People/paths/~1people/post). ## 2026-09-15 ### Sales - The field that carries the product document is now called `document` on the products Monde labels "Documento" on the registration screen: **Car Rental** and **Travel Package** (previously `booking_number`), **Travel Insurance** (previously `voucher_code`), **Train Ticket**, **Ground Transportation** and **Excursion** (previously `locator`). On **CVC Package** the same field is now called `receipt_number`, the "Recibo Nº" of the screen. - Products whose screen label was already another word are unchanged: **Airline Ticket** keeps `locator` ("Localizador"), **Lodging** keeps `booking_number` ("Reserva"), **Cruise** keeps `booking_number` ("Booking"), and **Other** and **Own Operation** already used `document`. - On sale creation, the passenger document is now sent in `document`, in place of `ticket_number`, on the products where Monde has that field: **Travel Insurance**, **Ground Transportation**, **Train Ticket**, **Travel Package** and **Own Operation**. `ticket_number` remains the ticket number of the **Airline Ticket** passenger, on read and on creation, and the `ticket_number` of each seat in `ground_transportations[].segments[].seats[]` is unchanged. - The product `document` now accepts 40 characters on every product, the same length Monde stores. On **Ground Transportation** and **Train Ticket** the limit was 20. - The old names are still accepted on sale creation and still come back on read, but they left the documentation, which now describes only the new name. They will be removed in a later step, giving existing integrations time to adjust. ## 2026-09-14 ### Sales - In [Create sale](#tag/Sales/paths/~1sales/post), the `travel_agent` field is now called `seller`, the same name the sale read already uses and the same term used in Monde. - In the sale query, passengers of **Other**, **Excursion** and **Own Operation** now return `document`, which Monde already stores but did not return. In those same three products, `other_fees` left the response, because they have no second per-passenger fee. **Own Operation** also dropped `rav_fee`, `rav_fee_discount` and `agency_fee`, which the product does not charge the passenger. **Car Rental** is unchanged. ## 2026-09-11 ### Products - The product `kind` now includes `excursion` and `cvc_package` (CVC package). CVC packages used to come back with no kind. - The `?kind=` filter now accepts `cvc_package` and `excursion`, and is described as a list of values: several kinds separated by commas, as in `?kind=insurance,cruise`. The call does not change. - In [Get product by ID](#tag/Products/paths/~1products~1{id}/get), the `restitutes_lei_kandir` field of each supply is now called `restitutes_kandir_law`. The value does not change. - System products now show `system: true` in the examples, and the field description was corrected: a system product cannot be deleted, but it can be edited. ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post): the commission role in the `commissions` array is now set through the `kind` field (`seller`, `intermediary` or `person`), instead of `job_title_id` (UUID). `seller` and `intermediary` record the matching system job title; `person` records none. The recipient's `external_id` remains required. - When creating sales, the passenger `ticket_number` field is now accepted for own operation, train ticket and travel package, storing the passenger's document — the same column the query returns as `document` for these products. - The `?status=` filter is now described as a list of values: several statuses separated by commas, as in `?status=opened,closed`. The call does not change. ### Accounts payable and receivable - The `?status=` filter is now described as a list of values: several statuses separated by commas, as in `?status=open,overdue`. The call does not change. ## 2026-09-10 ### Attachments - [Upload attachment](#tag/Attachments/paths/~1attachments/post) is now available: send one file per request as `multipart/form-data`, providing `resource_type` (currently `sale`) and the target sale's `resource_id`, plus `file` and an optional `description`. It validates the extension (pdf, images, office files, txt, csv), the 12 MB maximum size and the real file content. The attachment then appears in the sale query and download. Accepts an `Idempotency-Key` for safe retries. ## 2026-09-09 ### Sales - The `payer` field on each payment now takes a full person object, the same one used for the sale payer, and creates the person when it does not exist yet. Before, it only referenced an already registered person by `external_id`. Repeating the sale payer's `external_id` resolves to the same person. When omitted, the payment still inherits the sale payer. ## 2026-09-08 ### Authentication - Authentication now uses the `Bearer` scheme in the `Authorization` header. The credential is unchanged and does not need to be reissued, so integrations already in production keep working. Use `Bearer` from now on. ### Sales - In [Create sale](#tag/Sales/paths/~1sales/post), the products' `external_id` is now called `local_id`, and the same applies to each `payments[].*.products[]` item. The `local_id` is a correlation key valid only inside the request: it must be unique among the products of that sale, it is not stored and it can be reused in later sales. It only accepts text. - When reading [List sales](#tag/Sales/paths/~1sales/get) and [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get), products no longer carry `external_id`. The product identifier on read is `id`. ## 2026-09-03 ### All queries - List queries now paginate by cursor. The response carries `next_cursor` in the `pagination` node, and to ask for the next page you send it back in the `cursor` parameter, while `has_next_page` is true. See the [Pagination](#tag/Pagination) section. The `page` parameter keeps working as before for whoever already integrated, but it is no longer the published form: with `page` the cost of each page grows with how deep the walk goes, and with the cursor it does not. Whoever paginates by cursor no longer receives `page` in the `pagination` node. ## 2026-09-02 ### Supplier credentialing - Suppliers now receive their credentials on a dedicated page in Monde (the email only carries the link to it); the `client_secret` is shown a single time and is no longer emailed. The page also includes the "Connect with Monde" button snippet. - Credentialing gained an approval step: confirm your credentials at `POST /oauth/homologation` (HTTP Basic with `client_id` and `client_secret`). While pending, authorization does not work; once it answers `200`, it becomes active. See the [Supplier credentialing](#tag/Automatic-connection) section. ## 2026-09-01 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts the `payer` field on each payment (agency credit card, bank slip and bank deposit; vendor card, credit and others), referencing by `external_id` the person who actually pays that payment — typically the person financially responsible informed on the sale. On the agency side the generated account receivable uses that payer as its person; on the vendor side the payer is written on the account payable entry. When omitted, the payment inherits the payer of the sale. An `external_id` that matches no registered person returns 422. ## 2026-08-31 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts the `requester`, to record who requested the sale along with its creation. It is an individual (physical person), an optional field, resolved by `external_id` (find-or-create), like the other roles. ## 2026-08-28 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts the `commissions` array, to record manual commissions (seller, intermediary or another role) along with the sale. The recipient is referenced by `external_id`, the same one sent as the seller/intermediary; the job title goes in `job_title_id`. It is only accepted when `status` is `closed`; a commission with an intermediary job title requires the sale to have an intermediary. ## 2026-08-27 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now returns 422 when a sale person's (payer, supplier, passenger) CPF/CNPJ already belongs to another person in the database, with the error on the `cpf_cnpj` field. Previously the document conflict raised an internal error (500). ## 2026-08-26 ### Supplier credentialing - Suppliers approved by Monde can now create sales on the v3 API on behalf of an agency via OAuth 2.0 (Authorization Code + PKCE), without the agency sharing a credential password. See the step by step (authorization at the root URL, exchanging the code for a token and using the Bearer on the fixed v3 URL) in the [Supplier credentialing](#tag/Automatic-connection) section. The agency can revoke access at any time and revocation invalidates the token immediately. ## 2026-08-24 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now inherits the included services registered on the product. When the sale product's `included_services` field is not sent, the product's registered text is stored; when it is sent, the provided text is appended to the registered one. Previously the sale product field kept only what the request sent. ## 2026-08-21 ### Sales - [List sales](#tag/Sales/paths/~1sales/get) now filters by `number` (one per request): pass the number shown in the app and the query returns the matching sale without translating number into UUID first. A non-integer number returns 400. - [List sales](#tag/Sales/paths/~1sales/get) now filters by `updated_since` (ISO 8601 date or date-time, e.g. `2026-08-01` or `2026-08-01T14:30:00`; the Brasília time zone is assumed when no zone is given): it returns sales updated at or after that instant, to reprocess only what changed since the last query, even within the same day. An invalid value returns 400. ### Travels - [List travels](#tag/Travels/paths/~1travels/get) now filters by date with `date_field` + `date_from`/`date_to`: choose the date in `date_field` (`start_date` or `end_date`, the trip start and end computed from the linked sales) and provide the closed inclusive range in `date_from`/`date_to` (ISO `YYYY-MM-DD`, both optional). `date_field` is required when any date is given; an invalid date format, an inverted range (`date_from` greater than `date_to`) or a `date_field` outside the list return 400. A travel with no linked sales has no computed dates and never shows up in a date range. ### Accounts payable and receivable - [List accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get) now filters by `number` (one per request): pass the bill number shown in the app. Installment bills carry a parcel suffix (e.g., `362-1`), so provide the number exactly as shown. - [List accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get) now filters by date with `date_field` + `date_from`/`date_to`: choose the date in `date_field` (`issue_date`, `due_date` or `settlement_date`) and provide the closed inclusive range in `date_from`/`date_to` (ISO `YYYY-MM-DD`, both optional). `date_field` is required when any date is given; an invalid date format, an inverted range (`date_from` greater than `date_to`) or a `date_field` outside the list return 400. Filtering by `settlement_date` returns only settled bills (unsettled ones have no settlement date and fall outside the range); since the default status (`open`, `overdue`) excludes settled bills, include `settled` in the `status` parameter when using `settlement_date`. ## 2026-08-20 ### Sales - [Create a sale](#tag/Sales/paths/~1sales/post) now accepts the `status` field. It still defaults to `opened`; send `closed` to create the sale already closed. Closing honors every existing rule (no pending balance, and on a consolidator install the intermediary is required) and requires the close-sale permission on the credential. If the sale cannot be closed, the whole creation is rejected with 422 and nothing is persisted. ## 2026-08-17 ### Sales - [List sales](#tag/Sales/paths/~1sales/get) now filters by date with `date_field` + `date_from`/`date_to`: choose the date in `date_field` (`sale_date`, `departure_date` or `return_date`) and provide the closed inclusive range in `date_from`/`date_to` (ISO `YYYY-MM-DD`, both optional). It replaces `period_start`/`period_end`, which were removed. `date_field` is required when any date is given; an invalid date format, an inverted range (`date_from` greater than `date_to`) or a `date_field` outside the list return 400. - In the sale response, `period_start` and `period_end` became `departure_date` and `return_date` — same values (trip start and end, computed from the earliest and latest product dates). ## 2026-08-14 ### Sales - [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) now brings the `excursions` array. - In sale creation, the passenger fee field (`fees`) is now accepted on every product with passengers — travel insurance, cruise, hotel, ground transportation, car rental, train ticket, travel package, and own operation —, matching what the read already uses. `rav_fee`, `rav_fee_discount` and `agency_fee` are now accepted on the same products, except own operation, whose passenger only has amount and fee; `other_fees` (hotel, car rental, travel package) and `tip` (cruise) are now accepted as well. On the products that had a product-specific name for the main fee field — `service_fee` (hotel and ground transportation) and `booking_fee` (train ticket) —, the old names are still accepted for now, but are no longer documented in favor of `fees`. - Fixed `totals.balance`: sales created through [Create sale](#tag/Sales/paths/~1sales/post) always came back with a `0` balance on read, even when there was a real open balance. It now reflects the correct balance on both the list query and the query by ID. ### People - [Get person by ID](#tag/People/paths/~1people~1{id}/get) gained the `kandir_law` node: per-product tax withholding (amount, boarding fee, DU/RAV fee, and service fee, each broken down by tax — IR, CSLL, PIS, and COFINS — plus the total, for both domestic and international regimes), with the reference to the product. Only exists for companies; comes back `null` for individuals. - `city_inscription` and `tax_identification_number` moved back to the person's top level. They were inside `additional_data`, which only exists for an individual person, but both fields are legal-person data. ### Invoice rules - In `closing.period_kind`, the value `separate` became `standalone`. This closing cadence leaves each sale in its own invoice, and `standalone` is how the API already names that same concept in the accounts payable/receivable `kind`. ### Accounts payable/receivable, and invoices - The two fields that still came in the old format since the 2026-08-13 entry caught up with the code: in [Get invoice by ID](#tag/Invoices/paths/~1nfs~1{id}/get), items no longer bring `id`; in [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get), `credit_card_items[].id` gave way to the `movement` reference. ### Naming - The [Products](#tag/Products/paths/~1products/get) and [Tasks](#tag/Tasks/paths/~1tasks/get) schemas now follow the rest of the API's convention: the list schema got the `_summary` suffix, and the plain name became the get by ID schema. ### Naming - `registered_at` was renamed to `created_at` in [sales](#tag/Sales/paths/~1sales/get), [accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get), [invoices](#tag/Invoices/paths/~1nfs/get), [invoice (NF) rules](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules/get), [tasks](#tag/Tasks/paths/~1tasks/get), [travels](#tag/Travels/paths/~1travels/get), [sellers](#tag/Sellers/paths/~1sellers/get), [people](#tag/People/paths/~1people/get), [CVC statement](#tag/CVC-Statement/paths/~1cvc_statements/get) and [logs](#tag/Logs/paths/~1logs/get) — the more common name for this concept across REST APIs. - `registered_by` was renamed to `created_by`, for the same reason, in [sales](#tag/Sales/paths/~1sales/get), [accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get), [invoices](#tag/Invoices/paths/~1nfs/get), [invoice (NF) rules](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules/get), [tasks](#tag/Tasks/paths/~1tasks/get), [travels](#tag/Travels/paths/~1travels/get), [sellers](#tag/Sellers/paths/~1sellers/get), [people](#tag/People/paths/~1people/get) and [CVC statement](#tag/CVC-Statement/paths/~1cvc_statements/get). ## 2026-08-13 Read pattern adjusted across several endpoints, in the same direction as the 2026-08-11 entry: the list brings the record's own fields, and the associations — references and data from other entities — stay in the get by ID. - The [rate limit](#tag/Rate-limits) changed from 60 to **10 requests every 3 seconds** per origin IP address. ### People - [List people](#tag/People/paths/~1people/get) now brings every field of the person itself, which previously existed only in the get by ID: `rg_ie`, `passport_number`, `passport_expiration_date`, `foreigner`, `foreign_identity_document`, `business_phone`, `website`, `cvc_code`, `observations`, `charge_billet_fee`, `registered_at` and the `additional_data`, `last_contacts`, `tax_withholding` and `airline` nodes. - `gender` and `birthdate` were added, in both reads. - [Get person by ID](#tag/People/paths/~1people~1{id}/get) kept what is an association: `birthplace`, `seller`, `promoter`, `registered_by`, `contacts`, `labels`, `custom_fields`, `attachments` and `credit_cards`. - Contacts and credit cards no longer bring `id`: they are data that only exist inside the person. - In the credit cards, `masked_number` became `last_digits` and now brings only the last four digits, without the mask. ### Accounts payable and receivable - [List accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get) now brings `billet`, `check` and `card`, which previously existed only in the get by ID. They are data of the entry itself. - In `credit_card_items`, the `id` — which was the account movement identifier, not the line's — gave way to the `movement` reference, resolved in [Get account movement by ID](#tag/Account-movements/paths/~1account_movements~1{id}/get). ### Invoices - The items in [Query invoices by ID](#tag/Invoices/paths/~1nfs~1{id}/get) no longer bring `id`. The item has no endpoint of its own, and the identifier resolved nothing. ### Cities, categories, accounts and cards - `state` and `country` left [List cities](#tag/Cities/paths/~1cities/get) and stayed in [Get city by ID](#tag/Cities/paths/~1cities~1{id}/get). - `group` left [List categories](#tag/Categories/paths/~1categories/get) and stayed in [Get category by ID](#tag/Categories/paths/~1categories~1{id}/get). - `bank` left [List accounts and cards](#tag/Accounts-and-Cards/paths/~1accounts/get) and stayed in [Get account or card by ID](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get). ### Logs - `kind` now declares its possible values: `insertion`, `edition`, `deletion`, `custom` and `export`. There are no others. - The `person` description now points to [Get person by ID](#tag/People/paths/~1people~1{id}/get), the endpoint that resolves the reference. ### Sales, products, tasks and invoice (NF) rules - [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) now brings the `travel` reference, resolved in [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get). The link existed only in the opposite direction. - [Products](#tag/Products/paths/~1products/get) now brings `active`, and [Tasks](#tag/Tasks/paths/~1tasks/get), `deleted`. - In the invoice (NF) rules, inside `payer_rule`, `supplier_rule` and `representative_rule`, `recipient` now comes before `revenues` and `discounts`. ## 2026-08-12 - [List sales](#tag/Sales/paths/~1sales/get) gained the `people_id` filter: it returns the sales in which the given person participates in any role (payer, seller, intermediary, requester, approver, promoter, passenger, supplier, representative or the person who registered the sale). It accepts multiple comma-separated identifiers — a sale matches when any of the people participates. - New endpoints to read the custom field definitions: [List custom fields](#tag/Custom-Fields/paths/~1custom_fields/get) and [Get custom field by ID](#tag/Custom-Fields/paths/~1custom_fields~1{id}/get). The list brings the custom fields by resource (`sales`, `travels`, `people`, `bills` and `tasks`), with the identifier, the name, the kind, whether it is required, whether it is active and the registered options of list-kind fields, and accepts the `resource` filter; the get by ID resolves a field definition from its id. The definitions are not scoped by company. The identifier of each field is numeric (not a UUID like in the rest of the API). - The `pagination` node no longer carries `total` and `total_pages`, and now carries `has_next_page`. To walk through a whole query, request the next page while `has_next_page` is true. The request does not change: `page` and `size` work as before. Counting the total required walking every record matching the filter on each request, which on large databases cost more than fetching the page itself. ## 2026-08-11 Every read now comes in two forms: a lean **list query**, for extracting volume, and a **query by ID**, with the complete record. Associations are no longer embedded: they come as a reference carrying only the identifier. Each reference description points to the endpoint that resolves it, and references and collections appear only on the query by ID. The changes are grouped by endpoint. The new queries by ID are documented before they exist: each one carries the **In development** badge until the code ships. The list queries that already existed remain in **Beta**, available for use. ### Sales - [List sales](#tag/Sales/paths/~1sales/get) returns only the scalar fields of the sale plus the totals. The products, the payments, the commissions, the attachments, the custom fields and the `financial` node left the list and remain in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get), which is also where the references live: payer, seller, company, intermediary, requester, approver, promoter, operation and whoever registered it. - `sale_id` became `id`. `travel_agent` became `seller`, and the reference points to [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) — the `id` is the same as before, because the seller shares the identifier of the person; for the person data, use that same `id` on [Get person by ID](#tag/People/paths/~1people~1{id}/get). - Three fields were dropped: `company_identifier`, which carried the taxpayer ID copied from the company and gives way to the `company` reference (it is still required on creation), `totals.payments`, and `role` on the commissions. - On commissions, `value`, `retained_value` and `leftover` became `amount`, `retained_amount` and `balance`; on the totals, `final_value` became `final_amount`; on vendor transfers, `value` became `amount`. - **Payments changed shape.** `payments` is no longer a list: it is now an object with `agency` and `vendor`. Under `agency`, `bills` and `refunds` are reference lists, resolved by [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) and [Get refund by ID](#tag/Refunds/paths/~1refunds~1{id}/get); `credit`, `retained_by_intermediary` and `legacy` come embedded, because they generate no bill. Under `vendor` there is one list per method: `credit_card`, `check`, `credit` and `others`. - As a result, the per-method nodes on the agency side are gone (`cash`, `check`, `credit_card`, `debit_card`, `bank_slip`, `bank_deposit`, `others`, `custom` and `invoice`). All of them generate a bill, and it is the bill that carries the payment method, the account, the settlement, the billet and the products covered. A bill settled through several methods appears once, and each settlement comes in `movements`, on the bill itself. - Each `products` item now carries `amount` and the `sale_product` reference, replacing `external_id` and `payment_amount`. Every embedded payment gained `payer`, which may differ from the payer of the sale. - In the `financial` node, `vendor` became `vendor_bills` and `bills` became `standalone_bills` — both now reference lists to bills. The items and amounts come from the bill itself. - The sale `operation` field is the reference to the own operation on the header, and the detail of the own-operation product lives in the `operations` collection, alongside the other products. In the 2026-08-07 entry that field started returning the whole product when a line existed; it is now always a reference. - Each sale product now carries its own `id`, which makes the `sale_product` reference of the bill, the invoice, the refund and the CVC statement resolvable. On the `others`, `operation` and `cvc_package` types, `product_name` and `product_with_passengers` were dropped and the `product` reference was added; the other eight types have a single system product each, and the array name already identifies it. - `currency` is an ISO code (text) both on creation and on read; the full `currency` object is now exclusive to [Currencies](#tag/Currencies/paths/~1currencies/get). On sale products, `currency` and `exchange_rate` are creation fields: on read they always return BRL and 1, and the amounts come converted to Brazilian Real. - In `custom_fields`, each field now carries the `id` of the definition and no longer carries `name`. The name, the kind and the choices come from the custom field definitions query. - The response of [Create sale](#tag/Sales/paths/~1sales/post) is now the same as the query by ID. The request body does not change. - [Create sale](#tag/Sales/paths/~1sales/post) now accepts the optional `description` field on agency payments (credit card, bank slip and bank deposit). When provided, the text is saved on the financial entry; when omitted, "Pagamento venda" is still used. Maximum of 60 characters. ### Accounts payable and receivable - [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) gained the `check` and `card` blocks, with the check and card data recorded on it. They used to appear only on the sale, and were unreachable while the payment was not settled. - On `kind`, `sale_separate` and `vendor_separate` became `sale_standalone` and `vendor_standalone`. The `kind` filter takes the new values. - In `custom_fields`, each field now carries the `id` of the definition and no longer carries `name`, as on the sale. ### People - New [Get person by ID](#tag/People/paths/~1people~1{id}/get), with the contacts, labels, custom fields, attachments and credit cards. [List people](#tag/People/paths/~1people/get) is now lean. - The city of the address, the birthplace, the seller, the promoter and whoever registered the record come as references. - `external_id` is now documented on the query: the response already carried the identifier you assigned to the person, but it was not documented. It comes null when the querying credential has no external identifier for that person. - [List people](#tag/People/paths/~1people/get) now accepts filters by `name`, `cpf_cnpj`, `passport_number`, `phone`, `kind` (`individual` or `company`), `code` and `email`. All are optional and combinable (logical AND between them): `name`, `passport_number` and `email` match by substring, case- and accent-insensitive; `cpf_cnpj` and `phone` accept digits only (formatting is ignored) and `code` is an exact match. With no filters, the behavior is the same as before. ### Products - New [Get product by ID](#tag/Products/paths/~1products~1{id}/get), with the supplies in `supplies`: each one carries the supplier, the commission data and the representatives. - On supplies, `commission_value` became `commission_amount`, and `commission_type` now takes `amount` instead of `value`. ### Tasks - New [Get task by ID](#tag/Tasks/paths/~1tasks~1{id}/get), with the history in `history` (comments and changes) and the custom fields. - `category` is no longer text: it became a reference, resolved by [Get task category by ID](#tag/Task-Categories/paths/~1task_categories~1{id}/get). ### Travels - New [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get), with references to the linked sales and passengers. The per-passenger amounts belong to each sale and come from the sale endpoint. - `client` became `customer`, and `seller` now points to the sellers endpoint. ### CVC statement - `seller` now points to [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get). ### Quotes - New [Get quote by ID](#tag/Quotes/paths/~1quotes~1{id}/get). `status` was dropped: it is derivable from `active` and `valid_until`, both still in the response. ### Attachments - `attachment_id` became `id`. ### Other registries - These now have a lean list query and a query by ID: [sellers](#tag/Sellers/paths/~1sellers~1{id}/get), [accounts and cards](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get), [cost centers](#tag/Cost-Centers/paths/~1cost_centers~1{id}/get), [cities](#tag/Cities/paths/~1cities~1{id}/get), [categories](#tag/Categories/paths/~1categories~1{id}/get), [payment methods](#tag/Payment-Methods/paths/~1payment_methods~1{id}/get), [invoice (NF) rules](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules~1{id}/get), [billing rules](#tag/Billing-Rules/paths/~1invoice_rules~1{id}/get), [integrations](#tag/Integrations/paths/~1integrations~1{id}/get) and [currency by code](#tag/Currencies/paths/~1currencies~1{code}/get). - On sellers, the corresponding person now comes in the `person` field. - Still nested, with the full data: the state and the country of the city, the bank of the account, and the group of the category. They have no registry of their own in v3, so there is no endpoint to resolve them. The state gained `name`, and the country gained `code` (ISO 3166-1 alpha-2) and `code_3` (alpha-3). ### New registries on the read side - [Labels](#tag/Labels/paths/~1labels/get) and [task categories](#tag/Task-Categories/paths/~1task_categories/get), with a list query and a query by ID. They are the targets of the `labels` reference on the person and the `category` reference on the task. ## 2026-08-10 - [Create sale](#tag/Sales/paths/~1sales/post) now accepts **custom fields** in the `custom_fields` field (an array of `{id, value}`). The `id` is the same returned by [List custom fields](#tag/Custom-Fields/paths/~1custom_fields/get); the `value` must match the field kind (integer for numeric, number for currency, ISO 8601 date, text for the others). ⚠️ Active required fields of the sales module become mandatory: the create returns **422** if one of them is missing a value. - On the sale and bill reads, each `custom_fields` item is now `{id, value}`: it brings the field `id` (the reference) and the `value`, and no longer brings the `name`. The name, the kind and the rest of the definition are obtained from [Get custom field by ID](#tag/Custom-Fields/paths/~1custom_fields~1{id}/get) or from [List custom fields](#tag/Custom-Fields/paths/~1custom_fields/get), so the consumer always reads the reference and not a projected value that can become stale. ## 2026-08-07 - [Create sale](#tag/Sales/paths/~1sales/post) now accepts the **own operation** product in the `operation` field (a single object; at most one per sale). The product is informed by `product_id` and, depending on its configuration, the values go by `passengers` or by `quantity` × `unit_price` (with `unit_fee` and the hidden service fee `agency_fee`, a single line-level value); the supplier is the sale's own company. - On read ([List sales](#tag/Sales/paths/~1sales/get) and [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get)), the `operation` field now brings the full detail of the own operation product; it previously brought only `id` and `name`. - New endpoints to read the change history: [List logs](#tag/Logs/paths/~1logs/get) and [Get log by ID](#tag/Logs/paths/~1logs~1{id}/get). The list brings the recorded action, the origin, the description of the change and when it was recorded, with filters by author, audited record, action and origin; the get by ID adds the references to the author and to the audited record. The history is not scoped by company. ## 2026-08-04 - The items of [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) changed: `customer_items` and `vendor_items` were replaced by a single `items`, which brings every item of the entry, including sale payment items, which previously came out in no array at all. The item now brings only its own columns (`description`, `cost_center`, `checked`, `amount`) plus the `sale`, `sale_product` and `cvc_statement` references; the sale product data was removed and its source is [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get). - Each `credit_card_items` line now brings `id` and the `bill` reference, and lost `description` and `person`. The `id` is the account movement's, so it can be looked up with [Get account movement by ID](#tag/Account-movements/paths/~1account_movements~1{id}/get). - Each `commissions` line gained the `person` reference, and the `leftover` field was renamed to `balance`. - The entry lost `sale_number`, `balance`, `status`, `overdue_days` and `settled_late`, and gained `canceled`, `checked`, `invoice_closed`, `system_generated` and `recurrence_group_id`. The get by ID gained the `sale` and `invoice_rule` references. In the `status` filter, `paid` became `settled`. ## 2026-07-31 - New read endpoints for the CVC statement: [Query CVC statement](#tag/CVC-Statement/paths/~1cvc_statements/get) and [Query CVC statement by ID](#tag/CVC-Statement/paths/~1cvc_statements~1{id}/get). The list brings the receipt number, the movement, sale, cancellation, boarding and return dates, the product name, the package name, the totals, the commissions, the deposit, the balances and the imported, edited, checked and deleted marks; the get by ID adds the movement kind and the references to company, contractor, seller, intermediary, sale, sale product, NF and whoever registered it. A deleted receipt stays out of the list but remains reachable by ID. Scoped by company. - New read endpoints for invoices: [Query invoices](#tag/Invoices/paths/~1nfs/get) and [Query invoices by ID](#tag/Invoices/paths/~1nfs~1{id}/get). The list brings numbering, status, operation nature, dates, amounts, the recipient data stored on the invoice with the reference to their city, the withholdings and taxes and the NFS-e data, with status and issue period filters; the query by ID adds the invoice items and the references to person, company, sale product, sale and who registered or canceled it. Scoped by company. - New read endpoints for refunds: [Query refunds](#tag/Refunds/paths/~1refunds/get) and [Query refunds by ID](#tag/Refunds/paths/~1refunds~1{id}/get). They bring the refund side (customer or supplier), the amount, the description, the issue and due dates, and the individual view adds the references to sale, sale product, person, company and account payable or receivable, scoped by company. ## 2026-07-29 - New read endpoints for account movements: [List account movements](#tag/Account-movements/paths/~1account_movements/get) and [Get account movement by ID](#tag/Account-movements/paths/~1account_movements~1{id}/get). The list brings date, amount, direction (credit or debit), note and the check and card data; the get by ID adds the references to account, payment method, bill, credit card invoice and the account on the other side of the transfer. Scoped by company. ## 2026-07-28 - New read endpoints for accounts payable and receivable: [List accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get) and [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get). They bring identification, values, status, billet, recurrence, categories, apportionments, settlement movements, invoice items (customer, vendor or credit card), commissions, attachments and custom fields, scoped by company. ## 2026-07-17 - The [List sales](#tag/Sales/paths/~1sales/get) and [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoints now include the sale attachments in the `attachments` field: each attachment carries `id`, `description`, `extension`, `content_type` and `download_url`, with the content accessible through a temporary download link. ## 2026-07-16 - The [List sales](#tag/Sales/paths/~1sales/get) and [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoints now return the operation in the `operation` field (an object with `id` and `name`); previously only the identifier was returned in `operation_id`. ## 2026-07-15 - The [List sales](#tag/Sales/paths/~1sales/get) and [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoints now include the sale commissions in the `commissions` field: the split per person and role (seller, intermediary and others), with commission amount, retained amount and remaining balance. ## 2026-07-14 - The [List sales](#tag/Sales/paths/~1sales/get) and [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoints now include the sale financial data in the `financial` field: financial notes, vendor payouts, and the accounts payable and receivable entries linked to the sale. ## 2026-07-10 - New read endpoints for the system master data: [cabins](#tag/Cabins/paths/~1cabins/get), [categories](#tag/Categories/paths/~1categories/get), [cost centers](#tag/Cost-Centers/paths/~1cost_centers/get), [cities](#tag/Cities/paths/~1cities/get), [accounts and cards](#tag/Accounts-and-Cards/paths/~1accounts/get), [payment methods](#tag/Payment-Methods/paths/~1payment_methods/get), [integrations](#tag/Integrations/paths/~1integrations/get), [currencies](#tag/Currencies/paths/~1currencies/get), [ships](#tag/Ships/paths/~1ships/get), [quotes](#tag/Quotes/paths/~1quotes/get), [people](#tag/People/paths/~1people/get), [invoice (NF) rules](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules/get), [billing rules](#tag/Billing-Rules/paths/~1invoice_rules/get), [tasks](#tag/Tasks/paths/~1tasks/get), [sellers](#tag/Sellers/paths/~1sellers/get) and [travels](#tag/Travels/paths/~1travels/get). - name: Automatic connection description: " Besides the credential generated by the agency, a partner approved by Monde can access the v3 API on behalf of a travel agency, via OAuth 2.0 (Authorization Code + PKCE), without the agency sharing a credential password. What the partner can do is set by Monde on approval, and the agency sees and approves that list when it authorizes.

In short

  1. The agency clicks "Connect with Monde" in your system, signs in to Monde and authorizes your system.
  2. Monde sends the agency back to your redirect_uri with a code.
  3. Your backend exchanges the code for a token and uses the token to call the API on behalf of that agency.
The flow is OAuth 2.0 authorization (Authorization Code + PKCE). It is not single sign-on (SSO) or OpenID Connect: the token grants access to the agency's API and does not identify the person who authorized it. Monde returns no id_token and no user data.

Every endpoint in this section lives at https://web.monde.com.br.

Signup and credentials

  • Sign the partner up at https://web.monde.com.br/partners/signup and confirm the email. Monde reviews the signup, sets the permissions and approves it.
  • On approval, Monde emails you a link to your automatic connection page. The 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.
  • Keep the client_secret on your backend only. It never goes to the browser or to the user's app.

1. Enable the automatic connection

In the partner area (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.
  • Each partner has a single 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.
  • Once enabled, you can change both URLs, but not leave them blank.

2. Authorization

On each connection attempt, generate a new 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
  • Do not send scope: what the partner can do are the permissions set on approval.
  • If the 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.
The agency logs in, picks the company and consents. Only an agency administrator can authorize.

3. Return to the redirect_uri

When the agency approves, the browser goes back to the redirect_uri with the code and the same state you sent:
YOUR_REDIRECT_URI?code=agencia%7CujES3JCJylJRoM3j_kGeavaD2hFqz2oqw1Lazq_u0rs&state=STATE
When 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
  • Compare the state with the one in the session. If it differs or is missing, discard the response.
  • The 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.
  • Nothing comes back to the 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.

"Connect with Monde" button

Put a button on your platform in the "Sign in with Google" style, with the label "Connect with Monde". The 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:

1. Negative (blue background)

Monde Connect with Monde
<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>

2. Colored (white background)

Monde Connect with Monde
<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>

3. Text only

Connect with Monde
<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>

4. Exchange the code for a token

Do the exchange on your backend, never in the browser. The body goes as 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.

5. Using the v3 API

The v3 API URL does not change: call https://web.monde.com.br/api/v3 with the token in the Authorization header (the token already carries the agency).
Authorization: Bearer YOUR_ACCESS_TOKEN
To 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.
  • The partner only reaches the company the agency picked, with the permissions it approved. In sales, accounts payable and receivable, tasks and travels, each permission reaches only what the partner created, and listing and getting require the "View" permission of the resource also for what it created; access to records of other origins is an exception granted by Monde on approval, shown highlighted on the consent screen. Permissions over what applies to the whole agency are exceptions too, since whoever writes reaches what the agency registered: creating and editing custom fields; creating, editing and deleting task categories, labels, roles, billing rules, invoice (NF) rules, products (with their suppliers and representatives), accounts and cards (and reopening their cash), financial categories, cost centers, payment methods and payment method details; writing, deleting, issuing and copying invoices and generating invoices, since an invoice is a tax document of the agency; closing and paying commissions, which reach those of every seller; reading, creating, updating, deleting and restoring CVC statement receipts; the whole CVC Master Statement, CVC Statement Closing, CVC Master Statement Closing and CVC Deposit Check, including reading them; and the CVC statement import, which writes the sales and registers of the company that come from CVC, of any origin.
  • The connection needs no separate license for any permission. Each resource's rules still apply: a read-only company takes no writes, and Guides require the Monde Pro license.
  • The created sale comes back in full in the POST /sales response.
  • The agency can delete the connection at any time; access stops immediately and the API starts answering 401.

6. Disconnect (revocation)

When the user disconnects on your platform, or if the token leaks, revoke the token from your backend:
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.

7. Connection started by the agency

Optional. The default path is the Conectar com o Monde button (steps 2 to 4), which every integration needs. Implement this step only after the button, if you want to offer the connection on the Monde Web Integrations screen as well. It does not replace the button. The agency can also connect with the partner without leaving Monde: on the Integrations screen, an administrator picks the partner and the company, sees the permissions and confirms. It is not an OAuth flow and does not go through the redirect_uri: your backend polls the new connections and receives each one already with its token, with nobody copying a key.
  • To be listed on the Integrations screen, check Connection started by the agency in the partner area (https://web.monde.com.br/partners/integration), only after the polling below is implemented. The automatic connection must be enabled (step 1).
  • The agency gives its consent inside Monde, with the same permissions as in step 2. The connection through the authorization (steps 2 to 4) keeps working; both coexist.
Poll the new connections from your backend from time to time (we recommend every 1 to 5 minutes), with the 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 } }
  • Each connection is delivered only once. Store the 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.
  • The 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.
  • Each poll delivers up to 50 connections, oldest first, in the 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.
  • The connection waits for your poll for 72 hours. After that it is no longer delivered, and the integration is deleted in the agency account, which has to connect again. A connection the agency deletes before your poll is not delivered either.
  • The response comes with 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.
" components: parameters: authorization_header: name: Authorization in: header required: true description: Access credential provided by the travel agency, in the Bearer scheme. schema: type: string example: Bearer bW9uZGV8dXNlcjpwYXNzMTIz content_type_json: name: Content-Type in: header required: true description: Request content type. Must be application/json. schema: type: string enum: - application/json example: application/json content_type_multipart: name: Content-Type in: header required: true description: Request content type. Must be multipart/form-data. schema: type: string enum: - multipart/form-data example: multipart/form-data idempotency_key_header: name: Idempotency-Key in: header required: true description: Client-generated idempotency key (UUID v4). See the [Idempotency](#tag/Idempotency) section for more details. schema: type: string format: uuid pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" example: 550e8400-e29b-41d4-a716-446655440000 cursor: name: cursor in: query required: false schema: type: string description: Cursor of the next page, exactly as it came in `next_cursor`. Without it, the query starts at the first page. example: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 size: name: size in: query required: false schema: type: integer minimum: 1 maximum: 50 default: 20 description: Number of records per page example: 10 schemas: entity_reference: type: object description: Reference to a related record. properties: id: type: string format: uuid description: Identifier of the referenced record. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 required: - id numeric_entity_reference: type: object description: Reference to a related record. properties: id: type: integer description: Identifier of the referenced record. example: 42 required: - id person: type: object properties: email: type: - string - 'null' description: 'Email address.

Example: "contact@example.com".' maxLength: 200 phone_number: type: - string - 'null' description: 'Phone number, without dashes or spaces. For international numbers, use + and the country code.

Examples: "1134567890", "+33170180123".' maxLength: 20 mobile_number: type: - string - 'null' description: 'Mobile phone number, without dashes or spaces. For international numbers, use + and the country code.

Examples: "11934567890", "+447911123456".' maxLength: 20 address: type: - object - 'null' description: Address. properties: postal_code: type: - string - 'null' description: 'Postal code, without dashes.

Example: "04078011".' maxLength: 8 street: type: - string - 'null' description: 'Street name.

Example: "Avenida Divino Salvador".' maxLength: 50 street_number: type: - string - 'null' description: 'Building number.

Example: "5000".' maxLength: 10 neighborhood: type: - string - 'null' description: 'Neighborhood.

Example: "Planalto Paulista".' maxLength: 30 additional_info: type: - string - 'null' description: 'Additional address information, like building, apartment or floor.

Example: "Casa 2".' maxLength: 20 city_ibge: type: - string - 'null' description: 'IBGE city code. When provided, it defines the city, which must be among the cities the agency can use ([List cities](#tag/Cities/paths/~1cities/get)); the name is not checked, and the state and country, if sent, must match the city.

Example: "3550308".' minLength: 7 maxLength: 7 city_name: type: - string - 'null' description: ' City name. Without `city_ibge`, the city is looked up by name, ignoring accents and case, among the cities the agency can use ([List cities](#tag/Cities/paths/~1cities/get)): in Brazil, in the state of `state_code`; abroad, in the country of `country_code`. Abroad with `state_code`, the city is first looked up as "Name, subdivision", the form in which the API used to register cities. The city is not registered: a name that matches none is refused (422).
  • **Required** when the `country_code` field is present.
Example: "São Paulo". ' maxLength: 50 state_code: type: - string - 'null' description: ' Code or acronym representing the state (or another subdivision of the country, such as a province, district, or region).
  • **Required** when the `country_code` field is equal "BR".
Examples: "SP", "RJ", "NY", "CA", "FL", "BAV", "VIC". ' maxLength: 3 country_code: type: - string - 'null' description: ' Country code in the ISO-3166-1 alpha-2 standard.
  • **Required** when the `city_name` field is present.
Examples: "BR", "US", "GE", "AU". ' minLength: 2 maxLength: 2 city_inscription: type: - string - 'null' description: City inscription maxLength: 15 observations: type: - string - 'null' description: Person observations charge_billet_fee: type: boolean description: Indicates whether the bank slip fee is charged to the person default: false person_references: type: object properties: seller: description: Seller responsible for the person "$ref": "#/components/schemas/entity_reference" promoter: description: Person promoter (operator plans) "$ref": "#/components/schemas/entity_reference" labels: type: array description: Labels assigned to the person. items: "$ref": "#/components/schemas/entity_reference" contacts: type: array description: People linked to this registration as contacts. Each person must already be registered and cannot repeat in the list. items: "$ref": "#/components/schemas/person_contact" custom_fields: type: array description: Custom fields of people, defined by the agency. Send each field by `id` and `value`. The active fields marked as required must come filled in. items: "$ref": "#/components/schemas/person_custom_field" credit_cards: type: array description: Credit cards of the person, individual or company. The number and the security code are stored encrypted and never come back in the response, which brings only the last four digits. The card is valid until the last day of the expiration month, and an expired card is refused. Requires the "View financial tab" and "Register credit card" permissions on people. items: "$ref": "#/components/schemas/person_credit_card_write" cost_centers: type: array description: 'Cost centers of the corporate client: its departments accepted in the cost center of the passenger and of the invoice item when it is the payer. They are not the cost centers of the agency, from `/cost_centers`. Only a company has cost centers, and a name does not repeat in the list, regardless of case.' items: "$ref": "#/components/schemas/person_cost_center_write" kandir_law: type: array description: Kandir law withholdings (Brazilian law 9,430/1996, art. 64) of the company, one per product, in the same format as the get by ID. Only the active Airfare, Travel Insurance and Ground Transportation products accept a withholding. A percentage left out is zero, and a negative one is refused. The `total` of each group is the sum of IR, CSLL, PIS and COFINS and is not informed. Requires the "View financial tab" permission on people. items: "$ref": "#/components/schemas/person_kandir_law_write" person_birthplace: type: - object - 'null' description: 'Place of birth: the city where the person was born. Provide the IBGE code or, when it is not available, the city name with state and country. Without the IBGE code, the city is looked up by name, ignoring accents and case, among the cities the agency can use: in Brazil, in the state; abroad, in the country. The city is not registered: a name that matches none is refused (422).' properties: city_ibge: type: - string - 'null' description: 'IBGE code of the city of birth. When provided, it defines the city, which must be among the cities the agency can use ([List cities](#tag/Cities/paths/~1cities/get)); the name is not checked, and the state and country, if sent, must match the city.

Example: "3550308".' minLength: 7 maxLength: 7 city_name: type: - string - 'null' description: |- Name of the city of birth.
  • **Required** when the `country_code` field is present.
Example: "São Paulo". maxLength: 50 state_code: type: - string - 'null' description: |- Code or abbreviation of the state of birth (or another country subdivision).
  • **Required** when the `country_code` field equals "BR".
Examples: "SP", "RJ", "NY". maxLength: 3 country_code: type: - string - 'null' description: |- Country of birth code in the ISO-3166-1 alpha-2 standard.
  • **Required** when the `city_name` field is present.
Examples: "BR", "US", "PT". minLength: 2 maxLength: 2 person_additional_data: type: - object - 'null' description: Additional data of the individual person. Absent (null) for legal person. properties: marital_status: type: - string - 'null' description: |- Marital status (individual person).
  • single
  • married
  • separated
  • divorced
  • widowed
  • civil_union
enum: - single - married - separated - divorced - widowed - civil_union - rg_emitter: type: - string - 'null' description: RG issuing agency maxLength: 10 rg_issue_date: type: - string - 'null' format: date description: RG issue date birth_certificate: type: - string - 'null' description: Birth certificate maxLength: 50 mother_name: type: - string - 'null' description: Mother name maxLength: 50 person_tax_withholding: type: - object - 'null' description: Tax withholdings of the legal person. Absent (null) for individual person. properties: iss: type: boolean description: Indicates ISS withholding (legal person) default: false ir: type: boolean description: Indicates IR withholding (legal person) default: false pis_cofins_csll: type: boolean description: Indicates PIS/COFINS/CSLL withholding (legal person) default: false person_airline: type: - object - 'null' description: Airline data of the legal person (suppliers). Absent (null) for individual person. properties: code: type: - string - 'null' description: Airline code (suppliers). It is unique among people — on registration, a code another person already carries is refused. maxLength: 3 number: type: - string - 'null' description: Airline number (suppliers) maxLength: 3 person_contact: type: object required: - person properties: role: type: - string - 'null' description: Role registered on the link, describing who the contact is maxLength: 50 person: description: Person that becomes a contact of this registration. "$ref": "#/components/schemas/entity_reference" person_custom_field: type: object required: - id properties: id: type: integer description: Identifier of the custom field definition. The name, the kind and the choices of the definition come from the custom field definitions query. example: 123 value: type: - string - number - 'null' description: | Custom field value. It must match the field kind: - numeric: integer number. - currency: monetary value (number). - text: free text. - date: date in the ISO 8601 format (YYYY-MM-DD). - choices: one of the options registered in the definition. individual_person: allOf: - type: object required: - external_id - name properties: external_id: type: string description: '**Unique** identifier used to identify the record on Monde. You must provide this information and use it in future references to the same record. Any unique string is allowed, such as an identity document or UUID.

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

Example: "Maria da Silva".' maxLength: 100 gender: type: - string - 'null' description: Gender. enum: - female - male - birthdate: type: - string - 'null' description: 'Birthdate in ISO 8601 format (YYYY-MM-DD).

Example: "1990-02-12".' format: date cpf: type: - string - 'null' description: 'Brazilian Individual Taxpayer Registry (CPF), without dots, dashes, or spaces.

Example: "38107867807".' maxLength: 11 minLength: 11 rg: type: - string - 'null' description: 'Brazilian Identity Card (RG), without dots, dashes, or spaces.

Example: "461196037".' maxLength: 20 passport_number: type: - string - 'null' description: 'Passport number, without dots, dashes, or spaces.

Example: "FG225776".' maxLength: 20 passport_expiration_date: type: - string - 'null' format: date description: 'Passport expiration date in ISO 8601 format (YYYY-MM-DD).

Example: "2035-12-01".' foreigner: type: boolean description: Indicates whether the person is foreign. Use `true` for individuals who do not have Brazilian nationality. default: false foreign_identity_document: type: - string - 'null' description: ' Identity document of the foreigner, issued in their country of origin. Without dots, dashes or spaces.

Example: "41234567". ' maxLength: 30 business_phone: type: - string - 'null' description: Business phone maxLength: 20 birthplace: "$ref": "#/components/schemas/person_birthplace" additional_data: "$ref": "#/components/schemas/person_additional_data" - "$ref": "#/components/schemas/person" company_person: allOf: - type: object required: - external_id - name properties: external_id: type: string description: '**Unique** identifier used to identify the record on Monde. You must provide this information and use it in future references to the same record. Any unique string is allowed, such as an identity document or UUID.

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

Example: "Epic Journey".' maxLength: 100 legal_name: type: - string - 'null' description: 'Legal name.

Example: "Epic Journey S.A.".' maxLength: 100 cnpj: type: - string - 'null' description: 'National Registry of Legal Entities (CNPJ), without dots, slashes, dashes, or spaces.

Example: "50559280000140".' minLength: 14 maxLength: 14 ie: type: - string - 'null' description: 'Brazilian State Registration (IE), without dots, dashes, or spaces.

Example: "123456789012".' maxLength: 20 foreigner: type: boolean description: Indicates whether the company is foreign. Use `true` for companies that are not based in Brazil. default: false website: type: - string - 'null' description: Website (legal person) maxLength: 50 tax_identification_number: type: - string - 'null' description: Tax identification number (foreign legal person) maxLength: 20 tax_withholding: "$ref": "#/components/schemas/person_tax_withholding" airline: "$ref": "#/components/schemas/person_airline" - "$ref": "#/components/schemas/person" person_union_fields: type: object properties: person_kind: type: string description: Indicates whether it is a person (individual) or legal entity (company). enum: - individual - company external_id: type: string description: '**Unique** identifier used to identify the record on Monde. You must provide this information and use it in future references to the same record. Any unique string is allowed, such as an identity document or UUID.

Example: "09fbbf97-4ccb-4e5d-8fe4-2eacc38138b3".' maxLength: 50 name: type: string description: 'Name or trade name, according to the person kind.

Example: "Maria da Silva" or "Epic Journey".' maxLength: 100 legal_name: type: - string - 'null' description: 'Legal name.

Example: "Epic Journey S.A.".' maxLength: 100 gender: type: - string - 'null' description: Gender. enum: - female - male - birthdate: type: - string - 'null' description: 'Birthdate in ISO 8601 format (YYYY-MM-DD).

Example: "1990-02-12".' format: date cpf_cnpj: type: string description: 'Brazilian Individual Taxpayer Registry (CPF) or National Registry of Legal Entities (CNPJ), according to the person kind, without dots, slashes, dashes or spaces.

Example: "38107867807" or "50559280000140".' minLength: 11 maxLength: 14 rg_ie: type: - string - 'null' description: 'Brazilian Identity Card (RG) or Brazilian State Registration (IE), according to the person kind, without dots, dashes, or spaces.

Example: "461196037" or "123456789012".' maxLength: 20 passport_number: type: - string - 'null' description: 'Passport number, without dots, dashes, or spaces.

Example: "FG225776".' maxLength: 20 passport_expiration_date: type: - string - 'null' format: date description: 'Passport expiration date in ISO 8601 format (YYYY-MM-DD).

Example: "2035-12-01".' foreigner: type: boolean description: Indicates whether the person or company is foreign. Use `true` for individuals who do not have Brazilian nationality or companies that are not based in Brazil. default: false foreign_identity_document: type: - string - 'null' description: ' Identity document of the foreigner, issued in their country of origin. Without dots, dashes or spaces.

Example: "41234567". ' maxLength: 30 business_phone: type: - string - 'null' description: Business phone maxLength: 20 birthplace: "$ref": "#/components/schemas/person_birthplace" additional_data: "$ref": "#/components/schemas/person_additional_data" website: type: - string - 'null' description: Website (legal person) maxLength: 50 tax_identification_number: type: - string - 'null' description: Tax identification number (foreign legal person) maxLength: 20 tax_withholding: "$ref": "#/components/schemas/person_tax_withholding" airline: "$ref": "#/components/schemas/person_airline" individual_or_company: allOf: - type: object required: - person_kind - external_id - name - "$ref": "#/components/schemas/person_union_fields" - "$ref": "#/components/schemas/person" person_registration: allOf: - type: object required: - person_kind - name - "$ref": "#/components/schemas/person_union_fields" - "$ref": "#/components/schemas/person" - "$ref": "#/components/schemas/person_references" person_update: allOf: - "$ref": "#/components/schemas/person_union_fields" - "$ref": "#/components/schemas/person" - "$ref": "#/components/schemas/person_update_references" person_update_references: type: object properties: seller: description: Seller responsible for the person oneOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' promoter: description: Person promoter (operator plans) oneOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' labels: type: array nullable: true description: 'Labels of the person. The list sent replaces the current one: a label left out of it is removed. Send an empty or null list to remove every label; leave the field out to keep the current ones. Each label must already be registered.' items: "$ref": "#/components/schemas/entity_reference" contacts: type: array nullable: true description: 'People linked to this registration as contacts. The list sent replaces the current one: a contact left out of it is undone. The role of each contact is the one that comes in the list: leaving it out leaves the contact with no role. Send an empty or null list to undo every contact; leave the field out to keep the current ones. Each person must already be registered and cannot repeat in the list. The links in which this person is the contact of somebody else are not affected.' items: "$ref": "#/components/schemas/person_contact" custom_fields: type: array description: 'Custom fields of people, defined by the agency. Unlike the other lists, it does not replace: every field sent is written over the current value and the ones left out stay as they are, so an empty or null list changes nothing. A field sent with a null or empty `value` is cleared, except a required one, which is refused. Send each field by `id` and `value`.' items: "$ref": "#/components/schemas/person_custom_field" credit_cards: type: array nullable: true description: 'Credit cards of the person. The list sent replaces the current one: since the read does not return the number, a card the person already has is cited by its `id` (the same one the get by ID returns), with only the fields to change; an item without `id` is a new card, and a card left out of the list is deleted. Send an empty or null list to delete them all; leave the field out to keep the current ones. An expired card can be changed, but not added. Requires the "View financial tab" permission on people and, depending on the operation, "Register credit card" (item without `id`), "View credit card data" and "Edit credit card" (item with `id` that changes some field) and "Remove credit card" (a card of the person left out of the list).' items: "$ref": "#/components/schemas/person_credit_card_write" cost_centers: type: array nullable: true description: 'Cost centers of the corporate client (not the ones of the agency, from `/cost_centers`). The list sent replaces the current one: a name the person already has, regardless of case, keeps that cost center; a new name adds one; a cost center left out of the list is deleted. Passengers and invoice items that already stored a name do not change. Send an empty or null list to delete them all; leave the field out to keep the current ones. Only a company has cost centers.' items: "$ref": "#/components/schemas/person_cost_center_write" kandir_law: type: array nullable: true description: 'Kandir law withholdings of the company, one per product. The list sent replaces the current one: the product identifies the withholding, so a product the person already has changes its withholding, and the group, scope and tax left out stay as they are (a percentage sent null is refused); a new product adds a withholding, with the percentages left out set to zero; a withholding left out of the list is deleted. Send an empty or null list to delete them all; leave the field out to keep the current ones. Requires the "View financial tab" permission on people when it brings some withholding or removes the ones the person has.' items: "$ref": "#/components/schemas/person_kandir_law_write" representative: allOf: - "$ref": "#/components/schemas/company_person" description: Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier. intermediary: allOf: - "$ref": "#/components/schemas/individual_or_company" description: Sale intermediary. A person or company that connects the parties involved in the sale of the product, facilitating the negotiation and generally receiving a commission for the intermediation. Required for tour operators, where the intermediary owes the customer invoice. product_summary: type: object description: Represents a product available in the system. properties: id: type: string format: uuid description: Unique product identifier example: f9d961b8-ea88-4346-8e52-afe94267417a name: type: string description: Product name example: Seguro Viagem included_services: type: string nullable: true description: Services included in the product example: Cobertura completa para viagens internacionais kind: type: string enum: - insurance - cruise - hotel - airline_ticket - train_ticket - ground_transportation - excursion - visa - car_rental - travel_package - cvc_package - operation - others description: " Product kind.
  • insurance: 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.
" example: insurance passengers: type: boolean description: Indicates whether the product has passengers example: true system: type: boolean description: Indicates whether the product is a system product (cannot be deleted) example: false active: type: boolean description: Indicates whether the product is active example: true nbs_code: type: string nullable: true description: Product NBS code (Brazilian Nomenclature of Services) example: '115022000' required: - id - name - kind - passengers - system - active - included_services product: type: object description: Represents a product with its supplies and representatives. allOf: - "$ref": "#/components/schemas/product_summary" - type: object properties: supplies: type: array description: Product supplies. Each supply carries the supplier, the commercial terms and the representatives. items: "$ref": "#/components/schemas/supply" required: - supplies supply: type: object description: Product supply, with the supplier and the commercial terms negotiated with it. properties: &853 id: type: string format: uuid description: Unique supply identifier example: 6a1f0c3e-2b4d-4e8f-9a7b-1c2d3e4f5a6b description: type: string nullable: true description: Supply description (optional field). example: Fornecimento padrão commission_type: &4 type: string enum: - percentage - amount description: Commission type — percentage or amount. example: percentage commission_percentage: &5 type: number format: double description: Commission percentage. example: 10.0 commission_amount: &6 type: number format: double description: Commission amount. example: 0.0 over_percentage: &7 type: number format: double description: Over percentage. example: 0.0 over_value: &8 type: number format: double description: Percentage applied over the over. example: 100.0 du_percentage: &9 type: number format: double description: DU card fee percentage. example: 0.0 rav_percentage: &10 type: number format: double description: RAV card fee percentage. example: 0.0 restitutes_kandir_law: type: boolean description: Indicates whether the supply restitutes Lei Kandir. example: true supplier: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Supply supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representations: type: array description: Representatives linked to the supply. items: "$ref": "#/components/schemas/representation" representation: type: object description: Representative linked to a supply, with its own commercial terms. properties: &852 id: type: string format: uuid description: Unique identifier of the representative in the supply example: 8d2e1f4a-3c5b-4d6e-8f7a-9b0c1d2e3f4a commission_type: *4 commission_percentage: *5 commission_amount: *6 over_percentage: *7 over_value: *8 du_percentage: *9 rav_percentage: *10 representative: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Supply representative.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
product_create: type: object writeOnly: true description: Data to create a product. required: - name properties: &11 name: &858 type: string maxLength: 50 description: Product name example: Passeio de Barco included_services: &859 type: string nullable: true description: Services included in the product example: Passeio de escuna com almoço active: &860 type: boolean default: true description: Indicates whether the product is active example: true nbs_code: &861 type: string nullable: true description: Product NBS code (Brazilian Nomenclature of Services) example: 1.2501.11.00 kind: &862 type: string enum: - others - operation default: others description: " Product kind. On creation only these are accepted:
  • others (default): other products.
  • operation: own operation, only in an agency base.
It does not change after creation. " example: others passengers: &863 type: boolean default: true description: Whether the product has passengers. Defaults to `true`. It does not change after creation. example: true product_update: type: object writeOnly: true description: Data to update a product. All fields are optional. properties: *11 supply_create: type: object writeOnly: true description: Data to add a supplier to the product. required: - supplier properties: &12 supplier: &854 allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supply supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
description: &855 type: string nullable: true maxLength: 50 description: Supply description (optional field). example: Tarifa net restitutes_kandir_law: &856 type: boolean description: Indicates whether the supply restitutes Lei Kandir. example: true commission_type: &13 type: string enum: - percentage - amount description: Commission type — percentage or amount. example: percentage commission_percentage: &14 type: number format: double description: Commission percentage. example: 10.0 commission_amount: &15 type: number format: double description: Commission amount. example: 0.0 over_percentage: &16 type: number format: double description: Over percentage. example: 0.0 over_value: &17 type: number format: double description: Percentage applied over the over. example: 100.0 du_percentage: &18 type: number format: double description: DU card fee percentage. example: 0.0 rav_percentage: &19 type: number format: double description: RAV card fee percentage. example: 0.0 supply_update: type: object writeOnly: true description: Data to update a supply. All fields are optional. properties: *12 representation_create: type: object writeOnly: true description: Data to add a representative to the supply. required: - representative properties: &20 representative: &857 allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supply representative.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
commission_type: *13 commission_percentage: *14 commission_amount: *15 over_percentage: *16 over_value: *17 du_percentage: *18 rav_percentage: *19 representation_update: type: object writeOnly: true description: Data to update a representative. All fields are optional. properties: *20 company_identifier: type: string description: 'National Registry of Legal Entities (CNPJ) of the travel agency issuing the sale. Must contain digits only.

Example: "86452403000197".' pattern: "^[0-9]{14}$" minLength: 14 maxLength: 14 sale_date: type: string format: date description: 'Sale date in ISO 8601 format (YYYY-MM-DD).

Example: "2026-11-16".' operation_id: type: string writeOnly: true description: Operation ID associated with this sale. The operation must be active. Travel agencies only; on a tour operator (consolidator), the field is rejected with 422. seller_create: type: object description: Data to register a seller. required: - name - external_id - person_id properties: external_id: type: string description: '**Unique** identifier used to identify the record on Monde. You must provide this information and use it in future references to the same record. Any unique string is allowed, such as an identity document or UUID.

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

Example: "Maria da Silva".' maxLength: 100 cpf: type: string description: 'Brazilian Individual Taxpayer Registry (CPF), without dots, dashes, or spaces.

Example: "38107867807".' maxLength: 11 minLength: 11 person_id: type: string format: uuid description: Identifier of the individual person that becomes a seller example: f9d961b8-ea88-4346-8e52-afe94267417a active: type: boolean default: true description: Indicates whether the seller is born active. When omitted, the seller is born active example: true writeOnly: true custom_field: type: object required: - id properties: id: type: integer description: Identifier of the custom field definition (the same returned by List custom fields). It is the identifier used to send the value when creating the sale. The name, the kind and the choices of the definition come from the custom field definitions query or from Get custom field by ID. example: 123 value: type: - string - number - 'null' description: | Custom field value. It must match the field kind: - numeric: integer number. - currency: monetary value (number). - text: free text. - date: date in ISO 8601 format (YYYY-MM-DD). - choices: one of the options registered for the field, sent as text. Always send a simple value (number, text or date), never an object or list; a non-simple value is ignored. commission_create: type: object writeOnly: true required: - person - kind - value properties: person: allOf: - "$ref": "#/components/schemas/individual_or_company" description: Person who receives the commission. It is looked up by `external_id` and, when not linked, by CPF/CNPJ; when not found, it is created. An existing person only has its blank fields filled in. It may repeat the `external_id` of the seller, the intermediary or another person of the sale. kind: type: string enum: - seller - intermediary - person description: 'Commission role. `seller` and `intermediary` record the matching system job title; `person` records no job title. The role does not restrict who receives it: a seller commission may go to any person. `intermediary` requires the sale to have an intermediary. Without `description`, `seller` and `intermediary` record “Comissão Vendedor” and “Comissão Intermediário”.' value: type: number format: double multipleOf: 0.01 exclusiveMaximum: 100000000000 description: Commission value.
  • It must be provided in Brazilian reais (BRL).
description: type: - string - 'null' description: 'Commission description: free text entered manually or the commission plan phrase that generated it.' retained_value: type: number format: double multipleOf: 0.01 exclusiveMaximum: 100000000000 description: Retained value of the commission. Optional, defaults to 0 when omitted.
  • It must be provided in Brazilian reais (BRL).
sale_totals: type: object readOnly: true properties: products: type: number format: double readOnly: true description: Total of products.
  • It comes in the sale currency of the products (`sale_currency`), BRL except for tour operators. With products in different sale currencies, the amounts are added as they are.
fees: type: number format: double readOnly: true description: Total of fees.
  • It comes in the sale currency of the products (`sale_currency`), BRL except for tour operators. With products in different sale currencies, the amounts are added as they are.
discount: type: number format: double readOnly: true description: Total of discounts.
  • It comes in the sale currency of the products (`sale_currency`), BRL except for tour operators. With products in different sale currencies, the amounts are added as they are.
revenue: type: number format: double readOnly: true description: Total sale revenue.
  • It comes in the sale currency of the products (`sale_currency`), BRL except for tour operators. With products in different sale currencies, the amounts are added as they are.
balance: type: number format: double readOnly: true description: Outstanding balance of the sale.
  • It comes in the sale currency of the products (`sale_currency`), BRL except for tour operators. With products in different sale currencies, the amounts are added as they are.
final_amount: type: number format: double readOnly: true description: Final sale amount.
  • It comes in the sale currency of the products (`sale_currency`), BRL except for tour operators. With products in different sale currencies, the amounts are added as they are.
sale: type: object required: - company_identifier - sale_date - payer - seller - id - sale_number properties: company_identifier: "$ref": "#/components/schemas/company_identifier" id: type: string format: uuid readOnly: true description: Unique sale identifier (UUID format). example: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_number: type: integer readOnly: true description: Sequential sale number generated automatically by the system. example: 987 sale_date: "$ref": "#/components/schemas/sale_date" departure_date: type: string format: date readOnly: true description: 'Trip start date in ISO 8601 format (YYYY-MM-DD), calculated considering the earliest start date among all products in the sale (hotel check-in, insurance start, cruise departure, etc.).

Example: "2024-03-15".' example: '2024-03-15' return_date: type: string format: date readOnly: true description: 'Trip end date in ISO 8601 format (YYYY-MM-DD), calculated considering the latest end date among all products in the sale (hotel check-out, insurance end, cruise arrival, etc.).

Example: "2024-03-22".' example: '2024-03-22' status: type: string default: opened enum: - opened - closed description: Sale status on creation. Defaults to `opened`. Send `closed` to create the sale already closed. This requires the sale to meet every closing rule (no pending balance). If it cannot be closed, the whole creation is rejected with 422. observations: type: string nullable: true description: General remarks about the sale, as free text with no length limit. printed_receipt: type: boolean readOnly: true description: Indicates whether the sale receipt was printed. example: false created_at: type: string format: date-time readOnly: true description: Date and time the sale was registered. example: '2024-03-15T10:30:00' created_by: type: object nullable: true readOnly: true description: Person who registered the sale. properties: id: type: string format: uuid description: Unique identifier of the person who registered the sale. example: c3b7e8eb-1199-4457-9170-923c3fe56c92 name: type: string description: Name of the person who registered the sale. example: Maria da Silva required: - id - name operation_id: "$ref": "#/components/schemas/operation_id" custom_fields: type: array description: Custom fields of the sale, defined by the agency. On creation, send each field by `id` and `value`; active required fields of the sales module become mandatory. items: "$ref": "#/components/schemas/custom_field" seller: "$ref": "#/components/schemas/seller_create" payer: allOf: - "$ref": "#/components/schemas/individual_or_company" description: Product buyer responsible for the payment, which can be either an individual or a legal entity. Even if the negotiation involves multiple payers, only the primary payer or the person who negotiated the product with the seller should be specified. intermediary: oneOf: - "$ref": "#/components/schemas/intermediary" - type: 'null' requester: description: Individual who requested the sale. oneOf: - "$ref": "#/components/schemas/individual_person" - type: 'null' approver: 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. oneOf: - "$ref": "#/components/schemas/individual_or_company" - type: 'null' promoter: readOnly: true description: 'Sale promoter, on tour operators (consolidators) only. It is not sent on create or update: it is the promoter registered on the intermediary, copied when the sale is created and whenever the intermediary changes. Null when the intermediary has no promoter.' oneOf: - "$ref": "#/components/schemas/individual_or_company" - type: 'null' insurances: type: array description: Travel insurance. items: "$ref": "#/components/schemas/insurance" cruises: type: array description: Cruise. items: "$ref": "#/components/schemas/cruise" hotels: type: array description: Hotel room nights. items: "$ref": "#/components/schemas/hotel" airline_tickets: type: array description: Airline ticket. items: "$ref": "#/components/schemas/airline_ticket" train_tickets: type: array description: " Train ticket. " items: "$ref": "#/components/schemas/train_ticket" ground_transportations: type: array description: " Ground transportation. " items: "$ref": "#/components/schemas/ground_transportation" car_rentals: type: array description: Car rental. items: "$ref": "#/components/schemas/car_rental" travel_packages: type: array description: Travel packages. items: "$ref": "#/components/schemas/travel_package" excursions: type: array description: " Excursions of the sale. The excursion is a system product: there is no need to inform which product is being sold. " items: "$ref": "#/components/schemas/excursion" visas: type: array 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.

There is no dedicated field for the consular fee nor for the service fee: each applicant's consular fee goes in 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.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the person who registered the sale.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
operation: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Own operation the sale belongs to. Present even when no own operation product is part of the sale.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the seller responsible for the sale.
  • Call the [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) endpoint for the full data.
payer: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the payer responsible for the sale payment.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
intermediary: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the sale intermediary.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
requester: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the person who requested the sale.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
approver: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the person who approved the sale.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
promoter: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the sale promoter.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
travel: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the travel the sale belongs to.
  • Call the [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get) endpoint for the full data.
custom_fields: type: array description: Custom fields filled in the sale. items: "$ref": "#/components/schemas/custom_field" insurances: type: array description: Travel insurances of the sale. items: "$ref": "#/components/schemas/insurance_read" cruises: type: array description: Cruises of the sale. items: "$ref": "#/components/schemas/cruise_read" hotels: type: array description: Lodging nights of the sale. items: "$ref": "#/components/schemas/hotel_read" airline_tickets: type: array description: Airline tickets of the sale. items: "$ref": "#/components/schemas/airline_ticket_read" train_tickets: type: array description: Train tickets of the sale. items: "$ref": "#/components/schemas/train_ticket_read" ground_transportations: type: array description: Ground transportations of the sale. items: "$ref": "#/components/schemas/ground_transportation_read" car_rentals: type: array description: Car rentals of the sale. items: "$ref": "#/components/schemas/car_rental_read" travel_packages: type: array description: Travel packages of the sale. items: "$ref": "#/components/schemas/travel_package_read" others: type: array description: Other products of the sale. items: "$ref": "#/components/schemas/others_read" excursions: type: array description: Excursions of the sale. items: "$ref": "#/components/schemas/excursion_read" visas: type: array description: Consular visas of the sale. items: "$ref": "#/components/schemas/visa_read" cvc_packages: type: array description: CVC packages of the sale. items: "$ref": "#/components/schemas/cvc_package_read" operations: type: array description: Own operation products sold in the sale, each with its own document, amounts and passengers. All belong to the operation in the `operation` field; older sales may contain more than one. items: "$ref": "#/components/schemas/operation_read" payments: allOf: - "$ref": "#/components/schemas/payment_read" description: Payments of the sale, split between those made to the agency and those made to the vendor. commissions: type: array description: Sale commissions. items: "$ref": "#/components/schemas/commission" attachments: type: array description: Sale attachments. items: "$ref": "#/components/schemas/attachment_summary" financial: allOf: - "$ref": "#/components/schemas/financial" description: Financial data of the sale. sales_response: type: object description: Response containing a paginated list of sales in listing form. properties: data: type: array description: Array containing the sales of the current page. items: "$ref": "#/components/schemas/sale_summary" pagination: "$ref": "#/components/schemas/pagination" financial: type: object readOnly: true description: 'Financial data of the sale: financial remarks, per-product vendor payouts and separate accounts payable/receivable entries linked to the sale.' properties: observations: type: - string - 'null' description: Financial remarks of the sale. vendor_bills: type: array description: |- Financial records holding this sale's vendor payouts. A record may aggregate payouts from several sales; use each item's `sale` to filter the ones from this sale.
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" standalone_bills: type: array description: |- Standalone accounts payable or receivable linked directly to this sale.
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" vendor_items: type: array description: 'The vendor items of the sale, as in the Financial tab of Monde: what is still to be invoiced, what is already in an entry and what was paid directly to the vendor, of every product, by due date. An item awaiting deletion is left out. The due date and description of an item not yet in an entry nor paid directly change in [Update vendor item of the sale](#tag/Sales/paths/~1sales~1{sale_id}~1vendor_items~1{id}/patch).' items: "$ref": "#/components/schemas/sale_vendor_item" sale_vendor_item: type: object readOnly: true description: 'Vendor item of the sale, a row of the Financial tab in Monde: what the agency settles with the vendor or the representative for a product of the sale.' properties: id: type: string format: uuid description: Item identifier (UUID). It is the `id` that [Update vendor item of the sale](#tag/Sales/paths/~1sales~1{sale_id}~1vendor_items~1{id}/patch) receives. example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 kind: type: string enum: - invoice - refund - signal - lei_kandir - reversal - leftover - retained - fine - cvc - generated_credit description: |- What the item is: - `invoice`: the amount to be invoiced to the vendor for the product. - `refund`: vendor refund. - `signal`: down payment. - `lei_kandir`: Lei Kandir. - `reversal`: reversal. - `leftover`: balance. - `retained`: retained amount. - `fine`: vendor fine on the cancellation of the product. - `cvc`: item of the CVC statement. - `generated_credit`: credit generated for the vendor, handled in the credit of the person. example: invoice description: type: - string - 'null' maxLength: 100 description: Description of the item. example: Faturar em dezembro due_date: type: - string - 'null' format: date description: Due date of the item. On an item already in an entry (`bill`), it is the due date of the entry, as in Monde. example: '2026-12-15' amount: type: number format: double description: Amount of the item, in the `currency`. Negative is what the agency pays the vendor; positive, what the vendor pays the agency. example: -650.95 currency: type: string minLength: 3 maxLength: 3 description: Currency of the item (ISO 4217 code). example: BRL sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Sale product of the item.
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Vendor or representative of the item.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
bill: anyOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' description: |- Entry (invoice or account payable/receivable) the item is in. Null while the item has not been invoiced.
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
payment: anyOf: - "$ref": "#/components/schemas/entity_reference" - type: 'null' description: 'Payment made directly to the vendor that settles the item: the `id` of the payment in `payments.vendor`, when reading the sale. Null when the item was not paid directly.' required: - id - kind - description - due_date - amount - currency - sale_product - person - bill - payment sale_vendor_item_update: type: object description: The fields of the item that change. An omitted field stays as it is. properties: due_date: type: string format: date description: 'New due date of the item, in ISO 8601 format (YYYY-MM-DD). The due date is required: `null` or an empty text answers `422`.' example: '2026-12-15' description: type: - string - 'null' maxLength: 100 description: New description of the item, up to 100 characters. `null` leaves the item without a description. example: Faturar em dezembro sale_vendor_invoice_create: type: object writeOnly: true description: 'The standalone payment or the deposit to generate: the kind and the vendor items, each with its amount.' properties: kind: type: string enum: - advance - deposit description: |- What to generate, as in Monde: - `advance`: **Generate Standalone Payment or Deposit**, from the Financial tab of the sale. The invoice gets the description "Pagamento Avulso". - `deposit`: **Vendor Deposit**, from the product menu. The invoice gets the description "Sinal", and the transaction kind of each item is always the one of its balance. example: advance product_id: type: string format: uuid description: 'Product of the sale (UUID, the `id` in `products` when reading the sale), as the **Vendor Deposit** of the product menu: every item must be of this product. A product that is not of the sale answers `404`; an own operation or deleted product answers `422`.' example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 items: type: array minItems: 1 description: The vendor items that go into the invoice, at least one. All of them must be of this sale, be open, and be of the same vendor or representative and the same currency, as the Monde grid filtered by the chosen vendor. items: type: object properties: id: type: string format: uuid description: Vendor item identifier (UUID), the `id` of the item in `financial.vendor_items` when reading the sale. Open is the item without an entry (`bill` null) and without a direct payment (`payment` null); with the automatic vendor invoice, also the one in the automatic invoice not yet settled. example: 8e3c1f52-7a4b-4d29-b6e0-3f9a2c7d1b84 amount: type: number format: double exclusiveMinimum: 0 multipleOf: 0.01 description: 'Amount to generate from the item, greater than zero, in the currency of the item. It has no ceiling, as in Monde. An amount equal to the item takes the whole item to the invoice; a different amount splits the item: the generated part goes to the invoice and the rest stays open.' example: 650.95 transaction_kind: type: string enum: - debit - credit description: |- The transaction kind of the item, as the Movement column in Monde: - `debit`: Pay, the agency pays the vendor. - `credit`: Receive, the vendor pays the agency. When omitted, it follows the balance of the item: `debit` on a negative item, `credit` on a positive one. On `deposit` the field is ignored, and the balance always decides. example: debit required: - id - amount required: - kind - items sale_to_invoice_product: type: object writeOnly: true properties: sale_product_id: type: string format: uuid description: Product of the sale (UUID, the `id` of the product when reading the sale). example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 amount: type: number format: double multipleOf: 0.01 description: 'Amount of the product, other than zero, in the sale currency, with the sign of the customer balance of the product, as the Monde screen shows it: negative on a product with a negative balance, positive on the others. The opposite sign answers `422`.' example: 650.95 required: - sale_product_id - amount sale_to_invoice_products: type: array writeOnly: true minItems: 1 description: 'The products of the sale and the amount of each one, at least one. Each product appears once, has a customer balance and has the same sale currency as the others: a payment has a single currency. The sum of the amounts, with their signs, cannot be zero.' items: "$ref": "#/components/schemas/sale_to_invoice_product" sale_to_invoice_payer_id: type: string format: uuid writeOnly: true description: Payer (person UUID, the `id` from [List people](#tag/People/paths/~1people/get)). When omitted, it is the payer of the sale. A person that does not exist answers `422`. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 sale_to_invoice_create: type: object writeOnly: true description: 'The to-invoice payment (Faturar) to add: the payer, the cost center and the amount of each product.' properties: payer_id: "$ref": "#/components/schemas/sale_to_invoice_payer_id" cost_center: type: string maxLength: 50 description: Cost center of the payer, up to 50 characters. With a legal-entity payer, it must be one of the cost centers registered on it, and it is stored with the registered name. With an individual payer it is refused, unless the agency uses free-text cost centers. When omitted, the payment has no cost center. example: Diretoria products: "$ref": "#/components/schemas/sale_to_invoice_products" required: - products sale_to_invoice_return_create: type: object writeOnly: true description: 'The to-invoice return (Devolução Faturar) to add: the payer, the description and the amount of each product.' properties: payer_id: "$ref": "#/components/schemas/sale_to_invoice_payer_id" description: type: string maxLength: 100 description: Description of the to-invoice return, up to 100 characters. example: Reembolso do seguro products: "$ref": "#/components/schemas/sale_to_invoice_products" required: - products sale_to_invoice_removal: type: object writeOnly: true description: The to-invoice line to remove, pointed by the customer invoice and the cost center, and the confirmations Monde asks for before deleting. properties: bill_id: type: string format: uuid description: Customer invoice of the line (UUID, the `bill.id` of the line in `payments.agency.to_invoice` when reading the sale). example: 4f5a6b7c-8d9e-4f01-a2b3-c4d5e6f70819 cost_center: type: string nullable: true description: Cost center of the line, its `cost_center` when reading the sale. Null, empty or omitted points to the line without a cost center. example: reopen_sale: type: boolean default: false description: Confirms reopening the closed sale, as Monde asks before deleting. With `true`, the closed sale is reopened and the line is removed; it also requires the permission "Reabrir venda" (reopen sale). Without the confirmation, a closed sale answers `409`. On an open sale, it has no effect. example: false remove_settlement: type: boolean default: false description: Confirms undoing the settlement of a settled customer invoice, as Monde asks before deleting. Without the confirmation, a settled invoice answers `409`. On an open invoice, it has no effect. example: false required: - bill_id commission: type: object readOnly: true description: 'Commission of the sale: one line of the commission split for a person (seller, intermediary or another role).' properties: description: type: - string - 'null' description: 'Commission description: free text entered manually or the commission plan phrase that generated it.' amount: type: number format: double multipleOf: 0.01 description: Commission value. It may be negative when it represents an adjustment.
  • It must be provided in Brazilian reais (BRL).
retained_amount: type: number format: double multipleOf: 0.01 description: Retained value of the commission.
  • It must be provided in Brazilian reais (BRL).
balance: type: number format: double multipleOf: 0.01 description: Commission balance (amount minus retained amount).
  • It must be provided in Brazilian reais (BRL).
person: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Person who receives the commission.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
required: - amount - retained_amount - balance - person attachment: type: object required: - resource_type - resource_id - file properties: resource_type: type: string enum: - sale - person - bill - travel - task description: 'Resource that will receive the attachment: "sale" for a sale, "person" for a person, "bill" for an account payable or receivable, "travel" for a travel, "task" for a task.

Example: "sale"' resource_id: type: string format: uuid description: 'ID of the resource that will receive the attachment.

Example: "cc36d5d7-b699-43f1-b081-24c15e2db5e8"' file: type: string format: binary description: 'Binary file to attach.
  • Only one file per request.
  • Allowed extensions: .pdf, .doc, .docx, .odt, .xls, .xlsx, .ods, .ppt, .pptx, .jpg, .jpeg, .png, .webp, .heic, .heif, .txt, .csv.
  • Maximum size per file: 12 MB.
' description: type: string description: 'Attachment description. When omitted, the file name without the extension is used. The characters that Windows does not accept in a file name (\ / : * ? " < > |) are replaced by a hyphen (-).' maxLength: 255 attachment_summary: type: object readOnly: true properties: id: type: string format: uuid readOnly: true description: Attachment identifier. description: type: string readOnly: true description: Attachment description. extension: type: string readOnly: true description: 'File extension, lowercase and without the leading dot.

Example: "pdf"' content_type: type: string readOnly: true description: 'MIME type derived from the file extension. When the extension is unknown, returns "application/octet-stream".

Example: "application/pdf"' download_url: type: string format: uri readOnly: true description: Address to download this attachment content. Just follow it using the same API credentials; the response redirects (302) to a temporary link to the file, which expires within a few minutes. Accessing this URL again generates a new temporary link.

The content is returned gzip compressed and without a Content-Encoding header, so it must be decompressed explicitly before use. The real file type and extension are in the content_type and extension fields. attachments_response: type: object required: - id properties: id: type: string format: uuid description: Attachment identifier. description: type: string description: Attachment description. maxLength: 255 extension: type: string description: 'File extension, lowercase and without the leading dot.

Example: "pdf"' content_type: type: string description: 'MIME type derived from the file extension. When the extension is unknown, returns "application/octet-stream".

Example: "application/pdf"' download_url: type: string format: uri description: Address to download this attachment content. Just follow it using the same API credentials; the response redirects (302) to a temporary link to the file, which expires within a few minutes. Accessing this URL again generates a new temporary link.

The content is returned gzip compressed and without a Content-Encoding header, so it must be decompressed explicitly before use. The real file type and extension are in the content_type and extension fields. sale_product_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. sale_product_local_id: type: string writeOnly: true description: 'Name you give the product, **required** on a new product and unique among the products of the request. It links the product you sent to the `id` Monde generates: the response brings each product with the `id` next to this `local_id`. Keep the `id` and use it to update the product later. In this same request, the payments point to the product by it (`sale_product_local_id`). It is not stored, so it does not come back in the sale get. Any text is accepted, such as the product code in your system.' maxLength: 50 product_status: type: string readOnly: true enum: - active - canceled - deleted description: Status of the product within the sale. product_issue_date: type: string format: date readOnly: true description: Product issue date. product_canceled_at: type: string format: date-time readOnly: true description: Product cancellation date. product_calculate_commission: type: boolean readOnly: true description: Whether the product counts toward the commission plan goals. An active product always counts; a canceled one only counts when it was canceled with `calculate_commission`. product_deleted_balance: type: number format: double readOnly: true description: Customer balance deleted when the product, or some of its passengers, was canceled with `delete_customer_balance`, in the final currency of the sale. It reduces the sale revenue. Zero when the cancellation deleted no balance. product_delete_supplier_balance: type: boolean readOnly: true description: Whether the product cancellation deleted the open supplier balance, with `delete_supplier_balance`. product_supplier_fine: type: number format: double readOnly: true description: Fine charged by the supplier when the product was canceled, as a positive amount, in the final currency of the sale; the amount in the origin currency comes in `supplier_fine_origin_currency`. Zero when there is no fine. product_supplier_fine_origin_currency: type: number format: double readOnly: true description: Amount of `supplier_fine` in the product origin currency (`origin_currency`). product_observations: type: string readOnly: true description: Product remarks. vendor_reservation_url: type: string description: Reservation URL in the source system. Use this field to provide a link to the reservation that is generating this sale. This link will be used to create a shortcut from Monde to your system, allowing users to quickly navigate between the two systems. format: uri sale_product_external_number: type: - string - 'null' maxLength: 20 description: 'Additional field of the product, with the title the agency gave it in Monde (for example, "Nº Pedido"). Look up the title of each field in [List product additional fields](#tag/Sales/paths/~1sale_product_additional_fields/get), which lists this field as `external_number`. A field without a title does not appear in Monde: the API ignores the value sent and leaves it out of the reading. On update, omitting it keeps the stored value and sending null clears it.' example: TT48499 sale_product_additional1: type: - string - 'null' maxLength: 20 description: 'Additional field of the product, with the title the agency gave it in Monde (for example, "Nº Pedido"). Look up the title of each field in [List product additional fields](#tag/Sales/paths/~1sale_product_additional_fields/get), which lists this field as `additional1`. A field without a title does not appear in Monde: the API ignores the value sent and leaves it out of the reading. On update, omitting it keeps the stored value and sending null clears it.' example: TT48499 sale_product_additional2: type: - string - 'null' maxLength: 20 description: 'Additional field of the product, with the title the agency gave it in Monde (for example, "Nº Pedido"). Look up the title of each field in [List product additional fields](#tag/Sales/paths/~1sale_product_additional_fields/get), which lists this field as `additional2`. A field without a title does not appear in Monde: the API ignores the value sent and leaves it out of the reading. On update, omitting it keeps the stored value and sending null clears it.' example: TT48499 reservation_due_date: type: - string - 'null' format: date description: 'Reservation due date in ISO 8601 format (YYYY-MM-DD). Tour operators (consolidators) only: on a travel agency, the field is rejected with 422 and returns null. On update, omitting it keeps the stored date and sending null clears it.' currency_code: type: string description: ' Currency code, according to ISO 4217.

On create, it is the origin currency: the currency in which the product is originally sold, and the product amounts must be provided in it. Example: "USD". The currency the customer pays in goes in `sale_currency`.

On read, it is the sale currency of the product, in which its amounts come. The origin currency comes in `origin_currency`. ' minLength: 3 maxLength: 3 origin_currency_code: type: string readOnly: true description: ISO 4217 code of the currency in which the product is originally sold. The fields with the `_origin_currency` suffix come in this currency. minLength: 3 maxLength: 3 sale_currency_code: type: string writeOnly: true default: BRL description: " ISO 4217 code of the sale currency: the currency in which the customer pays for the product and in which its invoice and payments are issued. Default: BRL.
  • For tour operators, any registered currency is accepted. For travel agencies, only BRL.
  • When it equals `currency`, `exchange_rate` must be 1 or be left out. When it differs, `exchange_rate` is **required**.
  • Each payment (`payments`) has a single currency: every product in a payment must have the same sale currency.
On read, it comes in the product `currency` field. " minLength: 3 maxLength: 3 exchange_rate: type: object format: double exclusiveMinimum: 0 description: 'An exchange rate of the currency: how many reais one unit of it is worth, from the quote date and time on.' properties: id: type: string format: uuid description: Exchange rate ID example: 8c1d6f0e-6a4b-4f1e-9d55-2f3c9b7a1e10 currency: type: object description: The exchange rate's currency, by its code properties: code: type: string example: USD required: - code value: type: number description: How many reais one unit of the currency is worth, with up to 4 decimal places example: 5.4321 quoted_at: type: string format: date-time description: Quote date and time, in Brasília time example: '2026-10-14T09:30:00' required: - id - currency - value - quoted_at commission_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Commission amount that the supplier or representative pays to the travel agency based on the product sale value. Provide the monetary value, not the percentage. When reading, it comes in the final currency of the sale, and the amount in the origin currency comes in `commission_amount_origin_currency`.
  • It must be provided in the same currency specified in the `currency` field.
" commission_percentage: type: number format: double readOnly: true minimum: 0 description: Supplier commission percentage. over_amount: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Supplier over amount, in the final currency of the sale. The amount in the origin currency comes in `over_amount_origin_currency`.
  • It must be provided in the same currency specified in the `currency` field.
" over_percentage: type: number format: double readOnly: true minimum: 0 description: Supplier over percentage. over: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Base on which the over is calculated.
  • It must be provided in the same currency specified in the `currency` field.
" intermediary_commission_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Commission amount paid by the travel agency to the intermediary based on the product sale value. Provide the monetary value, not the percentage. When reading, it comes in the final currency of the sale, and the amount in the origin currency comes in `intermediary_commission_amount_origin_currency`.
  • It must be provided in the same currency specified in the `currency` field.
" intermediary_commission_percentage: type: number format: double readOnly: true minimum: 0 description: Intermediary commission percentage. intermediary_over_amount: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Intermediary over amount, in the final currency of the sale. The amount in the origin currency comes in `intermediary_over_amount_origin_currency`.
  • It must be provided in the same currency specified in the `currency` field.
" intermediary_over_percentage: type: number format: double readOnly: true minimum: 0 description: Intermediary over percentage. intermediary_over: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Base on which the intermediary over is calculated.
  • It must be provided in the same currency specified in the `currency` field.
" agency_service_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Service fee charged directly by the travel agency, with no direct association to the supplier or representative. The value is added to the product total and appears itemized for the final client.
  • It must be provided in the same currency specified in the `currency` field.
" cc_rav_fee: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Credit card administrative fee over the RAV.
  • It must be provided in the same currency specified in the `currency` field.
" cc_du_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 description: " Credit card administrative fee over the DU.
  • It must be provided in the same currency specified in the `currency` field.
" agency_card_rate: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Fee charged by the operator of the card used by the agency.
  • It must be provided in the same currency specified in the `currency` field.
" deductions: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Deductions applied to the product.
  • It must be provided in the same currency specified in the `currency` field.
" discount_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Discount amount granted on the travel agency's total revenue on the product. Provide the monetary value, not the percentage.
  • It must be provided in the same currency specified in the `currency` field.
" product_totals: type: object readOnly: true properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees.
  • It must be provided in the same currency specified in the `currency` field.
" fees_origin_currency: type: number format: double readOnly: true description: Amount of `fees` in the product origin currency (`origin_currency`). rav_fee: type: number format: double readOnly: true description: " Total of the passenger RAV for the product.
  • It must be provided in the same currency specified in the `currency` field.
" rav_fee_origin_currency: type: number format: double readOnly: true description: Amount of `rav_fee` in the product origin currency (`origin_currency`). rav_fee_discount: type: number format: double readOnly: true description: " Total RAV discount across the product passengers.
  • It must be provided in the same currency specified in the `currency` field.
" rav_fee_discount_origin_currency: type: number format: double readOnly: true description: Amount of `rav_fee_discount` in the product origin currency (`origin_currency`). agency_fee: type: number format: double readOnly: true description: " Total of the passenger hidden service fees for the product.
  • It must be provided in the same currency specified in the `currency` field.
" agency_fee_origin_currency: type: number format: double readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). discount: type: number format: double readOnly: true description: " Total discounts of the product.
  • It must be provided in the same currency specified in the `currency` field.
" discount_origin_currency: type: number format: double readOnly: true description: Amount of `discount` in the product origin currency (`origin_currency`). products: type: number format: double readOnly: true description: " Sum of the product values only, without fees, discounts, or deductions.
  • It must be provided in the same currency specified in the `currency` field.
" products_origin_currency: type: number format: double readOnly: true description: Amount of `products` in the product origin currency (`origin_currency`). customer_amount: type: number format: double readOnly: true description: " Total amount charged to the customer.
  • It must be provided in the same currency specified in the `currency` field.
" customer_amount_origin_currency: type: number format: double readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). amount: type: number format: double readOnly: true description: " Product total amount, summing products, fees, and remunerations and subtracting discounts and deductions.
  • It must be provided in the same currency specified in the `currency` field.
" amount_origin_currency: type: number format: double readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). product_name: type: string readOnly: true description: Name of the registered product. product_with_passengers: type: boolean readOnly: true description: Indicates whether the product works with passengers. When true, the financial breakdown comes from the passenger list and the quantity, unit_price and unit_fee fields return null. When false, the passenger list returns null and the values come from the product unit fields. product_document: type: string readOnly: true 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. maxLength: 40 quantity: type: integer readOnly: true minimum: 0 description: Number of product units, for products without passengers. For products with passengers, returns null, since the count corresponds to the passenger list. unit_price: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Unit price of the product, for products without passengers. The total corresponds to the unit price multiplied by the quantity. Comes in the origin currency (`origin_currency`). For products with passengers, returns null.
  • It must be provided in the same currency specified in the `currency` field.
" unit_fee: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: Unit fees of the product, for products without passengers. The total fees correspond to the unit fee multiplied by the quantity, without applying the product exchange rate. For products with passengers, returns null.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
destination: type: string readOnly: true description: Product destination. departure_date: type: string readOnly: true description: 'Start date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-21T00:00:46".' arrival_date: type: string readOnly: true description: 'End date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-24T00:00:46".' included_services: type: string readOnly: true description: 'Services included in the product. The `\n` character will be interpreted as a line break.

Example: "Local guide included\nTransfer".' insurance: type: object description: Travel insurance. required: - local_id - document - begin_date - end_date - destination - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &21 type: string description: General identifier for the insurance, used to locate it with the supplier or representative. It may be known as "voucher code", "policy number", "reservation code", "order code", among others. maxLength: 40 begin_date: &22 type: string description: 'Begin date and time of the insurance coverage in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the location of the insurance sale; therefore, it is not necessary to include time zone information.
Examples: "2026-11-21"; "2026-11-21T00:00:46"' end_date: &23 type: string description: 'End date and time of the insurance coverage in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the location of the insurance sale; therefore, it is not necessary to include time zone information.
Examples: "2026-12-06"; "2026-12-06T00:00:46"' destination: &24 type: string description: Type of destination of the trip. Use "national" for trips within Brazil, "international" for trips to other countries, and "cruise" for exclusively maritime insurances. enum: - national - international - cruise status: &25 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &26 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &27 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &28 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &29 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &30 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &31 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &32 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &33 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &34 type: string description: 'Additional information about what is included with the insurance purchase, such as the insurance coverage, plan name, etc. The `\n` character will be interpreted as a line break. Example: "Plan: Max International $ 60.000 with medical expenses coverage\nCode: 1234"' vendor_reservation_url: &35 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &36 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &37 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &38 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &39 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &40 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &41 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &42 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &43 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &44 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &45 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &46 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &47 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &48 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &49 allOf: - "$ref": "#/components/schemas/over_percentage" over: &50 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &51 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &52 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &53 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &54 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &55 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &56 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &57 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &58 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &59 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &60 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &61 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &62 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &63 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &64 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &65 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Insurance supplier. Company that directly owns the product, such as an insurer, for example. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/insurance_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees field of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. insurance_read: type: object description: Travel insurance. required: - document - begin_date - end_date - destination - currency - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *21 begin_date: *22 end_date: *23 destination: *24 status: *25 issue_date: *26 canceled_at: *27 calculate_commission: *28 deleted_balance: *29 delete_supplier_balance: *30 supplier_fine: *31 supplier_fine_origin_currency: *32 observations: *33 included_services: *34 vendor_reservation_url: *35 external_number: *36 additional1: *37 additional2: *38 reservation_due_date: *39 currency: *40 exchange_rate: *41 sale_currency: *42 origin_currency: *43 commission_amount: *44 commission_amount_origin_currency: *45 commission_percentage: *46 over_amount: *47 over_amount_origin_currency: *48 over_percentage: *49 over: *50 intermediary_commission_amount: *51 intermediary_commission_amount_origin_currency: *52 intermediary_commission_percentage: *53 intermediary_over_amount: *54 intermediary_over_amount_origin_currency: *55 intermediary_over_percentage: *56 intermediary_over: *57 agency_service_fee: *58 agency_service_fee_origin_currency: *59 agency_card_rate: *60 deductions: *61 deductions_origin_currency: *62 discount_amount: *63 discount_amount_origin_currency: *64 cc_rav_fee: *65 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees field of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Insurance supplier. Company that directly owns the product, such as an insurer, for example.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/insurance_passenger_read" cruise: type: object description: Cruise. required: - local_id - booking_number - departure_date - arrival_date - ship_name - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" booking_number: &66 type: string description: Booking number. maxLength: 40 departure_date: &67 type: string description: 'Cruise departure date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the cruise departure location; therefore, it is not necessary to include time zone information.
Examples: "2026-11-22"; "2026-11-22T00:00:46"' arrival_date: &68 type: string description: 'Cruise arrival date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the cruise arrival location; therefore, it is not necessary to include time zone information.
Examples: "2026-12-06"; "2026-12-06T00:00:46"' ship_name: &69 type: string description: Ship name. maxLength: 30 cruise_destination: &70 type: string description: 'Cruise destination. Example: "Bahamas".' maxLength: 30 accommodation_kind: &71 type: string description: 'Kind of accommodation purchased by the customer. Examples: "Single", "Double Room".' maxLength: 20 cabin_number: &72 type: string description: 'Cabin number. Example: "8074".' maxLength: 10 cabin_kind: &73 type: string description: 'Kind of cabin. Examples: "Suite", "Internal", "External", etc.' maxLength: 30 cabin_category: &74 type: string description: 'Code used to identify which category the cabin belongs to. Examples: "STD", "7A".' maxLength: 3 meal_plan: &75 type: string readOnly: true description: 'Cruise meal plan. Examples: "All inclusive", "Full board".' maxLength: 20 status: &76 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &77 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &78 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &79 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &80 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &81 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &82 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &83 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &84 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &85 type: string description: 'Additional information about what is included with the cruise purchase, such as the package name, itinerary, etc. The `\n` character will be interpreted as a line break. Example: "Package: All Inclusive\nCode: 1234".' vendor_reservation_url: &86 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &87 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &88 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &89 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &90 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &91 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &92 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &93 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &94 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &95 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &96 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &97 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &98 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &99 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &100 allOf: - "$ref": "#/components/schemas/over_percentage" over: &101 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &102 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &103 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &104 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &105 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &106 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &107 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &108 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &109 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &110 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &111 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &112 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &113 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &114 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &115 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &116 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Cruise supplier. Company that directly owns the product, such as a cruise line, for example. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/cruise_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and tip fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. cruise_read: type: object description: Cruise. required: - booking_number - departure_date - arrival_date - ship_name - currency - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 booking_number: *66 departure_date: *67 arrival_date: *68 ship_name: *69 cruise_destination: *70 accommodation_kind: *71 cabin_number: *72 cabin_kind: *73 cabin_category: *74 meal_plan: *75 status: *76 issue_date: *77 canceled_at: *78 calculate_commission: *79 deleted_balance: *80 delete_supplier_balance: *81 supplier_fine: *82 supplier_fine_origin_currency: *83 observations: *84 included_services: *85 vendor_reservation_url: *86 external_number: *87 additional1: *88 additional2: *89 reservation_due_date: *90 currency: *91 exchange_rate: *92 sale_currency: *93 origin_currency: *94 commission_amount: *95 commission_amount_origin_currency: *96 commission_percentage: *97 over_amount: *98 over_amount_origin_currency: *99 over_percentage: *100 over: *101 intermediary_commission_amount: *102 intermediary_commission_amount_origin_currency: *103 intermediary_commission_percentage: *104 intermediary_over_amount: *105 intermediary_over_amount_origin_currency: *106 intermediary_over_percentage: *107 intermediary_over: *108 agency_service_fee: *109 agency_service_fee_origin_currency: *110 agency_card_rate: *111 deductions: *112 deductions_origin_currency: *113 discount_amount: *114 discount_amount_origin_currency: *115 cc_rav_fee: *116 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and tip fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Cruise supplier. Company that directly owns the product, such as a cruise line, for example.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/cruise_passenger_read" hotel: type: object description: Hotel room nights. required: - local_id - booking_number - check_in - check_out - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" booking_number: &117 type: string description: Booking number. maxLength: 40 check_in: &118 type: string description: 'Check-in date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the hotel location; therefore, it is not necessary to include time zone information.
Examples: "2026-12-09"; "2026-12-09T00:00:46"' check_out: &119 type: string description: 'Check-out date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the hotel location; therefore, it is not necessary to include time zone information.
Examples: "2026-12-16"; "2026-12-16T00:00:46"' destination: &120 type: string description: Type of destination of the trip. Use "national" for trips within Brazil and "international" for trips to other countries. enum: - national - international accommodation_kind: &121 type: string description: 'Kind of accommodation purchased by the customer. Examples: "Single", "Double Room".' maxLength: 20 room_category: &122 type: string description: 'Room category. Examples: "Suite", "Deluxe".' maxLength: 20 meal_plan: &123 type: string description: 'Meal plan. Examples: "All Inclusive", "Half board".' maxLength: 20 nights: &124 type: integer readOnly: true minimum: 0 description: Number of nights (computed between check-in and check-out). status: &125 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &126 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &127 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &128 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &129 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &130 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &131 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &132 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &133 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &134 type: string description: 'Additional information about what is included with the accommodation purchase, such as the hotel address, room details, etc. The `\n` character will be interpreted as a line break. Example: "Grand EX Hotel: 5th Ave, New York, NY, United States\nRoom with City View".' vendor_reservation_url: &135 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &136 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &137 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &138 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &139 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &140 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &141 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &142 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &143 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &144 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &145 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &146 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &147 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &148 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &149 allOf: - "$ref": "#/components/schemas/over_percentage" over: &150 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &151 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &152 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &153 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &154 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &155 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &156 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &157 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &158 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &159 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &160 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &161 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &162 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &163 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &164 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &165 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Hotel providing the accommodation. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/hotel_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. hotel_read: type: object description: Hotel room nights. required: - booking_number - check_in - check_out - currency - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 booking_number: *117 check_in: *118 check_out: *119 destination: *120 accommodation_kind: *121 room_category: *122 meal_plan: *123 nights: *124 status: *125 issue_date: *126 canceled_at: *127 calculate_commission: *128 deleted_balance: *129 delete_supplier_balance: *130 supplier_fine: *131 supplier_fine_origin_currency: *132 observations: *133 included_services: *134 vendor_reservation_url: *135 external_number: *136 additional1: *137 additional2: *138 reservation_due_date: *139 currency: *140 exchange_rate: *141 sale_currency: *142 origin_currency: *143 commission_amount: *144 commission_amount_origin_currency: *145 commission_percentage: *146 over_amount: *147 over_amount_origin_currency: *148 over_percentage: *149 over: *150 intermediary_commission_amount: *151 intermediary_commission_amount_origin_currency: *152 intermediary_commission_percentage: *153 intermediary_over_amount: *154 intermediary_over_amount_origin_currency: *155 intermediary_over_percentage: *156 intermediary_over: *157 agency_service_fee: *158 agency_service_fee_origin_currency: *159 agency_card_rate: *160 deductions: *161 deductions_origin_currency: *162 discount_amount: *163 discount_amount_origin_currency: *164 cc_rav_fee: *165 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Hotel providing the accommodation.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/hotel_passenger_read" airline_ticket: type: object description: Airline ticket. required: - local_id - locator - segments - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" locator: &166 type: string description: Ticket locator code. maxLength: 10 destination: &864 type: string description: Flight destination. Use "national" for flights within Brazil and "international" for flights to other countries. enum: - national - international status: &167 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &168 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &169 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &170 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &171 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &172 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &173 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &174 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &175 type: string description: Product remarks. included_services: &176 type: string description: 'Additional information about what is included with the ticket, such as baggage allowance, meals, seat selection, and other benefits offered by the airline The `\n` character will be interpreted as a line break. Example: "3 checked bags at no extra cost\nFully reclining seat\nAccess to the Lounge".' vendor_reservation_url: &177 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &178 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &179 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &180 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &181 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &182 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &183 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &184 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &185 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &186 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &187 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &188 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &189 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &190 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &191 allOf: - "$ref": "#/components/schemas/over_percentage" over: &192 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &193 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &194 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &195 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &196 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &197 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &198 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &199 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &200 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &201 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &202 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &203 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &204 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &205 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &206 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &207 type: number format: double default: 0 minimum: 0 multipleOf: 0.01 description: " Credit card administrative fee over the RAV.
  • It must be provided in the same currency specified in the `currency` field.
" cc_du_fee: &208 allOf: - "$ref": "#/components/schemas/cc_du_fee" supplier: description: Airline providing the ticket. allOf: - type: object required: - airline_code - name properties: airline_code: type: string description: 'Airline IATA or ICAO code.

Example: "AA"' maxLength: 3 airline_number: type: string description: 'Airline IATA 3-digit code.

Example: "001"' maxLength: 3 name: type: string description: 'Trade name.

Example: "American Airlines".' maxLength: 100 legal_name: type: string description: 'Legal name.

Example: "American Airlines Inc.".' maxLength: 100 cnpj: type: string description: 'National Registry of Legal Entities (CNPJ), without dots, slashes, dashes, or spaces.

Example: "50559280000140".' minLength: 14 maxLength: 14 foreigner: type: boolean description: Indicates whether the company is foreign. Use `true` for companies that are not based in Brazil. - "$ref": "#/components/schemas/person" representative: allOf: - "$ref": "#/components/schemas/representative" segments: type: array description: List of segments that compose the flight itinerary. items: type: object required: - airline_code - flight_number - origin - departure_date - destination - arrival_date properties: airline_code: type: string description: 'Airline IATA or ICAO code.

Example: "AA"' maxLength: 3 flight_number: type: string description: Flight number, digits only. maxLength: 4 pattern: "^[0-9]+$" class: type: string description: Flight class. maxLength: 2 origin: type: string description: 'Origin airport IATA code.

Example: "NAS".' maxLength: 3 departure_date: type: string description: 'Departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the airport location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T00:00:46".' destination: type: string description: 'Destination airport IATA code.

Example: "JFK".' maxLength: 3 arrival_date: type: string description: 'Arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the airport location; therefore, it is not necessary to include time zone information.

Example: "2026-11-21T03:12:46".' seats: type: array description: Seats of the passengers on this segment, one per passenger. Each seat points to the passenger by the `ticket_number`, which must match the ticket of one of the passengers of the product. Therefore, a passenger with a seat must have the `ticket_number` informed. When reading, a seat entered in Monde for a passenger who has no ticket yet comes with a null `ticket_number`. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Seat number. maxLength: 3 ticket_number: type: string description: Ticket number associated with the seat. maxLength: 30 passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/airline_ticket_passenger" totals: type: object readOnly: true description: Consolidated totals of the product. properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the boarding_fee and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" rav_fee: type: number format: double readOnly: true description: " Total of the passenger RAV for the product.
  • It must be provided in the same currency specified in the `currency` field.
" rav_fee_discount: type: number format: double readOnly: true description: " Total RAV discount across the product passengers.
  • It must be provided in the same currency specified in the `currency` field.
" agency_fee: type: number format: double readOnly: true description: " Total of the passenger hidden service fees for the product.
  • It must be provided in the same currency specified in the `currency` field.
" discount: type: number format: double readOnly: true description: " Total discounts of the product.
  • It must be provided in the same currency specified in the `currency` field.
" products: type: number format: double readOnly: true description: " Sum of the product values only, without fees, discounts, or deductions.
  • It must be provided in the same currency specified in the `currency` field.
" du_fee: type: number format: double readOnly: true description: " Total of the passenger DU for the product.
  • It must be provided in the same currency specified in the `currency` field.
" du_fee_origin_currency: type: number format: double readOnly: true description: Amount of `du_fee` in the product origin currency (`origin_currency`). du_fee_discount: type: number format: double readOnly: true description: " Total DU discount across the product passengers.
  • It must be provided in the same currency specified in the `currency` field.
" du_fee_discount_origin_currency: type: number format: double readOnly: true description: Amount of `du_fee_discount` in the product origin currency (`origin_currency`). customer_amount: type: number format: double readOnly: true description: " Total amount charged to the customer.
  • It must be provided in the same currency specified in the `currency` field.
" amount: type: number format: double readOnly: true description: " Product total amount, summing products, fees, and remunerations and subtracting discounts and deductions.
  • It must be provided in the same currency specified in the `currency` field.
" airline_ticket_read: type: object description: Airline ticket. required: - locator - segments - currency - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 locator: *166 destination: type: string description: 'Flight destination: "national" or "international". An airline ticket recorded through the API before this rule may come as "cruise", a value Monde never accepted for airline tickets. To update that ticket, send "national" or "international": "cruise" is rejected with 422, also when the destination is omitted.' enum: - national - international - cruise status: *167 issue_date: *168 canceled_at: *169 calculate_commission: *170 deleted_balance: *171 delete_supplier_balance: *172 supplier_fine: *173 supplier_fine_origin_currency: *174 observations: *175 included_services: *176 vendor_reservation_url: *177 external_number: *178 additional1: *179 additional2: *180 reservation_due_date: *181 currency: *182 exchange_rate: *183 sale_currency: *184 origin_currency: *185 commission_amount: *186 commission_amount_origin_currency: *187 commission_percentage: *188 over_amount: *189 over_amount_origin_currency: *190 over_percentage: *191 over: *192 intermediary_commission_amount: *193 intermediary_commission_amount_origin_currency: *194 intermediary_commission_percentage: *195 intermediary_over_amount: *196 intermediary_over_amount_origin_currency: *197 intermediary_over_percentage: *198 intermediary_over: *199 agency_service_fee: *200 agency_service_fee_origin_currency: *201 agency_card_rate: *202 deductions: *203 deductions_origin_currency: *204 discount_amount: *205 discount_amount_origin_currency: *206 cc_rav_fee: *207 cc_du_fee: *208 totals: type: object readOnly: true description: Consolidated totals of the product. properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the boarding_fee and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" rav_fee: type: number format: double readOnly: true description: " Total of the passenger RAV for the product.
  • It must be provided in the same currency specified in the `currency` field.
" rav_fee_discount: type: number format: double readOnly: true description: " Total RAV discount across the product passengers.
  • It must be provided in the same currency specified in the `currency` field.
" agency_fee: type: number format: double readOnly: true description: " Total of the passenger hidden service fees for the product.
  • It must be provided in the same currency specified in the `currency` field.
" discount: type: number format: double readOnly: true description: " Total discounts of the product.
  • It must be provided in the same currency specified in the `currency` field.
" products: type: number format: double readOnly: true description: " Sum of the product values only, without fees, discounts, or deductions.
  • It must be provided in the same currency specified in the `currency` field.
" du_fee: type: number format: double readOnly: true description: " Total of the passenger DU for the product.
  • It must be provided in the same currency specified in the `currency` field.
" du_fee_origin_currency: type: number format: double readOnly: true description: Amount of `du_fee` in the product origin currency (`origin_currency`). du_fee_discount: type: number format: double readOnly: true description: " Total DU discount across the product passengers.
  • It must be provided in the same currency specified in the `currency` field.
" du_fee_discount_origin_currency: type: number format: double readOnly: true description: Amount of `du_fee_discount` in the product origin currency (`origin_currency`). customer_amount: type: number format: double readOnly: true description: " Total amount charged to the customer.
  • It must be provided in the same currency specified in the `currency` field.
" amount: type: number format: double readOnly: true description: " Product total amount, summing products, fees, and remunerations and subtracting discounts and deductions.
  • It must be provided in the same currency specified in the `currency` field.
" supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Airline providing the ticket.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
segments: type: array description: List of segments that compose the flight itinerary. items: type: object required: - airline_code - flight_number - origin - departure_date - destination - arrival_date properties: airline_code: type: string description: 'Airline IATA or ICAO code.

Example: "AA"' maxLength: 3 flight_number: type: string description: Flight number, digits only. maxLength: 4 class: type: string description: Flight class. maxLength: 2 origin: type: string description: 'Origin airport IATA code.

Example: "NAS".' maxLength: 3 departure_date: type: string description: 'Departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the airport location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T00:00:46".' destination: type: string description: 'Destination airport IATA code.

Example: "JFK".' maxLength: 3 arrival_date: type: string description: 'Arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the airport location; therefore, it is not necessary to include time zone information.

Example: "2026-11-21T03:12:46".' seats: type: array description: Seats of the passengers on this segment, one per passenger. Each seat points to the passenger by the `ticket_number`, which must match the ticket of one of the passengers of the product. Therefore, a passenger with a seat must have the `ticket_number` informed. When reading, a seat entered in Monde for a passenger who has no ticket yet comes with a null `ticket_number`. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Seat number. maxLength: 3 ticket_number: type: string nullable: true description: Ticket number associated with the seat. maxLength: 30 passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/airline_ticket_passenger_read" train_ticket: type: object description: " Train ticket. " required: - local_id - document - currency - segments - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &209 type: string description: General identifier for the train ticket, used to locate it with the supplier or representative. It may be known as "locator code", "ticket number", "booking number", among others. maxLength: 40 departure_date: &210 type: string readOnly: true description: 'Train ticket departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-21T00:00:46".' arrival_date: &211 type: string readOnly: true description: 'Train ticket arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-24T00:00:46".' status: &212 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &213 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &214 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &215 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &216 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &217 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &218 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &219 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &220 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &221 type: string description: ' Information about the services included in the train ticket, such as meals, onboard services, Wi-Fi, among other benefits offered by the railway operator. The `\n` character will be interpreted as a line break. On a sale update, it is required when the product `segments` are sent again, because the segment text lives here; left out along with the segments, it stays as it is.

Example: "Meal included\nFree Wi-Fi\nQuiet car". ' vendor_reservation_url: &222 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &223 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &224 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &225 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &226 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &227 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &228 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &229 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &230 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &231 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &232 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &233 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &234 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &235 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &236 allOf: - "$ref": "#/components/schemas/over_percentage" over: &237 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &238 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &239 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &240 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &241 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &242 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &243 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &244 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &245 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &246 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &247 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &248 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &249 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &250 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &251 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &252 allOf: - "$ref": "#/components/schemas/cc_rav_fee" segments: type: array writeOnly: true description: List of segments that compose the train itinerary. items: type: object required: - railway_operator - origin - departure_date - destination - arrival_date properties: railway_operator: type: string description: Railway operator responsible for the segment. maxLength: 50 origin: type: string description: 'Origin station.

Example: "Paris Gare de Lyon".' maxLength: 50 departure_date: type: string format: date-time description: 'Departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the station location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T00:00:46".' destination: type: string description: 'Destination station.

Example: "Nice-Ville".' maxLength: 50 arrival_date: type: string format: date-time description: 'Arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the station location; therefore, it is not necessary to include time zone information.

Example: "2026-11-21T03:12:46".' supplier: description: Railway operator or distributor company that is providing the train ticket. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/train_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees field of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. train_ticket_read: type: object description: " Train ticket. " required: - document - currency - segments - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *209 departure_date: *210 arrival_date: *211 status: *212 issue_date: *213 canceled_at: *214 calculate_commission: *215 deleted_balance: *216 delete_supplier_balance: *217 supplier_fine: *218 supplier_fine_origin_currency: *219 observations: *220 included_services: *221 vendor_reservation_url: *222 external_number: *223 additional1: *224 additional2: *225 reservation_due_date: *226 currency: *227 exchange_rate: *228 sale_currency: *229 origin_currency: *230 commission_amount: *231 commission_amount_origin_currency: *232 commission_percentage: *233 over_amount: *234 over_amount_origin_currency: *235 over_percentage: *236 over: *237 intermediary_commission_amount: *238 intermediary_commission_amount_origin_currency: *239 intermediary_commission_percentage: *240 intermediary_over_amount: *241 intermediary_over_amount_origin_currency: *242 intermediary_over_percentage: *243 intermediary_over: *244 agency_service_fee: *245 agency_service_fee_origin_currency: *246 agency_card_rate: *247 deductions: *248 deductions_origin_currency: *249 discount_amount: *250 discount_amount_origin_currency: *251 cc_rav_fee: *252 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees field of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Railway operator or distributor company that is providing the train ticket.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
segments: type: array writeOnly: true description: List of segments that compose the train itinerary. items: type: object required: - railway_operator - origin - departure_date - destination - arrival_date properties: railway_operator: type: string description: Railway operator responsible for the segment. maxLength: 50 origin: type: string description: 'Origin station.

Example: "Paris Gare de Lyon".' maxLength: 50 departure_date: type: string format: date-time description: 'Departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the station location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T00:00:46".' destination: type: string description: 'Destination station.

Example: "Nice-Ville".' maxLength: 50 arrival_date: type: string format: date-time description: 'Arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the station location; therefore, it is not necessary to include time zone information.

Example: "2026-11-21T03:12:46".' passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/train_passenger_read" ground_transportation: type: object description: " Ground transportation. " required: - local_id - document - segments - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &253 type: string description: General identifier for the ground transportation, used to locate it with the supplier or representative. It may be known as "locator", "ticket number", "booking number", among others. maxLength: 40 departure_date: &254 type: string readOnly: true description: 'Ground transportation departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-21T00:00:46".' arrival_date: &255 type: string readOnly: true description: 'Ground transportation arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-24T00:00:46".' status: &256 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &257 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &258 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &259 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &260 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &261 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &262 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &263 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &264 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &265 type: string description: ' Information about services included in the ground transportation, such as meals, Wi-Fi, and other benefits offered by the coach company. The `\n` character will be interpreted as a line break. On a sale update, it is required when the product `segments` are sent again, because the segment text lives here; left out along with the segments, it stays as it is.

Example: "Meal included\nFree Wi-Fi".' vendor_reservation_url: &266 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &267 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &268 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &269 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &270 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &271 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &272 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &273 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &274 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &275 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &276 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &277 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &278 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &279 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &280 allOf: - "$ref": "#/components/schemas/over_percentage" over: &281 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &282 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &283 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &284 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &285 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &286 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &287 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &288 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &289 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &290 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &291 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &292 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &293 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &294 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &295 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &296 allOf: - "$ref": "#/components/schemas/cc_rav_fee" segments: type: array writeOnly: true description: List of segments that compose the ground transportation itinerary. items: type: object required: - coach_company - origin - departure_date - destination - arrival_date properties: coach_company: type: string description: 'Name of the coach company responsible for the segment.

Example: "Greyhound Lines"' maxLength: 100 service_class: type: string description: 'Ticket class.

Examples: "Sleeper, Standard, Executive".' maxLength: 20 origin: type: string description: 'Origin terminal or station.

Example: "Port Authority Bus Terminal".' maxLength: 100 departure_date: type: string format: date-time description: 'Departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the boarding location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T00:00:46".' destination: type: string description: 'Destination terminal or station.

Example: "Union Station".' maxLength: 100 arrival_date: type: string format: date-time description: 'Arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the arrival location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T04:00:46".' seats: type: array writeOnly: true description: List of seats associated with this segment. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Seat number. maxLength: 3 ticket_number: type: string description: Ticket number associated with the seat. maxLength: 20 supplier: description: Coach company providing the service. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/ground_transportation_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees field of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. ground_transportation_read: type: object description: " Ground transportation. " required: - document - segments - currency - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *253 departure_date: *254 arrival_date: *255 status: *256 issue_date: *257 canceled_at: *258 calculate_commission: *259 deleted_balance: *260 delete_supplier_balance: *261 supplier_fine: *262 supplier_fine_origin_currency: *263 observations: *264 included_services: *265 vendor_reservation_url: *266 external_number: *267 additional1: *268 additional2: *269 reservation_due_date: *270 currency: *271 exchange_rate: *272 sale_currency: *273 origin_currency: *274 commission_amount: *275 commission_amount_origin_currency: *276 commission_percentage: *277 over_amount: *278 over_amount_origin_currency: *279 over_percentage: *280 over: *281 intermediary_commission_amount: *282 intermediary_commission_amount_origin_currency: *283 intermediary_commission_percentage: *284 intermediary_over_amount: *285 intermediary_over_amount_origin_currency: *286 intermediary_over_percentage: *287 intermediary_over: *288 agency_service_fee: *289 agency_service_fee_origin_currency: *290 agency_card_rate: *291 deductions: *292 deductions_origin_currency: *293 discount_amount: *294 discount_amount_origin_currency: *295 cc_rav_fee: *296 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees field of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Coach company providing the service.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
segments: type: array writeOnly: true description: List of segments that compose the ground transportation itinerary. items: type: object required: - coach_company - origin - departure_date - destination - arrival_date properties: coach_company: type: string description: 'Name of the coach company responsible for the segment.

Example: "Greyhound Lines"' maxLength: 100 service_class: type: string description: 'Ticket class.

Examples: "Sleeper, Standard, Executive".' maxLength: 20 origin: type: string description: 'Origin terminal or station.

Example: "Port Authority Bus Terminal".' maxLength: 100 departure_date: type: string format: date-time description: 'Departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the boarding location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T00:00:46".' destination: type: string description: 'Destination terminal or station.

Example: "Union Station".' maxLength: 100 arrival_date: type: string format: date-time description: 'Arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The date and time will always be relative to the arrival location therefore, it is not necessary to include time zone information.

Example: "2026-11-21T04:00:46".' seats: type: array writeOnly: true description: List of seats associated with this segment. items: type: object required: - seat_number - ticket_number properties: seat_number: type: string description: Seat number. maxLength: 3 ticket_number: type: string description: Ticket number associated with the seat. maxLength: 20 passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/ground_transportation_passenger_read" car_rental: type: object description: Car rental. required: - local_id - document - pickup_date - dropoff_date - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &297 type: string description: General identifier for the rental, used to locate it with the supplier or representative. It may be known as "booking number", "voucher code", "locator", among others. maxLength: 40 pickup_date: &298 type: string description: ' Vehicle pickup date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the pickup location; therefore, it is not necessary to include time zone information.
Examples: "2026-11-21"; "2026-11-21T00:00:46" ' pickup_location: &299 type: string description: ' Vehicle pickup location.

Example: "Congonhas Airport" ' maxLength: 30 dropoff_date: &300 type: string description: ' Vehicle dropoff date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the dropoff location; therefore, it is not necessary to include time zone information.
Examples: "2026-11-28"; "2026-11-28T00:00:46" ' dropoff_location: &301 type: string description: ' Vehicle dropoff location.

Example: "Congonhas Airport" ' maxLength: 30 destination: &302 type: string description: Type of destination for the rental. Use "national" for rentals within Brazil and "international" for rentals in other countries. enum: - national - international vehicle_category: &303 type: string description: ' Category of the rented vehicle.

Examples: "Economy", "Intermediate", "Premium", "SUV". ' maxLength: 50 rental_days: &304 type: integer readOnly: true minimum: 0 description: Number of rental days (between pickup and drop-off). status: &305 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &306 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &307 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &308 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &309 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &310 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &311 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &312 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &313 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &314 type: string description: ' Additional information about what is included with the vehicle rental, such as mileage, insurance, extras, etc. The `\n` character will be interpreted as a line break.

Example: "Unlimited mileage\nBasic insurance included\nFull tank". ' vendor_reservation_url: &315 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &316 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &317 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &318 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &319 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &320 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &321 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &322 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &323 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &324 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &325 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &326 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &327 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &328 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &329 allOf: - "$ref": "#/components/schemas/over_percentage" over: &330 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &331 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &332 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &333 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &334 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &335 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &336 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &337 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &338 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &339 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &340 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &341 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &342 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &343 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &344 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &345 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Car rental company providing the service. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/default_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. car_rental_read: type: object description: Car rental. required: - document - pickup_date - dropoff_date - currency - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *297 pickup_date: *298 pickup_location: *299 dropoff_date: *300 dropoff_location: *301 destination: *302 vehicle_category: *303 rental_days: *304 status: *305 issue_date: *306 canceled_at: *307 calculate_commission: *308 deleted_balance: *309 delete_supplier_balance: *310 supplier_fine: *311 supplier_fine_origin_currency: *312 observations: *313 included_services: *314 vendor_reservation_url: *315 external_number: *316 additional1: *317 additional2: *318 reservation_due_date: *319 currency: *320 exchange_rate: *321 sale_currency: *322 origin_currency: *323 commission_amount: *324 commission_amount_origin_currency: *325 commission_percentage: *326 over_amount: *327 over_amount_origin_currency: *328 over_percentage: *329 over: *330 intermediary_commission_amount: *331 intermediary_commission_amount_origin_currency: *332 intermediary_commission_percentage: *333 intermediary_over_amount: *334 intermediary_over_amount_origin_currency: *335 intermediary_over_percentage: *336 intermediary_over: *337 agency_service_fee: *338 agency_service_fee_origin_currency: *339 agency_card_rate: *340 deductions: *341 deductions_origin_currency: *342 discount_amount: *343 discount_amount_origin_currency: *344 cc_rav_fee: *345 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Car rental company providing the service.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/car_rental_passenger_read" travel_package: type: object description: Travel packages. required: - local_id - document - begin_date - destination - package_name - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &346 type: string description: General identifier for the package, used to locate it with the supplier or representative. It may be known as "booking number", "voucher code", "locator", "order code", among others. maxLength: 40 begin_date: &347 type: string description: 'Package begin date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the package destination; therefore, it is not necessary to include time zone information.
Examples: "2026-11-23"; "2026-11-23T00:00:46"' end_date: &348 type: string description: 'Package end date and time in ISO 8601 format.
  • The date is required, while the time is optional.
  • If only the date is provided, use the format YYYY-MM-DD.
  • If both date and time are provided, use the format YYYY-MM-DDTHH:MM:SS.
  • The date and time will always be relative to the package destination; therefore, it is not necessary to include time zone information.
Examples: "2026-11-30"; "2026-11-30T00:00:46"' destination: &349 type: string description: Type of destination of the trip. Use "national" for trips within Brazil and "international" for trips to other countries. enum: - national - international package_name: &350 type: string description: ' Name of the travel package.

Examples: "Aracajú", "Surf Trip Trancoso". ' maxLength: 50 transport: &351 type: string description: " Type of transportation included in the package.

  • self_provided: self-provided transportation.
  • road_transport: road transportation.
  • no_transport: no transportation.
  • charter_flight: charter flight.
  • scheduled_flight: scheduled flight.
" enum: - self_provided - road_transport - no_transport - charter_flight - scheduled_flight maxLength: 20 status: &352 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &353 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &354 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &355 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &356 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &357 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &358 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &359 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &360 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &361 type: string description: ' Additional information about what is included in the travel package, such as accommodation details, tours, meals, etc. The `\n` character will be interpreted as a line break.

Example: "Accommodation: 5-star hotel\nMeals: Breakfast included\nTours: City tour and surf lessons". ' vendor_reservation_url: &362 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &363 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &364 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &365 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &366 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &367 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &368 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &369 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &370 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &371 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &372 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &373 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &374 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &375 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &376 allOf: - "$ref": "#/components/schemas/over_percentage" over: &377 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &378 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &379 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &380 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &381 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &382 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &383 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &384 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &385 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &386 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &387 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &388 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &389 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &390 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &391 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &392 allOf: - "$ref": "#/components/schemas/cc_rav_fee" supplier: description: Supplier responsible for the travel package. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/travel_package_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. travel_package_read: type: object description: Travel packages. required: - document - begin_date - destination - package_name - currency - supplier - passengers readOnly: true 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *346 begin_date: *347 end_date: *348 destination: *349 package_name: *350 transport: *351 status: *352 issue_date: *353 canceled_at: *354 calculate_commission: *355 deleted_balance: *356 delete_supplier_balance: *357 supplier_fine: *358 supplier_fine_origin_currency: *359 observations: *360 included_services: *361 vendor_reservation_url: *362 external_number: *363 additional1: *364 additional2: *365 reservation_due_date: *366 currency: *367 exchange_rate: *368 sale_currency: *369 origin_currency: *370 commission_amount: *371 commission_amount_origin_currency: *372 commission_percentage: *373 over_amount: *374 over_amount_origin_currency: *375 over_percentage: *376 over: *377 intermediary_commission_amount: *378 intermediary_commission_amount_origin_currency: *379 intermediary_commission_percentage: *380 intermediary_over_amount: *381 intermediary_over_amount_origin_currency: *382 intermediary_over_percentage: *383 intermediary_over: *384 agency_service_fee: *385 agency_service_fee_origin_currency: *386 agency_card_rate: *387 deductions: *388 deductions_origin_currency: *389 discount_amount: *390 discount_amount_origin_currency: *391 cc_rav_fee: *392 totals: allOf: - "$ref": "#/components/schemas/product_totals" - type: object properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees, summing the fees and other_fees fields of each passenger.
  • It must be provided in the same currency specified in the `currency` field.
" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier responsible for the travel package.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/travel_package_passenger_read" others: type: object description: Other sale products, 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 product chosen from the agency catalog. The product must be active. See the available products at GET /products?kind=others. local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" product_name: allOf: - "$ref": "#/components/schemas/product_name" product_with_passengers: allOf: - "$ref": "#/components/schemas/product_with_passengers" document: type: string maxLength: 40 description: 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. destination: type: string description: Destination type of the product. Use "national" for products within Brazil and "international" for products in other countries. enum: - national - international departure_date: type: string description: 'Start date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-21T00:00:46".' arrival_date: type: string description: 'End date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-24T00:00:46".' status: allOf: - "$ref": "#/components/schemas/product_status" issue_date: allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: type: string description: Product remarks. included_services: type: string description: 'Services included in the product. The `\n` character will be interpreted as a line break.

Example: "Local guide included\nTransfer".' vendor_reservation_url: allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: allOf: - "$ref": "#/components/schemas/sale_currency_code" commission_amount: allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: allOf: - "$ref": "#/components/schemas/over_percentage" over: allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: allOf: - "$ref": "#/components/schemas/deductions" discount_amount: allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: description: Number of product units, for products without passengers. For products with passengers, returns null, since the count corresponds to the passenger list. oneOf: - type: integer minimum: 1 maximum: 2147483647 - type: 'null' unit_price: oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' unit_fee: description: Unit fees of the product, for products without passengers. The total fees correspond to the unit fee multiplied by the quantity, without applying the product exchange rate. For products with passengers, returns null.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' agency_fee: description: Hidden service fee of the line, in the origin currency. A single value (not multiplied by the quantity). Only applies to the product without passengers; with passengers the fee is informed per passenger. oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' supplier: description: Product supplier. Company that directly owns the product, such as a currency exchange broker or a train pass issuer, for example. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: description: Passengers List. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/others_passenger" - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. others_read: type: object readOnly: true description: Other sale products, which may or may not have passengers. required: - currency - supplier 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: &865 allOf: - "$ref": "#/components/schemas/product_document" destination: &866 allOf: - "$ref": "#/components/schemas/destination" departure_date: &867 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &868 allOf: - "$ref": "#/components/schemas/arrival_date" status: &869 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &870 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &871 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &872 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &873 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &874 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &875 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &876 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &877 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &878 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &879 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &880 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &881 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &882 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &883 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &884 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &885 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &886 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &887 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &888 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &889 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &890 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &891 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &892 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &893 allOf: - "$ref": "#/components/schemas/over_percentage" over: &894 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &895 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &896 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &897 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &898 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &899 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &900 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &901 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &902 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &903 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &904 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &905 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &906 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &907 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &908 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &909 allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: &910 oneOf: - "$ref": "#/components/schemas/quantity" - type: 'null' unit_price: &911 oneOf: - "$ref": "#/components/schemas/unit_price" - type: 'null' unit_fee: &912 oneOf: - "$ref": "#/components/schemas/unit_fee" - type: 'null' agency_fee: &913 description: Hidden service fee of the line, in the final currency of the sale (`currency`). A single value (not multiplied by the quantity). Null in the product with passengers, where the fee comes in each passenger. oneOf: - type: number format: double - type: 'null' agency_fee_origin_currency: &914 readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). oneOf: - type: number format: double - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Registered product this sale item comes from.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product supplier. Company that directly owns the product, such as a currency exchange broker or a train pass issuer, for example.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: description: Passengers List. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/default_passenger_read" - type: 'null' excursion: type: object description: " Excursions of the sale. The excursion is a system product: there is no need to inform which product is being sold. " required: - local_id - document - departure_date - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" document: &393 type: string description: General identifier for the excursion, used to locate it with the supplier or representative. It may be known as "locator", "voucher number", "booking number", among others. maxLength: 40 status: &394 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &395 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &396 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &397 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &398 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &399 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &400 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &401 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" included_services: &402 type: string description: ' Information about the services included in the excursion, such as guide, transportation, meals, among other benefits offered by the supplier. The `\n` character will be interpreted as a line break.

Example: "Local guide included\nTransportation included". ' vendor_reservation_url: &403 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &404 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &405 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &406 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &407 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &408 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &409 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &410 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &411 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &412 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &413 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &414 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &415 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &416 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &417 allOf: - "$ref": "#/components/schemas/over_percentage" over: &418 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &419 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &420 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &421 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &422 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &423 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &424 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &425 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &426 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &427 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &428 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &429 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &430 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &431 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &432 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &433 allOf: - "$ref": "#/components/schemas/cc_rav_fee" departure_date: type: string description: 'Excursion departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-21T00:00:46".' arrival_date: type: string description: 'Excursion arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-22T00:00:46".' observations: type: string description: Product remarks. supplier: description: Supplier of the excursion. Company that directly owns the product. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/excursion_passenger" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. excursion_read: type: object readOnly: true description: " Excursions of the sale. The excursion is a system product: there is no need to inform which product is being sold. " required: - document - 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: *393 status: *394 issue_date: *395 canceled_at: *396 calculate_commission: *397 deleted_balance: *398 delete_supplier_balance: *399 supplier_fine: *400 supplier_fine_origin_currency: *401 included_services: *402 vendor_reservation_url: *403 external_number: *404 additional1: *405 additional2: *406 reservation_due_date: *407 currency: *408 exchange_rate: *409 sale_currency: *410 origin_currency: *411 commission_amount: *412 commission_amount_origin_currency: *413 commission_percentage: *414 over_amount: *415 over_amount_origin_currency: *416 over_percentage: *417 over: *418 intermediary_commission_amount: *419 intermediary_commission_amount_origin_currency: *420 intermediary_commission_percentage: *421 intermediary_over_amount: *422 intermediary_over_amount_origin_currency: *423 intermediary_over_percentage: *424 intermediary_over: *425 agency_service_fee: *426 agency_service_fee_origin_currency: *427 agency_card_rate: *428 deductions: *429 deductions_origin_currency: *430 discount_amount: *431 discount_amount_origin_currency: *432 cc_rav_fee: *433 departure_date: type: string readOnly: true description: 'Excursion departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-21T00:00:46".' arrival_date: type: string readOnly: true description: 'Excursion arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-22T00:00:46".' observations: allOf: - "$ref": "#/components/schemas/product_observations" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier of the excursion. Company that directly owns the product.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/default_passenger_read" visa: type: object 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.

There is no dedicated field for the consular fee nor for the service fee: each applicant's consular fee goes in 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.

Examples: "Turismo" (tourism), "Negócios" (business), "Estudo" (study), "Trabalho" (work).' maxLength: 50 example: Turismo destination_country: &915 type: string description: 'Country of the visa, by its ISO 3166-1 alpha-2 code (two letters), such as "US" for the United States. Required. The code must be in Monde''s country list: a code outside it is refused with 422.' minLength: 2 maxLength: 2 example: US destination: &436 type: string description: 'Destination classification used for invoicing: "national" for travel within Brazil and "international" for travel to other countries. It is not the visa country, which goes in 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.

Example: "Interview scheduling\nDS-160 form filling". ' vendor_reservation_url: &446 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &447 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &448 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &449 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &450 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &451 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &452 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &453 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &454 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &455 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &456 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &457 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &458 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &459 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &460 allOf: - "$ref": "#/components/schemas/over_percentage" over: &461 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &462 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &463 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &464 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &465 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &466 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &467 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &468 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &469 allOf: - "$ref": "#/components/schemas/agency_service_fee" description: 'Service fee charged by the agency for the visa assistance, with no link to the supplier or representative. The amount adds up to the product total. The consular fee does not go here: it goes in 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.

Example: "2026-12-16T00:00:46".' arrival_date: type: string description: 'Visa end date and time, usually the planned return date, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Cannot be earlier than departure_date. Optional.

Example: "2026-12-31T00:00:46".' observations: type: string description: Product remarks. supplier: description: Supplier of the visa. Company that provides the visa service, such as the visa assistance company or the consulate itself. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" passengers: type: array description: Visa applicants. Each one carries its consular fee in 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.

There is no dedicated field for the consular fee nor for the service fee: each applicant's consular fee goes in 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.

Example: "2026-12-16T00:00:46".' arrival_date: type: string readOnly: true description: 'Visa end date and time, usually the planned return date, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Cannot be earlier than departure_date. Optional.

Example: "2026-12-31T00:00:46".' observations: allOf: - "$ref": "#/components/schemas/product_observations" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier of the visa. Company that provides the visa service, such as the visa assistance company or the consulate itself.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: type: array description: Visa applicants. Each one carries its consular fee in 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).

Example: "2026-11-21T00:00:46".' arrival_date: type: string description: 'End date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-11-24T00:00:46".' status: allOf: - "$ref": "#/components/schemas/product_status" issue_date: allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: allOf: - "$ref": "#/components/schemas/product_deleted_balance" observations: type: string description: Product remarks. included_services: type: string description: 'Services included in the product. The `\n` character will be interpreted as a line break.

Example: "Local guide included\nTransfer".' vendor_reservation_url: allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: allOf: - "$ref": "#/components/schemas/sale_product_additional2" currency: allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: allOf: - "$ref": "#/components/schemas/origin_currency_code" intermediary_commission_amount: allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: allOf: - "$ref": "#/components/schemas/agency_card_rate" discount_amount: allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). quantity: description: Number of product units, for products without passengers. For products with passengers, returns null, since the count corresponds to the passenger list. oneOf: - type: integer minimum: 1 maximum: 2147483647 - type: 'null' unit_price: oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' unit_fee: description: Unit fees of the product, for products without passengers. The total fees correspond to the unit fee multiplied by the quantity, without applying the product exchange rate. For products with passengers, returns null.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' agency_fee: description: Hidden service fee of the line, in the origin currency. A single value (not multiplied by the quantity). Only applies to the product without passengers; with passengers the fee is informed per passenger. oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' supplier: readOnly: true description: Supplier of the own-operation product. Company that directly owns the product, such as a local operator hired to run the service, for example. allOf: - "$ref": "#/components/schemas/company_person" passengers: description: Passengers List. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/operation_passenger" - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. operation_read: type: object readOnly: true description: Own-operation products of the sale (operated by the agency itself), which may or may not have passengers. required: - currency - supplier 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 document: &916 allOf: - "$ref": "#/components/schemas/product_document" departure_date: &917 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &918 allOf: - "$ref": "#/components/schemas/arrival_date" status: &919 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &920 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &921 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &922 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &923 allOf: - "$ref": "#/components/schemas/product_deleted_balance" observations: &924 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &925 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &926 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &927 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &928 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &929 allOf: - "$ref": "#/components/schemas/sale_product_additional2" currency: &930 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &931 allOf: - "$ref": "#/components/schemas/exchange_rate" sale_currency: &932 allOf: - "$ref": "#/components/schemas/sale_currency_code" origin_currency: &933 allOf: - "$ref": "#/components/schemas/origin_currency_code" intermediary_commission_amount: &934 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &935 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &936 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &937 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &938 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &939 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &940 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &941 allOf: - "$ref": "#/components/schemas/agency_card_rate" discount_amount: &942 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &943 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). quantity: &944 oneOf: - "$ref": "#/components/schemas/quantity" - type: 'null' unit_price: &945 oneOf: - "$ref": "#/components/schemas/unit_price" - type: 'null' unit_fee: &946 oneOf: - "$ref": "#/components/schemas/unit_fee" - type: 'null' agency_fee: &947 description: Hidden service fee of the line, in the final currency of the sale (`currency`). A single value (not multiplied by the quantity). It is null in the product with passengers. oneOf: - type: number format: double - type: 'null' agency_fee_origin_currency: &948 readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). oneOf: - type: number format: double - type: 'null' totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Registered product this sale item comes from.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier of the own-operation product. Company that directly owns the product, such as a local operator hired to run the service, for example.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
passengers: description: Passengers List. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/operation_passenger_read" - type: 'null' cvc_package: type: object readOnly: true description: CVC packages of the sale. Always without passengers. required: - id - package_name - quantity - unit_price - currency - supplier properties: id: allOf: - "$ref": "#/components/schemas/sale_product_id" package_name: &477 type: string readOnly: true description: Name of the purchased CVC package. receipt_number: &478 type: string readOnly: true description: General identifier for the CVC package, used to locate it with CVC. It is the receipt number issued for the package. maxLength: 40 departure_date: &479 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &480 allOf: - "$ref": "#/components/schemas/arrival_date" status: &481 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &482 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &483 allOf: - "$ref": "#/components/schemas/product_canceled_at" calculate_commission: &484 allOf: - "$ref": "#/components/schemas/product_calculate_commission" deleted_balance: &485 allOf: - "$ref": "#/components/schemas/product_deleted_balance" delete_supplier_balance: &486 allOf: - "$ref": "#/components/schemas/product_delete_supplier_balance" supplier_fine: &487 allOf: - "$ref": "#/components/schemas/product_supplier_fine" supplier_fine_origin_currency: &488 allOf: - "$ref": "#/components/schemas/product_supplier_fine_origin_currency" observations: &489 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &490 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &491 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" external_number: &492 allOf: - "$ref": "#/components/schemas/sale_product_external_number" additional1: &493 allOf: - "$ref": "#/components/schemas/sale_product_additional1" additional2: &494 allOf: - "$ref": "#/components/schemas/sale_product_additional2" reservation_due_date: &495 allOf: - "$ref": "#/components/schemas/reservation_due_date" currency: &496 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &497 allOf: - "$ref": "#/components/schemas/exchange_rate" origin_currency: &498 allOf: - "$ref": "#/components/schemas/origin_currency_code" commission_amount: &499 allOf: - "$ref": "#/components/schemas/commission_amount" commission_amount_origin_currency: &500 allOf: - "$ref": "#/components/schemas/commission_amount" readOnly: true description: Amount of `commission_amount` in the product origin currency (`origin_currency`). commission_percentage: &501 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &502 allOf: - "$ref": "#/components/schemas/over_amount" over_amount_origin_currency: &503 allOf: - "$ref": "#/components/schemas/over_amount" readOnly: true description: Amount of `over_amount` in the product origin currency (`origin_currency`). over_percentage: &504 allOf: - "$ref": "#/components/schemas/over_percentage" over: &505 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &506 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_amount_origin_currency: &507 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" readOnly: true description: Amount of `intermediary_commission_amount` in the product origin currency (`origin_currency`). intermediary_commission_percentage: &508 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &509 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_amount_origin_currency: &510 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" readOnly: true description: Amount of `intermediary_over_amount` in the product origin currency (`origin_currency`). intermediary_over_percentage: &511 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &512 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &513 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_service_fee_origin_currency: &514 allOf: - "$ref": "#/components/schemas/agency_service_fee" readOnly: true description: Amount of `agency_service_fee` in the product origin currency (`origin_currency`). agency_card_rate: &515 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &516 allOf: - "$ref": "#/components/schemas/deductions" deductions_origin_currency: &517 allOf: - "$ref": "#/components/schemas/deductions" readOnly: true description: Amount of `deductions` in the product origin currency (`origin_currency`). discount_amount: &518 allOf: - "$ref": "#/components/schemas/discount_amount" discount_amount_origin_currency: &519 allOf: - "$ref": "#/components/schemas/discount_amount" readOnly: true description: Amount of `discount_amount` in the product origin currency (`origin_currency`). cc_rav_fee: &520 allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: &521 allOf: - "$ref": "#/components/schemas/quantity" unit_price: &522 allOf: - "$ref": "#/components/schemas/unit_price" unit_fee: &523 allOf: - "$ref": "#/components/schemas/unit_fee" supplier: description: Supplier of the CVC package. Company that directly owns the product, i.e., CVC. allOf: - "$ref": "#/components/schemas/company_person" representative: allOf: - "$ref": "#/components/schemas/representative" totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. cvc_package_read: type: object readOnly: true description: CVC packages of the sale. Always without passengers. required: - package_name - quantity - unit_price - currency - supplier 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: 7e6d5c4b-3a2f-4109-8e7d-6c5b4a392817 package_name: *477 receipt_number: *478 departure_date: *479 arrival_date: *480 status: *481 issue_date: *482 canceled_at: *483 calculate_commission: *484 deleted_balance: *485 delete_supplier_balance: *486 supplier_fine: *487 supplier_fine_origin_currency: *488 observations: *489 included_services: *490 vendor_reservation_url: *491 external_number: *492 additional1: *493 additional2: *494 reservation_due_date: *495 currency: *496 exchange_rate: *497 origin_currency: *498 commission_amount: *499 commission_amount_origin_currency: *500 commission_percentage: *501 over_amount: *502 over_amount_origin_currency: *503 over_percentage: *504 over: *505 intermediary_commission_amount: *506 intermediary_commission_amount_origin_currency: *507 intermediary_commission_percentage: *508 intermediary_over_amount: *509 intermediary_over_amount_origin_currency: *510 intermediary_over_percentage: *511 intermediary_over: *512 agency_service_fee: *513 agency_service_fee_origin_currency: *514 agency_card_rate: *515 deductions: *516 deductions_origin_currency: *517 discount_amount: *518 discount_amount_origin_currency: *519 cc_rav_fee: *520 quantity: *521 unit_price: *522 unit_fee: *523 totals: allOf: - "$ref": "#/components/schemas/product_totals" description: Consolidated totals of the product. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Registered product this sale item comes from.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier of the CVC package. Company that directly owns the product, i.e., CVC.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product representative. A company that represents the supplier in the sale of the product, such as an operator or consolidator. It should be provided when the travel agency has not purchased the product directly from the supplier.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
payment_product: type: object required: - amount oneOf: - required: - sale_product_id - required: - sale_product_local_id properties: sale_product_id: type: string format: uuid description: 'Only in the sale update: `id` of a product the sale already has (the one from the response that created it or from the sale get). Send this or `sale_product_local_id`, one of the two.' sale_product_local_id: type: string maxLength: 50 description: "`local_id` of a product sent in this same request. Send this or `sale_product_id`, one of the two." amount: type: number format: double exclusiveMinimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: 'Payment amount allocated to this product, in the sale currency (`sale_currency`). For a product with an exchange rate, compute the total as the sum of the amounts converted and rounded one by one (see the product `exchange_rate`): to close the sale (`status: closed`), the payments must add up to exactly that total: one cent less leaves a pending balance and one cent more is refused as overpayment.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
' payment_amount: type: number format: double readOnly: true multipleOf: 0.01 description: Amount of the settlement movement.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
bank_account: type: object required: - bank_code - agency_number - account_number description: 'Details of the bank account that will receive the payment. The account is looked up by bank, agency and number among the active checking accounts of the sale company (company_identifier): an account of another company is not found, even when the data matches.' properties: description: type: string readOnly: true description: Name of the bank account registered in the agency. bank_code: type: string description: 'Bank code.

Example: 001. (Code for Banco do Brasil)' maxLength: 10 agency_number: type: string description: Bank branch number maxLength: 10 agency_digit: type: string description: Bank branch check digit maxLength: 2 account_number: type: string description: Bank account number maxLength: 20 account_digit: type: string description: Bank account check digit maxLength: 2 payment_card_last_digits: type: string description: Last 4 digits of the card. minLength: 4 maxLength: 4 payment_authorization: type: string description: Authorization code. maxLength: 20 payment_due_date: type: string format: date description: Payment due date in ISO 8601 format (YYYY-MM-DD). payment_settlement_date: type: string format: date description: Payment settlement date in ISO 8601 format (YYYY-MM-DD). payment_settlement_exchange_rate: type: number exclusiveMinimum: 0 description: 'Settlement exchange rate, from the payment currency to the bank account currency. Only applies with `settlement_date` and an account in another currency: when omitted, the ratio between the latest rates of both currencies registered in Monde is used, and without the rate of either one the response is 422. With the account in the payment currency, it must be 1 or omitted. The movement enters the account already converted.' payment_observations: type: string maxLength: 255 description: 'Payment observations. Can be used to specify which transfer type was used.

Examples: "Pix", "TED", "DOC".' agency_others_product: type: object required: - amount oneOf: - required: - sale_product_id - required: - sale_product_local_id properties: sale_product_id: type: string format: uuid description: 'Only in the sale update: `id` of a product the sale already has (the one from the response that created it or from the sale get). Send this or `sale_product_local_id`, one of the two.' sale_product_local_id: type: string maxLength: 50 description: "`local_id` of a product sent in this same request. Send this or `sale_product_id`, one of the two." amount: type: number format: double multipleOf: 0.01 exclusiveMinimum: -100000000000 exclusiveMaximum: 100000000000 description: |- Payment amount allocated to this product, in the sale currency (`sale_currency`). For a product with an exchange rate, compute the total as the sum of the amounts converted and rounded one by one (see the product `exchange_rate`): to close the sale (`status: closed`), the payments must add up to exactly that total: one cent less leaves a pending balance and one cent more is refused as overpayment. In the overpayment return (`overpayment_return`), it carries the sign of the customer balance of the product: negative on a product with a negative balance, positive on the others. Otherwise, it is always positive.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
payment_description: type: string maxLength: 60 description: Payment description saved on the financial entry. When omitted, "Pagamento venda" is used. Maximum of 60 characters. payment_products: type: array description: List of products linked to this payment, with their respective amounts. **All products in the list must have the same supplier or representative**. items: "$ref": "#/components/schemas/payment_product" payment_installments: type: integer description: Number of installments. minimum: 1 default: 1 payment_vendor_due_date: type: string format: date readOnly: true description: Due date of the vendor payment. payment_agency_due_date: type: string format: date readOnly: true description: Payment due date in ISO 8601 format (YYYY-MM-DD). agency_credit_card: type: object required: - card_last_digits - card_brand - due_date - bank_account - products - amount properties: due_date: &949 allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &950 allOf: - "$ref": "#/components/schemas/payment_settlement_date" settlement_exchange_rate: &951 allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: &952 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true card_last_digits: &953 allOf: - "$ref": "#/components/schemas/payment_card_last_digits" card_brand: &954 type: string description: Card brand. enum: - amex - diners - hipercard - mastercard - visa - elo authorization: &955 allOf: - "$ref": "#/components/schemas/payment_authorization" card_rate_percentage: &956 type: number format: double minimum: 0 maximum: 100 writeOnly: true description: 'Agency payment only (`agency.credit_card`). Agency card fee, as a percentage of the payment amount, from 0 to 100. Monde calculates the fee amount, rounded to cents.

Send either `card_rate_percentage` or `card_rate`: both together are rejected with 422. Without either, the *Taxa cartão de crédito* setting of the company Sales settings applies, as in Monde. `0` records the payment with no fee.

The fee is split among the payment products as in Monde, adds up to the `agency_card_rate` of each product (which lowers its revenue) and reduces the final amount of the bill, in the card fee category set for the company. Without that category, a fee above zero is rejected with 422. With `settlement_date`, the movement receives the payment amount minus the fee.

Example: a payment of R$ 264.55 with `card_rate_percentage` 3 has a fee of R$ 7.94, and the bill final amount is R$ 256.61.' card_rate: &957 type: number format: double minimum: 0 multipleOf: 0.01 writeOnly: true description: Agency payment only (`agency.credit_card`). Agency card fee as an amount, from 0 up to the payment amount. Monde calculates its percentage, and an amount above the payment is rejected with 422.

Send either `card_rate` or `card_rate_percentage`. The default, split and category rules are described in `card_rate_percentage`.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
payer: "$ref": "#/components/schemas/payment_payer_write" amount: allOf: - "$ref": "#/components/schemas/payment_amount" bank_account: "$ref": "#/components/schemas/bank_account" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true vendor_credit_card: type: object required: - card_last_digits - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" card_last_digits: allOf: - "$ref": "#/components/schemas/payment_card_last_digits" authorization: allOf: - "$ref": "#/components/schemas/payment_authorization" installments: allOf: - "$ref": "#/components/schemas/payment_installments" payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" agency_bank_slip: type: object required: - due_date - bank_account - products - amount properties: due_date: &958 allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &959 allOf: - "$ref": "#/components/schemas/payment_settlement_date" settlement_exchange_rate: &960 allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: &961 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true bank_slip_number: &962 type: integer readOnly: true description: Bank slip number. amount: &963 allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer_write" bank_account: "$ref": "#/components/schemas/bank_account" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true vendor_others: type: object required: - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" details: type: string maxLength: 255 description: 'Details about the payment. Can be used to specify the payment method used.

Examples: "Pix", "Bank slip", "Invoice", "Cash".' payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" agency_bank_deposit: type: object required: - due_date - bank_account - products - amount properties: due_date: &964 description: Expected bank deposit date (due date) in ISO 8601 format (YYYY-MM-DD). allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &965 allOf: - "$ref": "#/components/schemas/payment_settlement_date" settlement_exchange_rate: &966 allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: &967 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true observations: &968 allOf: - "$ref": "#/components/schemas/payment_observations" amount: &969 allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer_write" bank_account: "$ref": "#/components/schemas/bank_account" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true vendor_credit: type: object required: - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" document: type: string readOnly: true description: Supplier credit identification, such as a document number or other reference, when applicable. payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" agency_credit: type: object required: - products properties: payer: "$ref": "#/components/schemas/payment_payer_write" products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true agency_retained_by_intermediary: type: object required: - products properties: products: allOf: - "$ref": "#/components/schemas/payment_products" writeOnly: true payment_check_number: type: integer minimum: 1 maximum: 2147483647 description: Check number. payment_check_bank_code: type: string maxLength: 3 description: Code of the bank that issued the check. payment_check_document: type: string description: 'CPF (11 digits) or CNPJ (14 digits) of whoever issued the check. It may come with or without punctuation: only the digits are stored.' agency_cash: type: object required: - due_date - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_exchange_rate: allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" description: allOf: - "$ref": "#/components/schemas/payment_description" payer: "$ref": "#/components/schemas/payment_payer_write" products: "$ref": "#/components/schemas/payment_products" agency_check: type: object required: - due_date - check_number - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_exchange_rate: allOf: - "$ref": "#/components/schemas/payment_settlement_exchange_rate" check_number: "$ref": "#/components/schemas/payment_check_number" bank_code: "$ref": "#/components/schemas/payment_check_bank_code" document: "$ref": "#/components/schemas/payment_check_document" description: allOf: - "$ref": "#/components/schemas/payment_description" payer: "$ref": "#/components/schemas/payment_payer_write" products: "$ref": "#/components/schemas/payment_products" agency_others: type: object required: - due_date - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" details: type: string maxLength: 255 description: 'Details about the payment. Can be used to specify the payment method used.

Examples: "Pix", "Bank slip", "Invoice", "Cash".' description: allOf: - "$ref": "#/components/schemas/payment_description" payer: "$ref": "#/components/schemas/payment_payer_write" overpayment_return: type: boolean default: false writeOnly: true description: 'With `true`, the payment is the Return › Generate Account Payable of Monde (Devolução › Gerar Conta a Pagar): it gives back to the customer what was paid in excess. It is only accepted when, before it, some product of the sale has a negative customer balance (what was paid exceeds what the product is worth), counting the products and the payments that come before it in the list; otherwise, 422. The `amount` of each product carries the sign of the customer balance of that product, as Monde shows it: negative on a product with a negative balance and positive on the others; a sign that does not match is refused with 422, and the sum cannot be zero (422). There is no ceiling. The bill stays open, without account and without payment method: it is a debit (account payable) when the sum is negative, and a credit when it is positive. The negative amount goes to the customer payment category and the positive one to the customer receipt category, from the company settings; without them, 422. The return has no `description` nor `details` (422 when sent): the bill gets the default description, which can be changed later in the payment update. Also valid on an operator installation. Once written, the return comes in `payments.agency.bills` and is changed as the Outros payment; `overpayment_return` is not accepted in the change.' products: type: array description: List of products linked to this payment, with their respective amounts. **All products in the list must have the same supplier or representative**. items: "$ref": "#/components/schemas/agency_others_product" vendor_check: type: object required: - due_date - check_number - products properties: due_date: allOf: - "$ref": "#/components/schemas/payment_due_date" check_number: "$ref": "#/components/schemas/payment_check_number" bank_code: "$ref": "#/components/schemas/payment_check_bank_code" document: "$ref": "#/components/schemas/payment_check_document" payer: "$ref": "#/components/schemas/payment_payer_write" products: "$ref": "#/components/schemas/payment_products" payment_agency: type: object description: 'A single payment method per item: to pay with two methods, send two payments.' minProperties: 1 maxProperties: 1 properties: credit_card: description: Credit card payment. "$ref": "#/components/schemas/agency_credit_card" bank_slip: description: 'Bank slip payment. The bank slip is issued in reais: it only accepts products whose sale currency is BRL.' "$ref": "#/components/schemas/agency_bank_slip" bank_deposit: description: Payment by account deposit, which may represent different transfer methods such as Pix, TED, or DOC. You can use the observations field to specify which transfer type was used. "$ref": "#/components/schemas/agency_bank_deposit" credit: description: 'Payment using the credit the payer has with the agency (the sale company). It generates no bill: it records the payment and one item per product, due on the sale date. Without `payer`, the payer is the sale''s. With Monde''s credit control on, the amount is checked against the payer''s balance with the company, adding up every agency credit of the request, and consumed when the sale is saved; without enough balance, the response is 422. When the update takes it out of the sale, the used credit goes back to the payer. Without the credit control, the payment is recorded without checking the balance. Not accepted on an operator installation (422).' "$ref": "#/components/schemas/agency_credit" retained_by_intermediary: description: 'Amount retained by the sale intermediary, per product. Agency only, and only on a sale with an intermediary: on an operator installation, or without an intermediary, the response is 422. It generates no bill: it records one item per product, under the sale payer and due on the sale date, as in Monde. It accepts no payer or due date of its own.' "$ref": "#/components/schemas/agency_retained_by_intermediary" cash: description: 'Cash payment. Creates a bill in the Cash account set in the Sales settings of the company, which is not sent in the payload: without that account set, the response is 422. With the automatic settlement of Cash turned on in the Sales settings, the bill is created already settled on the due date, as in Monde. When settling in an account in another currency, the rate is `settlement_exchange_rate` or, without it, the one from the latest quotations. The due date cannot be earlier than the sale date. Not accepted on an operator (422).' "$ref": "#/components/schemas/agency_cash" check: description: 'Check payment. Each payment is one check: for several checks, send several payments. Creates a bill with the check data in the Check account set in the Sales settings of the company, which is not sent in the payload: without that account set, the response is 422. With the automatic settlement of Check turned on in the Sales settings, the bill is settled on the sale date, with the account movement on the check due date, as in Monde. When settling in an account in another currency, the rate is `settlement_exchange_rate` or, without it, the one from the latest quotations. The due date cannot be earlier than the sale date. Not accepted on an operator (422).' "$ref": "#/components/schemas/agency_check" others: description: Payment with another method. Creates an open bill, without account and without payment method, with the `details` text in its observations, as in Monde. The due date cannot be earlier than the sale date. Not accepted on an operator (422), except as an overpayment return (`overpayment_return`). "$ref": "#/components/schemas/agency_others" payment_vendor: type: object description: 'A single payment method per item: to pay with two methods, send two payments.' minProperties: 1 maxProperties: 1 properties: credit_card: description: Credit card payment. "$ref": "#/components/schemas/vendor_credit_card" others: description: Payment by other methods. Use the `details` field to specify the payment method used. "$ref": "#/components/schemas/vendor_others" credit: description: 'Payment using available supplier or representative credit. With Monde''s credit control on, the payment amount is checked against the payer''s balance with the supplier and representative of a single product, as in Monde: the first product of the payment, in alphabetical order of the representative and then of the supplier. Products of another supplier paid together use that same balance. Credit without a representative is a separate balance. The check adds up every credit payment of the request, and the amount is consumed when the sale is saved; without enough balance, the response is 422. When the update takes it out of the sale, the used credit goes back to the payer. Without the credit control, and on an operator installation, the payment is recorded without checking the balance.' "$ref": "#/components/schemas/vendor_credit" check: description: 'Check paid directly to the vendor. Each payment is one check: for several checks, send several payments. Does not create a bill: stores the vendor payment with the due date and the check data. The due date cannot be earlier than the sale date. Not accepted on an operator (422).' "$ref": "#/components/schemas/vendor_check" payment: type: object required: - local_id oneOf: - required: - agency - required: - vendor properties: local_id: type: string maxLength: 50 description: 'Name the integration gives the payment, unique among the new payments of the request. Required on a new payment. It is not stored: it comes back in the response, inside the payment, next to the generated `id`. It is how you know which `id` belongs to which payment, to keep or remove it in the sale update.' example: pagamento-1 agency: description: Payments directed to the agency. "$ref": "#/components/schemas/payment_agency" vendor: description: Payments directed to the vendor. Only updates balance, does not create accounts receivable. "$ref": "#/components/schemas/payment_vendor" payment_product_read: type: object readOnly: true description: Sale product covered by the payment, with the amount allocated to it. properties: amount: type: number format: double multipleOf: 0.01 description: Payment amount allocated to this product.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Sale product that received the amount.
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
payment_products_read: type: array readOnly: true description: Sale products covered by this payment, with the amount allocated to each one. items: "$ref": "#/components/schemas/payment_product_read" grouped_payment_product_read: type: object readOnly: true description: Sale product covered by the payment, with the amount allocated to it. properties: id: type: string format: uuid description: 'Identifier of the item recorded for this product. It keeps the payment in the sale update, like the payment `id`: the payment `id` may change when an identical payment included later joins the same line, and the item `id` does not.' example: 9c2e4a71-5b3d-4f80-a6c1-7d9e0b2f4a35 amount: type: number format: double multipleOf: 0.01 description: Payment amount allocated to this product.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Sale product that received the amount.
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
grouped_payment_products_read: type: array readOnly: true description: Sale products covered by this payment, with the amount allocated to each one. items: "$ref": "#/components/schemas/grouped_payment_product_read" payment_payer: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Payer of this payment, which may differ from the payer of the sale.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
payment_payer_write: writeOnly: true allOf: - "$ref": "#/components/schemas/individual_or_company" description: 'Payer of this payment, an individual or legal entity, provided the same way as the sale payer: when it does not exist, it is created by external_id or by document. When omitted, the payment inherits the payer of the sale.' payment_check: type: object readOnly: true nullable: true description: Check data; null when the payment was not by check. properties: number: type: integer nullable: true description: Check number. bank: type: string nullable: true description: Code of the bank that issued the check. document: type: string nullable: true description: Taxpayer ID of the check holder. payment_card: type: object readOnly: true nullable: true description: Card data; null when the payment was not by card. properties: brand: type: string nullable: true description: Card brand. last_digits: type: string nullable: true description: Last 4 digits of the card. authorization: type: string nullable: true description: Authorization code. agency_credit_read: type: object readOnly: true description: Payments using credit available at the agency. They generate no bill, so they come embedded. properties: id: type: string format: uuid description: Payment identifier. It is what the sale update uses to keep it in the `payments` list. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_agency_due_date" document: type: string nullable: true readOnly: true description: Agency credit identification, such as a document number or other reference, when applicable. amount: allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer" origin_sale: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true nullable: true description: |- Sale that originated the credit.
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
products: "$ref": "#/components/schemas/payment_products_read" agency_retained_by_intermediary_read: type: object readOnly: true description: 'Amounts retained by the intermediary. They generate no bill, so they come embedded. Items with the same due date, cost center and description form a single line, as in Monde: a retained amount included later with the same data joins the line and may change its `id`; the `id` of each item in `products` does not change, and any of them keeps the whole line in the update.' properties: id: type: string format: uuid description: Payment identifier. It is what the sale update uses to keep it in the `payments` list. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_agency_due_date" amount: description: Amount retained by the intermediary. Always positive.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/grouped_payment_products_read" agency_to_invoice_read: type: object readOnly: true description: 'A to-invoice line, as the payments grid of Monde: the to-invoice payments (Faturar) and to-invoice returns (Devolução Faturar) of the sale that already entered a customer invoice, grouped by invoice and cost center. The line has no `id`: it is pointed by the invoice and the cost center, as in the [to-invoice removal](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice~1removal/post). A to-invoice payment that has not entered an invoice yet does not show: those are the seconds until the automatic invoicing takes it. The payer and the due date are those of the invoice, in [Read account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get).' properties: bill: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Customer invoice the line is in.
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
cost_center: type: string nullable: true description: Cost center of the line; null on the line without a cost center. example: Diretoria amount: type: number format: double multipleOf: 0.01 description: |- Amount of the line: the sum of the products, with the sign. A negative amount is a to-invoice return.
  • In the sale currency of the product (`sale_currency`), BRL except for tour operators.
example: 2350.0 products: type: array description: 'What each product of the sale adds up to in the line, with the sign: a negative amount is a to-invoice return.' items: "$ref": "#/components/schemas/payment_product_read" agency_legacy_read: type: object readOnly: true description: Payments to the agency recorded without a bill in earlier versions of the system. No new payment lands in this list, and the method used comes in payment_method. properties: id: type: string format: uuid description: Payment identifier. It is what the sale update uses to keep it in the `payments` list. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_agency_due_date" amount: allOf: - "$ref": "#/components/schemas/payment_amount" check: "$ref": "#/components/schemas/payment_check" card: "$ref": "#/components/schemas/payment_card" payer: "$ref": "#/components/schemas/payment_payer" payment_method: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Payment method used.
  • Call the [Get payment method by ID](#tag/Payment-Methods/paths/~1payment_methods~1{id}/get) endpoint for the full data.
products: "$ref": "#/components/schemas/payment_products_read" vendor_credit_card_read: type: object readOnly: true properties: id: type: string format: uuid description: Payment identifier. It is what the sale update uses to keep it in the `payments` list. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" card_last_digits: readOnly: true allOf: - "$ref": "#/components/schemas/payment_card_last_digits" authorization: readOnly: true allOf: - "$ref": "#/components/schemas/payment_authorization" installments: readOnly: true allOf: - "$ref": "#/components/schemas/payment_installments" payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" vendor_check_read: type: object readOnly: true properties: id: type: string format: uuid description: Payment identifier. It is what the sale update uses to keep it in the `payments` list. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" bank_code: type: string readOnly: true description: Code of the bank that issued the check. check_number: type: integer readOnly: true description: Check number. payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" vendor_credit_read: type: object readOnly: true properties: id: type: string format: uuid description: Payment identifier. It is what the sale update uses to keep it in the `payments` list. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" document: type: string nullable: true readOnly: true description: Supplier credit identification, such as a document number or other reference, when applicable. payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" vendor_others_read: type: object readOnly: true properties: id: type: string format: uuid description: Payment identifier. It is what the sale update uses to keep it in the `payments` list. example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 due_date: allOf: - "$ref": "#/components/schemas/payment_vendor_due_date" details: type: string maxLength: 255 readOnly: true description: 'Details about the payment. Can be used to specify the payment method used.

Examples: "Pix", "Bank slip", "Invoice", "Cash".' payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_read" payment_agency_read: type: object readOnly: true description: Payments made to the agency. The `bills` and `refunds` lists are references; the remaining ones are payments recorded without a bill and come embedded. properties: bills: type: array description: |- Bills generated by the payments made to the agency and the customer invoices of returns. The to-invoice payment and the to-invoice return come in `to_invoice`, in the line of the customer invoice they entered. The payment method, the account, the settlement and the products covered live on the bill.
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" refunds: type: array description: |- Customer refunds recorded on this sale.
  • Call the [Query refunds by ID](#tag/Refunds/paths/~1refunds~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" credit: type: array description: Payment using available agency credit. items: "$ref": "#/components/schemas/agency_credit_read" to_invoice: type: array description: 'To-invoice payment (Faturar) and to-invoice return (Devolução Faturar): the payer pays, or gets back, through the customer invoice. They generate no bill of their own: each line is what the sale already has in a customer invoice, per cost center. Read only: add through the [to-invoice payment](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice/post) and the [to-invoice return](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice_returns/post), and remove through the [to-invoice removal](#tag/Sales/paths/~1sales~1{sale_id}~1to_invoice~1removal/post).' items: "$ref": "#/components/schemas/agency_to_invoice_read" retained_by_intermediary: type: array description: Amount retained by the intermediary. items: "$ref": "#/components/schemas/agency_retained_by_intermediary_read" legacy: type: array description: Payments to the agency recorded without a bill in earlier versions of the system. No new payment lands in this list, and the method used comes in payment_method. items: "$ref": "#/components/schemas/agency_legacy_read" payment_vendor_read: type: object readOnly: true description: Payments made to the vendor or representative. They generate no bill, so they come embedded, along with the products each payment covers. properties: credit_card: type: array description: Credit card payment. items: "$ref": "#/components/schemas/vendor_credit_card_read" check: type: array description: Check payment. items: "$ref": "#/components/schemas/vendor_check_read" credit: type: array description: 'Payment using available supplier or representative credit. With Monde''s credit control on, the payment amount is checked against the payer''s balance with the supplier and representative of a single product, as in Monde: the first product of the payment, in alphabetical order of the representative and then of the supplier. Products of another supplier paid together use that same balance. Credit without a representative is a separate balance. The check adds up every credit payment of the request, and the amount is consumed when the sale is saved; without enough balance, the response is 422. When the update takes it out of the sale, the used credit goes back to the payer. Without the credit control, and on an operator installation, the payment is recorded without checking the balance.' items: "$ref": "#/components/schemas/vendor_credit_read" others: type: array description: Payment by other methods. Use the `details` field to specify the payment method used. items: "$ref": "#/components/schemas/vendor_others_read" payment_read: type: object readOnly: true description: Payments of the sale, split between those made to the agency and those made to the vendor. properties: agency: allOf: - "$ref": "#/components/schemas/payment_agency_read" description: Payments made to the agency. The `bills` and `refunds` lists are references; the remaining ones are payments recorded without a bill and come embedded. vendor: allOf: - "$ref": "#/components/schemas/payment_vendor_read" description: Payments made to the vendor or representative. They generate no bill, so they come embedded, along with the products each payment covers. payment_update: type: object oneOf: - required: - id - required: - local_id - agency - required: - local_id - vendor description: 'Payment in the sale update. Without `id`, adds a new payment, as on creation. With only the `id`, keeps the payment the sale already has. With the `id` and the method it was added with, changes the payment, as in Monde: the payer (`payer`), the due date (`due_date`), the description (`description`) and the method data (card, check, `details`, `observations`) change, and only what was sent. The amount and the method do not change: `products`, `bank_account`, `settlement_date`, `settlement_exchange_rate`, `card_rate` and `card_rate_percentage` in a change are refused with 422, and so is another method; to change them, remove the payment from the list and add a new one without `id`. The locks are those of Monde: a settled or invoiced payment (in a client or vendor invoice) is not changed (422), and a closed sale is only changed after reopening (409). The retained-by-intermediary payment and the old payment recorded only in the sale are not changed here (422).' properties: id: type: string format: uuid description: 'Identifier of a payment the sale already has (the one that came back next to the `local_id` in the creation or update response, or the one in the sale get: the `id` of the supplier, credit or retained-by-intermediary payment or of any item in their `products`, or the bill in `payments.agency.bills`). With only the `id`, the payment stays as it is. The to-invoice payment and the to-invoice return are not part of this list: the sale update neither keeps nor removes them. With the `id` and the method it was added with, the payment is changed: see the change in the payment description.' example: 6b0d3f2e-91a4-4c57-8e1d-2f7a9c4b8e10 local_id: type: string maxLength: 50 description: 'Name the integration gives the payment, unique among the new payments of the request. Required on a new payment. It is not stored: it comes back in the response, inside the payment, next to the generated `id`. It is how you know which `id` belongs to which payment, to keep or remove it in the sale update.' example: pagamento-1 agency: description: Payments directed to the agency. "$ref": "#/components/schemas/payment_agency" vendor: description: Payments directed to the vendor. Only updates balance, does not create accounts receivable. "$ref": "#/components/schemas/payment_vendor" written_item: type: object description: 'Product or payment sent in this request: the generated `id` and the `local_id` you gave it.' properties: id: type: string format: uuid example: 5d7e2a91-4c3b-4f8e-9a16-2b0c8d3e7f45 local_id: type: string nullable: true description: 'The `local_id` you sent in this item. It is not stored: it only comes in the response to the request that sent the item. Null on a product updated by `id` without a `local_id`.' example: seguro-1 sale_written: description: The sale in the get by ID format. Each product and payment sent in this request brings the `local_id` next to the generated `id`. allOf: - "$ref": "#/components/schemas/sale_detail" sale_written_reference: type: object description: 'Response to a credential that cannot get the updated sale: the sale `id` and, in the same format as the sale, the `id` and the `local_id` of each product and payment sent in this request. Nothing beyond what you sent.' properties: id: type: string format: uuid example: 212b54b8-27df-4859-80a9-79ad855bcd09 insurances: type: array items: "$ref": "#/components/schemas/written_item" cruises: type: array items: "$ref": "#/components/schemas/written_item" hotels: type: array items: "$ref": "#/components/schemas/written_item" airline_tickets: type: array items: "$ref": "#/components/schemas/written_item" train_tickets: type: array items: "$ref": "#/components/schemas/written_item" ground_transportations: type: array items: "$ref": "#/components/schemas/written_item" car_rentals: type: array items: "$ref": "#/components/schemas/written_item" travel_packages: type: array items: "$ref": "#/components/schemas/written_item" others: type: array items: "$ref": "#/components/schemas/written_item" cvc_packages: type: array items: "$ref": "#/components/schemas/written_item" operations: type: array items: "$ref": "#/components/schemas/written_item" excursions: type: array items: "$ref": "#/components/schemas/written_item" visas: type: array items: "$ref": "#/components/schemas/written_item" payments: type: object properties: agency: type: object properties: bills: type: array items: "$ref": "#/components/schemas/written_item" credit: type: array items: "$ref": "#/components/schemas/written_item" retained_by_intermediary: type: array items: "$ref": "#/components/schemas/written_item" vendor: type: object properties: credit_card: type: array items: "$ref": "#/components/schemas/written_item" check: type: array items: "$ref": "#/components/schemas/written_item" credit: type: array items: "$ref": "#/components/schemas/written_item" others: type: array items: "$ref": "#/components/schemas/written_item" passenger_document: type: string description: Passenger identification for the product, such as a ticket number or other identification reference, when applicable. maxLength: 30 passenger_cost_center: type: string maxLength: 50 description: Passenger cost center. When the sale payer is a legal person, it must be one of the cost centers registered for that payer (case-insensitive) and is stored with the name as registered; any other value rejects the sale with 422. With an individual payer, or when the sales setting **Enter the cost center as free text** is on, any text is accepted. passenger_canceled_at: type: string format: date-time readOnly: true description: Passenger cancellation date. passenger_amount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Product amount charged to the passenger.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_fees: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: ' Fees charged by the supplier or representative. Also known as "administrative fee", "issuance fee", "boarding fee", among others.
  • It must be provided in the same currency specified in the `currency` field.
' passenger_other_fees: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Miscellaneous fees charged to the passenger, in addition to the product-specific fees. What it represents varies by product.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_tip: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Gratuity charged to the passenger on the cruise.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_rav_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Travel Agent Remuneration (RAV), revenue generated by the agency, especially on airfare.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_rav_fee_discount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Discount applied over the RAV.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_agency_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Fee charged directly by the travel agency, without direct link to the supplier or representative. The value is added to the product total but is not shown detailed to the end customer.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_customer_amount: type: number format: double readOnly: true minimum: 0 description: " Amount charged to the customer for the passenger.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_total_amount: type: number format: double readOnly: true minimum: 0 description: " Passenger total amount.
  • It must be provided in the same currency specified in the `currency` field.
" passenger_person: description: 'The passenger person: their data, to register or update by `external_id`, or only the `id` of a person already registered. The person identifies the passenger in the product: the same person appears only once, and when the sale is changed a person who is already a passenger has that same passenger changed.' oneOf: - "$ref": "#/components/schemas/individual_person" - "$ref": "#/components/schemas/passenger_person_reference" passenger_person_reference: type: object title: Registered person description: Points to a registered person by the `id`, as the sale get returns it. The person data is not changed here, and the other fields sent with the `id` are ignored. Requires the permission to read people; without it, or with a legal person, the response is 422. required: - id properties: id: type: string format: uuid description: Identifier (UUID) of the registered individual person. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 insurance_passenger: type: object required: - person properties: document: &524 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &525 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &526 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &527 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &528 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Amount of `fees` in the product origin currency (`origin_currency`). rav_fee: &529 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &530 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Amount of `rav_fee` in the product origin currency (`origin_currency`). rav_fee_discount: &531 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &532 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Amount of `rav_fee_discount` in the product origin currency (`origin_currency`). agency_fee: &533 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &534 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). amount: &535 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &536 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). customer_amount: &537 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &538 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). total_amount: &539 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &540 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Amount of `total_amount` in the product origin currency (`origin_currency`). person: &541 allOf: - "$ref": "#/components/schemas/passenger_person" insurance_passenger_read: type: object readOnly: true required: - person properties: document: *524 cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: &559 allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Passenger personal data.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
train_passenger: type: object required: - person properties: document: &542 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &543 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &544 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &545 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &546 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Amount of `fees` in the product origin currency (`origin_currency`). rav_fee: &547 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &548 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Amount of `rav_fee` in the product origin currency (`origin_currency`). rav_fee_discount: &549 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &550 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Amount of `rav_fee_discount` in the product origin currency (`origin_currency`). agency_fee: &551 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &552 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). amount: &553 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &554 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). customer_amount: &555 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &556 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). total_amount: &557 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &558 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Amount of `total_amount` in the product origin currency (`origin_currency`). person: *541 train_passenger_read: type: object readOnly: true required: - person properties: document: *542 cost_center: *543 canceled_at: *544 fees: *545 fees_origin_currency: *546 rav_fee: *547 rav_fee_origin_currency: *548 rav_fee_discount: *549 rav_fee_discount_origin_currency: *550 agency_fee: *551 agency_fee_origin_currency: *552 amount: *553 amount_origin_currency: *554 customer_amount: *555 customer_amount_origin_currency: *556 total_amount: *557 total_amount_origin_currency: *558 person: *559 ground_transportation_passenger: type: object required: - person - document properties: document: &560 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &561 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &562 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &563 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &564 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Amount of `fees` in the product origin currency (`origin_currency`). rav_fee: &565 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &566 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Amount of `rav_fee` in the product origin currency (`origin_currency`). rav_fee_discount: &567 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &568 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Amount of `rav_fee_discount` in the product origin currency (`origin_currency`). agency_fee: &569 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &570 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). amount: &571 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &572 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). customer_amount: &573 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &574 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). total_amount: &575 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &576 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Amount of `total_amount` in the product origin currency (`origin_currency`). person: *541 ground_transportation_passenger_read: type: object readOnly: true required: - person properties: document: *560 cost_center: *561 canceled_at: *562 fees: *563 fees_origin_currency: *564 rav_fee: *565 rav_fee_origin_currency: *566 rav_fee_discount: *567 rav_fee_discount_origin_currency: *568 agency_fee: *569 agency_fee_origin_currency: *570 amount: *571 amount_origin_currency: *572 customer_amount: *573 customer_amount_origin_currency: *574 total_amount: *575 total_amount_origin_currency: *576 person: *559 cruise_passenger: type: object required: - person properties: document: &577 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &578 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &579 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &580 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &581 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Amount of `fees` in the product origin currency (`origin_currency`). tip: &582 allOf: - "$ref": "#/components/schemas/passenger_tip" tip_origin_currency: &583 allOf: - "$ref": "#/components/schemas/passenger_tip" readOnly: true description: Amount of `tip` in the product origin currency (`origin_currency`). rav_fee: &584 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &585 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Amount of `rav_fee` in the product origin currency (`origin_currency`). rav_fee_discount: &586 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &587 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Amount of `rav_fee_discount` in the product origin currency (`origin_currency`). agency_fee: &588 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &589 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). amount: &590 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &591 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). customer_amount: &592 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &593 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). total_amount: &594 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &595 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Amount of `total_amount` in the product origin currency (`origin_currency`). person: *541 cruise_passenger_read: type: object readOnly: true required: - person properties: document: *577 cost_center: *578 canceled_at: *579 fees: *580 fees_origin_currency: *581 tip: *582 tip_origin_currency: *583 rav_fee: *584 rav_fee_origin_currency: *585 rav_fee_discount: *586 rav_fee_discount_origin_currency: *587 agency_fee: *588 agency_fee_origin_currency: *589 amount: *590 amount_origin_currency: *591 customer_amount: *592 customer_amount_origin_currency: *593 total_amount: *594 total_amount_origin_currency: *595 person: *559 operation_passenger: type: object required: - person properties: document: &616 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &617 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &618 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &619 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &620 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Amount of `fees` in the product origin currency (`origin_currency`). amount: &621 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &622 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). customer_amount: &623 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &624 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). total_amount: &625 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &626 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Amount of `total_amount` in the product origin currency (`origin_currency`). person: *541 default_passenger: type: object required: - person properties: document: &597 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &598 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &599 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &600 allOf: - "$ref": "#/components/schemas/passenger_fees" fees_origin_currency: &601 allOf: - "$ref": "#/components/schemas/passenger_fees" readOnly: true description: Amount of `fees` in the product origin currency (`origin_currency`). other_fees: &602 allOf: - "$ref": "#/components/schemas/passenger_other_fees" other_fees_origin_currency: &603 allOf: - "$ref": "#/components/schemas/passenger_other_fees" readOnly: true description: Amount of `other_fees` in the product origin currency (`origin_currency`). rav_fee: &604 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &605 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Amount of `rav_fee` in the product origin currency (`origin_currency`). rav_fee_discount: &606 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &607 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Amount of `rav_fee_discount` in the product origin currency (`origin_currency`). agency_fee: &608 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &609 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). amount: &610 allOf: - "$ref": "#/components/schemas/passenger_amount" amount_origin_currency: &611 allOf: - "$ref": "#/components/schemas/passenger_amount" readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). customer_amount: &612 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &613 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). total_amount: &614 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &615 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Amount of `total_amount` in the product origin currency (`origin_currency`). person: *541 default_passenger_read: type: object readOnly: true required: - person properties: document: &596 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: *559 excursion_passenger: type: object required: - person properties: document: *596 cost_center: *525 canceled_at: *526 fees: *527 fees_origin_currency: *528 rav_fee: *529 rav_fee_origin_currency: *530 rav_fee_discount: *531 rav_fee_discount_origin_currency: *532 agency_fee: *533 agency_fee_origin_currency: *534 amount: *535 amount_origin_currency: *536 customer_amount: *537 customer_amount_origin_currency: *538 total_amount: *539 total_amount_origin_currency: *540 person: *541 visa_passenger: type: object description: 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: *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.

Passenger original ticket number. Use this field to indicate that the ticket was reissued by providing the ticket number that originated the reissue." maxLength: 30 emission_name: &649 type: string description: Passenger name as issued on the ticket. maxLength: 50 cost_center: &650 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &651 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" boarding_fee: &652 type: number format: double minimum: 0 exclusiveMaximum: 100000000000 description: " Boarding fee charged to the passenger.
  • It must be provided in the same currency specified in the `currency` field.
" boarding_fee_origin_currency: &653 type: number format: double readOnly: true description: Amount of `boarding_fee` in the product origin currency (`origin_currency`). other_fees: &654 allOf: - "$ref": "#/components/schemas/passenger_other_fees" other_fees_origin_currency: &655 allOf: - "$ref": "#/components/schemas/passenger_other_fees" readOnly: true description: Amount of `other_fees` in the product origin currency (`origin_currency`). rav_fee: &656 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_origin_currency: &657 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" readOnly: true description: Amount of `rav_fee` in the product origin currency (`origin_currency`). rav_fee_discount: &658 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" rav_fee_discount_origin_currency: &659 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" readOnly: true description: Amount of `rav_fee_discount` in the product origin currency (`origin_currency`). du_fee: &660 type: number format: double minimum: 0 description: " Additional remuneration that some airlines offer to agencies (DU).
  • It must be provided in the same currency specified in the `currency` field.
" du_fee_origin_currency: &661 type: number format: double readOnly: true description: Amount of `du_fee` in the product origin currency (`origin_currency`). du_fee_discount: &662 type: number format: double readOnly: true minimum: 0 description: " Discount applied over the DU.
  • It must be provided in the same currency specified in the `currency` field.
" du_fee_discount_origin_currency: &663 type: number format: double readOnly: true description: Amount of `du_fee_discount` in the product origin currency (`origin_currency`). agency_fee: &664 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" agency_fee_origin_currency: &665 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" readOnly: true description: Amount of `agency_fee` in the product origin currency (`origin_currency`). amount: &666 type: number format: double default: 0 minimum: 0 description: " Product amount charged to the passenger.
  • It must be provided in the same currency specified in the `currency` field.
" amount_origin_currency: &667 type: number format: double readOnly: true description: Amount of `amount` in the product origin currency (`origin_currency`). customer_amount: &668 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" customer_amount_origin_currency: &669 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" readOnly: true description: Amount of `customer_amount` in the product origin currency (`origin_currency`). total_amount: &670 allOf: - "$ref": "#/components/schemas/passenger_total_amount" total_amount_origin_currency: &671 allOf: - "$ref": "#/components/schemas/passenger_total_amount" readOnly: true description: Amount of `total_amount` in the product origin currency (`origin_currency`). person: description: Passenger personal data. allOf: - "$ref": "#/components/schemas/individual_person" airline_ticket_passenger_read: type: object readOnly: true required: - ticket_number properties: ticket_number: *647 original_ticket_number: *648 emission_name: *649 cost_center: *650 canceled_at: *651 boarding_fee: *652 boarding_fee_origin_currency: *653 other_fees: *654 other_fees_origin_currency: *655 rav_fee: *656 rav_fee_origin_currency: *657 rav_fee_discount: *658 rav_fee_discount_origin_currency: *659 du_fee: *660 du_fee_origin_currency: *661 du_fee_discount: *662 du_fee_discount_origin_currency: *663 agency_fee: *664 agency_fee_origin_currency: *665 amount: *666 amount_origin_currency: *667 customer_amount: *668 customer_amount_origin_currency: *669 total_amount: *670 total_amount_origin_currency: *671 person: *559 pagination: type: object description: Pagination information for the response. properties: size: type: integer minimum: 1 maximum: 50 description: Number of records per page example: 10 has_next_page: type: boolean description: Whether a next page exists. To walk through the whole query, request the next page with `next_cursor` while this is true example: true next_cursor: type: - string - 'null' description: Cursor to request the next page. Null when there is no next page. example: eyJfcmFpbHMiOnsiZGF0YSI6WyIyMDI2LTAzLTEwIiwiNmIwZjdjMWUtMmQ0YS00ZjhiLTljMzEtNThhMGQ3ZTEzZjQyIl0sInB1ciI6ImFwaS92My9wcm9kdWN0cyNpbmRleCJ9fQ--3aa1d942d6240ca905038c019d661bc90af6836fc4a818cee3663829c75970e4 cabin: type: object description: Represents a cabin type registered in the system. properties: name: type: string maxLength: 30 description: Cabin name (unique identifier) example: Varanda required: - name cabin_write: type: object description: Data to create or update a cabin. On update, every field is optional. additionalProperties: false properties: name: type: string minLength: 1 maxLength: 30 description: Cabin name, up to 30 characters and not repeating another cabin. Line breaks are removed. Required on creation; on update, a new name renames the cabin. example: Varanda ship: type: object description: Represents a ship registered in the system. properties: name: type: string maxLength: 30 description: Ship name (unique identifier) example: MSC Preziosa required: - name ship_write: type: object description: Data to create or update a ship. On update, every field is optional. additionalProperties: false properties: name: type: string minLength: 1 maxLength: 30 description: Ship name, up to 30 characters and not repeating another ship. Line breaks are removed. Required on creation; on update, a new name renames the ship. example: MSC Preziosa package: type: object description: Represents a package registered in the system. properties: name: type: string maxLength: 50 description: Package name (unique identifier) example: Disney 7 noites services_included: type: - string - 'null' description: Services included in the package, which Monde copies to the tour package product description when the package is chosen in the sale example: Aéreo, hotel e ingressos para os parques required: - name package_write: type: object description: Data to create or update a package. On update, every field is optional. additionalProperties: false properties: name: type: string minLength: 1 maxLength: 50 description: Package name, up to 50 characters and not repeating another package. Line breaks are removed. Required on creation; on update, a new name renames the package. example: Disney 7 noites services_included: type: - string - 'null' description: Services included in the package. On update, null clears the field. example: Aéreo, hotel e ingressos para os parques cost_center: type: object description: Represents a cost center registered in the system. properties: id: type: string format: uuid description: Unique cost center identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Cost center description example: Marketing required: - id - description cost_center_create: type: object writeOnly: true description: Data to register a cost center. required: - description properties: description: type: string maxLength: 50 description: Cost center description, up to 50 characters. Required on creation. example: Marketing cost_center_update: type: object writeOnly: true description: Data to change a cost center. properties: description: type: string maxLength: 50 description: Cost center description, up to 50 characters. Required on creation. example: Marketing currency: type: object description: Represents a currency registered in the system. properties: code: type: string minLength: 3 maxLength: 3 description: Currency code in ISO 4217 format (unique identifier) example: BRL description: type: string description: Currency description example: Real symbol: type: string nullable: true description: Currency symbol example: R$ active: type: boolean description: Indicates whether the currency is active example: true required: - code - description - active currency_update: type: object description: Data to update the currency. Every field is optional. additionalProperties: false properties: code: type: string minLength: 3 maxLength: 3 description: 'Currency code. It is fixed: a value different from the current one is rejected (422)' example: USD description: type: string maxLength: 100 description: 'Currency description. It is fixed: a value different from the current one is rejected (422)' example: Dólar Americano symbol: type: - string - 'null' maxLength: 5 description: 'Currency symbol. It is fixed: a value different from the current one is rejected (422)' example: US$ active: type: boolean description: Whether the currency is active example: true exchange_rate_create: type: object description: Data to record the currency's new exchange rate. additionalProperties: false properties: value: type: number exclusiveMinimum: 0 maximum: 99999999999.9999 description: How many reais one unit of the currency is worth, greater than zero. It is recorded with 4 decimal places example: 5.4321 required: - value exchange_rate_update: type: object description: The new exchange rates of several currencies. additionalProperties: false properties: exchange_rates: type: array minItems: 1 description: The new exchange rates, one per currency items: type: object properties: currency_code: type: string minLength: 3 maxLength: 3 description: Currency code, active and other than BRL example: USD value: type: number exclusiveMinimum: 0 maximum: 99999999999.9999 description: How many reais one unit of the currency is worth, greater than zero. It is recorded with 4 decimal places example: 5.4321 required: - currency_code - value required: - exchange_rates exchange_rate_update_response: type: object description: The exchange rates recorded by the update. properties: exchange_rates: type: array description: The recorded exchange rates. A currency whose value did not change is left out items: "$ref": "#/components/schemas/exchange_rate" required: - exchange_rates category_summary: type: object description: Represents a financial category registered in the system, with the category's own fields. properties: id: type: string format: uuid description: Unique category identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Category description example: Aluguel kind: type: string enum: - expense - revenue description: 'Category kind, inherited from its group: `expense` or `revenue`. In a financial entry, a `revenue` category adds to the amount of a `credit` entry (accounts receivable) and is deducted from a `debit` entry (accounts payable); an `expense` category does the opposite.' example: expense pass_through: type: boolean description: Indicates whether the category is a pass-through category. Pass-through amounts merely flow through the agency and must not be counted as actual revenue or expense. example: false required: - id - description - kind - pass_through category: description: Represents a financial category registered in the system, with its group. allOf: - "$ref": "#/components/schemas/category_summary" - type: object required: - group properties: group: type: object description: Group the category belongs to properties: id: type: string format: uuid description: Unique identifier of the category group in UUID format example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: type: string description: Name of the category group example: Despesas Administrativas required: - id - name category_create: type: object writeOnly: true description: Data to register a financial category. required: - description - group_id properties: description: type: string maxLength: 50 description: Category description, up to 50 characters. Required on creation. example: Aluguel group_id: type: string format: uuid description: ID of the category group (see `GET /category_groups`). Required on creation. On update, only a group of the same kind. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 pass_through: type: boolean description: 'Whether the category is a pass through: amounts that only go through the agency and stay out of the result. On creation, the default is `false`.' example: false category_update: type: object writeOnly: true description: Data to change a financial category. Send only the fields that change. properties: description: type: string maxLength: 50 description: Category description, up to 50 characters. Required on creation. example: Aluguel group_id: type: string format: uuid description: ID of the category group (see `GET /category_groups`). Required on creation. On update, only a group of the same kind. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 pass_through: type: boolean description: 'Whether the category is a pass through: amounts that only go through the agency and stay out of the result. On creation, the default is `false`.' example: false city_summary: type: object description: Represents a city registered in the system, with the city's own fields. properties: id: type: string format: uuid description: Unique city identifier example: f9d961b8-ea88-4346-8e52-afe94267417a name: type: string description: City name example: São Paulo ibge: type: string nullable: true description: City IBGE code (Brazilian cities only) example: '3550308' siafi: type: string nullable: true description: City SIAFI code (Brazilian cities only) example: '7107' required: - id - name city: description: Represents a city registered in the system, with its state and country. allOf: - "$ref": "#/components/schemas/city_summary" - type: object properties: state: type: object nullable: true description: City state (null for foreign cities) properties: id: type: string format: uuid description: Unique state identifier example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 acronym: type: string description: State acronym (UF) example: SP name: type: string description: State name example: São Paulo required: - id - acronym - name country: type: object nullable: true description: City country properties: id: type: string format: uuid description: Unique country identifier example: c3b7e8eb-1199-4457-9170-923c3fe56c92 name: type: string description: Country name example: Brasil code: type: string nullable: true description: Two-letter country code (ISO 3166-1 alpha-2) example: BR code_3: type: string nullable: true description: Three-letter country code (ISO 3166-1 alpha-3) example: BRA sisbacen: type: integer nullable: true description: Country SISBACEN code example: 1058 required: - id - name person_role_summary: type: object description: Represents a role in the list query, with the own fields of the role. properties: id: type: string format: uuid description: Unique role identifier example: 7c1e4b2a-9d3f-4a6b-8e5c-2f1d0a9b8c7e description: type: string description: Role name example: Gerente seller: type: boolean description: Marks the system seller role, which commissions the seller of the sale example: false intermediary: type: boolean description: Marks the system intermediary role, which commissions the intermediary of the sale example: false system: type: boolean description: Marks a system role (Seller and Intermediary), which is not renamed nor deleted example: false required: - id - description - seller - intermediary - system person_role: description: Represents a registered role, with the companies or sellers over whose sales it is commissioned and the linked people. allOf: - "$ref": "#/components/schemas/person_role_summary" - type: object properties: commissioned_over: type: array description: Companies and sellers over whose sales the role is commissioned (the "Commissioned over" group in Monde), by the person `id`. Empty in a system role. items: "$ref": "#/components/schemas/entity_reference" people: type: array description: People linked to the role. items: "$ref": "#/components/schemas/person_role_person" person_role_person: type: object description: Person linked to the role. properties: id: type: string format: uuid description: Identifier of the link of the person with the role, used to keep it on update example: 0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b person: allOf: - "$ref": "#/components/schemas/entity_reference" description: Linked person commission_plan: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Commission plan of the person in the role start_date: type: string format: date nullable: true description: Date from which the person is commissioned in the role example: '2026-01-01' not_commissioned: type: boolean description: Marks that the person is not commissioned in the role example: false goals: type: array description: Goals of the person in the role, per year (the "Plan and Goals" in Monde). items: "$ref": "#/components/schemas/person_role_goal" required: - id - person - commission_plan - start_date - not_commissioned - goals person_role_goal: type: object description: Goal of the person in the role for a year, with the amount of each month, as in [Goals](#tag/Goals). properties: id: type: string format: uuid readOnly: true description: Identifier of the goal, the same as in [Goals](#tag/Goals), used to keep it on update example: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a year: type: integer description: Year of the goal example: 2026 months: "$ref": "#/components/schemas/goal_months" required: - id - year - months person_role_write: type: object description: Data to register a role. properties: &672 description: type: string maxLength: 30 description: Role name, up to 30 characters. example: Gerente commissioned_over: type: array description: Companies and active sellers over whose sales the role is commissioned, by the `id` from [List companies](#tag/Companies/paths/~1companies/get) or [List sellers](#tag/Sellers/paths/~1sellers/get), which is the id of the person. Required on registration, with at least one item. On update, the list sent replaces the list of the role. items: "$ref": "#/components/schemas/entity_reference" people: type: array description: People linked to the role. On update, the list sent is final. items: "$ref": "#/components/schemas/person_role_person_write" required: - description person_role_update: type: object description: Data to update a role. Every field is optional. properties: *672 person_role_person_write: type: object description: Person linked to the role. Without `id`, links a new person; with `id`, keeps that link and changes only the fields sent. properties: id: type: string format: uuid description: Identifier of a link the role already has, from the role query. When omitted, the item links a new person. example: 0e9d8c7b-6a5f-4e3d-2c1b-0a9f8e7d6c5b person: allOf: - "$ref": "#/components/schemas/entity_reference" description: 'Person to link, by the `id` from [List people](#tag/People/paths/~1people/get). Required in an item without `id`. An existing link does not change person: to link another one, send a new item.' commission_plan: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Commission plan of the person in the role, by the plan `id`. Null removes the plan from the link. start_date: type: string format: date nullable: true description: Date from which the person is commissioned, in the YYYY-MM-DD format. Required unless `not_commissioned` is `true`. example: '2026-01-01' not_commissioned: type: boolean description: "`true` when the person is not commissioned in the role, which waives the start date. Omitted in a new item, it is `false`." example: false goals: type: array nullable: true description: 'Goals of the person in the role. The list sent is final: a goal with `id` stays, a goal without `id` comes in, and a goal left out is deleted. When omitted, the goals stay as they are; when null, all of them are deleted. One year per person in the role.' items: "$ref": "#/components/schemas/person_role_goal_write" person_role_goal_write: type: object description: Goal of the person in the role. Without `id`, creates a goal; with `id`, keeps that goal and changes only the fields sent. properties: id: type: string format: uuid description: Identifier of a goal the person already has in the role, from the role query. When omitted, the item creates a new goal. example: 1d2c3b4a-5f6e-4d7c-8b9a-0f1e2d3c4b5a year: type: integer description: Year of the goal, required in a new goal. In a new goal or when it changes, it goes from the previous year to five years ahead; a goal already saved with another year is accepted while the year does not change. One year per person in the role. example: 2026 months: allOf: - "$ref": "#/components/schemas/goal_months" description: Amount of each month, never negative. In a new goal, `months` and `january` are required, and an omitted month gets the January amount. In an existing goal, only the months sent change. seller_summary: type: object description: Represents a seller in the list read, with the register's own fields. properties: id: type: string format: uuid description: Unique seller identifier (the same as the corresponding person identifier) example: f9d961b8-ea88-4346-8e52-afe94267417a active: type: boolean description: Indicates whether the seller is active example: true created_at: type: string format: date-time description: Date and time the seller was registered example: '2024-03-15T10:30:00' required: - id - created_at seller: description: Represents a seller registered in the system. The seller identifier is the same as the corresponding person identifier. allOf: - "$ref": "#/components/schemas/seller_summary" - type: object required: - person properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Person corresponding to the seller
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the seller
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
seller_update: type: object writeOnly: true description: 'Data to change a seller. Every field is optional: a field left out stays as it is. None of them can be removed: sent as null, it is rejected.' properties: person_id: type: string format: uuid description: Identifier of the person of the seller. Optional; if sent, it must be the seller's own person, which does not change example: f9d961b8-ea88-4346-8e52-afe94267417a active: type: boolean description: Indicates whether the seller stays active. An inactive seller is no longer offered in new sales example: false payment_method: type: object description: Represents a payment method registered in the system. properties: id: type: string format: uuid description: Unique payment method identifier example: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 name: type: string description: Payment method description example: Dinheiro system: type: boolean description: Indicates whether the payment method is a system default (cannot be edited or deleted) example: true required: - id - name - system payment_method_create: type: object writeOnly: true description: Data to register a payment method. required: - name properties: name: type: string maxLength: 30 description: Payment method name, up to 30 characters. Required on creation. example: Vale-viagem payment_method_update: type: object writeOnly: true description: Data to change a payment method. properties: name: type: string maxLength: 30 description: Payment method name, up to 30 characters. Required on creation. example: Vale-viagem account_summary: type: object description: Represents an account or card in the list read, with the register's own fields. properties: id: type: string format: uuid description: Unique account identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Account description example: Banco do Brasil - Matriz kind: type: string enum: - checking_account - card_account - check_account - cashier_account description: " Account kind.
  • checking_account: checking account.
  • card_account: credit card.
  • check_account: checks.
  • cashier_account: cashier.
" example: checking_account active: type: boolean description: Indicates whether the account is active example: true currency: type: string minLength: 3 maxLength: 3 description: Account currency code in ISO 4217 format example: BRL initial_balance: type: number format: double description: Account initial balance example: 1500.0 bank_operation: type: string nullable: true description: Bank operation code. Relevant only for Caixa Econômica Federal checking accounts; null otherwise. example: '001' agency: type: string nullable: true description: Bank branch number example: '1412' agency_digit: type: string nullable: true description: Bank branch digit example: '5' number: type: string nullable: true description: Bank account number example: '04640' digit: type: string nullable: true description: Bank account digit example: '2' pix_key: type: string nullable: true description: Account Pix key example: financeiro@agencia.com.br bill_expiration: type: integer nullable: true minimum: 1 maximum: 31 description: Bill due day (1 to 31). Applies only to credit card accounts; null otherwise. example: 10 bill_closing: type: integer nullable: true minimum: 1 maximum: 31 description: Bill closing day (1 to 31). Applies only to credit card accounts; null otherwise. example: 1 required: - id - description - kind - active - currency - initial_balance account: description: Represents an account or card registered in the system. Bank fields are filled for checking accounts; card fields, for credit cards. allOf: - "$ref": "#/components/schemas/account_summary" - type: object required: - companies properties: bank: type: object nullable: true description: Account bank (checking accounts only) properties: id: type: string format: uuid description: Unique bank identifier example: c3b7e8eb-1199-4457-9170-923c3fe56c92 number: type: string description: Bank number example: '001' name: type: string description: Bank name example: Banco do Brasil required: - id - name owner: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Account owner
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
card_operator: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Card operator (credit cards only)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
companies: type: array description: |- Companies where the account is available
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" invoice_company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: Company where the credit card invoice is generated; null for other accounts. user_groups: type: array description: User groups the account is released to. An empty list is an account with no group restriction. items: "$ref": "#/components/schemas/entity_reference" next_bank_slip_number: type: integer nullable: true description: Number of the next bank slip the checking account issues. Null on other accounts. example: 1520 billing_accounts: type: array description: Bank slip billing setups of the checking account (Monde Bancos and CobreBem). items: "$ref": "#/components/schemas/billing_account" billing_account: type: object description: Bank slip billing of the checking account, through Monde Bancos or CobreBem. PJBank billing has its own registration and does not appear here. properties: id: type: string format: uuid description: Unique billing setup identifier kind: type: string enum: - monde_bancos - cobre_bem description: 'Who issues the bank slip: `monde_bancos` or `cobre_bem`.' registered: type: boolean description: Whether the billing is registered. On CobreBem, it is informed on writing, as on the screen; on Monde Bancos, it comes from the chosen portfolio, and the value sent is ignored. active: type: boolean description: Whether the billing setup is active bank_issues_billet: type: boolean description: The bank issues the bank slip bank_generates_number: type: boolean description: The bank generates the our-number allows_unregistered_issue: type: boolean description: Allows issuing the bank slip before registration (registered billing only) portfolio: type: string nullable: true description: Portfolio, one of those offered by the account bank (Monde Bancos) document_kind: type: string nullable: true description: Document kind, such as `DM` (trade bill) or `DS` (service bill) return_layout: type: string nullable: true description: Return file layout, one of those offered by the account bank (Monde Bancos) remittance_layout: type: string nullable: true description: Remittance file layout, one of those offered by the account bank (Monde Bancos) agreement_code: type: string nullable: true description: Agreement code variation: type: string nullable: true description: Portfolio variation accept: type: string nullable: true description: Acceptance (one letter) ceb_code: type: string nullable: true description: CEB code billet_instructions: type: string nullable: true description: Bank slip instructions. Together with the interest, protest and fee lines, the bank slip has up to 6 lines. local_of_payment: type: string nullable: true description: Place of payment assignor_format: type: string nullable: true description: Assignor code format our_number_format: type: string nullable: true description: Our-number format other_settings: type: string nullable: true description: Bank specific settings, one per line, as key=value late_fine: type: number format: double nullable: true description: Late fine (%) late_interest: type: number format: double nullable: true description: Late interest (%) bank_fee: type: number format: double nullable: true description: Bank fee billet_rate: type: number format: double nullable: true description: Bank slip fee last_remittance: type: integer nullable: true description: Last remittance number days_protest: type: integer nullable: true description: Days to protest guarantor: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Guarantor
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
cobre_bem: type: object nullable: true description: CobreBem configuration; null on Monde Bancos billing. properties: license_loaded: type: boolean description: Whether the CobreBem license file is loaded skip_detail2: type: boolean description: Do not generate remittance detail 2 skip_detail3: type: boolean description: Do not generate remittance detail 3 config1: type: string nullable: true description: License setting 1 config2: type: string nullable: true description: License setting 2 config3: type: string nullable: true description: License setting 3 config4: type: string nullable: true description: License setting 4 config5: type: string nullable: true description: License setting 5 remittance_layout: type: string nullable: true description: Remittance layout return_layout: type: string nullable: true description: Return layout document_kind: type: string nullable: true description: Document kind remittance_accept: type: string nullable: true description: Remittance acceptance (one letter) instruction1: type: string nullable: true description: Billing instruction 1 instruction2: type: string nullable: true description: Billing instruction 2 instruction3: type: string nullable: true description: Billing instruction 3 title_properties: type: string nullable: true description: Special title properties, one per line, as PROPERTY=VALUE account_properties: type: string nullable: true description: Special account properties, one per line, as PROPERTY=VALUE instruction1_value: type: integer nullable: true description: Value of billing instruction 1 instruction2_value: type: integer nullable: true description: Value of billing instruction 2 instruction3_value: type: integer nullable: true description: Value of billing instruction 3 billing_account_write: type: object description: Bank slip billing of the checking account. With `id`, updates the existing billing setup; without `id`, creates a new one. properties: id: type: string format: uuid description: Identifier of the billing setup to update. Without it, the billing setup is created. kind: type: string enum: - monde_bancos - cobre_bem default: monde_bancos description: 'Who issues the bank slip: `monde_bancos` or `cobre_bem`.' registered: type: boolean description: Whether the billing is registered. On CobreBem, it is informed on writing, as on the screen; on Monde Bancos, it comes from the chosen portfolio, and the value sent is ignored. active: type: boolean description: Whether the billing setup is active bank_issues_billet: type: boolean description: The bank issues the bank slip bank_generates_number: type: boolean description: The bank generates the our-number allows_unregistered_issue: type: boolean description: Allows issuing the bank slip before registration (registered billing only) portfolio: type: string nullable: true description: Portfolio, one of those offered by the account bank (Monde Bancos) document_kind: type: string nullable: true description: Document kind, such as `DM` (trade bill) or `DS` (service bill) return_layout: type: string nullable: true description: Return file layout, one of those offered by the account bank (Monde Bancos) remittance_layout: type: string nullable: true description: Remittance file layout, one of those offered by the account bank (Monde Bancos) agreement_code: type: string nullable: true description: Agreement code variation: type: string nullable: true description: Portfolio variation accept: type: string nullable: true description: Acceptance (one letter) ceb_code: type: string nullable: true description: CEB code billet_instructions: type: string nullable: true description: Bank slip instructions. Together with the interest, protest and fee lines, the bank slip has up to 6 lines. local_of_payment: type: string nullable: true description: Place of payment assignor_format: type: string nullable: true description: Assignor code format our_number_format: type: string nullable: true description: Our-number format other_settings: type: string nullable: true description: Bank specific settings, one per line, as key=value late_fine: type: number format: double nullable: true description: Late fine (%) late_interest: type: number format: double nullable: true description: Late interest (%) bank_fee: type: number format: double nullable: true description: Bank fee billet_rate: type: number format: double nullable: true description: Bank slip fee last_remittance: type: integer nullable: true description: Last remittance number days_protest: type: integer nullable: true description: Days to protest guarantor: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Guarantor
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
cobre_bem: type: object nullable: true description: CobreBem configuration; null on Monde Bancos billing. properties: license: type: string nullable: true writeOnly: true description: 'Content of the CobreBem license file. Accepted only on write: the query tells only whether it is loaded.' skip_detail2: type: boolean description: Do not generate remittance detail 2 skip_detail3: type: boolean description: Do not generate remittance detail 3 config1: type: string nullable: true description: License setting 1 config2: type: string nullable: true description: License setting 2 config3: type: string nullable: true description: License setting 3 config4: type: string nullable: true description: License setting 4 config5: type: string nullable: true description: License setting 5 remittance_layout: type: string nullable: true description: Remittance layout return_layout: type: string nullable: true description: Return layout document_kind: type: string nullable: true description: Document kind remittance_accept: type: string nullable: true description: Remittance acceptance (one letter) instruction1: type: string nullable: true description: Billing instruction 1 instruction2: type: string nullable: true description: Billing instruction 2 instruction3: type: string nullable: true description: Billing instruction 3 title_properties: type: string nullable: true description: Special title properties, one per line, as PROPERTY=VALUE account_properties: type: string nullable: true description: Special account properties, one per line, as PROPERTY=VALUE instruction1_value: type: integer nullable: true description: Value of billing instruction 1 instruction2_value: type: integer nullable: true description: Value of billing instruction 2 instruction3_value: type: integer nullable: true description: Value of billing instruction 3 account_update: description: Data to update an account or card. Every field is optional. allOf: - "$ref": "#/components/schemas/account_write" - type: object properties: next_bank_slip_number: type: integer minimum: 1 maximum: 2147483647 description: 'Number of the next bank slip, only when updating a checking account; on other accounts, it is ignored, and empty text is refused (422) on any account. The numbering only moves forward: a number lower than the current one, or not greater than the last issued bank slip, answers 422. Resending the current number changes nothing.' account_write: type: object description: Account or card fields accepted on create and on update. properties: description: type: string maxLength: 50 description: Account description currency: type: string description: Currency code (ISO 4217), one of the registered currencies. It cannot change after the account has movements. active: type: boolean description: Whether the account is active. The default receipt account cannot be deactivated. initial_balance: type: number format: double description: Initial balance, with up to 2 decimal places. Does not exist on credit cards, where it is ignored. Changing it reopens the closed cash of the account and requires the **Reopen Cash** permission. owner: "$ref": "#/components/schemas/entity_reference" bank: allOf: - "$ref": "#/components/schemas/entity_reference" description: Bank of the checking account, by the `id` from [List banks](#tag/Banks/paths/~1banks/get). It cannot change after the account has a billing setup. agency: type: string description: 'Branch of the checking account: 4 digits, numbers only.' agency_digit: type: string maxLength: 1 description: Bank branch digit bank_operation: type: string description: Account operation, only at Caixa Econômica Federal (bank 104), with 3 or 4 digits. number: type: string maxLength: 10 description: Bank account number digit: type: string maxLength: 1 description: Bank account digit pix_key: type: string maxLength: 100 description: Account Pix key card_operator: allOf: - "$ref": "#/components/schemas/entity_reference" description: Credit card operator (person), required on credit cards. bill_expiration: type: integer minimum: 1 maximum: 31 description: Card invoice due day (1 to 31), required on credit cards. bill_closing: type: integer minimum: 1 maximum: 31 description: Card invoice closing day (1 to 31), required on credit cards. invoice_company: allOf: - "$ref": "#/components/schemas/entity_reference" description: Company where the card invoice is generated, one of the `companies`. With a single company, it is that one. companies: type: array minItems: 1 description: Companies where the account is available, by `id` (the same returned by the query). At least one; on update, it is the final list. items: "$ref": "#/components/schemas/entity_reference" user_groups: type: array description: User groups with access to the account. Without groups, the account has no restriction. A total access group cannot be linked. On update, it is the final list. items: "$ref": "#/components/schemas/entity_reference" billing_accounts: type: array description: 'Bank slip billing setups, only on checking accounts; on other accounts, the list is ignored. On update, it is the final list: a billing setup that already issued bank slips cannot be left out.' items: "$ref": "#/components/schemas/billing_account_write" account_create: description: Data to register an account or card. allOf: - "$ref": "#/components/schemas/account_write" - type: object required: - kind - description - currency - companies properties: kind: type: string enum: - cashier_account - checking_account - card_account description: 'Account kind: `cashier_account` (cash), `checking_account` or `card_account` (credit card). It does not change after creation.' nf_rule_summary: type: object description: Represents an invoice (NF) rule in the list read, with the register's own fields. properties: id: &674 type: string format: uuid description: Unique rule identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: &675 type: string description: Rule description example: Regra padrão de pacotes representative_scope: &676 type: string enum: - any - none - specific description: " Indicates which representatives the rule applies to.
  • none: applies only to sales without a representative.
  • specific: applies only to the representative indicated in representative.
  • any: applies to any representative.
" example: any created_at: &677 type: string format: date-time description: Date and time the rule was registered example: '2024-03-15T10:30:00' payer_rule: &678 type: object properties: &673 recipient: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person the invoice is issued to (null = the sale person itself)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
revenues: type: array description: Components that add to the invoice amount (own fees, agency commission and over) items: type: string enum: - du_fee - rav_fee - agency_service_fee - agency_fee - commission_amount - over_amount discounts: type: array description: Components that reduce the invoice amount (card fees, intermediary commission and over, and the total discount) items: type: string enum: - cc_du_fee - cc_rav_fee - discount - intermediary_commission_amount - intermediary_over_amount required: - recipient - revenues - discounts description: Issuance to the payer supplier_rule: &679 type: object properties: *673 required: - recipient - revenues - discounts description: Issuance to the supplier representative_rule: &680 type: object properties: *673 required: - recipient - revenues - discounts description: Issuance to the representative required: - id - representative_scope - payer_rule - supplier_rule - representative_rule - created_at nf_rule: type: object description: Represents an invoice (nota fiscal) issuing rule, with the amount components (revenues and discounts) that compose each issuance. properties: id: *674 description: *675 representative_scope: *676 created_at: *677 product: &971 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Product the rule applies to (null = all products)
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
supplier: &972 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Supplier the rule applies to (null = all suppliers)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: &973 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Representative the rule applies to (present when representative_scope = specific)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
payer: &974 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Payer the rule applies to (null = all payers)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
created_by: &975 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the rule
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
payer_rule: *678 supplier_rule: *679 representative_rule: *680 required: - id - representative_scope - payer_rule - supplier_rule - representative_rule - created_at task_summary: type: object description: Represents a task registered in the system. properties: id: type: string format: uuid description: Unique task identifier example: f9d961b8-ea88-4346-8e52-afe94267417a number: type: integer description: Sequential task number example: 1042 title: type: string description: Task title example: Enviar voucher para o cliente description: type: string nullable: true description: Task description example: Confirmar os dados do embarque antes do envio. due: type: string format: date-time nullable: true description: Due date and time (null when the task has no due date, and then it is never overdue) example: '2024-04-01T09:00:00' completed_at: type: string format: date-time nullable: true description: Completion date and time (null when not completed) example: visualized: type: boolean description: Indicates whether the task was visualized by the assignee example: true deleted: type: boolean description: Indicates whether the task was deleted example: false created_at: type: string format: date-time description: Date and time the task was registered example: '2024-03-15T10:30:00' required: - id - number - title - visualized - deleted - created_at task_historic: type: object readOnly: true description: Task history entry — a comment or a change log record. properties: created_at: type: string format: date-time description: Date and time the history entry was registered example: '2024-04-01T09:30:00' text: type: string nullable: true description: Comment recorded in the history (null when the entry is only a change log) example: Cliente confirmou os dados do embarque. historic: type: string nullable: true description: Task change log (null when the entry is only a comment) example: "'Título' alterado de 'A' para 'B'" person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the history entry (null when the entry has no person as its author, such as one registered by Monde itself or by an API credential)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
attachments: type: array description: Attachments sent with the comment, with the download link. They also show in the task attachments. items: "$ref": "#/components/schemas/attachment_summary" task: description: Represents a task with its history and custom fields. allOf: - "$ref": "#/components/schemas/task_summary" - type: object required: - assignee - history - custom_fields properties: category: allOf: - "$ref": "#/components/schemas/numeric_entity_reference" nullable: true description: |- Task category (null when the task has no category)
  • Call the [Get task category by ID](#tag/Task-Categories/paths/~1task_categories~1{id}/get) endpoint for the full data.
assignee: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Task assignee
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked to the task
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale linked to the task (null when there is none)
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
travel: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Travel linked to the task (null when there is none)
  • Call the [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get) endpoint for the full data.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Bill (account payable or receivable) linked to the task (null when there is none)
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Task company (null when the task applies to all companies)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the task
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
history: type: array readOnly: true description: Task history (comments and change logs) items: "$ref": "#/components/schemas/task_historic" custom_fields: type: array readOnly: true description: Custom fields filled in the task, defined by the agency items: "$ref": "#/components/schemas/custom_field" attachments: type: array readOnly: true description: Task attachments, including the ones sent in comments, with the download link. The download follows the get of the task, with the same permission. items: "$ref": "#/components/schemas/attachment_summary" task_historic_create: type: object writeOnly: true description: Comment to append to the task history. required: - text properties: text: type: string description: Comment text example: Cliente confirmou os dados do embarque. task_comment_create: type: object writeOnly: true description: Comment to append to the task history, with text, attachments or both. Without attachments, the text is required. properties: text: type: string description: Comment text example: Cliente confirmou os dados do embarque. attachment_ids: type: array description: Identifiers of the attachments to link to the comment, returned by [Upload attachment](#tag/Attachments/paths/~1attachments/post). Each one must be an attachment of this task, not deleted and not yet in a comment; the others answer 422 as not found. items: type: string format: uuid example: - 5f1c2a8e-9b4d-4c6a-8e2f-1a3b5c7d9e0f task_create: type: object writeOnly: true description: Data to create a task. required: - company_identifier - title - assignee_id properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" nullable: true description: CNPJ of the company where the task will be created, digits only. Null creates the task without a company, applying to every company; the field is required and omitting it is rejected. A company where the credential has no permission at all is rejected as a CNPJ not found title: type: string maxLength: 100 description: Task title example: Enviar voucher para o cliente description: type: string description: Task description example: Confirmar os dados do embarque antes do envio. due: type: string format: date-time description: Due date and time (null when the task has no due date, and then it is never overdue) example: '2024-04-01T09:00:00' category_id: type: integer description: Identifier of the task category, obtained from [List task categories](#tag/Task-Categories/paths/~1task_categories/get). example: 11 assignee_id: type: string format: uuid description: Identifier of the person assigned to the task, obtained from [List people](#tag/People/paths/~1people/get). The person must be an active Monde user and, on the task of a company, have access to its tasks, as in Monde. The check applies to every change of the task, also when the assignee does not change. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 person_id: type: string format: uuid description: Identifier of the person linked to the task, obtained from [List people](#tag/People/paths/~1people/get). example: c3b7e8eb-1199-4457-9170-923c3fe56c92 sale_id: type: string format: uuid description: Identifier of the sale to link, obtained from [List sales](#tag/Sales/paths/~1sales/get). With `travel_id`, the sale must belong to that travel. example: 8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 travel_id: type: string format: uuid description: Identifier of the travel to link, obtained from [List travels](#tag/Travels/paths/~1travels/get). example: 1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 bill_id: type: string format: uuid description: Identifier of the bill (account payable or receivable) to link, obtained from [List accounts payable and receivable](#tag/Accounts-Payable-and-Receivable/paths/~1bills/get). With `sale_id`, the bill must belong to that sale. example: 5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 history: type: array description: Comments the task is born with items: "$ref": "#/components/schemas/task_historic_create" custom_fields: type: array description: Custom fields to fill in the task, defined by the agency items: "$ref": "#/components/schemas/custom_field" task_update: type: object writeOnly: true description: Data to update a task. Every field is optional. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" nullable: true description: CNPJ of the company the task is moved to, digits only. Null removes the task from its company, leaving it valid for every company; omitted, it keeps the current company. A company where the credential has no permission at all is rejected as a CNPJ not found. A task of another user also requires "See tasks of other users" in the target company; without it, the answer is 403 with the Monde message title: type: string maxLength: 100 description: Task title example: Enviar voucher atualizado para o cliente description: type: string nullable: true description: Task description example: Voucher reemitido com o novo horário do embarque. due: type: string format: date-time nullable: true description: Due date and time. Null removes the due date, and the task is no longer overdue; omitted, keeps the current due date example: '2024-04-02T09:00:00' category_id: type: integer nullable: true description: Identifier of the task category, obtained from [List task categories](#tag/Task-Categories/paths/~1task_categories/get). Null removes the category; omitted, keeps the current category. example: 11 assignee_id: type: string format: uuid description: Identifier of the person assigned to the task, obtained from [List people](#tag/People/paths/~1people/get). The person must be an active Monde user and, on the task of a company, have access to its tasks, as in Monde. The check applies to every change of the task, also when the assignee does not change. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 person_id: type: string format: uuid nullable: true description: Identifier of the person linked to the task, obtained from [List people](#tag/People/paths/~1people/get). example: c3b7e8eb-1199-4457-9170-923c3fe56c92 sale_id: type: string format: uuid nullable: true description: Identifier of the sale to link, with the creation rules. Null removes the link; omitted, it keeps the current one. example: 8a1f2c3d-4b5e-4f60-8172-93a4b5c6d7e8 travel_id: type: string format: uuid nullable: true description: Identifier of the travel to link, with the creation rules. Null removes the link; omitted, it keeps the current one. example: 1b2c3d4e-5f60-4718-8293-a4b5c6d7e8f9 bill_id: type: string format: uuid nullable: true description: Identifier of the bill to link, with the creation rules. Null removes the link; omitted, it keeps the current one. example: 5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9 completed: type: boolean description: "`true` completes the task, with the date and time of the update; `false` reopens it. Completing a task that is already completed keeps the original completion date." example: true custom_fields: type: array description: 'Task custom fields, defined by the agency. Not replaced: each field sent overwrites its current value and the ones not sent stay as they are, so an empty list changes nothing and a field cannot be cleared by this operation. Send each field by `id` and `value`.' items: "$ref": "#/components/schemas/custom_field" task_category: type: object description: Represents a task category registered in the system. properties: id: type: integer description: Unique task category identifier example: 42 name: type: string description: Task category name example: Emissão kanban: type: boolean description: Whether the category is a column of the task board (kanban). example: true kanban_position: type: integer nullable: true minimum: 1 description: Position of the column on the task board, starting at 1, from left to right. Null when the category is not on the board. The column of the tasks without a category is not a category and is not counted. example: 2 required: - id - name - kanban - kanban_position task_category_create: type: object writeOnly: true description: Data to create a task category. required: - name properties: name: type: string maxLength: 30 description: Task category name, up to 30 characters. It is unique, case-insensitive, and surrounding spaces are discarded. example: Emissão kanban: type: boolean default: true description: Whether the category is a column of the task board (kanban). When omitted, the category joins the board. example: true kanban_position: type: integer minimum: 1 description: Position of the column on the task board, starting at 1, from left to right; the other columns shift. It goes from 1 to the number of board columns already counting this category, and is only accepted for a category that stays on the board. When omitted, a new category joins as the last column and an updated one keeps its position. example: 2 task_category_update: type: object writeOnly: true description: Data to update a task category. Every field is optional. properties: name: type: string maxLength: 30 description: Task category name, up to 30 characters. It is unique, case-insensitive, and surrounding spaces are discarded. example: Emissão de bilhetes kanban: type: boolean description: Whether the category is a column of the task board (kanban). When it returns to the board without `kanban_position`, the column gets back the position it had. example: false kanban_position: type: integer nullable: true minimum: 1 description: Position of the column on the task board, starting at 1, from left to right; the other columns shift. It goes from 1 to the number of board columns already counting this category, and is only accepted for a category that stays on the board. When omitted, a new category joins as the last column and an updated one keeps its position. example: 1 travel_summary: type: object description: Represents a travel in the list, with scalar fields and references. properties: id: type: string format: uuid description: Unique travel identifier example: f9d961b8-ea88-4346-8e52-afe94267417a number: type: string description: Sequential travel number example: '000042' description: type: string nullable: true description: Travel description example: Lua de mel - Cancún situation: type: string nullable: true enum: - upcoming - ongoing - finished description: " Travel situation, calculated from the period.
  • upcoming: not started yet.
  • ongoing: in progress.
  • finished: finished.
Null when the travel has no linked sales with active products. " example: upcoming start_date: type: string format: date nullable: true description: Earliest start date among the products of the linked sales example: '2024-05-10' end_date: type: string format: date nullable: true description: Latest end date among the products of the linked sales example: '2024-05-24' observations: type: string nullable: true description: Travel observations example: Cliente prefere assentos na janela. created_at: type: string format: date-time nullable: true description: Date and time the travel was registered example: '2024-03-15T10:30:00' required: - id - number travel: type: object description: Represents a travel with its scalar fields and the references to the linked sales and passengers. allOf: - "$ref": "#/components/schemas/travel_summary" - type: object properties: customer: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Travel customer
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Travel seller
  • Call the [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Travel company
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the travel
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
sales: type: array description: |- References to the sales linked to the travel
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" passengers: type: array description: |- References to the passengers of the travel, deduplicated per person
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" attachments: type: array description: Travel attachments, with the download link. The download follows the get of the travel, with the same permission. items: "$ref": "#/components/schemas/attachment_summary" custom_fields: type: array readOnly: true description: Custom fields filled in the travel, defined by the agency items: "$ref": "#/components/schemas/custom_field" travel_create: type: object writeOnly: true description: Data to create a travel. required: - company_identifier - description - customer_id - seller_id properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ of the travel's company, digits only. A company where the credential has no permission at all is rejected as a CNPJ not found description: type: string maxLength: 60 description: Travel description, up to 60 characters example: Lua de mel - Cancún customer_id: type: string format: uuid description: 'ID of the person who is the travel customer, the same as in `GET /people`. Sending the customer requires the "Read all people" permission: without it, the customer is refused (422) as one that does not exist.' example: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 seller_id: type: string format: uuid description: ID of the travel seller, the same as in `GET /sellers`. Must be an active seller; on update, the current seller of the travel sent back is accepted even if inactive example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 observations: type: string description: Travel observations example: Cliente prefere assentos na janela. custom_fields: type: array description: Custom fields to fill in the travel, defined by the agency. The required ones must be sent on creation items: "$ref": "#/components/schemas/custom_field" travel_update: type: object writeOnly: true description: Travel fields to change. An omitted field stays as it is. properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 'CNPJ of the travel''s company, digits only. The company does not change after the travel is created: only the travel''s own CNPJ is accepted' description: type: string maxLength: 60 description: Travel description, up to 60 characters example: Lua de mel - Cancún e Tulum customer_id: type: string format: uuid description: 'ID of the person who is the travel customer, the same as in `GET /people`. Sending the customer requires the "Read all people" permission: without it, the customer is refused (422) as one that does not exist.' example: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 seller_id: type: string format: uuid description: ID of the travel seller, the same as in `GET /sellers`. Must be an active seller; on update, the current seller of the travel sent back is accepted even if inactive example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 observations: type: string nullable: true description: Travel observations. Sent as null, they are cleared; an empty text is saved as sent example: Incluir o passeio a Tulum. custom_fields: type: array description: 'Travel custom fields, defined by the agency. Not replaced: each field sent overwrites its current value and the ones not sent stay as they are. A required field cannot be sent empty. Send each field by `id` and `value`.' items: "$ref": "#/components/schemas/custom_field" quote_summary: type: object description: Represents a quote in the list read, with the register's own fields. properties: id: type: integer description: Unique quote identifier example: 42 title: type: string description: Quote title example: Cancún subtitle: type: string description: Quote subtitle. Optional. example: Lua de mel - 14 noites details: type: string description: Quote details, in HTML. Images come as <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 quote
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Quote company
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
user: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- User who owns the quote
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
quote_create: type: object writeOnly: true description: Data to create a quote. required: - company_identifier - user_id - title - valid_until properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ of the company where the quote will be created, digits only. The company cannot be read only. 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 description: 'Identifier of the quote''s person (customer), from [List people](#tag/People/paths/~1people/get). Optional. 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 description: Quote subtitle. Optional. example: Lua de mel - 14 noites valid_until: type: string format: date description: Quote validity date (YYYY-MM-DD). Cannot be in the past. example: '2035-05-31' details: type: string 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 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 ``, with only the image reference. example: "

Dia 1

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 guide
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
user: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- User who owns the guide
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
guide_create: type: object writeOnly: true description: Data to create a guide. required: - company_identifier - user_id - title properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ of the company where the guide will be created, digits only. The company must have the Monde Pro license, and neither the company nor the Monde Pro license can be read-only. 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 subtitle: type: string description: Guide subtitle. Optional. example: Roteiro de 5 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, `

` and `

`: `

` and `

` become `

`, and `

` and `
` become `

`. From the style, only the center or right alignment of paragraphs and headings passes. Three blocks also pass, never one inside another: the highlight box (`
`), text only (paragraphs, headings, and lists), where an image goes to a paragraph right after the box and anything else goes after it; the section with a background image (`
`), where the first image becomes the background and the others are discarded; and the columns (`
` with two or three `
`). Outside this format, the `div` is removed and its content stays. Images in a row in the same paragraph become a carousel; with `data-carousel="thumbnails"` on the paragraph, the carousel shows thumbnails below instead of dots. Any other `data-carousel` value is dropped. An image without `data-quote-image` is discarded. Optional: sent empty, or with only what the cleaning discards, the guide has no content.' example: "

Dia 1

Chegada 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, `

` and `

`: `

` and `

` become `

`, and `

` and `
` become `

`. From the style, only the center or right alignment of paragraphs and headings passes. Three blocks also pass, never one inside another: the highlight box (`
`), text only (paragraphs, headings, and lists), where an image goes to a paragraph right after the box and anything else goes after it; the section with a background image (`
`), where the first image becomes the background and the others are discarded; and the columns (`
` with two or three `
`). Outside this format, the `div` is removed and its content stays. Images in a row in the same paragraph become a carousel; with `data-carousel="thumbnails"` on the paragraph, the carousel shows thumbnails below instead of dots. Any other `data-carousel` value is dropped. An image without `data-quote-image` is discarded. Optional: sent empty, or with only what the cleaning discards, the guide has no content.' example: "

Dia 6

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.
" example: supplier destination: type: string enum: - every - national - international - cruise description: " Destination the rule applies to.
  • every: all.
  • national: national.
  • international: international.
  • cruise: cruise (available only for the Travel Insurance product).
" example: every movement: type: string enum: - every_movement - to_pay - to_receive description: " Movement the rule applies to. Applies only to supplier and representative rules; for customer rules it is always every_movement and has no effect.
  • every_movement: all.
  • to_pay: payable to the supplier.
  • to_receive: receivable from the supplier.
" example: every_movement cost_center: type: string nullable: true description: Cost center the rule applies to (customer rules only; null = all) example: Comercial closing: type: object description: Closing configuration that controls how sales are grouped into an invoice. properties: period_kind: type: string enum: - standalone - daily - weekly - weekly_iata - weekly_inside_month - decendial - fortnightly - monthly - custom description: " Closing cadence that groups sales into an invoice.
  • 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.
" example: weekly week_start: type: string nullable: true enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday description: Day the week starts on; used only when period_kind is weekly or weekly_inside_month, null otherwise. example: monday custom_period: type: string nullable: true description: Ranges of month days that define each custom closing period (used when period_kind = custom). Each range is 'start_day-end_day', in days of the month, separated by ';'. Example '1-8;9-15;16-23;24-31' means from day 1 to day 8, from day 9 to day 15, from day 16 to day 23, and from day 24 to day 31. example: 1-8;9-15;16-23;24-31 custom_period_due_date: type: string nullable: true description: Day of the month when each custom_period range is due, in the same order, separated by ';'. The Nth value is the due day of the Nth range. Example for '1-8;9-15;16-23;24-31', the value '10;17;25;5' makes the first range due on day 10, the second on 17, the third on 25, and the fourth on 5. example: 10;17;25;5 date_to_use: type: string enum: - after_sale_date - before_checkin - after_checkin - before_checkout - after_checkout description: " Sale reference date used to fit the item into the closing 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.
" example: after_sale_date required: - period_kind - date_to_use due_date: type: object description: Due date configuration for the generated invoice. properties: days_to_skip: type: integer description: Number of days after the period closing to compute the due date (business days when period_kind = weekly_iata). example: 5 on_weekend: type: string enum: - stay - next - previous description: " Due date adjustment when it falls on a Saturday, Sunday, or holiday.
  • stay: keeps the date.
  • next: moves to the next business day.
  • previous: moves to the previous business day.
" example: stay required: - days_to_skip - on_weekend required: - id - description - person_kind - destination - movement - closing - due_date invoice_rule: description: Represents a billing rule registered in the system. allOf: - "$ref": "#/components/schemas/invoice_rule_summary" - type: object properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Rule owner (null = applies to all people of the kind)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Product the rule applies to (null = all products)
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Supplier the rule applies to (representative rules only; null = all)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
requester: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Requester the rule applies to (client rules only; null = all)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
integration_summary: type: object description: Represents an integration in the list query, with the record's own fields. properties: id: type: string format: uuid description: Integration unique identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Integration description example: Assist Card Matriz active: type: boolean description: Indicates whether the integration is active example: true vendor_id: type: string format: uuid description: Identifier of the integration's vendor example: b2359357-cff7-4d43-b6d2-99adf2ff373b vendor_name: type: string nullable: true description: Name of the integration provider example: Assist Card required: - id - description - active - vendor_id - vendor_name integration: description: Represents a vendor integration registered in the system, with the additional fields and without the access data to the vendor. allOf: - "$ref": "#/components/schemas/integration_summary" - type: object required: - additional_fields properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked as vendor or representative in the imported products
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Integration company (null when it applies to all companies)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
additional_fields: type: array description: Additional fields the vendor declares, in registration order. items: "$ref": "#/components/schemas/integration_additional_field" integration_additional_field: type: object description: An additional field the vendor declares for the integration. required: - name - type - value - filled properties: name: type: string description: Additional field name, the key used in `additional_fields` on writes example: agency_code type: type: string enum: - text - password - token description: 'Field type: `text`, `password` or `token`' example: text value: type: string nullable: true description: 'Field value. Always null for secret fields (`secret` in the vendor): only the service address and the agency''s identification are returned; user, password, token, API keys and PIN, never.' example: '1000' filled: type: boolean description: Indicates whether the field is filled example: true person_summary: type: object description: Represents a person in the listing, with own scalars and references to the strong entities, without weak entities. properties: id: type: string format: uuid description: Unique person identifier example: f9d961b8-ea88-4346-8e52-afe94267417a external_id: type: - string - 'null' maxLength: 50 description: Identifier you assigned to this person when creating it. Null when the querying credential has no external identifier for it. code: type: integer nullable: true description: Sequential person code example: 1042 person_kind: type: string enum: - individual - company description: Indicates whether it is a person (individual) or legal entity (company). example: individual name: type: string description: 'Name or trade name, according to the person kind.

Example: "Maria da Silva" or "Epic Journey".' maxLength: 100 legal_name: type: - string - 'null' description: 'Legal name.

Example: "Epic Journey S.A.".' maxLength: 100 cpf_cnpj: type: - string - 'null' description: 'Brazilian Individual Taxpayer Registry (CPF) or National Registry of Legal Entities (CNPJ), according to the person kind, without dots, slashes, dashes or spaces.

Example: "38107867807" or "50559280000140".' minLength: 11 maxLength: 14 gender: type: - string - 'null' enum: - female - male - description: Gender. birthdate: type: - string - 'null' format: date description: 'Birthdate in ISO 8601 format (YYYY-MM-DD).

Example: "1990-02-12".' rg_ie: type: - string - 'null' description: 'Brazilian Identity Card (RG) or Brazilian State Registration (IE), according to the person kind, without dots, dashes, or spaces.

Example: "461196037" or "123456789012".' maxLength: 20 city_inscription: type: - string - 'null' description: City inscription tax_identification_number: type: - string - 'null' description: Tax identification number (foreign legal person) passport_number: type: - string - 'null' description: 'Passport number, without dots, dashes, or spaces.

Example: "FG225776".' maxLength: 20 passport_expiration_date: type: - string - 'null' format: date description: 'Passport expiration date in ISO 8601 format (YYYY-MM-DD).

Example: "2035-12-01".' foreigner: type: boolean description: Indicates whether the person or company is foreign. Use `true` for individuals who do not have Brazilian nationality or companies that are not based in Brazil. default: false foreign_identity_document: type: - string - 'null' description: ' Identity document of the foreigner, issued in their country of origin. Without dots, dashes or spaces.

Example: "41234567". ' maxLength: 30 email: type: - string - 'null' description: 'Email address.

Example: "contact@example.com".' maxLength: 200 phone_number: type: - string - 'null' description: 'Phone number, without dashes or spaces. For international numbers, use + and the country code.

Examples: "1134567890", "+33170180123".' maxLength: 20 mobile_number: type: - string - 'null' description: 'Mobile phone number, without dashes or spaces. For international numbers, use + and the country code.

Examples: "11934567890", "+447911123456".' maxLength: 20 business_phone: type: - string - 'null' description: Business phone example: '4133334444' website: type: - string - 'null' description: Website (legal person) example: https://www.agencia.com.br cvc_code: type: - integer - 'null' description: Person CVC code observations: type: - string - 'null' description: Person observations charge_billet_fee: type: boolean description: Indicates whether the bank slip fee is charged to the person example: false created_at: type: - string - 'null' format: date-time description: Date and time the person was registered address: type: - object - 'null' description: Address. properties: postal_code: type: - string - 'null' description: 'Postal code, without dashes.

Example: "04078011".' maxLength: 8 street: type: - string - 'null' description: 'Street name.

Example: "Avenida Divino Salvador".' maxLength: 50 street_number: type: - string - 'null' description: 'Building number.

Example: "5000".' maxLength: 10 neighborhood: type: - string - 'null' description: 'Neighborhood.

Example: "Planalto Paulista".' maxLength: 30 additional_info: type: - string - 'null' description: 'Additional address information, like building, apartment or floor.

Example: "Casa 2".' maxLength: 20 city: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Address city. State and country are returned by the city lookup by ID.
  • Call the [Get city by ID](#tag/Cities/paths/~1cities~1{id}/get) endpoint for the full data.
additional_data: type: - object - 'null' description: Additional data of the individual person. Absent (null) for legal person. properties: marital_status: type: - string - 'null' enum: - single - married - separated - divorced - widowed - civil_union - description: |- Marital status (individual person).
  • single
  • married
  • separated
  • divorced
  • widowed
  • civil_union
example: married rg_emitter: type: - string - 'null' description: RG issuing agency example: SSP/SP rg_issue_date: type: - string - 'null' format: date description: RG issue date birth_certificate: type: - string - 'null' description: Birth certificate mother_name: type: - string - 'null' description: Mother name last_contacts: type: object description: Dates of the last contacts and movements of the person. properties: first_sale_date: type: - string - 'null' format: date description: Date of the first sale of the person last_sale_date: type: - string - 'null' format: date description: Date of the last sale of the person last_departure_date: type: - string - 'null' format: date description: Date of the last departure of the person last_return_date: type: - string - 'null' format: date description: Date of the last return of the person last_task_update_at: type: - string - 'null' format: date-time description: Date and time of the last task update of the person tax_withholding: type: - object - 'null' description: Tax withholdings of the legal person. Absent (null) for individual person. properties: iss: type: boolean description: Indicates ISS withholding (legal person) ir: type: boolean description: Indicates IR withholding (legal person) pis_cofins_csll: type: boolean description: Indicates PIS/COFINS/CSLL withholding (legal person) airline: type: - object - 'null' description: Airline data of the legal person (suppliers). Absent (null) for individual person. properties: code: type: - string - 'null' description: Airline code (suppliers). It is unique among people — on registration, a code another person already carries is refused. example: '957' number: type: - string - 'null' description: Airline number (suppliers) person_detail: description: Represents the complete person, with the listing fields plus the grouped blocks and the weak entities. allOf: - "$ref": "#/components/schemas/person_summary" - type: object properties: birthplace: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Birthplace, the birth city of the individual person
  • Call the [Get city by ID](#tag/Cities/paths/~1cities~1{id}/get) endpoint for the full data.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Seller responsible for the person
  • Call the [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) endpoint for the full data.
promoter: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person promoter (operator plans)
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who performed the registration, as a reference with id and name
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
contacts: type: array description: Contact links of the person, in both directions — who is a contact of them and whose contact they are. items: type: object properties: role: type: - string - 'null' description: Role registered on the link, describing who the contact is person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- The other person in the link: the contact of the queried person, or the person whose contact they are
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
labels: type: array description: |- Labels assigned to the person.
  • Call the [Get label by ID](#tag/Labels/paths/~1labels~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" custom_fields: type: array description: Filled custom fields of the person, as definition and value pairs. items: type: object properties: id: type: integer description: Identifier of the custom field definition. The name, the kind and the choices of the definition come from the custom field definitions query. example: 123 value: type: - string - number - 'null' description: Filled custom field value attachments: type: array description: Attachments of the person. The download is done through the signed URL in download_url. items: "$ref": "#/components/schemas/attachment_summary" credit_cards: type: array description: Credit cards of the person. The full number is never returned. Only comes with the "View financial tab" and "View credit card data" permissions on people; without them, the field is left out. items: type: object properties: id: type: string format: uuid description: Unique identifier (UUID) of the card, with which the person update changes the card without sending the number again. name: type: - string - 'null' description: Card name/nickname last_digits: type: - string - 'null' description: Last four digits of the card maxLength: 4 example: '1111' expiration_date: type: - string - 'null' format: date description: Card expiration date issuer: type: - string - 'null' description: Card issuer/brand ticket_card: type: - string - 'null' description: Ticket card identification cost_centers: type: - array - 'null' description: 'Cost centers of the corporate client, in name order: its departments accepted in the cost center of the passenger and of the invoice item when it is the payer. They are not the cost centers of the agency, from `/cost_centers`. Absent (null) for individuals.' items: type: object properties: name: type: string description: Name of the cost center example: Diretoria kandir_law: type: - array - 'null' description: Per-product tax withholding required by Brazilian law 9,430/1996 (art. 64), applicable to companies. Absent (null) for individuals. Only comes with the "View financial tab" permission on people; without it, the field is left out. items: type: object properties: amount: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Withholding applied to the product's amount. boarding_fee: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Withholding applied to the boarding fee. du_rav_fee: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Withholding applied to the DU/RAV fee. service_fee: allOf: - "$ref": "#/components/schemas/kandir_law_tax_group" description: Withholding applied to the service fee. product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product the withholding percentages apply to.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
invoice_rules: type: array description: Invoice rules that belong to the person, as customer, supplier or representative (each one's detail is in [Get invoice rule by ID](#tag/Billing-Rules)). The rule that applies to every person is not listed here. Rules are written through the invoice rules resource, not through the person. items: "$ref": "#/components/schemas/entity_reference" photo: type: - object - 'null' description: Photo of the individual, or logo of the company. Only the type and size; the image itself is downloaded from [Download person photo](#tag/People/paths/~1people~1{person_id}~1photo/get). Null when there is no photo. properties: content_type: type: string description: Type of the stored image. example: image/jpeg size: type: integer description: Image size, in bytes. example: 48213 kandir_law_tax_group: type: object properties: national: allOf: - "$ref": "#/components/schemas/kandir_law_tax_breakdown" description: Withholding percentages for a domestic product. international: allOf: - "$ref": "#/components/schemas/kandir_law_tax_breakdown" description: Withholding percentages for an international product. kandir_law_tax_breakdown: type: object properties: ir: type: number format: float description: Withholding percentage of income tax (IR). csll: type: number format: float description: Withholding percentage of CSLL. pis: type: number format: float description: Withholding percentage of PIS. cofins: type: number format: float description: Withholding percentage of COFINS. total: type: number format: float description: Total withholding percentage, the sum of IR, CSLL, PIS and COFINS. person_credit_card_write: type: object writeOnly: true description: 'Credit card. Without `id`, it adds a card and requires number, name, issuer and expiration. With `id`, it changes the card: number, name, issuer and expiration left out stay as they are and, sent null, are refused; the security code and the ticket card sent null are cleared. An empty security code also leaves the card without one; an empty ticket card or expiration is refused (422), as it is neither one of the options nor a number.' properties: id: type: string format: uuid description: Unique identifier (UUID) of a card the person already has, to change it. Leave it out to add a card. example: 6f1c2b9e-3a5d-4c8e-9b7a-1d2e3f4a5b6c number: type: string pattern: "^[0-9]{1,30}$" description: Card number, digits only, up to 30. It is stored encrypted and never returned. example: '4111111111111111' cvv: type: - string - 'null' pattern: "^[0-9]{0,4}$" description: Security code, optional, digits only, up to 4. It is stored encrypted and never returned. For security reasons, storing it is not recommended. example: '123' name: type: string maxLength: 30 description: Name printed on the card, up to 30 characters. example: ALINE NAKID issuer: type: string maxLength: 20 description: Card issuer, up to 20 characters. Monde offers Amex, Diners, Hipercard, MasterCard, Visa and Elo. example: Visa ticket_card: type: - string - 'null' enum: - CPB - Cielo - CTA - EBTA - description: 'Ticket card used in the card export: `CPB`, `Cielo`, `CTA` or `EBTA`.' example: CTA expiration_month: type: integer minimum: 1 maximum: 12 description: Expiration month, from 1 to 12. example: 11 expiration_year: type: integer description: Expiration year, with four digits. example: 2030 person_cost_center_write: type: object writeOnly: true description: Cost center of the corporate client. required: - name properties: name: type: string maxLength: 50 description: Name of the cost center, up to 50 characters. example: Diretoria person_kandir_law_write: type: object writeOnly: true description: Kandir law withholding on a product. required: - product properties: product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Product of the withholding: Airfare, Travel Insurance or Ground Transportation. It does not repeat in the list
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
amount: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Withholding applied to the product's amount. boarding_fee: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Withholding applied to the boarding fee. du_rav_fee: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Withholding applied to the DU/RAV fee. service_fee: allOf: - "$ref": "#/components/schemas/person_kandir_law_group_write" description: Withholding applied to the service fee. person_kandir_law_group_write: type: object writeOnly: true description: Percentages of a group, by scope. properties: national: allOf: - "$ref": "#/components/schemas/person_kandir_law_breakdown_write" description: Withholding percentages for a domestic product. international: allOf: - "$ref": "#/components/schemas/person_kandir_law_breakdown_write" description: Withholding percentages for an international product. person_kandir_law_breakdown_write: type: object writeOnly: true description: 'Percentages of IR, CSLL, PIS and COFINS, from zero up. The total is not informed: it is the sum of the four.' properties: ir: type: - number - 'null' minimum: 0 description: Withholding percentage of income tax (IR). example: 1.5 csll: type: - number - 'null' minimum: 0 description: Withholding percentage of CSLL. example: 1.5 pis: type: - number - 'null' minimum: 0 description: Withholding percentage of PIS. example: 1.5 cofins: type: - number - 'null' minimum: 0 description: Withholding percentage of COFINS. example: 1.5 label: type: object description: Represents a label used to classify people. properties: id: type: string format: uuid description: Unique identifier of the label in UUID format example: f9d961b8-ea88-4346-8e52-afe94267417a name: type: string maxLength: 38 description: Label name example: VIP required: - id - name label_create: type: object writeOnly: true description: Data to create a label. required: - name properties: name: type: string maxLength: 38 description: Label name, with up to 38 characters and different from the name of the other labels example: Lua de mel label_update: type: object writeOnly: true description: 'Data to change a label. Every field is optional: a field left out stays as it is. The name cannot be removed, and sending it as null is rejected.' properties: name: type: string maxLength: 38 description: Label name, with up to 38 characters and different from the name of the other labels example: Cliente VIP company: type: object description: Represents a system company, with the data of its legal person. properties: id: type: string format: uuid description: Unique identifier of the company (the same as its legal person). It is the `id` the other reads bring in `company` example: 8a1f3c52-6d0e-4b7a-9c21-5e4f7d8b9a10 name: type: string description: Company name example: Monde Viagens legal_name: type: string description: Company legal name; without it, the name example: Monde Viagens e Turismo Ltda cnpj: type: string nullable: true description: Company CNPJ, digits only. It is the value to send in `company_identifier` in writes example: '46598887000162' read_only: type: boolean description: 'Indicates whether the company is read only in the Companies registry: it is queried, but rejects writes with `403`' example: false person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Legal person of the company
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
required: - id - name - legal_name - cnpj - read_only - person bill_billet: type: object nullable: true properties: status: type: string enum: - unregistered - pending_registration - waiting_return - registered - rejected - bank_settled - pending_cleared - cleared - pending_update description: Billet billing status. example: registered number: type: integer nullable: true description: Billet number. example: 12345 our_number: type: string nullable: true description: Billet our-number. example: '000000012345' amount: type: number format: double description: Billet amount. example: 1500.0 demonstrative: type: string nullable: true description: Billet demonstrative. example: Pagável em qualquer banco até o vencimento. rejection_reason: type: string nullable: true description: Reason for the billet registration rejection, when present. example: account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Billing account of the billet.
  • Call the [Get account or card by ID](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get) endpoint for the full data.
bill_check: type: object nullable: true description: Check data recorded on the bill; null when the payment was not by check. properties: number: type: integer nullable: true description: Check number. example: 123456 bank: type: string nullable: true description: Code of the bank that issued the check. example: '237' document: type: string nullable: true description: Taxpayer ID of the check holder. example: '03832060901' bill_card: type: object nullable: true description: Card data recorded on the bill; null when the payment was not by card. 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 of the card transaction. example: '600551159' bill_category: type: object properties: amount: type: number format: double description: Category amount, always positive. The category group defines whether it is revenue or expense. example: 1500.0 category: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Financial category of the apportionment.
  • Call the [Get category by ID](#tag/Categories/paths/~1categories~1{id}/get) endpoint for the full data.
bill_apportionment: type: object properties: percentage: type: number format: double description: Company percentage in the apportionment, derived from the amount. example: 50.0 amount: type: number format: double description: Amount apportioned to the company. example: 750.0 company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Apportionment company.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
bill_cost_center: type: object properties: percentage: type: number format: double description: Cost center percentage in the apportionment, derived from the amount. example: 100.0 amount: type: number format: double description: Amount apportioned to the cost center. example: 1500.0 cost_center: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Cost center.
  • Call the [Get cost center by ID](#tag/Cost-Centers/paths/~1cost_centers~1{id}/get) endpoint for the full data.
bill_commission: type: object properties: description: type: string nullable: true description: Commission description. example: Comissão pacote amount: type: number format: double description: Commission amount. example: 150.0 retained_amount: type: number format: double description: Retained commission amount. example: 0.0 balance: type: number format: double description: 'Commission balance: the amount minus the retained amount.' example: 150.0 person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who receives the commission.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
bill_item: type: object properties: id: type: string format: uuid description: Item identifier, used by the actions on the invoice items. example: 5c0f3a1e-8d2b-4f6a-9e1c-7b4d2a6f8e30 description: type: string nullable: true description: Item description. example: Diárias de Hospedagem cost_center: type: string nullable: true description: Cost center noted on the item, as free text. It is unrelated to the cost center registry and to the entry cost center apportionment, which comes in apportionments.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.
example: vendor kind: type: string enum: - invoice - refund - signal - lei_kandir - reversal - leftover - retained - fine - cvc - generated_credit description: |- Item kind.
  • 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.
example: invoice document: type: string nullable: true description: Document of the sale product that originated the item, such as the ticket or booking number. Null when the item did not come from a sale product. example: '9572345678901' issue_date: type: string format: date nullable: true description: Item issue date. example: '2026-10-03' person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Person of the item: the customer on customer items and the supplier on vendor items.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale the item belongs to.
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale product that originated the item. The identifier appears on the matching product inside the sale.
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
cvc_statement: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- CVC statement line reconciled with the item. It can be present alongside 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.
  • Call the [Query CVC statement by ID](#tag/CVC-Statement/paths/~1cvc_statements~1{id}/get) endpoint for the full data.
bill_credit_card_item: type: object properties: date: type: string format: date nullable: true description: Charge date. example: '2026-04-08' amount: type: number format: double description: Charge amount, with the raw sign of the movement (negative for expenses). example: -717.91 checked: type: boolean description: Indicates whether the charge was checked. example: false movement: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Account movement that originated this invoice line.
  • Call the [Get account movement by ID](#tag/Account-movements/paths/~1account_movements~1{id}/get) endpoint for the full data.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Entry settled by this invoice line.
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
bill_custom_field: type: object properties: id: type: integer description: Identifier of the custom field definition. The name, the kind and the choices of the definition come from the custom field definitions query or from Get custom field by ID. example: 123 value: type: - string - 'null' description: Custom field value. example: Matriz bill_summary: type: object description: Summary of an account payable or receivable, as returned by the list endpoint. 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.
' example: credit kind: 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.
' example: customer_invoice description: type: string nullable: true description: Entry description. example: Fatura cliente - Janeiro/2026 document: type: string nullable: true description: Document associated with the entry. example: NF 1001 invoice_number: type: integer nullable: true description: Invoice number, when the entry is an invoice. example: 42 currency: type: string minLength: 3 maxLength: 3 description: ISO 4217 code of the entry currency. The amount, the final amount and the movements are in it. example: BRL amount: type: number format: double description: Original amount of the entry. example: 1500.0 final_amount: type: number format: double description: Final amount of the entry (after category adjustments). example: 1500.0 issue_date: type: string format: date nullable: true description: Issue date. example: '2026-01-10' due_date: type: string format: date nullable: true description: Due date. example: '2026-02-10' settlement_date: type: string format: date nullable: true description: Settlement date; null when the entry has not been settled yet. example: created_at: type: string format: date-time nullable: true description: Entry registration date and time. example: '2026-01-10T13:45:36' canceled: type: boolean description: Indicates whether the entry was canceled. example: false checked: type: boolean description: Indicates whether the entry was checked. example: false invoice_closed: type: boolean description: Indicates whether the entry invoice was closed. A closed invoice takes no further items. example: false system_generated: type: boolean description: Indicates whether the entry was generated by the system rather than registered manually. example: true generates_credit: type: boolean description: Indicates whether the entry generates credit. example: false periodicity: type: string enum: - without_periodicity - weekly - biweekly - monthly - bimonthly - quarterly - semiannual - annual description: Recurrence periodicity (without_periodicity, weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual). example: monthly recurrence_kind: type: string enum: - non_recurrent - recurrent - installment - recurrency_excluded description: Recurrence kind (non_recurrent, recurrent, installment, recurrency_excluded). example: installment recurrence_group_id: type: string format: uuid nullable: true description: 'Identifier of the series of entries generated by an installment plan or by a recurrence: every entry in the same series shares the value. The creation response already brings it, but the read by ID only shows it once the series is generated in the background. Null when the entry belongs to no series. It is not a queryable entity, only a grouping key.' example: 5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f recurrence_status: type: string nullable: true enum: - pending - generated - retrying description: 'Status of the installment or recurrence series, which is generated in the background: 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.
' example: credit kind: 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.
' example: customer_invoice description: type: string nullable: true description: Entry description. example: Fatura cliente - Janeiro/2026 document: type: string nullable: true description: Document associated with the entry. example: NF 1001 invoice_number: type: integer nullable: true description: Invoice number, when the entry is an invoice. example: 42 currency: type: string minLength: 3 maxLength: 3 description: ISO 4217 code of the entry currency. The amount, the final amount and the movements are in it. example: BRL amount: type: number format: double description: Original amount of the entry. example: 1500.0 final_amount: type: number format: double description: Final amount of the entry (after category adjustments). example: 1500.0 issue_date: type: string format: date nullable: true description: Issue date. example: '2026-01-10' due_date: type: string format: date nullable: true description: Due date. example: '2026-02-10' settlement_date: type: string format: date nullable: true description: Settlement date; null when the entry has not been settled yet. example: created_at: type: string format: date-time nullable: true description: Entry registration date and time. example: '2026-01-10T13:45:36' canceled: type: boolean description: Indicates whether the entry was canceled. example: false checked: type: boolean description: Indicates whether the entry was checked. example: false invoice_closed: type: boolean description: Indicates whether the entry invoice was closed. A closed invoice takes no further items. example: false system_generated: type: boolean description: Indicates whether the entry was generated by the system rather than registered manually. example: true generates_credit: type: boolean description: Indicates whether the entry generates credit. example: false periodicity: type: string enum: - without_periodicity - weekly - biweekly - monthly - bimonthly - quarterly - semiannual - annual description: Recurrence periodicity (without_periodicity, weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual). example: monthly recurrence_kind: type: string enum: - non_recurrent - recurrent - installment - recurrency_excluded description: Recurrence kind (non_recurrent, recurrent, installment, recurrency_excluded). example: installment recurrence_group_id: type: string format: uuid nullable: true description: 'Identifier of the series of entries generated by an installment plan or by a recurrence: every entry in the same series shares the value. The creation response already brings it, but the read by ID only shows it once the series is generated in the background. Null when the entry belongs to no series. It is not a queryable entity, only a grouping key.' example: 5f1c8a2e-9b3d-4c7a-8e1f-2a3b4c5d6e7f 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. sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale that originated the entry.
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked to the entry (customer or vendor).
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Company that owns the entry.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Forecast (bank) account linked to the entry.
  • Call the [Get account or card by ID](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get) endpoint for the full data.
payment_method: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Effective payment method: the settlement one takes precedence over the planned one. Null when there is none.
  • Call the [Get payment method by ID](#tag/Payment-Methods/paths/~1payment_methods~1{id}/get) endpoint for the full data.
operation: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Own operation linked to the entry.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
invoice_rule: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Invoice rule that originated the entry.
  • Call the [Get billing rule by ID](#tag/Billing-Rules/paths/~1invoice_rules~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- User who registered the entry.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
movements: type: array description: |- Settlement movements of the entry.
  • Call the [Get account movement by ID](#tag/Account-movements/paths/~1account_movements~1{id}/get) endpoint for the full data.
items: "$ref": "#/components/schemas/entity_reference" apportionments: type: object description: Apportionment of the entry amount, broken down by company and by cost center. properties: per_company: type: array description: Apportionment across companies. items: "$ref": "#/components/schemas/bill_apportionment" per_cost_center: type: array description: Apportionment across cost centers. items: "$ref": "#/components/schemas/bill_cost_center" custom_fields: type: array description: Custom fields filled in the entry. items: "$ref": "#/components/schemas/bill_custom_field" attachments: type: array description: Entry attachments, with a temporary download link. items: "$ref": "#/components/schemas/attachment_summary" categories: type: array description: Apportionment of the entry by financial category. items: "$ref": "#/components/schemas/bill_category" commissions: type: array description: Commissions linked to the entry. items: "$ref": "#/components/schemas/bill_commission" items: type: array description: Items that make up the entry. items: "$ref": "#/components/schemas/bill_item" credit_card_items: type: array description: Credit card invoice items (consolidated charges); populated when kind = credit_card_invoice, empty array otherwise. items: "$ref": "#/components/schemas/bill_credit_card_item" required: - id - transaction_kind - kind - amount - final_amount - canceled bill_create: type: object writeOnly: true description: Data to create an account payable or receivable, open or already settled. required: - transaction_kind - person_id - description - amount - due_date - categories properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 'CNPJ of the entry''s company. The credential must be able to create entries in it. Required, except for a sale entry (with 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.
example: debit description: type: string nullable: true description: 'Note of the movement itself: the text entered on the transfer between accounts, or the installment identification when the credit card payment was split into installments. It is not the description of the settled account payable or receivable, which comes in the resource referenced by bill' example: Repasse diário check: allOf: - "$ref": "#/components/schemas/account_movement_check" description: Check data, null when the movement was not made by check card: allOf: - "$ref": "#/components/schemas/account_movement_card" description: Card data, null when the movement was not made by card. Full number, security code, expiration date and cardholder name are never returned required: - id - amount - transaction_kind account_movement: type: object description: Full detail of an account movement. 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.
example: debit description: type: string nullable: true description: 'Note of the movement itself: the text entered on the transfer between accounts, or the installment identification when the credit card payment was split into installments. It is not the description of the settled account payable or receivable, which comes in the resource referenced by bill' example: Repasse diário check: allOf: - "$ref": "#/components/schemas/account_movement_check" description: Check data, null when the movement was not made by check card: allOf: - "$ref": "#/components/schemas/account_movement_card" description: Card data, null when the movement was not made by card. Full number, security code, expiration date and cardholder name are never returned card_rate: type: number format: double description: 'Card fee of the movement. It is only deducted on a receivable paid by credit or debit card into a checking account: the customer paid 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
  • Call the [Get account or card by ID](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get) endpoint for the full data.
payment_method: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Payment method of the movement
  • Call the [Get payment method by ID](#tag/Payment-Methods/paths/~1payment_methods~1{id}/get) endpoint for the full data.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Account payable or receivable settled by the movement
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
credit_card_invoice: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Credit card invoice the movement is part of
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
counterpart_account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Account on the other side of the transfer between accounts: the destination one when this movement is the outflow, the origin one when it is the inflow. Null when the movement is not a transfer
  • Call the [Get account or card by ID](#tag/Accounts-and-Cards/paths/~1accounts~1{id}/get) endpoint for the full data.
required: - id - amount - transaction_kind - account account_movements_response: type: object description: Response containing the list of account movements with pagination information. properties: data: type: array description: Array containing the account movements of the current page. items: "$ref": "#/components/schemas/account_movement_summary" pagination: "$ref": "#/components/schemas/pagination" refund_summary: type: object description: 'Represents a sale refund in the list: only the refund own fields.' properties: id: &681 type: string format: uuid description: Unique refund identifier example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 refund_type: &682 type: string enum: - customer - vendor description: |- Refund side.
  • customer: customer refund.
  • vendor: supplier or representative refund.
example: vendor amount: &683 type: number format: double description: Refund amount example: -91.36 description: &684 type: string nullable: true description: Refund description example: Reembolso Incentivo issue_date: &685 type: string format: date nullable: true description: Refund issue date example: '2021-06-16' due_date: &686 type: string format: date nullable: true description: Refund due date example: '2021-06-17' required: - id - refund_type - amount refund: type: object description: Represents a sale refund with the references to the related entities. properties: id: *681 refund_type: *682 amount: *683 description: *684 issue_date: *685 due_date: *686 sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Refunded sale
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale product that originated the refund. The identifier appears in the corresponding product inside the sale
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Customer or supplier/representative of the refund
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Refund company
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Refund account payable or receivable, null while it is not invoiced
  • Call the [Get account payable or receivable by ID](#tag/Accounts-Payable-and-Receivable/paths/~1bills~1{id}/get) endpoint for the full data.
required: - id - refund_type - amount - sale - sale_product - person - company refund_create: type: object description: Body to record a refund on the sale. properties: sale_product_id: type: string format: uuid description: Identifier of the refunded sale product, as it appears on the product inside the sale. example: e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148 refund_type: type: string enum: - customer - vendor description: |- Refund side.
  • customer: the agency gives the amount back to the customer.
  • vendor: refund with the product vendor or representative.
example: customer amount: type: number format: double minimum: 0 exclusiveMinimum: true description: Refund amount, positive. The sign comes from `transaction_kind`. example: 1208.89 transaction_kind: type: string enum: - credit - debit description: |- Direction of the money for the agency.
  • 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.
example: debit billing: type: string enum: - invoice - bill description: |- How the refund is billed.
  • invoice: goes to the invoice by the billing rules.
  • bill: generates right away a separate invoice with it alone.
example: invoice issue_date: type: string format: date description: Refund issue date. When omitted, today. example: '2022-04-09' description: type: string maxLength: 100 description: Refund description, up to 100 characters. example: Reembolso devido ao cancelamento da viagem person_id: type: string format: uuid description: 'Person who receives the customer refund. When omitted, the sale payer. Not valid on a vendor refund. Sending the person requires the "Read all people" permission: without it, the person is refused (422) as one that does not exist.' example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 cost_center: type: string maxLength: 50 description: Cost center of the customer refund, only with `billing` equal to `invoice`. For a legal person with registered cost centers, it must be one of them, unless the agency enters cost centers as free text. example: Diretoria required: - sale_product_id - refund_type - amount - billing refunds_response: type: object description: Response containing the refund list with pagination information. properties: data: type: array description: Array containing the refunds of the current page. items: "$ref": "#/components/schemas/refund_summary" pagination: "$ref": "#/components/schemas/pagination" passenger_list_named_reference: type: object description: Reference to a related record, with its name. properties: id: type: string format: uuid description: Identifier of the referenced record. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: type: string description: Name of the referenced record. example: Maria Silva required: - id - name passenger_list_airline_segment: type: object description: Air segment of the product, with the passenger's seat. properties: airline_code: type: string description: Airline code. example: TP flight_number: type: string nullable: true description: Flight number. example: '88' class: type: string nullable: true description: Booking class. example: Y origin: type: string description: Origin airport (IATA). example: GRU departure_date: type: string description: Departure of the segment (ISO 8601). example: '2026-11-10T23:55:00' destination: type: string description: Destination airport (IATA). example: LIS arrival_date: type: string nullable: true description: Arrival of the segment (ISO 8601). example: '2026-11-11T13:40:00' seat_number: type: string nullable: true description: Seat of the passenger in the segment. Null when no seat was assigned. example: 12A required: - airline_code - origin - departure_date - destination passenger_list_row: type: object description: Passenger of a product sold. properties: id: type: string format: uuid description: Identifier of the passenger in the sale product. example: 2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35 person: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Registration of the passenger.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
name: type: string description: Name of the passenger in the registration. example: Ana Souza emission_name: type: string nullable: true description: Emission name of the passenger in the product. gender: type: string nullable: true description: 'Gender of the passenger: `M` or `F`.' birthplace: type: string nullable: true description: City of birth of the passenger. cpf: type: string nullable: true description: CPF of the passenger. rg: type: string nullable: true description: RG of the passenger. rg_issuing_agency: type: string nullable: true description: Issuing agency of the passenger's RG. birth_certificate: type: string nullable: true description: Birth certificate of the passenger. passport_number: type: string nullable: true description: Passport number of the passenger. email: type: string nullable: true description: E-mail of the passenger. phone_number: type: string nullable: true description: Phone. mobile_number: type: string nullable: true description: Mobile phone of the passenger. birthdate: type: string format: date nullable: true description: Birth date of the passenger. rg_issue_date: type: string format: date nullable: true description: Issue date of the passenger's RG. passport_expiration_date: type: string format: date nullable: true description: Passport expiration date of the passenger. address: type: object description: Address of the passenger, the one in their registration. properties: postal_code: type: string nullable: true description: Postal code. street: type: string nullable: true description: Street. street_number: type: string nullable: true description: Number. additional_info: type: string nullable: true description: Additional information. neighborhood: type: string nullable: true description: Neighborhood. city_name: type: string nullable: true description: City name. state_code: type: string nullable: true description: State abbreviation. ticket_number: type: string nullable: true description: Document of the passenger in the product, such as the ticket number. cost_center: type: string nullable: true description: Cost center of the passenger in the product. canceled_at: type: string format: date nullable: true description: Cancellation date of the passenger in the product. Null when not canceled. sale: type: object description: |- Sale of the product, with its number, date and status.
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. number: type: integer description: Number of the sale. example: 1024 date: type: string format: date description: Date of the sale. example: '2026-10-01' status: type: string enum: - opened - closed - canceled description: Status of the sale. example: closed required: - id - number - date - status sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Sale product the passenger is in.
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
product: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" description: |- Registered product, with its name.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
supplier: type: object description: |- Supplier of the product, with its name and city.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. name: type: string description: Name of the referenced record. city_name: type: string nullable: true description: City name. representative: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Representative of the supplier in the product, with their name. Null when the product has none.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
departure_date: type: string nullable: true description: Departure or start of the product (ISO 8601). Brings the time when the product has it. example: '2026-11-10T08:30:00' arrival_date: type: string nullable: true description: Arrival or end of the product (ISO 8601). Brings the time when the product has it. example: '2026-11-20' destination: type: string nullable: true enum: - national - international - cruise description: 'Destination of the product: `national`, `international` or `cruise`.' example: international document: type: string nullable: true description: Document of the product, such as the locator or the booking number. product_details: type: object description: 'The product details Monde shows according to its type: accommodation, cruise, car rental and package. What does not belong to the product type comes null.' properties: nights: type: integer nullable: true description: Nights. accommodation_kind: type: string nullable: true description: Accommodation type. room_category: type: string nullable: true description: Room category. meal_plan: type: string nullable: true description: Meal plan. cabin_kind: type: string nullable: true description: Cabin type. cabin_number: type: string nullable: true description: Cabin number. cabin_category: type: string nullable: true description: Cabin category. ship_name: type: string nullable: true description: Ship name. cruise_destination: type: string nullable: true description: Ship destination. vehicle_category: type: string nullable: true description: Vehicle category. pickup_location: type: string nullable: true description: Vehicle pickup location. dropoff_location: type: string nullable: true description: Vehicle drop-off location. package_name: type: string nullable: true description: Package name. transport: type: string nullable: true description: Package transport. airline_segments: type: array description: Air segments of the product, in flight order, each with the passenger's seat. Empty list when the product has no segments. items: "$ref": "#/components/schemas/passenger_list_airline_segment" amounts: type: object description: Amounts of the passenger in the product, in the product's sale currency, as the amount columns of the report. properties: currency: type: string nullable: true description: Sale currency of the product. amount: type: number format: double description: Product amount. fees: type: number format: double description: Fees. other_fees: type: number format: double description: Other fees. total_fees: type: number format: double description: Total fees. du_fee: type: number format: double description: DU fee. du_fee_discount: type: number format: double description: DU fee discount. rav_fee: type: number format: double description: RAV fee. rav_fee_discount: type: number format: double description: RAV fee discount. agency_fee: type: number format: double description: Hidden service fee. customer_amount: type: number format: double description: 'Customer amount: the product amount plus the hidden service fee.' total_amount: type: number format: double description: Total amount. external_number: type: string nullable: true description: External number of the product. The name the field shows in Monde is the one in the agency's Settings. additional1: type: string nullable: true description: Additional 1 of the product. The name the field shows in Monde is the one in the agency's Settings. additional2: type: string nullable: true description: Additional 2 of the product. The name the field shows in Monde is the one in the agency's Settings. company: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" description: Company of the sale, with its name. seller: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" description: |- Seller of the sale, with their name.
  • Call the [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) endpoint for the full data.
payer: type: object description: |- Payer of the sale, with their name and phone.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. name: type: string description: Name of the referenced record. phone_number: type: string nullable: true description: Phone. intermediary: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Intermediary of the sale, with their name. Null when the sale has none.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
requester: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Requester of the sale, with their name. Null when the sale has none.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
approver: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Approver of the sale, with their name. Null when the sale has none. Only for an agency.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
promoter: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Promoter of the sale, with their name. Null when the sale has none. Only for an operator.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
own_operation: allOf: - "$ref": "#/components/schemas/passenger_list_named_reference" nullable: true description: |- Own operation of the sale, with its name. Null when the sale has none. Only for an agency.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
travel: type: object nullable: true description: |- Travel of the sale, with its number and description. Null when the sale is not in a travel.
  • Call the [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. number: type: string nullable: true description: Number of the travel. example: '000001' description: type: string nullable: true description: Description of the travel. example: Lua de mel custom_fields: type: object description: Filled custom fields of the passenger, the sale and the travel. properties: person: type: array description: Custom fields of the passenger's registration. items: "$ref": "#/components/schemas/custom_field" sale: type: array description: Custom fields of the sale. items: "$ref": "#/components/schemas/custom_field" travel: type: array description: Custom fields of the travel. items: "$ref": "#/components/schemas/custom_field" required: - id - person - name - sale - sale_product - product - supplier - airline_segments - amounts - company - seller - payer - custom_fields passenger_list_response: type: object description: Paginated passenger list. properties: data: type: array description: Passengers of the page. items: "$ref": "#/components/schemas/passenger_list_row" pagination: "$ref": "#/components/schemas/pagination" sales_by_product_named_reference: type: object description: Reference to a related record, with its name. properties: id: type: string format: uuid description: Identifier of the referenced record. example: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: type: string description: Name of the referenced record. example: Maria Silva required: - id - name sales_by_product_airline_segment: type: object description: Air segment of the product. properties: airline_code: type: string description: Airline code. example: TP flight_number: type: string nullable: true description: Flight number. example: '88' class: type: string nullable: true description: Booking class. example: Y origin: type: string description: Origin airport (IATA). example: GRU departure_date: type: string description: Segment departure (ISO 8601). example: '2026-11-10T23:55:00' destination: type: string description: Destination airport (IATA). example: LIS arrival_date: type: string nullable: true description: Segment arrival (ISO 8601). example: '2026-11-11T13:40:00' required: - airline_code - origin - departure_date - destination sales_by_product_row: type: object description: Product sold. properties: id: type: string format: uuid description: |- Identifier of the product in the sale.
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
example: 2f6d1c84-5b3a-4e7f-9a12-6c8e0d4b7a35 sale: type: object description: |- Sale of the product, with its number, date and status.
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. number: type: integer description: Sale number. example: 1024 date: type: string format: date description: Sale date. example: '2026-10-01' status: type: string enum: - opened - closed - canceled description: Sale status. example: closed required: - id - number - date - status company: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: Company of the sale, with its name. seller: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: |- Seller of the sale, with the name.
  • Call the [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) endpoint for the full data.
payer: type: object description: |- Payer of the sale, with the name, kind, document and contact.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. name: type: string description: Name of the referenced record. person_kind: type: string enum: - individual - company description: 'Payer kind: `individual` or `company`.' example: individual cpf_cnpj: type: string nullable: true description: Payer's CPF or CNPJ. email: type: string nullable: true description: Payer's email. phone_number: type: string nullable: true description: Payer's phone. mobile_number: type: string nullable: true description: Payer's mobile phone. own_operation: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Own operation of the sale, with the name. Null when the sale has none.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
requester: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Requester of the sale, with the name. Null when the sale has none.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
intermediary: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Intermediary of the sale, with the name. Null when the sale has none.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
approver: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Approver of the sale, with the name. Null when the sale has none.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
promoter: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Promoter of the sale, with the name. Null when the sale has none. Only comes with more than one currency.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
travel: type: object nullable: true description: |- Travel of the sale, with the number and description. Null when the sale is not in a travel.
  • Call the [Get travel by ID](#tag/Travels/paths/~1travels~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. number: type: string nullable: true description: Travel number. example: '000001' description: type: string nullable: true description: Travel description. example: Lua de mel product: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: |- Registered product, with the name.
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
supplier: type: object description: |- Supplier of the product, with the name, city, state and country.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
properties: id: type: string format: uuid description: Identifier of the referenced record. name: type: string description: Name of the referenced record. city_name: type: string nullable: true description: Supplier's city. state_code: type: string nullable: true description: Supplier's state code. country_name: type: string nullable: true description: Supplier's country. representative: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" nullable: true description: |- Representative of the supplier in the product, with the name. Null when the product has none.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
status: type: string enum: - active - canceled description: 'Product status: `active` or `canceled`.' example: active departure_date: type: string nullable: true description: Departure or start of the product (ISO 8601). Brings the time when the product has it. example: '2026-11-10T08:30:00' arrival_date: type: string nullable: true description: Arrival or end of the product (ISO 8601). Brings the time when the product has it. example: '2026-11-20' canceled_at: type: string format: date nullable: true description: Cancellation date of the product. Null when it was not canceled. quantity: type: integer nullable: true description: Quantity. example: 1 destination: type: string nullable: true enum: - national - international - cruise description: 'Product destination: `national`, `international` or `cruise`.' example: international document: type: string nullable: true description: Product document, such as the locator or the booking number. external_number: type: string nullable: true description: External number of the product. The name the field shows in Monde is the one in the agency Settings. additional1: type: string nullable: true description: Additional 1 of the product. The name the field shows in Monde is the one in the agency Settings. additional2: type: string nullable: true description: Additional 2 of the product. The name the field shows in Monde is the one in the agency Settings. product_details: type: object description: 'The product details Monde shows according to its type: lodging, cruise, car rental and package. What does not belong to the product type comes null.' properties: nights: type: integer nullable: true description: Nights. accommodation_kind: type: string nullable: true description: Accommodation type. room_category: type: string nullable: true description: Room category. meal_plan: type: string nullable: true description: Meal plan. cabin_kind: type: string nullable: true description: Cabin type. cabin_number: type: string nullable: true description: Cabin number. cabin_category: type: string nullable: true description: Cabin category. ship_name: type: string nullable: true description: Ship name. cruise_destination: type: string nullable: true description: Ship destination. vehicle_category: type: string nullable: true description: Vehicle category. pickup_location: type: string nullable: true description: Vehicle pickup location. dropoff_location: type: string nullable: true description: Vehicle drop-off location. package_name: type: string nullable: true description: Package name. transport: type: string nullable: true description: Package transport. passengers: type: array description: Passengers of the product. Empty list when the product has no passengers. items: type: object properties: id: type: string format: uuid nullable: true description: |- Passenger's record.
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
name: type: string nullable: true description: Passenger's name. nfs: type: array description: Invoices of the product that were not canceled. Empty list when the product has none. items: type: object properties: id: type: string format: uuid description: |- Invoice.
  • Call the [Query invoices by ID](#tag/Invoices/paths/~1nfs~1{id}/get) endpoint for the full data.
nfse_number: type: string nullable: true description: NFS-e number. airline_segments: type: array description: Air segments of the product, in flight order. Empty list when the product has no segments. items: "$ref": "#/components/schemas/sales_by_product_airline_segment" amounts: type: object description: Amounts of the product in its sale currency, as the amount columns of the report. properties: currency: type: string nullable: true description: Sale currency of the product. unit_amount: type: number format: double description: Unit amount. unit_fees: type: number format: double description: Unit fees. total_products: type: number format: double description: Products total. fees: type: number format: double description: 'Fees: the sum of the passengers'' fees.' other_fees: type: number format: double description: 'Other fees: the sum of the passengers'' other fees.' total_fees: type: number format: double description: Fees total. du_fee: type: number format: double description: DU fee. cc_du_fee: type: number format: double description: Credit card fee on the DU fee. cc_du_fee_percentage: type: number format: double description: Card fee on the DU fee, as a percentage of the DU fee. du_fee_discount: type: number format: double description: DU fee discount. rav_fee: type: number format: double description: RAV fee. cc_rav_fee: type: number format: double description: Credit card fee on the RAV fee. cc_rav_fee_percentage: type: number format: double description: Card fee on the RAV fee, as a percentage of the RAV fee. rav_fee_discount: type: number format: double description: RAV fee discount. agency_fee: type: number format: double description: Hidden service fee. agency_service_fee: type: number format: double description: Shown service fee. discount: type: number format: double description: Discount. total_discount: type: number format: double description: Discount total. deductions: type: number format: double description: Deductions. Does not come with more than one currency. billing: type: number format: double description: Billing. total_amount: type: number format: double description: Total amount. customer_refund: type: number format: double description: Refund to the customer. supplier_refund: type: number format: double description: Refund from the supplier. agency_card_rate: type: number format: double description: Agency card fee. supplier_fine: type: number format: double description: Supplier fine. deleted_balance: type: number format: double description: Deleted balance. kandir_retention: type: number format: double description: 'Kandir Law retention: the sum of the retentions on the amount, the service fee, the DU and RAV fees and the boarding fee.' origin_amounts: type: object description: Amounts of the product in the origin currency, with the operator exchange rate. properties: currency: type: string nullable: true description: Origin currency of the product. exchange_rate: type: number format: double description: Operator exchange rate. total_products: type: number format: double description: Products total. In the origin currency. total_fees: type: number format: double description: Fees total. In the origin currency. agency_fee: type: number format: double description: Hidden service fee. In the origin currency. du_fee: type: number format: double description: DU fee. In the origin currency. deductions: type: number format: double description: Deductions. Does not come with more than one currency. In the origin currency. agency_service_fee: type: number format: double description: Shown service fee. In the origin currency. discount: type: number format: double description: Discount. In the origin currency. du_fee_discount: type: number format: double description: DU fee discount. In the origin currency. rav_fee_discount: type: number format: double description: RAV fee discount. In the origin currency. total_amount: type: number format: double description: Total amount. In the origin currency. commission: type: object description: Commission, over and revenue of the product. Only comes in the companies where the credential has the Visualizar comissão, over e receitas permission. properties: commission_amount: type: number format: double description: Commission. commission_percentage: type: number format: double description: Commission, as a percentage. over: type: number format: double description: 'Over base: the base on which the over is calculated. Does not come with more than one currency.' over_amount: type: number format: double description: Over. over_percentage: type: number format: double description: Over, as a percentage. intermediary_commission_amount: type: number format: double description: Intermediary commission. intermediary_commission_percentage: type: number format: double description: Intermediary commission, as a percentage. intermediary_over_amount: type: number format: double description: Intermediary over. intermediary_over_percentage: type: number format: double description: Intermediary over, as a percentage. revenue: type: number format: double description: Revenue. revenue_percentage: type: number format: double description: Revenue, as a percentage of the billing. custom_fields: type: object description: Filled custom fields of the payer, the sale and the travel. properties: person: type: array description: Custom fields of the payer's record. items: "$ref": "#/components/schemas/custom_field" sale: type: array description: Custom fields of the sale. items: "$ref": "#/components/schemas/custom_field" travel: type: array description: Custom fields of the travel. items: "$ref": "#/components/schemas/custom_field" required: - id - sale - company - seller - payer - product - supplier - status - product_details - passengers - airline_segments - amounts - origin_amounts - custom_fields sales_by_product_response: type: object description: Paginated sales by product. properties: data: type: array description: Products of the page. items: "$ref": "#/components/schemas/sales_by_product_row" pagination: "$ref": "#/components/schemas/pagination" sales_by_seller_row: type: object description: Sales of one seller in one company, summed. properties: seller: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: |- Seller, with the name.
  • Call the [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/sales_by_product_named_reference" description: Company of the sales summed in the row, with the name. sales_count: type: integer description: 'Total Vendas: how many sales of the seller are in the sum.' example: 12 products_count: type: integer description: 'Total Produtos: how many sold products are in the sum.' example: 18 amounts: type: object description: Summed amounts of the products, as the amount columns of the report. properties: total_amount: type: number format: double description: 'Valor Total de Vendas: (Total Produto + Taxa de Serviço Oculta - Abatimentos) + Total Taxas + (Taxa DU - Desconto Taxa DU) + (Taxa RAV - Desconto Taxa RAV) + Taxa Serviço Destacada - Desconto.' billing: type: number format: double description: 'Faturamento: (Produtos - Abatimentos - Desconto) + Taxa DU + Taxa RAV + Taxa Serviço Destacada + Taxa de Serviço Oculta.' total_products: type: number format: double description: Valor Total Produtos. total_fees: type: number format: double description: 'Total Taxas: Taxas + Outras Taxas.' du_fee: type: number format: double description: DU fee. cc_du_fee: type: number format: double description: Credit card fee on the DU fee. du_fee_discount: type: number format: double description: DU fee discount. rav_fee: type: number format: double description: RAV fee. cc_rav_fee: type: number format: double description: Credit card fee on the RAV fee. rav_fee_discount: type: number format: double description: RAV fee discount. agency_fee: type: number format: double description: Hidden service fee. agency_service_fee: type: number format: double description: Shown service fee. discount: type: number format: double description: Discount. deductions: type: number format: double description: Deductions. required: - total_amount - billing - total_products - total_fees - du_fee - cc_du_fee - du_fee_discount - rav_fee - cc_rav_fee - rav_fee_discount - agency_fee - agency_service_fee - discount - deductions commission: type: object description: Commission, over and revenue summed from the products. properties: commission_amount: type: number format: double description: Commission. over_amount: type: number format: double description: Over. intermediary_commission_amount: type: number format: double description: Intermediary commission. intermediary_over_amount: type: number format: double description: Intermediary over. revenue: type: number format: double description: 'Receitas: (Taxa DU + Taxa RAV + Taxa Serviço Destacada + Taxa de Serviço Oculta + Comissão + Over + Reembolso Fornecedor) - (Desconto + Desconto Taxa DU + Desconto Taxa RAV + Taxa CC DU + Taxa CC RAV + Taxa Cartão Agência + Comissão Intermediário + Over Intermediário + Reembolso Cliente + Multa Fornecedor + Saldo Excluído).' required: - commission_amount - over_amount - intermediary_commission_amount - intermediary_over_amount - revenue required: - seller - company - sales_count - products_count - amounts - commission sales_by_seller_response: type: object description: Paginated sales by seller. properties: data: type: array description: Sellers of the page. items: "$ref": "#/components/schemas/sales_by_seller_row" pagination: "$ref": "#/components/schemas/pagination" cvc_statement_summary: type: object description: 'Represents a CVC statement receipt in the list: only the receipt own fields.' properties: id: &687 type: string format: uuid description: Unique CVC statement receipt identifier example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 receipt_number: &688 type: string nullable: true description: Receipt number, null on a movement that does not refer to a receipt example: '89930000112199' movement_date: &689 type: string format: date description: Movement date example: '2019-12-26' sale_date: &690 type: string format: date-time nullable: true description: Sale date recorded on the receipt example: '2019-12-26T18:00:00' cancellation_date: &691 type: string format: date-time nullable: true description: Cancellation date recorded on the receipt example: boarding_date: &692 type: string format: date nullable: true description: Boarding date recorded on the receipt example: '2020-09-01' return_date: &693 type: string format: date nullable: true description: Return date recorded on the receipt example: '2020-09-09' product_name: &694 type: string nullable: true description: 'Product name as it came in the CVC statement, as free text. It is not the product registered in the system: to reach the sale product, use the sale_product reference' example: Excursões Internacionais package_name: &695 type: string nullable: true description: Package name as it came in the CVC statement, as free text example: SANTIAGO total_payments: &696 type: number format: double description: Total of the movement entries example: 347.89 total_taxes: &697 type: number format: double description: Total of the movement taxes example: 0.0 total_discounts: &698 type: number format: double description: Total of the movement discounts example: 0.0 total_abatement: &699 type: number format: double description: Total of the movement abatements example: 0.0 calculated_commission: &700 type: number format: double description: Calculated commission of the movement example: 111.33 retained_commission: &701 type: number format: double description: Retained commission of the movement example: 0.0 intermediary_commission: &702 type: number format: double description: Intermediary commission on the movement example: 0.0 deposit: &703 type: number format: double description: Deposit amount of the movement example: 34.78 opfax: &704 type: number format: double description: Movement amount in OPFAX example: 0.0 opfax_balance: &705 type: number format: double description: Consolidated balance of the receipt pair generated when the entry is a partial OPFAX one, recorded identically on both rows. It is not the movement amount in OPFAX, which comes in opfax example: 0.0 balance: &706 type: number format: double description: Movement balance example: 76.55 imported: &707 type: boolean description: Indicates that the record came from the statement import example: true edited: &708 type: boolean description: Indicates that the record was changed by hand after being imported example: false checked: &709 type: boolean description: Receipt check mark example: false deleted: &710 type: boolean description: Indicates that the receipt was deleted. Always false in the list, which does not return a deleted receipt; when getting the receipt by ID it is true when the receipt was deleted example: false created_at: &711 type: string format: date-time nullable: true description: Date and time the record was registered example: '2019-12-30T08:45:48' required: - id - movement_date - balance - deleted cvc_statement: type: object description: Represents a CVC statement receipt with the movement kind and the references to the related entities. properties: id: *687 receipt_number: *688 movement_date: *689 sale_date: *690 cancellation_date: *691 boarding_date: *692 return_date: *693 product_name: *694 package_name: *695 total_payments: *696 total_taxes: *697 total_discounts: *698 total_abatement: *699 calculated_commission: *700 retained_commission: *701 intermediary_commission: *702 deposit: *703 opfax: *704 opfax_balance: *705 balance: *706 imported: *707 edited: *708 checked: *709 deleted: *710 created_at: *711 movement_kind: type: object description: Movement kind, with the name as CVC classifies it in the statement properties: code: type: integer description: CVC code of the movement kind, as it comes in the statement (for example, 0 receipt settlement, 3 OPFAX settlement, 11 manual adjustment) example: 0 name: type: string description: Movement kind name example: BAIXA DE RECIBO required: - code - name company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Receipt company
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
contractor: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person recorded as the contractor on the receipt
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person recorded as the seller on the receipt, not necessarily a person registered as a seller
  • Call the [Get seller by ID](#tag/Sellers/paths/~1sellers~1{id}/get) endpoint for the full data.
intermediary: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person recorded as the intermediary on the receipt
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale linked to the receipt, null when the movement has no sale
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale product linked to the receipt. The identifier appears in the corresponding product inside the sale
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
nf: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Invoice (NF) issued for the receipt
  • Call the [Query invoices by ID](#tag/Invoices/paths/~1nfs~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the record
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
required: - id - movement_date - balance - deleted - movement_kind - company cvc_statements_response: type: object description: Response containing the CVC statement receipt list with pagination information. properties: data: type: array description: Array containing the receipts of the current page. items: "$ref": "#/components/schemas/cvc_statement_summary" pagination: "$ref": "#/components/schemas/pagination" nf_item: type: object description: Represents an invoice item. properties: id: type: string format: uuid description: Invoice item unique identifier example: 2b7f0c94-6e1a-4d38-a5c2-9f4e1b7d3a60 local_id: type: string description: Identifier the item carried in the request, returned only in the write response to match the sent item with the saved one. It is not stored example: linha-1 description: type: string description: Invoice item description example: Prestação de serviço de intermediação de venda de Passagem Aérea amount: type: number format: double description: Item total amount example: 113.48 service_amount: type: number format: double description: Item service amount example: 2613.82 approximate_taxes_amount: type: number format: double description: Item approximate taxes amount example: 0.0 required: - id - description - amount nf_summary: type: object description: 'Represents an invoice in the list: only the invoice own fields.' properties: id: &712 type: string format: uuid description: Unique invoice identifier example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 number: &713 type: integer nullable: true description: Invoice number, null while it has not been numbered example: 982677 series: &714 type: string nullable: true description: Invoice series example: '1' issue_date: &715 type: string format: date description: Invoice issue date example: '2023-01-13' status: &716 type: string enum: - unissued - issued - processing - processing_cancellation - awaiting_processing - canceled - awaiting_issue - awaiting_cancellation description: |- 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.
example: issued operation_nature: &717 type: string description: Operation nature declared on the invoice example: Prestação de Serviço cfop: &718 type: string nullable: true description: Operations and Services Fiscal Code (CFOP) of the invoice example: '5933' nbs_code: &719 type: string nullable: true description: Brazilian Services Nomenclature (NBS) code of the invoice example: 1.2004.10.00 document: &720 type: string nullable: true description: Document stored on the invoice, used to reconcile it with the originating document example: '9572810403321' manual_emission: &721 type: boolean description: Indicates the invoice was issued manually, with the NFS-e number informed by whoever issued it example: false amount: &722 type: number format: double description: Invoice total amount, the base for the tax calculation example: 113.48 service_amount: &723 type: number format: double description: Invoice total service amount example: 2613.82 net_amount: &724 type: number format: double description: 'Invoice net amount: the total amount minus the PIS, COFINS, IR, CSLL and withheld ISS withholdings' example: 113.48 approximate_taxes_percentage: &725 type: number format: double description: Approximate taxes percentage of the invoice example: 0.0 approximate_taxes_amount: &726 type: number format: double description: Approximate taxes amount of the invoice example: 0.0 observations: &727 type: string nullable: true description: Invoice observations example: Nota emitida conforme contrato 4471. cvc_original_data: &728 type: string nullable: true description: Original data of the invoice imported from the CVC file, as Monde shows it in the CVC tab of the invoice ("Dados importados do arquivo"). Read only. Null when the invoice did not come from that file example: |- Série: Emissão: 03/08/2010 Tomador: Esferatur Passagens e Turismo Ltda Valor Total: 65,69 Documento: 009500220079 Produto: MIAMI - 2 dias e 1 noites printed_at: &729 type: string format: date-time nullable: true description: Date and time the invoice was printed or generated example: '2023-02-09T17:26:29' canceled_at: &730 type: string format: date-time nullable: true description: Date and time of the invoice cancellation example: '2023-03-02T09:14:52' created_at: &731 type: string format: date-time nullable: true description: Date and time the invoice was registered example: '2023-02-09T17:16:14' recipient: &732 type: object description: Recipient data stored on the invoice properties: kind: &976 type: string enum: - payer - supplier - representative description: |- Recipient role in the sale that originated the invoice.
  • payer: payer.
  • supplier: supplier.
  • representative: representative.
example: payer name: &977 type: string description: Recipient name or legal name example: Esferatur Passagens e Turismo Ltda cpf_cnpj: &978 type: string nullable: true description: Recipient CPF or CNPJ, digits only example: '76530260000130' state_inscription: &979 type: string nullable: true description: Recipient state inscription example: '2536987410' city_inscription: &980 type: string nullable: true description: Recipient city inscription example: '1023456' postal_code: &981 type: string nullable: true description: Recipient zip code, digits only example: '89010300' street: &982 type: string nullable: true description: Recipient street example: Alameda Rio Branco street_number: &983 type: string nullable: true description: Recipient address number example: '238' neighborhood: &984 type: string nullable: true description: Recipient district example: Jardim Blumenau additional_info: &985 type: string nullable: true description: Recipient address complement example: 1º andar phone: &986 type: string nullable: true description: Recipient phone example: "(47) 3221-0100" email: &987 type: string nullable: true description: Recipient email; it may contain several addresses separated by semicolon example: financeiro@esferatur.com.br foreign: &988 type: boolean description: Indicates the recipient is a foreigner example: false foreign_document: &989 type: string nullable: true description: Foreign recipient document example: AB1234567 city: &990 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Recipient city
  • Call the [Get city by ID](#tag/Cities/paths/~1cities~1{id}/get) endpoint for the full data.
taxes: &733 type: object description: Invoice withholdings and taxes properties: retain_iss: &991 type: boolean description: Indicates ISS withholding on the invoice example: false retain_ir: &992 type: boolean description: Indicates IR withholding on the invoice example: false retain_pis_cofins_csll: &993 type: boolean description: Indicates PIS, COFINS and CSLL withholding on the invoice example: false iss_percentage: &994 type: number format: double description: ISS percentage applied on the invoice example: 5.0 iss_amount: &995 type: number format: double description: Invoice ISS amount example: 5.67 pis_percentage: &996 type: number format: double description: PIS percentage applied on the invoice example: 0.0 pis_amount: &997 type: number format: double description: Invoice PIS amount example: 0.0 cofins_percentage: &998 type: number format: double description: COFINS percentage applied on the invoice example: 0.0 cofins_amount: &999 type: number format: double description: Invoice COFINS amount example: 0.0 ir_percentage: &1000 type: number format: double description: IR percentage applied on the invoice example: 0.0 ir_amount: &1001 type: number format: double description: Invoice IR amount example: 0.0 csll_percentage: &1002 type: number format: double description: CSLL percentage applied on the invoice example: 0.0 csll_amount: &1003 type: number format: double description: Invoice CSLL amount example: 0.0 nfse: &734 type: object description: NFS-e data corresponding to the invoice properties: number: &1004 type: string nullable: true description: NFS-e number example: '13299' batch: &1005 type: string nullable: true description: Batch the NFS-e was transmitted in example: '8471' protocol: &1006 type: string nullable: true description: Protocol returned in the NFS-e transmission example: '202302091716140001' verification_code: &1007 type: string nullable: true description: NFS-e verification code example: BFLXB50A processed_at: &1008 type: string format: date-time nullable: true description: Date and time of the NFS-e processing example: '2023-02-09T17:26:29' errors: &1009 type: string nullable: true description: Error returned in the NFS-e processing, null when there was no error example: Inscricao municipal do prestador nao encontrada. required: - id - issue_date - status - operation_nature - recipient nf: type: object description: Represents an invoice with the items and the references to the related entities. properties: id: *712 number: *713 series: *714 issue_date: *715 status: *716 operation_nature: *717 cfop: *718 nbs_code: *719 document: *720 manual_emission: *721 amount: *722 service_amount: *723 net_amount: *724 approximate_taxes_percentage: *725 approximate_taxes_amount: *726 observations: *727 cvc_original_data: *728 printed_at: *729 canceled_at: *730 created_at: *731 recipient: *732 taxes: *733 nfse: *734 person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Registered person the invoice was issued to. The recipient data is the one in the recipient block, recorded on the invoice; the registry may have changed since it was issued. Null when the recipient was informed only on the invoice
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Company that issued the invoice
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale product that originated the invoice. The identifier appears in the corresponding product inside the sale
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale that originated the invoice
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the invoice. Null on an invoice created or copied through the API: it was written by the credential, recorded in the log
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
canceled_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who canceled the invoice, null while the invoice has not been canceled and when the cancellation came through the API, recorded in the log with the credential
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
items: type: array description: Invoice items items: "$ref": "#/components/schemas/nf_item" required: - id - issue_date - status - operation_nature - recipient - company - items nf_create: type: object writeOnly: true description: Data to create a standalone invoice. Send the recipient as person_id or as recipient, never both. required: - company_identifier - items properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: 'CNPJ of the issuing company, digits only. Required on create. The invoice company does not change: on edit, the CNPJ of its own company is ignored, and another one answers 422' issue_date: type: string format: date description: Invoice issue date example: '2026-10-16' operation_nature: type: string maxLength: 30 description: Operation nature declared on the invoice example: Prestação de Serviço cfop: type: string maxLength: 10 description: Operations and Services Fiscal Code (CFOP) of the invoice example: '5933' nbs_code: type: string description: Brazilian Services Nomenclature (NBS) code of the invoice example: '109051200' observations: type: string maxLength: 2000 description: Invoice observations example: Referente à viagem de outubro person_id: type: string format: uuid nullable: true description: Identifier of the registered person who is the recipient. The recipient data and withholdings come from their record example: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 recipient: "$ref": "#/components/schemas/nf_recipient_write" taxes: "$ref": "#/components/schemas/nf_taxes_write" items: type: array description: Invoice items items: "$ref": "#/components/schemas/nf_item_write" nf_update: type: object writeOnly: true description: Data to edit an unissued invoice. An omitted field stays as it is. properties: issue_date: type: string format: date description: Invoice issue date example: '2026-10-16' operation_nature: type: string maxLength: 30 description: Operation nature declared on the invoice example: Prestação de Serviço cfop: type: string maxLength: 10 description: Operations and Services Fiscal Code (CFOP) of the invoice example: '5933' nbs_code: type: string description: Brazilian Services Nomenclature (NBS) code of the invoice example: '109051200' observations: type: string maxLength: 2000 description: Invoice observations example: Referente à viagem de outubro person_id: type: string format: uuid nullable: true description: Identifier of the registered person who is the recipient. The recipient data and withholdings come from their record example: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 recipient: "$ref": "#/components/schemas/nf_recipient_write" taxes: "$ref": "#/components/schemas/nf_taxes_write" items: type: array description: Invoice items items: "$ref": "#/components/schemas/nf_item_write" nf_recipient_write: type: object writeOnly: true description: Recipient data typed in the invoice. On create, it comes instead of person_id. On edit of an invoice linked to a registered person, the block only applies with person_id sent as null, the explicit choice of a typed recipient, as in Monde; without it, the block is ignored. A field omitted from the block stays as it is. properties: name: type: string description: Recipient name or legal name example: Esferatur Passagens e Turismo Ltda cpf_cnpj: type: string description: Recipient CPF or CNPJ, digits only example: '76530260000130' state_inscription: type: string description: Recipient state inscription example: '254174250' city_inscription: type: string description: Recipient city inscription example: '4471' postal_code: type: string description: Recipient zip code, digits only example: '89010300' street: type: string description: Recipient street example: Alameda Rio Branco street_number: type: string description: Recipient address number example: '238' neighborhood: type: string description: Recipient district example: Jardim Blumenau additional_info: type: string description: Recipient address complement example: 1º andar phone: type: string description: Recipient phone example: "(47) 3221-0100" email: type: string description: Recipient email; it may contain several addresses separated by semicolon example: financeiro@esferatur.com.br foreign: type: boolean description: Indicates the recipient is a foreigner example: false foreign_document: type: string description: Foreign recipient document example: X1234567 city_id: type: string format: uuid description: Identifier of the recipient's city example: 0a6a2f1b-77c4-4f0e-9c2a-5d3b8e6f1a92 nf_taxes_write: type: object writeOnly: true description: 'Invoice withholdings. They only apply with the recipient in recipient: with person_id, the withholdings are the person''s, and the ones sent are ignored.' properties: retain_iss: type: boolean description: Indicates ISS withholding on the invoice example: false retain_ir: type: boolean description: Indicates IR withholding on the invoice example: false retain_pis_cofins_csll: type: boolean description: Indicates PIS, COFINS and CSLL withholding on the invoice example: false nf_item_write: type: object writeOnly: true description: Invoice item. With id, it is an existing item that stays, changing only what was sent; without id, it is a new item, and description and amount are required. properties: id: type: string format: uuid description: Invoice item unique identifier example: f1c4a7e2-9b3d-4f68-8a51-6e2d0c9b7a13 local_id: type: string description: Identifier the item carried in the request, returned only in the write response to match the sent item with the saved one. It is not stored example: linha-1 description: type: string maxLength: 250 description: Invoice item description example: Intermediação de hospedagem amount: type: number format: double description: Item total amount example: 1500.0 service_amount: type: number format: double nullable: true description: Item service amount example: 1500.0 nf_manual_issuance: type: object writeOnly: true description: Number of the NFS-e issued at the city hall. required: - nfse_number properties: nfse_number: type: string maxLength: 20 description: NFS-e number generated by the city hall, up to 20 characters example: '4521' nf_amount_adjustment: type: object writeOnly: true description: Percentage of the amount adjustment. required: - percentage properties: percentage: type: number format: double description: 'Adjustment percentage, other than zero: positive increases the amount, negative decreases it (e.g. -10 reduces by 10%)' example: -10 nf_written_reference: type: object description: 'Write response for a credential that cannot read invoices in the company: the invoice identifier and, for each item sent, its identifier and local_id.' properties: id: type: string format: uuid description: Unique invoice identifier example: a3e8c1f4-7d2b-4e59-8c06-1b9f4d7e2a35 items: type: array description: Invoice items items: type: object properties: id: type: string format: uuid description: Invoice item unique identifier local_id: type: string description: Identifier the item carried in the request, returned only in the write response to match the sent item with the saved one. It is not stored required: - id nfs_response: type: object description: Response containing the invoice list with pagination information. properties: data: type: array description: Array containing the invoices of the current page. items: "$ref": "#/components/schemas/nf_summary" pagination: "$ref": "#/components/schemas/pagination" nf_generation_draft: type: object description: An invoice the generation would save, built by the invoice (NF) rule, still without a number. properties: recipient: type: object description: Recipient of the invoice. The other recipient fields follow those of [Get invoice by ID](#tag/Invoices/paths/~1nfs~1{id}/get) properties: kind: type: string enum: - payer - supplier - representative description: |- Role of the recipient in the invoice (NF) rule.
  • payer: payer.
  • supplier: supplier.
  • representative: representative.
example: payer name: type: string description: Recipient name or legal name example: Maria Souza cpf_cnpj: type: string nullable: true description: Recipient CPF or CNPJ, digits only example: '52998224725' person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person of the recipient
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
issue_date: type: string format: date description: Issue date the invoice will have, according to the reference company's settings (sale date, departure date or the day of the generation) example: '2026-10-16' operation_nature: type: string nullable: true description: Operation nature declared on the invoice example: Prestação de Serviço cfop: type: string nullable: true description: Operations and Services Fiscal Code (CFOP) of the invoice example: nbs_code: type: string nullable: true description: Brazilian Services Nomenclature (NBS) code of the invoice example: amount: type: number format: double description: 'Amount of the invoice: the formula result minus what the earlier invoices of the same product and recipient already covered' example: 120.0 service_amount: type: number format: double description: Invoice total service amount example: 1500.0 net_amount: type: number format: double description: 'Invoice net amount: the total amount minus the PIS, COFINS, IR, CSLL and withheld ISS withholdings' example: 120.0 taxes: type: object description: Withholdings and taxes computed as the invoice would come out, in the same format as `taxes` in [Get invoice by ID](#tag/Invoices/paths/~1nfs~1{id}/get) nf_rule: allOf: - "$ref": "#/components/schemas/entity_reference" description: Invoice (NF) rule that built the invoice. See the rule in [Get invoice (NF) rule by ID](#tag/Invoice-%28NF%29-Rules/paths/~1nf_rules~1{id}/get) nf_rule_description: type: string description: Description of the invoice (NF) rule example: Regra do pagante formula: type: string description: Formula of the rule that set the service amount example: Taxa de Serviço complementary: type: boolean description: Whether the invoice complements another one already generated for the same product and recipient example: false generatable: type: boolean description: Whether the invoice can be generated. Only an invoice with `true` goes in the generation request example: true error: type: string nullable: true description: Why the invoice cannot be generated, such as a negative amount; null when it can example: nf_generation: type: object description: A sold product with the invoices it already has and the ones the generation would save. properties: sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Sale product
  • Call the the sale product `id`, in [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
sale: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Sale of the product
  • Call the [Get sale by ID](#tag/Sales/paths/~1sales~1{id}/get) endpoint for the full data.
company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Company of the sale, which is the company of the invoices
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
sale_number: type: integer description: Sale number example: 1532 sale_date: type: string format: date description: Sale date example: '2026-10-05' product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Catalog product
  • Call the [Get product by ID](#tag/Products/paths/~1products~1{id}/get) endpoint for the full data.
payer: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Payer of the sale
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier of the product
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
representative: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Representative of the product, null when there is none
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
start_date: type: string format: date nullable: true description: Product start date example: '2026-11-10' end_date: type: string format: date nullable: true description: Product end date example: '2026-11-20' total_amount: type: number format: double description: Total amount of the product example: 1500.0 revenues: type: number format: double description: Revenue of the product the invoices can cover, net of refunds example: 120.0 nfs_amount: type: number format: double nullable: true description: Sum of the product's invoices, the existing ones and the ones the generation would save; null when the sum is negative example: 120.0 balance: type: number format: double description: Revenue minus the sum of the invoices example: 0.0 valid: type: boolean description: Whether the product has no errors. An invalid product does not generate invoices example: true errors: type: array description: Why the product is invalid, such as no applicable invoice (NF) rule or an invalid CPF/CNPJ of the recipient items: type: string existing_nfs: type: array description: The non-canceled invoices the product already has; the data of each one is in [Get invoice by ID](#tag/Invoices/paths/~1nfs~1{id}/get) items: "$ref": "#/components/schemas/entity_reference" new_nfs: type: array description: The invoices the generation would save items: "$ref": "#/components/schemas/nf_generation_draft" nf_generations_response: type: object description: Response of the list of invoices to generate, with the moment of the query and the pagination. properties: data: type: array description: The products of the current page. items: "$ref": "#/components/schemas/nf_generation" previewed_at: type: string format: date-time description: Moment of the query, with fractional seconds. Send it in the generation request example: '2026-10-16T10:15:30.123456-03:00' pagination: "$ref": "#/components/schemas/pagination" nf_generation_create: type: object description: 'The generation request: the invoices chosen in the list of invoices to generate.' required: - company_identifier - previewed_at - nfs properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ of the reference company, the same one of the list of invoices to generate previewed_at: type: string format: date-time description: The `previewed_at` returned by the query that showed these invoices. An invoice saved after it for any of the products refuses the generation with 409 example: '2026-10-16T10:15:30.123456-03:00' include_without_revenue: type: boolean default: false description: 'The same value used in the query: with `true`, the zero-valued invoices of the products without revenue can also be generated. Default: `false`' example: false nfs: type: array minItems: 1 maxItems: 500 description: The invoices to generate, at most 500 per request, without repeating the same invoice items: type: object required: - sale_product_id - recipient_kind properties: sale_product_id: type: string format: uuid description: The `sale_product.id` of the product in the list of invoices to generate example: 9b2f4a1e-6c3d-4e8f-a1b2-c3d4e5f6a7b8 recipient_kind: type: string enum: - payer - supplier - representative description: The `recipient.kind` of the invoice in the list of invoices to generate example: payer nf_generation_created: type: object description: The generated invoices. properties: data: type: array description: The generated invoices, in full, or with only the `id` for whoever cannot read invoices in their company. items: "$ref": "#/components/schemas/nf" log_summary: type: object description: 'Represents a history entry on the list: only the fields of the entry itself.' properties: id: &735 type: string format: uuid description: Unique identifier of the history entry example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 kind: &736 type: string enum: - insertion - edition - deletion - custom - export - email description: |- Recorded action.
  • 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.
example: edition origin: &737 type: string nullable: true description: Origin of the change. The set is open and grows as new screens start recording history, so treat the value as free text. The known values are 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
  • Call the [Get person by ID](#tag/People/paths/~1people~1{id}/get) endpoint for the full data.
resource: allOf: - "$ref": "#/components/schemas/entity_reference" description: 'Audited record. It is always the main record: on a change to a category or an item of a financial entry the identifier is the one of the entry, and on a change to a sale product it is the one of the sale' required: - id - kind - description - created_at - resource logs_response: type: object description: Response containing the list of logs with pagination information. properties: data: type: array description: Array containing the logs of the current page. items: "$ref": "#/components/schemas/log_summary" pagination: "$ref": "#/components/schemas/pagination" custom_field_definition: type: object description: 'Represents a custom field definition: the identifier and the field''s metadata.' properties: id: type: integer description: Unique identifier of the custom field. example: 123 resource: type: string enum: - sales - travels - people - bills - tasks description: Resource (origin) of the field, in the public vocabulary of the API. example: sales name: type: string description: Name of the custom field. example: Centro de custo kind: type: string enum: - numeric - currency - text - date - choices description: |- Kind of value accepted by the field.
  • numeric: integer number.
  • currency: monetary value.
  • text: free text.
  • date: date.
  • choices: one of the registered options (see choices).
example: choices required: type: boolean description: Indicates whether the field is required in the resource it is associated with. example: true active: type: boolean description: Indicates whether the field is active. example: true choices: type: array items: type: string description: Registered options of a list-kind field (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: "

Dia 1

Chegada e passeio pela Baixa.

" active: true public_url: https://suaviagem.app/guia/a1B2c3-lisboa internal_observations: Enviar junto com o voucher. cover_kind: color cover_color: "#1f4e79" cover_show_title: true cover_show_subtitle: true hide_cover_text: false cover_image_url: created_at: '2024-03-15T10:30:00' updated_at: '2024-03-16T08:15:00' - &821 id: 41 title: Buenos Aires subtitle: Feriado prolongado details: "

Tango em San Telmo e jantar em Puerto Madero.

" active: false public_url: https://suaviagem.app/guia/x9Y8z7-buenos-aires internal_observations: cover_kind: color cover_color: "#5f6777" cover_show_title: true cover_show_subtitle: true hide_cover_text: false cover_image_url: created_at: '2024-01-10T09:00:00' updated_at: '2024-01-12T14:20:00' pagination: size: 20 has_next_page: false next_cursor: paginated_guides: summary: 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: "

Dia 1

Chegada e passeio pela Baixa.

" active: true public_url: https://suaviagem.app/guia/a1B2c3-lisboa internal_observations: Enviar junto com o voucher. cover_kind: color cover_color: "#1f4e79" cover_show_title: true cover_show_subtitle: true hide_cover_text: false cover_image_url: created_at: '2024-03-15T10:30:00' updated_at: '2024-03-16T08:15:00' company: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 user: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 create_guide: summary: 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: "

Dia 1

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

Dia 1

Chegada e passeio pela Baixa.

" active: true public_url: https://suaviagem.app/guia/d4E5f6-copia-lisboa internal_observations: Enviar junto com o voucher. cover_kind: color cover_color: "#1f4e79" cover_show_title: true cover_show_subtitle: true hide_cover_text: false cover_image_url: created_at: '2024-04-02T11:00:00' updated_at: '2024-04-02T11:00:00' company: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 user: id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 all_invoice_rules: summary: 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, without company_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.

About the V3 API

  • The base URL for the requests is https://web.monde.com.br/api/v3.
  • The authentication credentials will be provided by the travel agency you are integrating with.
  • The API operates according to RESTful principles, using the JSON format.
  • We follow the OpenAPI specification; you can download the API documentation here to view it in other tools.
  • Each field available in the API has a specific type. Examples: string, integer, float, boolean, etc.
  • Date fields must be in ISO 8601 format (YYYY-MM-DD). Example: "2024-08-01".
  • Float fields must use a dot (.) as the decimal separator, with only two decimal places. Example: 99999.99.
  • Required fields are specified as required.
  • Empty text ("") 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).
  • On an update (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).
' contact: name: Questions and support email: suporte@monde.com.br servers: - url: https://web.monde.com.br/api/v3