--- paths: "/sales": get: summary: List sales x-badges: - name: Beta color: "#f5803e" tags: - Sales description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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. example: '2026-08-01T14:30:00' - "$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: summary: Create a sale x-badges: - name: Beta color: "#f5803e" tags: - Sales description: |- ⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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_detail" 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_detail" examples: all_products_sale: summary: Sale with all products "$ref": "#/components/examples/all_products_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" 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" 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: summary: Get sale by ID x-badges: - name: Beta color: "#f5803e" tags: - Sales description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

Returns complete data for a specific sale, including all associated products and information." 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" "/attachments": post: summary: Upload attachment x-badges: - name: Beta tags: - Attachments description: |- ⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" '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 default: - 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 default: - 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. 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 '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/products": get: summary: List products x-badges: - name: Beta color: "#f5803e" tags: - Products description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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 - 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" "/products/{id}": get: summary: Get product by ID x-badges: - name: In development color: "#6c757d" tags: - Products description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/cabins": get: summary: List cabins x-badges: - name: Beta color: "#f5803e" tags: - Cabins description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/ships": get: summary: List ships x-badges: - name: Beta color: "#f5803e" tags: - Ships description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/cost_centers": get: summary: List cost centers x-badges: - name: Beta color: "#f5803e" tags: - Cost Centers description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/cost_centers/{id}": get: summary: Get cost center by ID x-badges: - name: In development color: "#6c757d" tags: - Cost Centers description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/currencies": get: summary: List currencies x-badges: - name: Beta color: "#f5803e" tags: - Currencies description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: summary: Get currency by code x-badges: - name: In development color: "#6c757d" tags: - Currencies description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/categories": get: summary: List categories x-badges: - name: Beta color: "#f5803e" tags: - Categories description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/categories/{id}": get: summary: Get category by ID x-badges: - name: In development color: "#6c757d" tags: - Categories description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/cities": get: summary: List cities x-badges: - name: Beta color: "#f5803e" tags: - Cities description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

Returns the list of cities registered in the system." 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: 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: summary: Get city by ID x-badges: - name: In development color: "#6c757d" tags: - Cities description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

Returns a specific city 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 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" "/sellers": get: summary: List sellers x-badges: - name: Beta color: "#f5803e" tags: - Sellers description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/sellers/{id}": get: summary: Get seller by ID x-badges: - name: In development color: "#6c757d" tags: - Sellers description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/payment_methods": get: summary: List payment methods x-badges: - name: Beta color: "#f5803e" tags: - Payment Methods description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/payment_methods/{id}": get: summary: Get payment method by ID x-badges: - name: In development color: "#6c757d" tags: - Payment Methods description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/accounts": get: summary: List accounts and cards x-badges: - name: Beta color: "#f5803e" tags: - Accounts and Cards description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/accounts/{id}": get: summary: Get account or card by ID x-badges: - name: In development color: "#6c757d" tags: - Accounts and Cards description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/nf_rules": get: summary: List invoice (NF) rules x-badges: - name: Beta color: "#f5803e" tags: - Invoice (NF) Rules description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: summary: Get invoice (NF) rule by ID x-badges: - name: In development color: "#6c757d" tags: - Invoice (NF) Rules description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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: summary: List tasks x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

Returns the list of tasks from the companies where the credential has permission (tasks without a company are visible in all of them). Deleted tasks 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/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: summary: Create task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

Creates a task in the company given in `company_identifier`, with assignee, category, and due date. Accepts, in `history`, the comments the task is born with. 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: summary: Get task by ID x-badges: - name: In development color: "#6c757d" tags: - Tasks description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

Returns the data of a specific task, including its history 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 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: summary: Update task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: '⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

Updates an existing task. Send only the fields that should change: a field that is omitted, or sent as null or as an empty string, stays as it is, so a field cannot be cleared by this operation. `title` is the exception: a task must have a title, and sending it as an empty string is rejected. To complete the task send `completed` as `true`, and to reopen it, as `false`. `company_identifier` moves the task to another company and also requires the create/edit tasks permission there; a task cannot be left without a company by this operation. Custom fields are not replaced: each one sent overwrites its current value, and the others stay. Comments are sent through [Comment on the task](#tag/Tasks/paths/~1tasks~1{task_id}~1history/post). Requires the create/edit tasks permission. 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 "Read all tasks" permission in the task''s company; without it, the update is written all the same and the response returns only the `id` of the task.' 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. '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: summary: Delete task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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. '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: summary: Comment on the task x-badges: - name: Beta color: "#f5803e" tags: - Tasks description: '⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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 "Read all tasks" permission in the task''s company. The task participants are notified of the comment by email, as when the comment is made in Monde. Requires the create/edit tasks permission. A deleted task does not take comments: the response is 409. 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. '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_historic_create" examples: create_task_historic: summary: Comment on the task "$ref": "#/components/examples/create_task_historic" "/task_categories": get: summary: List task categories x-badges: - name: In development color: "#6c757d" tags: - Task Categories description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

Returns the list of task 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/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" "/task_categories/{id}": get: summary: Get task category by ID x-badges: - name: In development color: "#6c757d" tags: - Task Categories description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/travels": get: summary: List travels x-badges: - name: Beta color: "#f5803e" tags: - Travels description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/travels/{id}": get: summary: Get travel by ID x-badges: - name: In development color: "#6c757d" tags: - Travels description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

Returns a specific travel with its scalar fields 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" "/quotes": get: summary: List quotes x-badges: - name: Beta color: "#f5803e" tags: - Quotes description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/quotes/{id}": get: summary: Get quote by ID x-badges: - name: In development color: "#6c757d" tags: - Quotes description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/invoice_rules": get: summary: List billing rules x-badges: - name: Beta color: "#f5803e" tags: - Billing Rules description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: summary: Get billing rule by ID x-badges: - name: In development color: "#6c757d" tags: - Billing Rules description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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: summary: List integrations x-badges: - name: Beta color: "#f5803e" tags: - Integrations description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

Returns the list of integrations from the companies where the credential has permission (integrations without a company apply to all of them). Integration access data (users, passwords, and tokens) 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/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: summary: Get integration by ID x-badges: - name: In development color: "#6c757d" tags: - Integrations description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

Returns a specific integration 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 integration 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: summary: List people x-badges: - name: Beta color: "#f5803e" tags: - People description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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 - "$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: summary: Create a person x-badges: - name: Beta color: "#f5803e" tags: - People description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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." 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: summary: Get person by ID x-badges: - name: Beta color: "#f5803e" tags: - People description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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)." 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: summary: Update a person x-badges: - name: Beta color: "#f5803e" tags: - People description: '⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

Updates a person already registered. Send only the fields that must change: a field left out, or sent as null or as empty text, stays as it is — a text field is not emptied by this operation. The `name` is the exception: a person must have a name, so sending it as empty text is refused. 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. The `labels` and `contacts` lists 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. The response returns the updated person in the same format as the get by ID when the credential also has the "Read all people" permission; without it, the update is written all the same and the response returns only the `id` of the person.' 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: summary: Delete a person x-badges: - name: Beta color: "#f5803e" tags: - People description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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. '415': "$ref": "#/components/responses/unsupported_media_type" '429': "$ref": "#/components/responses/too_many_requests" '500': "$ref": "#/components/responses/internal_server_error" "/labels": get: summary: List labels x-badges: - name: In development color: "#6c757d" tags: - Labels description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/labels/{id}": get: summary: Get label by ID x-badges: - name: In development color: "#6c757d" tags: - Labels description: "⚠️ This endpoint is not available yet — it is only documented as a reference of what we have planned.

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" "/bills": get: summary: List accounts payable and receivable x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: 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" "/bills/{id}": get: summary: Get account payable or receivable by ID x-badges: - name: Beta color: "#f5803e" tags: - Accounts Payable and Receivable description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/account_movements": get: summary: List account movements x-badges: - name: Beta color: "#f5803e" tags: - Account movements description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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 - "$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: summary: Get account movement by ID x-badges: - name: Beta color: "#f5803e" tags: - Account movements description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/refunds": get: summary: List refunds x-badges: - name: Beta color: "#f5803e" tags: - Refunds description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: summary: Get refund by ID x-badges: - name: Beta color: "#f5803e" tags: - Refunds description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/cvc_statements": get: summary: List CVC statement receipts x-badges: - name: Beta color: "#f5803e" tags: - CVC Statement description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: summary: Get CVC statement receipt by ID x-badges: - name: Beta color: "#f5803e" tags: - CVC Statement description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/nfs": get: summary: List invoices x-badges: - name: Beta color: "#f5803e" tags: - Invoices description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/nfs/{id}": get: summary: Get invoice by ID x-badges: - name: Beta color: "#f5803e" tags: - Invoices description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" "/logs": get: summary: List logs x-badges: - name: Beta color: "#f5803e" tags: - Logs description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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 not scoped by company: a credential with the permission reads every entry." 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 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: summary: Get log by ID x-badges: - name: Beta color: "#f5803e" tags: - Logs description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: summary: List custom fields x-badges: - name: Beta color: "#f5803e" tags: - Custom Fields description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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: summary: Get custom field by ID x-badges: - name: Beta color: "#f5803e" tags: - Custom Fields description: "⚠️ This endpoint can already be used, but as it is still in a testing phase (beta), it may change.

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" 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 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. ' - name: Products description: Query available travel products (insurance, cruises, hotels, airline tickets, own operations, and others) to use in your sales. - name: Cabins description: Query the cabin types registered in the system to use in cruise products. - name: Ships description: Query the ships registered in the system to use in cruise products. - name: Cost Centers description: Query the cost centers registered in the system to use in financial transactions. - name: Currencies description: Query the currencies registered in the system to use in sale products and financial transactions. - name: Categories description: Query the financial categories registered in the system, grouped by kind (revenue or expense) and group. - name: Cities description: Query the cities registered in the system, with state, country, and official codes (IBGE, SIAFI, and SETEC). - name: Sellers description: Query the sellers registered in the system to use in your sales. - name: Payment Methods description: Query the payment methods registered in the system to use in financial transactions. - name: Accounts and Cards description: Query the accounts and cards registered in the system, with bank and credit card data and the companies where each account is available. - name: Invoice (NF) Rules description: Query the invoice (nota fiscal) issuing rules registered in the system, with the sale fields that compose each issuance. - name: Tasks description: Query, create, update, and delete tasks, with assignee, linked person, category, and due date, and comment on their history. - name: Task Categories description: Query the task categories registered in the system. - name: Travels description: Query the travels registered in the system, with customer, seller, situation, and the period calculated from the linked sales. - name: Quotes description: Query the quotes registered in the system, with validity, status, and the public viewing link. - name: Billing Rules description: Query the billing rules registered in the system, with the rule owner, closing period, and due date conditions. - name: Integrations description: Query the vendor integrations registered in the system. Integration credentials are never returned. - name: People description: Query the people registered in the system, with contact data, documents, and additional information. - name: Labels description: Query the labels registered in the system to classify people. - name: Accounts Payable and Receivable description: 'Query 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.' - 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: Refunds description: 'Query 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: 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: 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.' - 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.' - 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-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 Basic Auth, 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 during approval, and the agency sees and approves that list when it authorizes.

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

Approval credentials

1. Activate the automatic connection (approval check)

Before using it, confirm your credentials work by calling the approval endpoint with client_id and client_secret (HTTP Basic). While approval is pending, authorization does not work.
curl -X POST https://web.monde.com.br/oauth/homologation
    -u "YOUR_CLIENT_ID:YOUR_CLIENT_SECRET"

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

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

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"

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

Example: "3550308".' minLength: 7 maxLength: 7 city_name: type: - string - 'null' description: ' City name. 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). 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. 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" 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. A city that is not registered yet is created.'" properties: city_ibge: type: - string - 'null' description: '''IBGE code of the city of birth.

Example: "3550308".''' minLength: 7 maxLength: 7 city_name: type: - string - 'null' description: |- 'Name of the city of birth. Example: "São Paulo". ' maxLength: 50 state_code: type: - string - 'null' description: |- ' Code or abbreviation of the state of birth (or another country subdivision). Examples: "SP", "RJ", "NY". ' maxLength: 3 country_code: type: - string - 'null' description: |- ' Country of birth code in the ISO-3166-1 alpha-2 standard. 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). ' 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 "$ref": "#/components/schemas/entity_reference" promoter: description: Person promoter (operator plans) "$ref": "#/components/schemas/entity_reference" labels: type: array description: 'Labels of the person. The list sent replaces the current one: a label left out of it is removed. Send an empty 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 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 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 list changes nothing and a field cannot be emptied by this operation. Send each field by `id` and `value`.' items: "$ref": "#/components/schemas/person_custom_field" 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. 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 - car_rental - travel_package - cvc_package - operation - others description: " Product kind. " 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: type: object description: Product supply, with the supplier and the commercial terms negotiated with it. properties: &535 description: type: string nullable: true description: Supply description (optional field). example: Fornecimento padrão commission_type: &1 type: string enum: - percentage - amount description: Commission type — percentage or value. example: percentage commission_percentage: &2 type: number format: double description: Commission percentage. example: 10.0 commission_amount: &3 type: number format: double description: Commission amount. example: 0.0 over_percentage: &4 type: number format: double description: Over percentage. example: 0.0 over_value: &5 type: number format: double description: Percentage applied over the over. example: 100.0 du_percentage: &6 type: number format: double description: DU card fee percentage. example: 0.0 rav_percentage: &7 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. representations: type: array description: Representatives linked to the supply. items: type: object description: Representative linked to a supply, with its own commercial terms. properties: &534 commission_type: *1 commission_percentage: *2 commission_amount: *3 over_percentage: *4 over_value: *5 du_percentage: *6 rav_percentage: *7 representative: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Supply representative. required: - supplies 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-09-29".' operation_id: type: string writeOnly: true description: Operation ID associated with this sale. seller_create: type: object description: Seller who negotiated the product with the client and is responsible for the sale. required: - name - external_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 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: - external_id - kind - value properties: external_id: type: string maxLength: 50 description: External identifier of the person who receives the commission, the same one sent as the sale's seller or intermediary. kind: type: string enum: - seller - intermediary - person description: Commission role. `seller` and `intermediary` record the matching system job title; `person` records no job title. `intermediary` requires the sale to have an intermediary. value: type: number format: double multipleOf: 0.01 exclusiveMaximum: 100000000000 description: Commission value. 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. sale_totals: type: object readOnly: true properties: products: type: number format: double readOnly: true description: Total of products. fees: type: number format: double readOnly: true description: Total of fees. discount: type: number format: double readOnly: true description: Total of discounts. revenue: type: number format: double readOnly: true description: Total sale revenue. balance: type: number format: double readOnly: true description: Outstanding balance of the sale. final_amount: type: number format: double readOnly: true description: Final sale amount. 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) and the close-sale permission. If it cannot be closed, the whole creation is rejected with 422. observations: type: string readOnly: true description: General remarks about the sale. 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. oneOf: - "$ref": "#/components/schemas/individual_or_company" - type: 'null' promoter: readOnly: true description: Sale promoter (operator plans). 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: |- ⚠️ This product is not available yet for creation — it is only documented as a reference of what we have planned.

' Airline ticket.

It is possible to insert airline tickets in two ways: Tickets sent individually will be internally grouped into the same sale by our system, as long as they have the same `locator` and `sale date`. Tickets with the same locator but different sale dates will not be grouped and will instead be inserted as separate sales. ' 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" 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. others: type: array readOnly: true 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 can be distributed across one or more products through the local_id match, 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. 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_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. created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the person who registered the sale. 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. seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the seller responsible for the sale. payer: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the payer responsible for the sale payment. intermediary: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the sale intermediary. requester: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the person who requested the sale. approver: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the person who approved the sale. promoter: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the sale promoter. travel: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Reference to the travel the sale belongs to. 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" 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. items: "$ref": "#/components/schemas/entity_reference" standalone_bills: type: array description: |- Standalone accounts payable or receivable linked directly to this sale. items: "$ref": "#/components/schemas/entity_reference" 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. retained_amount: type: number format: double multipleOf: 0.01 description: Retained value of the commission. balance: type: number format: double multipleOf: 0.01 description: Commission balance (amount minus retained amount). person: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Person who receives the commission. required: - amount - retained_amount - balance - person attachment: type: object required: - resource_type - resource_id - file properties: resource_type: type: string enum: - sale - person description: 'Resource that will receive the attachment: "sale" for a sale, "person" for a person.

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. ' description: type: string description: Attachment description. 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: " **Required** correlation key, used to reference this product in the payments of the same request. It must be unique among the products of the sale. It is not stored, so it does not come back when reading the sale and can be reused in other sales. Any string is allowed, such as a document or UUID. " 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_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 currency_code: type: string description: 'Currency code in which the product is originally sold, according to ISO 4217.

Example: "EUR".

On read, this field always returns BRL, and the product amounts come converted to Brazilian Real.' minLength: 3 maxLength: 3 exchange_rate: type: number format: double exclusiveMinimum: 0 description: 'Exchange rate used to convert values from the currency in which the product is originally sold to Brazilian Real. On read, this field always returns 1, because the amounts already come in Brazilian Real. ' 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. " 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. " 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. " 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. " 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. " 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. " 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. " cc_rav_fee: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Credit card administrative fee over the RAV. " cc_du_fee: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 description: " Credit card administrative fee over the DU. " 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. " deductions: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Deductions applied to the product. " 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. " product_totals: type: object readOnly: true properties: fees: type: number format: double readOnly: true description: " Total of the product passenger fees. " rav_fee: type: number format: double readOnly: true description: " Total of the passenger RAV for the product. " rav_fee_discount: type: number format: double readOnly: true description: " Total RAV discount across the product passengers. " agency_fee: type: number format: double readOnly: true description: " Total of the passenger hidden service fees for the product. " discount: type: number format: double readOnly: true description: " Total discounts of the product. " products: type: number format: double readOnly: true description: " Sum of the product values only, without fees, discounts, or deductions. " customer_amount: type: number format: double readOnly: true description: " Total amount charged to the customer. " amount: type: number format: double readOnly: true description: " Product total amount, summing products, fees, and remunerations and subtracting discounts and deductions. " 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. For products with passengers, returns null. " unit_fee: type: number format: double readOnly: true minimum: 0 multipleOf: 0.01 description: " Unit fees of the product, for products without passengers. For products with passengers, returns null. " 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-10-04T10:37:35".' arrival_date: type: string readOnly: true description: 'End date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-07T10:37:35".' 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: &8 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: &9 type: string description: 'Begin date and time of the insurance coverage in ISO 8601 format. Examples: "2026-10-04"; "2026-10-04T10:37:35"' end_date: &10 type: string description: 'End date and time of the insurance coverage in ISO 8601 format. Examples: "2026-10-19"; "2026-10-19T10:37:35"' destination: &11 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: &12 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &13 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &14 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &15 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &16 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: &17 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &18 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &19 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &20 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &21 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &22 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &23 allOf: - "$ref": "#/components/schemas/over_percentage" over: &24 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &25 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &26 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &27 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &28 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &29 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &30 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &31 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &32 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &33 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &34 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. " 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: *8 begin_date: *9 end_date: *10 destination: *11 status: *12 issue_date: *13 canceled_at: *14 observations: *15 included_services: *16 vendor_reservation_url: *17 currency: *18 exchange_rate: *19 commission_amount: *20 commission_percentage: *21 over_amount: *22 over_percentage: *23 over: *24 intermediary_commission_amount: *25 intermediary_commission_percentage: *26 intermediary_over_amount: *27 intermediary_over_percentage: *28 intermediary_over: *29 agency_service_fee: *30 agency_card_rate: *31 deductions: *32 discount_amount: *33 cc_rav_fee: *34 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. " 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. 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. 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: &35 type: string description: Booking number. maxLength: 40 departure_date: &36 type: string description: 'Cruise departure date and time in ISO 8601 format. Examples: "2026-10-05"; "2026-10-05T10:37:35"' arrival_date: &37 type: string description: 'Cruise arrival date and time in ISO 8601 format. Examples: "2026-10-19"; "2026-10-19T10:37:35"' ship_name: &38 type: string description: Ship name. maxLength: 30 cruise_destination: &39 type: string description: 'Cruise destination. Example: "Bahamas".' maxLength: 30 accommodation_kind: &40 type: string description: 'Kind of accommodation purchased by the customer. Examples: "Single", "Double Room".' maxLength: 20 cabin_number: &41 type: string description: 'Cabin number. Example: "8074".' maxLength: 10 cabin_kind: &42 type: string description: 'Kind of cabin. Examples: "Suite", "Internal", "External", etc.' maxLength: 30 cabin_category: &43 type: string description: 'Code used to identify which category the cabin belongs to. Examples: "STD", "7A".' maxLength: 3 meal_plan: &44 type: string readOnly: true description: 'Cruise meal plan. Examples: "All inclusive", "Full board".' maxLength: 20 status: &45 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &46 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &47 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &48 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &49 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: &50 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &51 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &52 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &53 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &54 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &55 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &56 allOf: - "$ref": "#/components/schemas/over_percentage" over: &57 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &58 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &59 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &60 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &61 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &62 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &63 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &64 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &65 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &66 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &67 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. " 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: *35 departure_date: *36 arrival_date: *37 ship_name: *38 cruise_destination: *39 accommodation_kind: *40 cabin_number: *41 cabin_kind: *42 cabin_category: *43 meal_plan: *44 status: *45 issue_date: *46 canceled_at: *47 observations: *48 included_services: *49 vendor_reservation_url: *50 currency: *51 exchange_rate: *52 commission_amount: *53 commission_percentage: *54 over_amount: *55 over_percentage: *56 over: *57 intermediary_commission_amount: *58 intermediary_commission_percentage: *59 intermediary_over_amount: *60 intermediary_over_percentage: *61 intermediary_over: *62 agency_service_fee: *63 agency_card_rate: *64 deductions: *65 discount_amount: *66 cc_rav_fee: *67 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. " 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. 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. 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: &68 type: string description: Booking number. maxLength: 40 check_in: &69 type: string description: 'Check-in date and time in ISO 8601 format. Examples: "2026-10-22"; "2026-10-22T10:37:35"' check_out: &70 type: string description: 'Check-out date and time in ISO 8601 format. Examples: "2026-10-29"; "2026-10-29T10:37:35"' destination: &71 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: &72 type: string description: 'Kind of accommodation purchased by the customer. Examples: "Single", "Double Room".' maxLength: 20 room_category: &73 type: string description: 'Room category. Examples: "Suite", "Deluxe".' maxLength: 20 meal_plan: &74 type: string description: 'Meal plan. Examples: "All Inclusive", "Half board".' maxLength: 20 nights: &75 type: integer readOnly: true minimum: 0 description: Number of nights (computed between check-in and check-out). 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" observations: &79 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &80 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: &81 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &82 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &83 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &84 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &85 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &86 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &87 allOf: - "$ref": "#/components/schemas/over_percentage" over: &88 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &89 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &90 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &91 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &92 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &93 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &94 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &95 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &96 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &97 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &98 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. " 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: *68 check_in: *69 check_out: *70 destination: *71 accommodation_kind: *72 room_category: *73 meal_plan: *74 nights: *75 status: *76 issue_date: *77 canceled_at: *78 observations: *79 included_services: *80 vendor_reservation_url: *81 currency: *82 exchange_rate: *83 commission_amount: *84 commission_percentage: *85 over_amount: *86 over_percentage: *87 over: *88 intermediary_commission_amount: *89 intermediary_commission_percentage: *90 intermediary_over_amount: *91 intermediary_over_percentage: *92 intermediary_over: *93 agency_service_fee: *94 agency_card_rate: *95 deductions: *96 discount_amount: *97 cc_rav_fee: *98 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. " description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Hotel providing the accommodation. 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. passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/hotel_passenger_read" airline_ticket: type: object description: " Airline ticket.

It is possible to insert airline tickets in two ways: Tickets sent individually will be internally grouped into the same sale by our system, as long as they have the same `locator` and `sale date`. Tickets with the same locator but different sale dates will not be grouped and will instead be inserted as separate sales. " required: - local_id - locator - destination - segments - currency - supplier - passengers properties: local_id: allOf: - "$ref": "#/components/schemas/sale_product_local_id" locator: &99 type: string description: Ticket locator code. maxLength: 10 destination: &100 type: string description: Flight destination. Use "national" for flights within Brazil and "international" for flights to other countries. enum: - national - international status: &101 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &102 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &103 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &104 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &105 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: &106 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &107 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &108 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &109 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &110 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &111 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &112 allOf: - "$ref": "#/components/schemas/over_percentage" over: &113 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &114 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &115 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &116 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &117 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &118 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &119 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &120 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &121 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &122 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &123 type: number format: double default: 0 minimum: 0 multipleOf: 0.01 description: " Credit card administrative fee over the RAV. " cc_du_fee: &124 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. 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-10-04T10:37:35".' 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-10-04T13:49:35".' 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/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. " rav_fee: type: number format: double readOnly: true description: " Total of the passenger RAV for the product. " rav_fee_discount: type: number format: double readOnly: true description: " Total RAV discount across the product passengers. " agency_fee: type: number format: double readOnly: true description: " Total of the passenger hidden service fees for the product. " discount: type: number format: double readOnly: true description: " Total discounts of the product. " products: type: number format: double readOnly: true description: " Sum of the product values only, without fees, discounts, or deductions. " du_fee: type: number format: double readOnly: true description: " Total of the passenger DU for the product. " du_fee_discount: type: number format: double readOnly: true description: " Total DU discount across the product passengers. " customer_amount: type: number format: double readOnly: true description: " Total amount charged to the customer. " amount: type: number format: double readOnly: true description: " Product total amount, summing products, fees, and remunerations and subtracting discounts and deductions. " airline_ticket_read: type: object description: " Airline ticket.

It is possible to insert airline tickets in two ways: Tickets sent individually will be internally grouped into the same sale by our system, as long as they have the same `locator` and `sale date`. Tickets with the same locator but different sale dates will not be grouped and will instead be inserted as separate sales. " required: - locator - destination - 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: *99 destination: *100 status: *101 issue_date: *102 canceled_at: *103 observations: *104 included_services: *105 vendor_reservation_url: *106 currency: *107 exchange_rate: *108 commission_amount: *109 commission_percentage: *110 over_amount: *111 over_percentage: *112 over: *113 intermediary_commission_amount: *114 intermediary_commission_percentage: *115 intermediary_over_amount: *116 intermediary_over_percentage: *117 intermediary_over: *118 agency_service_fee: *119 agency_card_rate: *120 deductions: *121 discount_amount: *122 cc_rav_fee: *123 cc_du_fee: *124 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. " rav_fee: type: number format: double readOnly: true description: " Total of the passenger RAV for the product. " rav_fee_discount: type: number format: double readOnly: true description: " Total RAV discount across the product passengers. " agency_fee: type: number format: double readOnly: true description: " Total of the passenger hidden service fees for the product. " discount: type: number format: double readOnly: true description: " Total discounts of the product. " products: type: number format: double readOnly: true description: " Sum of the product values only, without fees, discounts, or deductions. " du_fee: type: number format: double readOnly: true description: " Total of the passenger DU for the product. " du_fee_discount: type: number format: double readOnly: true description: " Total DU discount across the product passengers. " customer_amount: type: number format: double readOnly: true description: " Total amount charged to the customer. " amount: type: number format: double readOnly: true description: " Product total amount, summing products, fees, and remunerations and subtracting discounts and deductions. " supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Airline providing the ticket. 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. 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. 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-10-04T10:37:35".' 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-10-04T13:49:35".' 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/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: &125 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: &126 type: string readOnly: true description: 'Train ticket departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-04T10:37:35".' arrival_date: &127 type: string readOnly: true description: 'Train ticket arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-07T10:37:35".' status: &128 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &129 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &130 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &131 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &132 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.

Example: "Meal included\nFree Wi-Fi\nQuiet car". ' vendor_reservation_url: &133 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &134 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &135 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &136 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &137 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &138 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &139 allOf: - "$ref": "#/components/schemas/over_percentage" over: &140 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &141 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &142 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &143 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &144 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &145 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &146 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &147 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &148 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &149 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &150 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-10-04T10:37:35".' 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-10-04T13:49:35".' 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. " 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: *125 departure_date: *126 arrival_date: *127 status: *128 issue_date: *129 canceled_at: *130 observations: *131 included_services: *132 vendor_reservation_url: *133 currency: *134 exchange_rate: *135 commission_amount: *136 commission_percentage: *137 over_amount: *138 over_percentage: *139 over: *140 intermediary_commission_amount: *141 intermediary_commission_percentage: *142 intermediary_over_amount: *143 intermediary_over_percentage: *144 intermediary_over: *145 agency_service_fee: *146 agency_card_rate: *147 deductions: *148 discount_amount: *149 cc_rav_fee: *150 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. " 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. 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. 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-10-04T10:37:35".' 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-10-04T13:49:35".' 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: &151 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: &152 type: string readOnly: true description: 'Ground transportation departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-04T10:37:35".' arrival_date: &153 type: string readOnly: true description: 'Ground transportation arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-07T10:37:35".' status: &154 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &155 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &156 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &157 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &158 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.

Example: "Meal included\nFree Wi-Fi".' vendor_reservation_url: &159 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &160 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &161 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &162 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &163 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &164 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &165 allOf: - "$ref": "#/components/schemas/over_percentage" over: &166 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &167 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &168 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &169 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &170 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &171 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &172 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &173 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &174 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &175 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &176 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-10-04T10:37:35".' 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-10-04T14:37:35".' 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. " 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: *151 departure_date: *152 arrival_date: *153 status: *154 issue_date: *155 canceled_at: *156 observations: *157 included_services: *158 vendor_reservation_url: *159 currency: *160 exchange_rate: *161 commission_amount: *162 commission_percentage: *163 over_amount: *164 over_percentage: *165 over: *166 intermediary_commission_amount: *167 intermediary_commission_percentage: *168 intermediary_over_amount: *169 intermediary_over_percentage: *170 intermediary_over: *171 agency_service_fee: *172 agency_card_rate: *173 deductions: *174 discount_amount: *175 cc_rav_fee: *176 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. " description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Coach company providing the service. 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. 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-10-04T10:37:35".' 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-10-04T14:37:35".' 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: &177 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: &178 type: string description: ' Vehicle pickup date and time in ISO 8601 format. Examples: "2026-10-04"; "2026-10-04T10:37:36" ' pickup_location: &179 type: string description: ' Vehicle pickup location.

Example: "Congonhas Airport" ' maxLength: 30 dropoff_date: &180 type: string description: ' Vehicle dropoff date and time in ISO 8601 format. Examples: "2026-10-11"; "2026-10-11T10:37:36" ' dropoff_location: &181 type: string description: ' Vehicle dropoff location.

Example: "Congonhas Airport" ' maxLength: 30 destination: &182 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: &183 type: string description: ' Category of the rented vehicle.

Examples: "Economy", "Intermediate", "Premium", "SUV". ' maxLength: 50 rental_days: &184 type: integer readOnly: true minimum: 0 description: Number of rental days (between pickup and drop-off). status: &185 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &186 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &187 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &188 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &189 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: &190 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &191 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &192 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &193 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &194 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &195 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &196 allOf: - "$ref": "#/components/schemas/over_percentage" over: &197 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &198 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &199 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &200 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &201 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &202 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &203 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &204 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &205 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &206 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &207 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. " 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: *177 pickup_date: *178 pickup_location: *179 dropoff_date: *180 dropoff_location: *181 destination: *182 vehicle_category: *183 rental_days: *184 status: *185 issue_date: *186 canceled_at: *187 observations: *188 included_services: *189 vendor_reservation_url: *190 currency: *191 exchange_rate: *192 commission_amount: *193 commission_percentage: *194 over_amount: *195 over_percentage: *196 over: *197 intermediary_commission_amount: *198 intermediary_commission_percentage: *199 intermediary_over_amount: *200 intermediary_over_percentage: *201 intermediary_over: *202 agency_service_fee: *203 agency_card_rate: *204 deductions: *205 discount_amount: *206 cc_rav_fee: *207 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. " description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Car rental company providing the service. 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. 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: &208 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: &209 type: string description: 'Package begin date and time in ISO 8601 format. Examples: "2026-10-06"; "2026-10-06T10:37:36"' end_date: &210 type: string description: 'Package end date and time in ISO 8601 format. Examples: "2026-10-13"; "2026-10-13T10:37:36"' destination: &211 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: &212 type: string description: ' Name of the travel package.

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

" enum: - self_provided - road_transport - no_transport - charter_flight - scheduled_flight maxLength: 20 status: &214 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &215 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &216 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &217 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &218 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: &219 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &220 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &221 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &222 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &223 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &224 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &225 allOf: - "$ref": "#/components/schemas/over_percentage" over: &226 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &227 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &228 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &229 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &230 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &231 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &232 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &233 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &234 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &235 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &236 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. " 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: *208 begin_date: *209 end_date: *210 destination: *211 package_name: *212 transport: *213 status: *214 issue_date: *215 canceled_at: *216 observations: *217 included_services: *218 vendor_reservation_url: *219 currency: *220 exchange_rate: *221 commission_amount: *222 commission_percentage: *223 over_amount: *224 over_percentage: *225 over: *226 intermediary_commission_amount: *227 intermediary_commission_percentage: *228 intermediary_over_amount: *229 intermediary_over_percentage: *230 intermediary_over: *231 agency_service_fee: *232 agency_card_rate: *233 deductions: *234 discount_amount: *235 cc_rav_fee: *236 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. " description: Consolidated totals of the product. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier responsible for the travel package. 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. passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/travel_package_passenger_read" others: type: object readOnly: true description: Other sale products, which may or may not have passengers. required: - id - product_name - product_with_passengers - currency - supplier properties: id: allOf: - "$ref": "#/components/schemas/sale_product_id" document: &237 allOf: - "$ref": "#/components/schemas/product_document" destination: &238 allOf: - "$ref": "#/components/schemas/destination" departure_date: &239 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &240 allOf: - "$ref": "#/components/schemas/arrival_date" status: &241 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &242 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &243 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &244 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &245 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &246 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &247 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &248 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &249 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &250 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &251 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &252 allOf: - "$ref": "#/components/schemas/over_percentage" over: &253 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &254 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &255 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &256 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &257 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &258 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &259 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &260 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &261 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &262 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &263 allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: &264 oneOf: - "$ref": "#/components/schemas/quantity" - type: 'null' unit_price: &265 oneOf: - "$ref": "#/components/schemas/unit_price" - type: 'null' unit_fee: &266 oneOf: - "$ref": "#/components/schemas/unit_fee" - type: 'null' product_name: allOf: - "$ref": "#/components/schemas/product_name" product_with_passengers: allOf: - "$ref": "#/components/schemas/product_with_passengers" 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/default_passenger_read" - 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: *237 destination: *238 departure_date: *239 arrival_date: *240 status: *241 issue_date: *242 canceled_at: *243 observations: *244 included_services: *245 vendor_reservation_url: *246 currency: *247 exchange_rate: *248 commission_amount: *249 commission_percentage: *250 over_amount: *251 over_percentage: *252 over: *253 intermediary_commission_amount: *254 intermediary_commission_percentage: *255 intermediary_over_amount: *256 intermediary_over_percentage: *257 intermediary_over: *258 agency_service_fee: *259 agency_card_rate: *260 deductions: *261 discount_amount: *262 cc_rav_fee: *263 quantity: *264 unit_price: *265 unit_fee: *266 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. 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. 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. passengers: description: Passengers List. oneOf: - type: array items: allOf: - "$ref": "#/components/schemas/default_passenger_read" - type: 'null' excursion_read: type: object readOnly: true description: " Excursions of the sale. Read-only: it is not currently possible to create or update excursions through the API. " 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: type: string readOnly: true 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 departure_date: type: string readOnly: true description: 'Excursion departure date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-04T10:37:36".' arrival_date: type: string readOnly: true description: 'Excursion arrival date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-04T10:37:36".' 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" observations: allOf: - "$ref": "#/components/schemas/product_observations" included_services: 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: allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: allOf: - "$ref": "#/components/schemas/exchange_rate" 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" 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. 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. passengers: type: array description: Passengers List. items: allOf: - "$ref": "#/components/schemas/default_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. 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-10-04T10:37:36".' arrival_date: type: string description: 'End date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).

Example: "2026-10-07T10:37:36".' 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" 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" currency: allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: allOf: - "$ref": "#/components/schemas/exchange_rate" 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" discount_amount: allOf: - "$ref": "#/components/schemas/discount_amount" 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 - type: 'null' unit_price: oneOf: - type: number format: double minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 - type: 'null' unit_fee: 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: &536 allOf: - "$ref": "#/components/schemas/product_document" departure_date: &537 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &538 allOf: - "$ref": "#/components/schemas/arrival_date" status: &539 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &540 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &541 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &542 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &543 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &544 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &545 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &546 allOf: - "$ref": "#/components/schemas/exchange_rate" intermediary_commission_amount: &547 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &548 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &549 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" intermediary_over_percentage: &550 allOf: - "$ref": "#/components/schemas/intermediary_over_percentage" intermediary_over: &551 allOf: - "$ref": "#/components/schemas/intermediary_over" agency_service_fee: &552 allOf: - "$ref": "#/components/schemas/agency_service_fee" agency_card_rate: &553 allOf: - "$ref": "#/components/schemas/agency_card_rate" discount_amount: &554 allOf: - "$ref": "#/components/schemas/discount_amount" quantity: &555 oneOf: - "$ref": "#/components/schemas/quantity" - type: 'null' unit_price: &556 oneOf: - "$ref": "#/components/schemas/unit_price" - type: 'null' unit_fee: &557 oneOf: - "$ref": "#/components/schemas/unit_fee" - 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. 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. 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: &267 type: string readOnly: true description: Name of the purchased CVC package. receipt_number: &268 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: &269 allOf: - "$ref": "#/components/schemas/departure_date" arrival_date: &270 allOf: - "$ref": "#/components/schemas/arrival_date" status: &271 allOf: - "$ref": "#/components/schemas/product_status" issue_date: &272 allOf: - "$ref": "#/components/schemas/product_issue_date" canceled_at: &273 allOf: - "$ref": "#/components/schemas/product_canceled_at" observations: &274 allOf: - "$ref": "#/components/schemas/product_observations" included_services: &275 allOf: - "$ref": "#/components/schemas/included_services" vendor_reservation_url: &276 allOf: - "$ref": "#/components/schemas/vendor_reservation_url" currency: &277 allOf: - "$ref": "#/components/schemas/currency_code" exchange_rate: &278 allOf: - "$ref": "#/components/schemas/exchange_rate" commission_amount: &279 allOf: - "$ref": "#/components/schemas/commission_amount" commission_percentage: &280 allOf: - "$ref": "#/components/schemas/commission_percentage" over_amount: &281 allOf: - "$ref": "#/components/schemas/over_amount" over_percentage: &282 allOf: - "$ref": "#/components/schemas/over_percentage" over: &283 allOf: - "$ref": "#/components/schemas/over" intermediary_commission_amount: &284 allOf: - "$ref": "#/components/schemas/intermediary_commission_amount" intermediary_commission_percentage: &285 allOf: - "$ref": "#/components/schemas/intermediary_commission_percentage" intermediary_over_amount: &286 allOf: - "$ref": "#/components/schemas/intermediary_over_amount" 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_card_rate: &290 allOf: - "$ref": "#/components/schemas/agency_card_rate" deductions: &291 allOf: - "$ref": "#/components/schemas/deductions" discount_amount: &292 allOf: - "$ref": "#/components/schemas/discount_amount" cc_rav_fee: &293 allOf: - "$ref": "#/components/schemas/cc_rav_fee" quantity: &294 allOf: - "$ref": "#/components/schemas/quantity" unit_price: &295 allOf: - "$ref": "#/components/schemas/unit_price" unit_fee: &296 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: *267 receipt_number: *268 departure_date: *269 arrival_date: *270 status: *271 issue_date: *272 canceled_at: *273 observations: *274 included_services: *275 vendor_reservation_url: *276 currency: *277 exchange_rate: *278 commission_amount: *279 commission_percentage: *280 over_amount: *281 over_percentage: *282 over: *283 intermediary_commission_amount: *284 intermediary_commission_percentage: *285 intermediary_over_amount: *286 intermediary_over_percentage: *287 intermediary_over: *288 agency_service_fee: *289 agency_card_rate: *290 deductions: *291 discount_amount: *292 cc_rav_fee: *293 quantity: *294 unit_price: *295 unit_fee: *296 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. supplier: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Supplier of the CVC package. Company that directly owns the product, i.e., CVC. 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. payment_product: type: object required: - local_id - payment_amount properties: local_id: type: string maxLength: 50 description: Correlation key that links this payment to a specific product in the sale. Must match the local_id of one of the products sent in this request. payment_amount: type: number format: double exclusiveMinimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: Payment amount allocated to this product. payment_amount: type: number format: double readOnly: true multipleOf: 0.01 description: Amount of the settlement movement. bank_account: type: object required: - bank_code - agency_number - account_number description: Details of the bank account that will receive the payment. 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_observations: type: string maxLength: 255 description: 'Payment observations. Can be used to specify which transfer type was used.

Examples: "Pix", "TED", "DOC".' 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: &558 allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &559 allOf: - "$ref": "#/components/schemas/payment_settlement_date" description: &560 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true card_last_digits: &561 allOf: - "$ref": "#/components/schemas/payment_card_last_digits" card_brand: &562 type: string description: Card brand. enum: - amex - diners - hipercard - mastercard - visa - elo authorization: &563 allOf: - "$ref": "#/components/schemas/payment_authorization" 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: &564 allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &565 allOf: - "$ref": "#/components/schemas/payment_settlement_date" description: &566 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true bank_slip_number: &567 type: integer readOnly: true description: Bank slip number. amount: &568 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: &569 description: Expected bank deposit date (due date) in ISO 8601 format (YYYY-MM-DD). allOf: - "$ref": "#/components/schemas/payment_due_date" settlement_date: &570 allOf: - "$ref": "#/components/schemas/payment_settlement_date" description: &571 allOf: - "$ref": "#/components/schemas/payment_description" writeOnly: true observations: &572 allOf: - "$ref": "#/components/schemas/payment_observations" amount: &573 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" payment_agency: type: object properties: credit_card: description: Credit card payment. "$ref": "#/components/schemas/agency_credit_card" bank_slip: description: Bank slip payment. "$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" payment_vendor: type: object 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. "$ref": "#/components/schemas/vendor_credit" payment: type: object properties: 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. sale_product: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Sale product that received the amount. 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" payment_payer: allOf: - "$ref": "#/components/schemas/entity_reference" readOnly: true description: |- Payer of this payment, which may differ from the payer of the sale. 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: 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. 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. properties: due_date: allOf: - "$ref": "#/components/schemas/payment_agency_due_date" amount: description: Amount retained by the intermediary. Always positive. allOf: - "$ref": "#/components/schemas/payment_amount" payer: "$ref": "#/components/schemas/payment_payer" products: "$ref": "#/components/schemas/payment_products_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: 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. products: "$ref": "#/components/schemas/payment_products_read" vendor_credit_card_read: type: object readOnly: true properties: 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: 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: 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: 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, including invoicing and returns. The payment method, the account, the settlement and the products covered live on the bill. items: "$ref": "#/components/schemas/entity_reference" refunds: type: array description: |- Customer refunds recorded on this sale. items: "$ref": "#/components/schemas/entity_reference" credit: type: array description: Payment using available agency credit. items: "$ref": "#/components/schemas/agency_credit_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. 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. 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 readOnly: true description: Passenger cost center. 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. " 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. ' 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. " passenger_tip: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Gratuity charged to the passenger on the cruise. " 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. " passenger_rav_fee_discount: type: number format: double default: 0 minimum: 0 multipleOf: 0.01 exclusiveMaximum: 100000000000 description: " Discount applied over the RAV. " 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. " passenger_customer_amount: type: number format: double readOnly: true minimum: 0 description: " Amount charged to the customer for the passenger. " passenger_total_amount: type: number format: double readOnly: true minimum: 0 description: " Passenger total amount. " passenger_person: description: Passenger personal data. allOf: - "$ref": "#/components/schemas/individual_person" insurance_passenger: type: object required: - person properties: document: &297 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &298 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &299 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &300 allOf: - "$ref": "#/components/schemas/passenger_fees" rav_fee: &301 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_discount: &302 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" agency_fee: &303 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" amount: &304 allOf: - "$ref": "#/components/schemas/passenger_amount" customer_amount: &305 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &306 allOf: - "$ref": "#/components/schemas/passenger_total_amount" person: &307 allOf: - "$ref": "#/components/schemas/passenger_person" insurance_passenger_read: type: object readOnly: true required: - person properties: document: *297 cost_center: *298 canceled_at: *299 fees: *300 rav_fee: *301 rav_fee_discount: *302 agency_fee: *303 amount: *304 customer_amount: *305 total_amount: *306 person: &318 allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Passenger personal data. train_passenger: type: object required: - person properties: document: &308 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &309 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &310 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &311 allOf: - "$ref": "#/components/schemas/passenger_fees" rav_fee: &312 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_discount: &313 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" agency_fee: &314 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" amount: &315 allOf: - "$ref": "#/components/schemas/passenger_amount" customer_amount: &316 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &317 allOf: - "$ref": "#/components/schemas/passenger_total_amount" person: *307 train_passenger_read: type: object readOnly: true required: - person properties: document: *308 cost_center: *309 canceled_at: *310 fees: *311 rav_fee: *312 rav_fee_discount: *313 agency_fee: *314 amount: *315 customer_amount: *316 total_amount: *317 person: *318 ground_transportation_passenger: type: object required: - person - document properties: document: &319 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &320 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &321 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &322 allOf: - "$ref": "#/components/schemas/passenger_fees" rav_fee: &323 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_discount: &324 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" agency_fee: &325 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" amount: &326 allOf: - "$ref": "#/components/schemas/passenger_amount" customer_amount: &327 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &328 allOf: - "$ref": "#/components/schemas/passenger_total_amount" person: *307 ground_transportation_passenger_read: type: object readOnly: true required: - person properties: document: *319 cost_center: *320 canceled_at: *321 fees: *322 rav_fee: *323 rav_fee_discount: *324 agency_fee: *325 amount: *326 customer_amount: *327 total_amount: *328 person: *318 cruise_passenger: type: object required: - person properties: cost_center: &329 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &330 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &331 allOf: - "$ref": "#/components/schemas/passenger_fees" tip: &332 allOf: - "$ref": "#/components/schemas/passenger_tip" rav_fee: &333 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_discount: &334 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" agency_fee: &335 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" amount: &336 allOf: - "$ref": "#/components/schemas/passenger_amount" customer_amount: &337 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &338 allOf: - "$ref": "#/components/schemas/passenger_total_amount" person: *307 cruise_passenger_read: type: object readOnly: true required: - person properties: cost_center: *329 canceled_at: *330 fees: *331 tip: *332 rav_fee: *333 rav_fee_discount: *334 agency_fee: *335 amount: *336 customer_amount: *337 total_amount: *338 person: *318 operation_passenger: type: object required: - person properties: document: &349 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: &350 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &351 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &352 allOf: - "$ref": "#/components/schemas/passenger_fees" amount: &353 allOf: - "$ref": "#/components/schemas/passenger_amount" customer_amount: &354 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &355 allOf: - "$ref": "#/components/schemas/passenger_total_amount" person: *307 default_passenger: type: object required: - person properties: cost_center: &339 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &340 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &341 allOf: - "$ref": "#/components/schemas/passenger_fees" other_fees: &342 allOf: - "$ref": "#/components/schemas/passenger_other_fees" rav_fee: &343 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_discount: &344 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" agency_fee: &345 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" amount: &346 allOf: - "$ref": "#/components/schemas/passenger_amount" customer_amount: &347 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &348 allOf: - "$ref": "#/components/schemas/passenger_total_amount" person: *307 default_passenger_read: type: object readOnly: true required: - person properties: document: &574 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: *298 canceled_at: *299 fees: *300 rav_fee: *301 rav_fee_discount: *302 agency_fee: *303 amount: *304 customer_amount: *305 total_amount: *306 person: *318 car_rental_passenger_read: type: object readOnly: true required: - person properties: cost_center: *339 canceled_at: *340 fees: *341 other_fees: *342 rav_fee: *343 rav_fee_discount: *344 agency_fee: *345 amount: *346 customer_amount: *347 total_amount: *348 person: *318 operation_passenger_read: type: object readOnly: true required: - person properties: document: *349 cost_center: *350 canceled_at: *351 fees: *352 amount: *353 customer_amount: *354 total_amount: *355 person: *318 travel_package_passenger: type: object required: - person properties: document: &356 allOf: - "$ref": "#/components/schemas/passenger_document" cost_center: *339 canceled_at: *340 fees: *341 other_fees: *342 rav_fee: *343 rav_fee_discount: *344 agency_fee: *345 amount: *346 customer_amount: *347 total_amount: *348 person: *307 travel_package_passenger_read: type: object readOnly: true required: - person properties: document: *356 cost_center: *339 canceled_at: *340 fees: *341 other_fees: *342 rav_fee: *343 rav_fee_discount: *344 agency_fee: *345 amount: *346 customer_amount: *347 total_amount: *348 person: *318 hotel_passenger: type: object required: - person properties: emission_name: &357 type: string readOnly: true description: Ticket emission name. maxLength: 30 cost_center: &358 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &359 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" fees: &360 allOf: - "$ref": "#/components/schemas/passenger_fees" other_fees: &361 allOf: - "$ref": "#/components/schemas/passenger_other_fees" rav_fee: &362 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_discount: &363 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" agency_fee: &364 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" amount: &365 allOf: - "$ref": "#/components/schemas/passenger_amount" customer_amount: &366 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &367 allOf: - "$ref": "#/components/schemas/passenger_total_amount" person: *307 hotel_passenger_read: type: object readOnly: true required: - person properties: emission_name: *357 cost_center: *358 canceled_at: *359 fees: *360 other_fees: *361 rav_fee: *362 rav_fee_discount: *363 agency_fee: *364 amount: *365 customer_amount: *366 total_amount: *367 person: *318 airline_ticket_passenger: type: object required: - ticket_number properties: ticket_number: &368 type: string description: Passenger ticket number. maxLength: 30 original_ticket_number: &369 type: string writeOnly: true description: 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: &370 type: string description: Passenger name as issued on the ticket. maxLength: 30 seat: &371 type: string readOnly: true description: Passenger seat. maxLength: 10 cost_center: &372 allOf: - "$ref": "#/components/schemas/passenger_cost_center" canceled_at: &373 allOf: - "$ref": "#/components/schemas/passenger_canceled_at" boarding_fee: &374 type: number format: double minimum: 0 exclusiveMaximum: 100000000000 description: " Boarding fee charged to the passenger. " other_fees: &375 allOf: - "$ref": "#/components/schemas/passenger_other_fees" rav_fee: &376 allOf: - "$ref": "#/components/schemas/passenger_rav_fee" rav_fee_discount: &377 allOf: - "$ref": "#/components/schemas/passenger_rav_fee_discount" du_fee: &378 type: number format: double minimum: 0 description: " Additional remuneration that some airlines offer to agencies (DU). " du_fee_discount: &379 type: number format: double readOnly: true minimum: 0 description: " Discount applied over the DU. " agency_fee: &380 allOf: - "$ref": "#/components/schemas/passenger_agency_fee" amount: &381 type: number format: double default: 0 minimum: 0 description: " Product amount charged to the passenger. " customer_amount: &382 allOf: - "$ref": "#/components/schemas/passenger_customer_amount" total_amount: &383 allOf: - "$ref": "#/components/schemas/passenger_total_amount" 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: *368 original_ticket_number: *369 emission_name: *370 seat: *371 cost_center: *372 canceled_at: *373 boarding_fee: *374 other_fees: *375 rav_fee: *376 rav_fee_discount: *377 du_fee: *378 du_fee_discount: *379 agency_fee: *380 amount: *381 customer_amount: *382 total_amount: *383 person: *318 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 description: Cabin name (unique identifier) example: Varanda required: - name ship: type: object description: Represents a ship registered in the system. properties: name: type: string description: Ship name (unique identifier) example: MSC Preziosa required: - name 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 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 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 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 - 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 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' setec: type: string nullable: true description: City SETEC code example: '354990' 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 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 created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the seller 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 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. " 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 card_operator: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Card operator (credit cards only) companies: type: array description: |- Companies where the account is available items: "$ref": "#/components/schemas/entity_reference" nf_rule_summary: type: object description: Represents an invoice (NF) rule in the list read, with the register's own fields. properties: id: &385 type: string format: uuid description: Unique rule identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: &386 type: string description: Rule description example: Regra padrão de pacotes representative_scope: &387 type: string enum: - any - none - specific description: " Indicates which representatives the rule applies to. " example: any created_at: &388 type: string format: date-time description: Date and time the rule was registered example: '2024-03-15T10:30:00' payer_rule: &389 type: object properties: &384 recipient: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person the invoice is issued to (null = the sale person itself) 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: &390 type: object properties: *384 required: - recipient - revenues - discounts description: Issuance to the supplier representative_rule: &391 type: object properties: *384 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: *385 description: *386 representative_scope: *387 created_at: *388 product: &575 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Product the rule applies to (null = all products) supplier: &576 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Supplier the rule applies to (null = all suppliers) representative: &577 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Representative the rule applies to (present when representative_scope = specific) payer: &578 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Payer the rule applies to (null = all payers) created_by: &579 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the rule payer_rule: *389 supplier_rule: *390 representative_rule: *391 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 description: Due date and time 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 - due - 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) task: description: Represents a task with its history and custom fields. allOf: - "$ref": "#/components/schemas/task_summary" - type: object required: - category - assignee - history - custom_fields properties: category: allOf: - "$ref": "#/components/schemas/numeric_entity_reference" description: |- Task category assignee: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Task assignee person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked to the task company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Task company (null when the task applies to all companies) created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the task 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" 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_create: type: object writeOnly: true description: Data to create a task. required: - company_identifier - title - due - category_id - assignee_id properties: company_identifier: allOf: - "$ref": "#/components/schemas/company_identifier" description: CNPJ of the company where the task will be created, digits only 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 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. 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 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" description: CNPJ of the company the task is moved to, digits only title: type: string maxLength: 100 description: Task title example: Enviar voucher atualizado para o cliente description: type: string description: Task description example: Voucher reemitido com o novo horário do embarque. due: type: string format: date-time description: Due date and time example: '2024-04-02T09: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. 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 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 required: - id - name 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. 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 seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Travel seller company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Travel company created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the travel sales: type: array description: |- References to the sales linked to the travel items: "$ref": "#/components/schemas/entity_reference" passengers: type: array description: |- References to the passengers of the travel, deduplicated per person items: "$ref": "#/components/schemas/entity_reference" 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 example: Lua de mel - 14 noites details: type: string description: Quote details (free text) 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. created_at: type: string format: date-time description: Creation date and time example: '2024-03-15T10:30:00' required: - id - title - subtitle - details - valid_until - active - created_at quote: description: Represents a quote registered in the system. allOf: - "$ref": "#/components/schemas/quote_summary" - type: object required: - company properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked to the quote company: allOf: - "$ref": "#/components/schemas/entity_reference" description: |- Quote company 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. " example: supplier destination: type: string enum: - every - national - international - cruise description: " Destination the rule applies to. " 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. " 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. " 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. " 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. " 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) product: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Product the rule applies to (null = all products) supplier: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Supplier the rule applies to (representative rules only; null = all) requester: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Requester the rule applies to (client rules only; null = all) integration_summary: type: object description: Represents an integration in the list read, with the register's own fields. properties: id: type: string format: uuid description: Unique integration identifier example: f9d961b8-ea88-4346-8e52-afe94267417a description: type: string description: Integration description example: BRT Consolidadora active: type: boolean description: Indicates whether the integration is active example: true vendor_name: type: string nullable: true description: Integration provider name example: BRT required: - id - description - active - vendor_name integration: description: Represents a vendor integration registered in the system, without access data. allOf: - "$ref": "#/components/schemas/integration_summary" - type: object properties: person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked as supplier or representative in the imported products company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Integration company (null when it applies to all companies) 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. 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). " 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 seller: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Seller responsible for the person promoter: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person promoter (operator plans) created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who performed the registration, as a reference with id and name 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 labels: type: array description: |- Labels assigned to the person. 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. items: type: object properties: 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 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. 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. 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. 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 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. 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. bill_apportionment: type: object properties: percentage: type: number format: double description: Company percentage in the apportionment. example: 50.0 amount: type: number format: double description: Amount corresponding to the company percentage. example: 750.0 company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Apportionment company. bill_cost_center: type: object properties: percentage: type: number format: double description: Cost center percentage in the apportionment. example: 100.0 amount: type: number format: double description: Amount corresponding to the cost center percentage. example: 1500.0 cost_center: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Cost center. 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. bill_item: type: object properties: 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 sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale the item belongs to. 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. 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. 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. bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Entry settled by this invoice line. 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. ' 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. ' 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 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. 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. 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. ' 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. ' 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 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. 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. person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person linked to the entry (customer or vendor). company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Company that owns the entry. account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Forecast (bank) account linked to the entry. 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. operation: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Own operation linked to the entry. invoice_rule: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Invoice rule that originated the entry. created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- User who registered the entry. movements: type: array description: |- Settlement movements of the entry. 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 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. ' 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. ' 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 account: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Account the movement was posted to payment_method: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Payment method of the movement bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Account payable or receivable settled by the movement credit_card_invoice: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Credit card invoice the movement is part of 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 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: &392 type: string format: uuid description: Unique refund identifier example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 refund_type: &393 type: string enum: - customer - vendor description: |- ' Refund side. ' example: vendor amount: &394 type: number format: double description: Refund amount example: -91.36 description: &395 type: string nullable: true description: Refund description example: Reembolso Incentivo issue_date: &396 type: string format: date nullable: true description: Refund issue date example: '2021-06-16' due_date: &397 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: *392 refund_type: *393 amount: *394 description: *395 issue_date: *396 due_date: *397 sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Refunded sale 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 person: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Customer or supplier/representative of the refund company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Refund company bill: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Refund account payable or receivable, null while it is not invoiced required: - id - refund_type - amount - sale - sale_product - person - company 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" cvc_statement_summary: type: object description: 'Represents a CVC statement receipt in the list: only the receipt own fields.' properties: id: &398 type: string format: uuid description: Unique CVC statement receipt identifier example: 6b0f7c1e-2d4a-4f8b-9c31-58a0d7e13f42 receipt_number: &399 type: string nullable: true description: Receipt number, null on a movement that does not refer to a receipt example: '89930000112199' movement_date: &400 type: string format: date description: Movement date example: '2019-12-26' sale_date: &401 type: string format: date-time nullable: true description: Sale date recorded on the receipt example: '2019-12-26T18:00:00' cancellation_date: &402 type: string format: date-time nullable: true description: Cancellation date recorded on the receipt example: boarding_date: &403 type: string format: date nullable: true description: Boarding date recorded on the receipt example: '2020-09-01' return_date: &404 type: string format: date nullable: true description: Return date recorded on the receipt example: '2020-09-09' product_name: &405 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: &406 type: string nullable: true description: Package name as it came in the CVC statement, as free text example: SANTIAGO total_payments: &407 type: number format: double description: Total of the movement entries example: 347.89 total_taxes: &408 type: number format: double description: Total of the movement taxes example: 0.0 total_discounts: &409 type: number format: double description: Total of the movement discounts example: 0.0 total_abatement: &410 type: number format: double description: Total of the movement abatements example: 0.0 calculated_commission: &411 type: number format: double description: Calculated commission of the movement example: 111.33 retained_commission: &412 type: number format: double description: Retained commission of the movement example: 0.0 intermediary_commission: &413 type: number format: double description: Intermediary commission on the movement example: 0.0 deposit: &414 type: number format: double description: Deposit amount of the movement example: 34.78 opfax: &415 type: number format: double description: Movement amount in OPFAX example: 0.0 opfax_balance: &416 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: &417 type: number format: double description: Movement balance example: 76.55 imported: &418 type: boolean description: Indicates that the record came from the statement import example: true edited: &419 type: boolean description: Indicates that the record was changed by hand after being imported example: false checked: &420 type: boolean description: Receipt check mark example: false deleted: &421 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: &422 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: *398 receipt_number: *399 movement_date: *400 sale_date: *401 cancellation_date: *402 boarding_date: *403 return_date: *404 product_name: *405 package_name: *406 total_payments: *407 total_taxes: *408 total_discounts: *409 total_abatement: *410 calculated_commission: *411 retained_commission: *412 intermediary_commission: *413 deposit: *414 opfax: *415 opfax_balance: *416 balance: *417 imported: *418 edited: *419 checked: *420 deleted: *421 created_at: *422 movement_kind: type: object description: Movement kind, with the name as CVC classifies it in the statement properties: name: type: string description: Movement kind name example: BAIXA DE RECIBO required: - name company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Receipt company contractor: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person recorded as the contractor on the receipt 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 intermediary: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person recorded as the intermediary on the receipt sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale linked to the receipt, null when the movement has no sale 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 nf: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Invoice (NF) issued for the receipt created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the record 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: 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: - description - amount nf_summary: type: object description: 'Represents an invoice in the list: only the invoice own fields.' properties: id: &423 type: string format: uuid description: Unique invoice identifier example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 number: &424 type: integer nullable: true description: Invoice number, null while it has not been numbered example: 982677 series: &425 type: string nullable: true description: Invoice series example: '1' issue_date: &426 type: string format: date description: Invoice issue date example: '2023-01-13' status: &427 type: string enum: - unissued - issued - processing - processing_cancellation - awaiting_processing - canceled - awaiting_issue - awaiting_cancellation description: |- ' Invoice status. ' example: issued operation_nature: &428 type: string description: Operation nature declared on the invoice example: Prestação de Serviço cfop: &429 type: string nullable: true description: Operations and Services Fiscal Code (CFOP) of the invoice example: '5933' nbs_code: &430 type: string nullable: true description: Brazilian Services Nomenclature (NBS) code of the invoice example: 1.2004.10.00 document: &431 type: string nullable: true description: Document stored on the invoice, used to reconcile it with the originating document example: '9572810403321' manual_emission: &432 type: boolean description: Indicates the invoice was issued manually, with the NFS-e number informed by whoever issued it example: false amount: &433 type: number format: double description: Invoice total amount, the base for the tax calculation example: 113.48 service_amount: &434 type: number format: double description: Invoice total service amount example: 2613.82 net_amount: &435 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: &436 type: number format: double description: Approximate taxes percentage of the invoice example: 0.0 approximate_taxes_amount: &437 type: number format: double description: Approximate taxes amount of the invoice example: 0.0 observations: &438 type: string nullable: true description: Invoice observations example: Nota emitida conforme contrato 4471. printed_at: &439 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: &440 type: string format: date-time nullable: true description: Date and time of the invoice cancellation example: '2023-03-02T09:14:52' created_at: &441 type: string format: date-time nullable: true description: Date and time the invoice was registered example: '2023-02-09T17:16:14' recipient: &442 type: object description: Recipient data stored on the invoice properties: kind: &580 type: string enum: - payer - supplier - representative description: |- ' Recipient role in the sale that originated the invoice. ' example: payer name: &581 type: string description: Recipient name or legal name example: Esferatur Passagens e Turismo Ltda cpf_cnpj: &582 type: string nullable: true description: Recipient CPF or CNPJ, digits only example: '76530260000130' state_inscription: &583 type: string nullable: true description: Recipient state inscription example: '2536987410' city_inscription: &584 type: string nullable: true description: Recipient city inscription example: '1023456' postal_code: &585 type: string nullable: true description: Recipient zip code, digits only example: '89010300' street: &586 type: string nullable: true description: Recipient street example: Alameda Rio Branco street_number: &587 type: string nullable: true description: Recipient address number example: '238' neighborhood: &588 type: string nullable: true description: Recipient district example: Jardim Blumenau additional_info: &589 type: string nullable: true description: Recipient address complement example: 1º andar phone: &590 type: string nullable: true description: Recipient phone example: "(47) 3221-0100" email: &591 type: string nullable: true description: Recipient email; it may contain several addresses separated by semicolon example: financeiro@esferatur.com.br foreign: &592 type: boolean description: Indicates the recipient is a foreigner example: false foreign_document: &593 type: string nullable: true description: Foreign recipient document example: AB1234567 city: &594 allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Recipient city taxes: &443 type: object description: Invoice withholdings and taxes properties: retain_iss: &595 type: boolean description: Indicates ISS withholding on the invoice example: false retain_ir: &596 type: boolean description: Indicates IR withholding on the invoice example: false retain_pis_cofins_csll: &597 type: boolean description: Indicates PIS, COFINS and CSLL withholding on the invoice example: false iss_percentage: &598 type: number format: double description: ISS percentage applied on the invoice example: 5.0 iss_amount: &599 type: number format: double description: Invoice ISS amount example: 5.67 pis_percentage: &600 type: number format: double description: PIS percentage applied on the invoice example: 0.0 pis_amount: &601 type: number format: double description: Invoice PIS amount example: 0.0 cofins_percentage: &602 type: number format: double description: COFINS percentage applied on the invoice example: 0.0 cofins_amount: &603 type: number format: double description: Invoice COFINS amount example: 0.0 ir_percentage: &604 type: number format: double description: IR percentage applied on the invoice example: 0.0 ir_amount: &605 type: number format: double description: Invoice IR amount example: 0.0 csll_percentage: &606 type: number format: double description: CSLL percentage applied on the invoice example: 0.0 csll_amount: &607 type: number format: double description: Invoice CSLL amount example: 0.0 nfse: &444 type: object description: NFS-e data corresponding to the invoice properties: number: &608 type: string nullable: true description: NFS-e number example: '13299' batch: &609 type: string nullable: true description: Batch the NFS-e was transmitted in example: '8471' protocol: &610 type: string nullable: true description: Protocol returned in the NFS-e transmission example: '202302091716140001' verification_code: &611 type: string nullable: true description: NFS-e verification code example: BFLXB50A processed_at: &612 type: string format: date-time nullable: true description: Date and time of the NFS-e processing example: '2023-02-09T17:26:29' errors: &613 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: *423 number: *424 series: *425 issue_date: *426 status: *427 operation_nature: *428 cfop: *429 nbs_code: *430 document: *431 manual_emission: *432 amount: *433 service_amount: *434 net_amount: *435 approximate_taxes_percentage: *436 approximate_taxes_amount: *437 observations: *438 printed_at: *439 canceled_at: *440 created_at: *441 recipient: *442 taxes: *443 nfse: *444 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 company: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Company that issued the invoice 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 sale: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Sale that originated the invoice created_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who registered the invoice canceled_by: allOf: - "$ref": "#/components/schemas/entity_reference" nullable: true description: |- Person who canceled the invoice, null while the invoice has not been canceled items: type: array description: Invoice items items: "$ref": "#/components/schemas/nf_item" required: - id - issue_date - status - operation_nature - recipient - company - items 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" log_summary: type: object description: 'Represents a history entry on the list: only the fields of the entry itself.' properties: id: &445 type: string format: uuid description: Unique identifier of the history entry example: 5f1b8b0e-3a2c-4d51-8f7a-1c9e2b4d6a83 kind: &446 type: string enum: - insertion - edition - deletion - custom - export description: |- ' Recorded action. ' example: edition origin: &447 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: &448 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: &449 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: *445 kind: *446 origin: *447 description: *448 created_at: *449 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 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. ' 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" 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 default: - 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 default: - The access credentials are not valid. forbidden: description: The request was refused, and the message returned in errors says why. There are three causes, each with a different remedy — the company the credential works in has no API license, the contracted license is read-only and the action writes, or the credential lacks the required permission on the resource. A missing license is always reported before a missing permission. content: application/json: schema: type: object properties: errors: type: array items: type: string default: - You do not have an API license. Contact our support team for more information. - Your API license does not grant access to this action. - You do not have permission to perform this action. 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 default: - 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. 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 default: - 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 default: - 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. content: application/json: schema: type: object properties: errors: type: array items: type: string 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 default: - 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" 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" 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" 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" 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" 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" 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" 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 list of integrations with pagination information. properties: data: type: array description: Array containing the integrations from 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" 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" 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" 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" 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: - 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: - 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 pagination: 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 all_products_sale_list: value: data: - id: 9f8e7d6c-5b4a-3210-9876-5432109876ab sale_number: 987 sale_date: '2026-09-29' status: closed observations: Venda finalizada. printed_receipt: true created_at: '2026-09-29T10: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-09-29' status: closed observations: Venda finalizada. printed_receipt: true created_at: '2026-09-29T10: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: id: b4c3d2e1-6f7a-4b9c-8d1e-2f3a4b5c6d7e operation: id: 8936058a-2906-4239-9a7f-e22ccc2c195e seller: id: 7c9e1a04-53b6-4f28-9d71-0e5a2c8b4f13 payer: &453 id: 2f8b6d51-9c04-4e37-a1b8-63d95e70c2a4 intermediary: id: d40a7f92-1e63-4b85-8c27-5a9f3e01b6d8 requester: id: b17c5e38-6a90-4d21-9f43-8e2b70c5a916 approver: id: 95e2a7c1-4b38-4f60-8d19-27a6f3e0b5c4 promoter: id: 6a3f9d27-8c51-4e04-b2f7-72e5c8a91b30 travel: id: 7c1d9f30-5a2b-4e68-9d47-2f8b6c0a1e35 custom_fields: - id: 12345 value: Reunião comercial insurances: - id: 1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071 document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' destination: international status: active issue_date: '2026-09-29' canceled_at: 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: &627 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: &450 id: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b representative: &451 id: '028ea1ef-3f8e-4c7f-93da-463794a5afda' passengers: - &628 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: &452 id: 322ff2c2-43e0-4376-bea5-20f88b673b6d cruises: - id: 2b3c4d5e-6f70-4819-ab2c-3d4e5f607182 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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-09-29' canceled_at: 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: &629 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: *450 representative: *451 passengers: - &630 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: *452 hotels: - id: 3c4d5e6f-7081-492a-bc3d-4e5f60718293 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' destination: international accommodation_kind: Duplo Casal room_category: Deluxe meal_plan: All Inclusive nights: 8 status: active issue_date: '2026-09-29' canceled_at: 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: &631 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: *450 representative: *451 passengers: - &632 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: *452 airline_tickets: - id: 4d5e6f70-8192-4a3b-cd4e-5f6071829304 locator: WABCJJ destination: international status: active issue_date: '2026-09-29' canceled_at: 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: &633 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: &634 id: 3d7b0c94-2a68-4f15-8e93-1c5a6d20b7f4 representative: *451 segments: - &635 airline_code: AA flight_number: '1234' class: A origin: NAS departure_date: '2026-10-04T10:37:36' destination: JFK arrival_date: '2026-10-04T10:37:36' passengers: - &636 ticket_number: '99526874895' emission_name: Maria da Silva seat: 12A 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: *452 train_tickets: - id: 5e6f7081-92a3-4b4c-de5f-607182930415 document: RE9988777 departure_date: '2026-10-04T10:37:36' arrival_date: '2026-10-07T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: &637 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: *450 representative: *451 passengers: - &638 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: *452 ground_transportations: - id: 6f708192-a3b4-4c5d-ef60-718293041526 document: GT123456 departure_date: '2026-10-04T10:37:36' arrival_date: '2026-10-07T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: &639 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: *450 representative: *451 passengers: - &640 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: *452 car_rentals: - id: 708192a3-b4c5-4d6e-f071-829304152637 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico rental_days: 7 status: active issue_date: '2026-09-29' canceled_at: 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: &641 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: *450 representative: *451 passengers: - &642 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: *452 travel_packages: - id: 8192a3b4-c5d6-4e7f-0182-930415263748 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight status: active issue_date: '2026-09-29' canceled_at: 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: &643 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: *450 representative: *451 passengers: - &644 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: *452 others: - id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 product: &645 id: a3b2c1d0-9e8f-4756-b4a3-2c1d0e9f8a7b document: OUT123456 destination: Salvador status: active issue_date: '2026-09-29' canceled_at: 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: &646 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: *450 representative: *451 passengers: - &647 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: *452 excursions: - id: d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081 document: EXC123456 departure_date: '2026-10-04T10:37:36' arrival_date: '2026-10-04T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: &648 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: *450 representative: *451 passengers: - &649 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: *452 cvc_packages: - id: 5c4b3a29-1e0d-4982-7c6b-5a4938271605 product: &653 id: c5d4e3f2-1a0b-4978-d6c5-4e3f2a1b0c9d package_name: CVC Caribe 7 noites receipt_number: '89100000183488' departure_date: '2026-10-14T10:37:36' arrival_date: '2026-10-21T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: &654 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: *450 representative: *451 operations: - id: 6d5c4b3a-2f1e-4093-8d7c-6b5a49382716 product: &650 id: b4c3d2e1-0f9a-4867-c5b4-3d2e1f0a9b8c document: OP-000123 departure_date: '2026-10-06T10:37:36' arrival_date: '2026-10-06T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: &651 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: *450 passengers: - &652 document: OP2024060056 cost_center: Corporativa EXT canceled_at: fees: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *452 payments: agency: &666 bills: - id: 9f2c8b71-4d3e-4a56-b8c9-1e2f3a4b5c6d - id: 1a77b3c2-5e6f-4708-9a1b-2c3d4e5f6071 - id: 4b5c6d7e-8f90-41a2-b3c4-d5e6f7081920 refunds: - id: 3b41c2d5-6e7f-4809-a1b2-c3d4e5f60718 credit: - due_date: '2026-10-29' document: CRED-000123 amount: 6475.34 payer: *453 origin_sale: id: 3d4e5f60-7182-4394-83a5-c3d4e5f6a7b8 products: - amount: 6475.34 sale_product: &664 id: 3c4d5e6f-7081-492a-bc3d-4e5f60718293 retained_by_intermediary: - due_date: '2026-10-29' amount: 195.0 payer: *453 products: - amount: 625.95 sale_product: &665 id: 1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071 legacy: - due_date: '2026-08-30' amount: 300.0 check: card: brand: mastercard last_digits: '5678' authorization: ABC123 payer: *453 payment_method: id: fc9f5c65-59d6-42bb-8dd1-a5c0e3e51ea9 products: - &454 amount: 8358.77 sale_product: &658 id: 2b3c4d5e-6f70-4819-ab2c-3d4e5f607182 vendor: &667 credit_card: - due_date: '2026-10-29' card_last_digits: '1234' authorization: XYZ789 installments: 2 payer: *453 products: - *454 - amount: 2500.0 sale_product: &659 id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 - amount: 3160.0 sale_product: &660 id: 5c4b3a29-1e0d-4982-7c6b-5a4938271605 - amount: 2500.0 sale_product: &661 id: 6d5c4b3a-2f1e-4093-8d7c-6b5a49382716 check: - due_date: '2026-10-29' bank_code: '341' check_number: 654321 payer: *453 products: - &455 amount: 134.14 sale_product: &663 id: 6f708192-a3b4-4c5d-ef60-718293041526 credit: - due_date: '2026-10-29' document: CRED-000123 payer: *453 products: - *455 others: - due_date: '2026-10-29' details: Fatura payer: *453 products: - amount: 2500.0 sale_product: &662 id: 8192a3b4-c5d6-4e7f-0182-930415263748 commissions: - &670 description: 'Plano: Padrão, cálculo: 10%' amount: 700.0 retained_amount: 0.0 balance: 700.0 person: id: 0a1b2c3d-4e5f-4061-8072-90a1b2c3d4e5 - &671 description: Comissão Intermediário amount: 49.75 retained_amount: 0.0 balance: 49.75 person: id: 1b2c3d4e-5f60-4172-8183-a1b2c3d4e5f6 - &672 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: - &668 id: c8b7a695-4d3e-4f21-b0a9-8e7d6c5b4a39 standalone_bills: - &669 id: f1e2d3c4-b5a6-4978-8f6e-5d4c3b2a1e0f all_products_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: &460 external_id: a8a41bec-e2a2-4d6a-b2f9-8fbc29169e46 name: João da Silva cpf: '83115137168' payer: &461 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: &614 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: &462 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: &615 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: &463 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: &616 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: &464 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: &617 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: - &465 local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: &456 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: &622 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: &457 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: &626 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: &481 - &503 document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: &458 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: &618 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: - &466 local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: &482 - &504 amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *458 hotels: - &467 local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: &484 - &505 amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *458 airline_tickets: - &468 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: &485 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: &624 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: *457 segments: &486 - &655 airline_code: AA flight_number: '1234' class: A origin: NAS departure_date: '2026-10-04T10:37:36' destination: JFK arrival_date: '2026-10-04T10:37:36' seats: - seat_number: A27 ticket_number: '99526874895' passengers: &487 - &506 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: *458 train_tickets: - &469 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: &488 - &656 railway_operator: SNCF origin: Paris Gare de Lyon departure_date: '2026-10-04T10:37:36' destination: Nice-Ville arrival_date: '2026-10-04T16:37:36' supplier: *456 representative: *457 passengers: &489 - &507 amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *458 ground_transportations: - &470 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: &490 - &657 coach_company: Viação UTIL service_class: LE origin: Terminal Rodoviário Novo Rio departure_date: '2026-10-02T10:37:36' destination: Terminal Rodoviário de Santos arrival_date: '2026-10-02T16:37:36' seats: - seat_number: '27' ticket_number: '0001234567' supplier: *456 representative: *457 passengers: &491 - &508 amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *458 car_rentals: - &471 local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: &492 - &509 amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *458 travel_packages: - &472 local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 passengers: &493 - &510 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: *458 payments: - &473 agency: credit_card: due_date: '2026-10-29' settlement_date: '2026-09-29' card_brand: mastercard card_last_digits: '5678' authorization: ABC123 bank_account: &459 bank_code: '237' agency_number: '1234' agency_digit: '5' account_number: '56789' account_digit: '0' products: - &497 local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 payment_amount: 264.55 - &474 agency: bank_slip: due_date: '2026-10-29' settlement_date: '2026-09-29' bank_account: *459 products: - &499 local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 payment_amount: 350.0 - &475 agency: bank_deposit: due_date: '2026-10-29' settlement_date: '2026-09-29' observations: TED bank_account: *459 products: - &496 local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 payment_amount: 6475.34 - &494 local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef payment_amount: 625.95 - &476 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - &495 local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 payment_amount: 8358.77 - &477 vendor: others: details: Fatura payer: &479 person_kind: individual external_id: cce45f2c-30e3-43a6-bbf1-af340188a04c name: Márcio da Veiga products: - &500 local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 payment_amount: 2500.0 - &478 vendor: credit: products: - &498 local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 payment_amount: 134.14 closed_sale_with_commissions: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - *465 cruises: - *466 hotels: - *467 airline_tickets: - *468 train_tickets: - *469 ground_transportations: - *470 car_rentals: - *471 travel_packages: - *472 payments: - *473 - *474 - *475 - *476 - *477 - *478 status: closed commissions: - &673 external_id: a8a41bec-e2a2-4d6a-b2f9-8fbc29169e46 kind: seller value: 150.0 - &674 external_id: 8a9de5ce-dac6-4721-851b-7366bf9ff5b0 kind: intermediary value: 80.0 retained_value: 10.0 required_fields_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *479 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' destination: international currency: BRL supplier: external_id: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b name: Epic Journey Insurance passengers: - amount: 625.95 person: &480 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-10-05' arrival_date: '2026-10-19' ship_name: MXS Example Seaview currency: BRL supplier: external_id: f2e3d4c5-b6a7-4c8d-9e0f-1a2b3c4d5e6f name: Epic Journey Cruises passengers: - amount: 8358.77 person: *480 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506091' check_in: '2026-10-22' check_out: '2026-10-29' currency: BRL supplier: external_id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d name: Epic Journey Hotel passengers: - amount: 5630.73 person: *480 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-10-04T10:37:36' destination: JFK arrival_date: '2026-10-04T10:37:36' supplier: airline_code: AA name: American Airlines passengers: - amount: 1360.67 person: *480 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-10-04T10:37:36' destination: Nice-Ville arrival_date: '2026-10-04T16:37:36' supplier: external_id: 1d26857c-6eb2-47f0-814e-fc3bd27e6cb9 name: Rail Europe passengers: - amount: 240.5 person: *480 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-10-02T10:37:36' destination: Terminal Rodoviário de Santos arrival_date: '2026-10-02T16:37:36' supplier: external_id: b3c4d5e6-f7a8-4b9c-0d1e-2f3a4b5c6d7e name: Viação UTIL passengers: - amount: 121.95 person: *480 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Brasília dropoff_date: '2026-10-11' 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: *480 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *480 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 value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: *456 representative: *457 passengers: *481 - local_id: 82670c74-0180-4362-bd69-2bda5803ca74 document: '14296923' begin_date: '2026-10-04' end_date: '2026-10-19' 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: *456 representative: *457 passengers: - document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: &483 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: &621 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-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: *482 - local_id: fe9dfa42-55a2-44d9-88ad-d5deccff6336 booking_number: '987568490' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: - amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *483 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: *484 - local_id: d309a038-3d41-447b-8c00-0d9841d27d70 booking_number: '1020506092' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: - amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *483 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: *485 representative: *457 segments: *486 passengers: *487 - 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: *485 representative: *457 segments: *486 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: *483 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: *488 supplier: *456 representative: *457 passengers: *489 - 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: *488 supplier: *456 representative: *457 passengers: - amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *483 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: *490 supplier: *456 representative: *457 passengers: *491 - 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: *490 supplier: *456 representative: *457 passengers: - amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *483 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: *492 - local_id: 14515a24-c160-480e-8c83-fa24202fdb46 document: CR987654321 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: - amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *483 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 passengers: *493 - local_id: 24e6d37f-3e4e-46bf-8954-f4570ef74b35 document: TP987654321 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 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: *483 payments: - &502 vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *494 - *495 insurance_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - *465 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *494 sale_with_custom_fields: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - *465 custom_fields: - id: 12345 value: Reunião comercial operation_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 operation: local_id: 9f8e7d6c-5b4a-3210-fedc-ba9876543210 product_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 document: OP-2026-0001 departure_date: '2026-10-04' arrival_date: '2026-10-19' 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: - &675 amount: 1200.0 fees: 60.0 document: OP-000123 person: *458 operation_no_passengers_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 operation: local_id: 1a2b3c4d-5e6f-7081-9203-a4b5c6d7e8f9 product_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 document: OP-2026-0002 departure_date: '2026-10-04' arrival_date: '2026-10-19' 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 cruise_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 cruises: - *466 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *495 hotel_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 hotels: - *467 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *496 airline_ticket_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 airline_tickets: - *468 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - local_id: d4e5f6a7-b8c9-0123-4567-890123def012 payment_amount: 1804.75 train_ticket_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 train_tickets: - *469 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *497 ground_transportation_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 ground_transportations: - *470 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *498 car_rental_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 car_rentals: - *471 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *499 travel_package_only_sale: value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 travel_packages: - *472 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - *500 company_payer_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 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: &619 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: *462 approver: *463 requester: *464 insurances: - *465 cruises: - *466 hotels: - *467 airline_tickets: - *468 train_tickets: - *469 ground_transportations: - *470 car_rentals: - *471 travel_packages: - *472 payments: - *473 - *474 - *475 - *476 - *477 - *478 foreigner_payer_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 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: &620 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: *462 approver: *463 requester: *464 insurances: - *465 cruises: - *466 hotels: - *467 airline_tickets: - *468 train_tickets: - *469 ground_transportations: - *470 car_rentals: - *471 travel_packages: - *472 payments: - *473 - *474 - *475 - *476 - *477 - *478 datetime_products_sale: x-ignore-on-postman: airline_tickets,train_tickets,car_rentals,travel_packages value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04T10:37:36' end_date: '2026-10-19T10:37:36' 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: *456 representative: *457 passengers: *481 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05T10:37:36' arrival_date: '2026-10-19T10:37:36' 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: *456 representative: *457 passengers: *482 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22T10:37:36' check_out: '2026-10-29T10:37:36' 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: *456 representative: *457 passengers: *484 airline_tickets: - *468 train_tickets: - *469 ground_transportations: - *470 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04T10:37:36' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11T10:37:36' 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: *456 representative: *457 passengers: *492 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09T10:37:36' end_date: '2026-10-16T10:37:36' 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: *456 representative: *457 passengers: *493 payments: - *473 - *474 - *475 - *476 - *477 - *478 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 value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: &501 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: &623 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: *457 passengers: *481 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *501 representative: *457 passengers: *482 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *501 representative: *457 passengers: *484 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: &625 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: *457 segments: *486 passengers: *487 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: *488 supplier: *456 representative: *457 passengers: *489 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: *490 supplier: *501 representative: *457 passengers: *491 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *501 representative: *457 passengers: *492 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *501 representative: *457 passengers: *493 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef payment_amount: 3818.3 - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 payment_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 value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: *456 representative: *457 passengers: - document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: *483 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: - amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *483 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: - amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *483 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: *485 representative: *457 segments: *486 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: *483 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: *488 supplier: *456 representative: *457 passengers: - amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *483 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: *490 supplier: *456 representative: *457 passengers: - amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *483 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: - amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *483 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 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: *483 payments: - *502 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 value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: *456 representative: *457 passengers: - *503 - document: '9921508090000' amount: 625.95 fees: 31.3 rav_fee: 15.0 rav_fee_discount: 5.0 agency_fee: 10.0 person: *483 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: - *504 - amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *483 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: - *505 - amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *483 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: *485 representative: *457 segments: *486 passengers: - *506 - 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: *483 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: *488 supplier: *456 representative: *457 passengers: - *507 - amount: 240.5 fees: 24.05 rav_fee: 10.0 rav_fee_discount: 2.0 agency_fee: 5.0 document: RE9988777 person: *483 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: *490 supplier: *456 representative: *457 passengers: - *508 - amount: 121.95 fees: 12.19 rav_fee: 5.0 rav_fee_discount: 1.0 agency_fee: 3.0 document: '0001234567' person: *483 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: - *509 - amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *483 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 passengers: - *510 - 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: *483 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef payment_amount: 1251.9 - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 payment_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 value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: *456 representative: *457 passengers: - *503 - person: *483 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: - *504 - person: *483 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: - *505 - person: *483 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: *485 representative: *457 segments: *486 passengers: - *506 - ticket_number: '99526874896' original_ticket_number: '99526874895' emission_name: Kaleigh Glover person: *483 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: *488 supplier: *456 representative: *457 passengers: - *507 - person: *483 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: *490 supplier: *456 representative: *457 passengers: - *508 - person: *483 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: - *509 - person: *483 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 passengers: - *510 - person: *483 payments: - *502 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 value: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 insurances: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: *456 representative: *457 passengers: *481 cruises: - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: *482 hotels: - local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: *484 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: *485 representative: *457 segments: *486 passengers: *487 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: *488 supplier: *456 representative: *457 passengers: *489 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: *490 supplier: *456 representative: *457 passengers: *491 car_rentals: - local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: *492 travel_packages: - local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 passengers: *493 payments: - vendor: credit_card: card_last_digits: '1234' authorization: XYZ789 installments: 2 products: - local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef payment_amount: 312.98 - local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 payment_amount: 4179.39 own_operation_sale: x-ignore-on-postman: airline_tickets,train_tickets,ground_transportations,car_rentals,travel_packages value: company_identifier: '46598887000162' sale_date: '2026-09-29' operation_id: 8936058a-2906-4239-9a7f-e22ccc2c195e seller: *460 payer: *461 intermediary: *462 insurances: - *465 cruises: - *466 hotels: - *467 airline_tickets: - *468 train_tickets: - *469 ground_transportations: - *470 car_rentals: - *471 travel_packages: - *472 payments: - *473 - *474 - *475 - *476 - *477 - *478 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: 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: 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 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: 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 all_categories: summary: All categories description: Example response containing expense and revenue categories. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a description: Aluguel pass_through: false - id: c3b7e8eb-1199-4457-9170-923c3fe56c92 description: Comissões a Repassar pass_through: true - id: d4c8f9fc-22aa-4568-a281-a34d4bf67da3 description: Venda de Pacotes 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 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 pass_through: false group: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 name: Receitas Operacionais 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: setec: - id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 name: Rio de Janeiro ibge: '3304557' siafi: '6001' setec: - id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 name: São Paulo ibge: '3550308' siafi: '7107' setec: 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' setec: 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' setec: 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_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 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 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: - &511 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: - *511 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: card_operator: companies: - id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 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: [] - &512 id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Seguro viagem - fornecedor emite representative_scope: none created_at: '2023-11-02T16:45:00' payer_rule: &676 recipient: revenues: [] discounts: [] supplier_rule: &677 recipient: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 revenues: - commission_amount - over_amount discounts: [] representative_rule: &678 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: - *512 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' - &513 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: - *513 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 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 - created_at: '2024-03-15T10:30:00' text: historic: Tarefa cadastrada person: custom_fields: - id: 123 value: Alta 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, due date, category, and assignee. value: company_identifier: '46598887000162' title: Cobrar segunda parcela due: '2024-04-05T14:00:00' category_id: 11 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 "Read all tasks" permission in the task''s company: 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. all_task_categories: summary: All task categories description: Example response containing task categories. value: data: - id: 12 name: Cobrança - id: 42 name: Emissão - id: 7 name: Reserva 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 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' - &514 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: - *514 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 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. created_at: '2024-03-15T10:30:00' - &515 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: created_at: '2024-01-10T09:00: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: - *515 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. created_at: '2024-03-15T10:30:00' person: id: 212b54b8-27df-4859-80a9-79ad855bcd09 company: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 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 - &516 id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Cliente corporativo mensal person_kind: customer destination: every movement: every_movement cost_center: Comercial closing: &679 period_kind: monthly week_start: custom_period: custom_period_due_date: date_to_use: after_sale_date due_date: &680 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: - *516 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 agent and searcher integrations. value: data: - id: f9d961b8-ea88-4346-8e52-afe94267417a description: BRT Consolidadora active: true vendor_name: BRT - &517 id: a1b2c3d4-e5f6-4708-b9c0-d1e2f3a4b5c6 description: Buscador de tarifas active: false vendor_name: pagination: size: 20 has_next_page: false next_cursor: paginated_integrations: summary: Paginated integrations description: Example paginated response showing the second page of results. value: data: - *517 pagination: size: 1 has_next_page: false next_cursor: integration: summary: Active integration description: Example response for a specific integration. value: id: f9d961b8-ea88-4346-8e52-afe94267417a description: BRT Consolidadora active: true vendor_name: BRT person: company: id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 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: &519 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: &520 marital_status: married rg_emitter: SSP/PR rg_issue_date: '2008-03-15' birth_certificate: mother_name: Ana Souza last_contacts: &521 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: - &518 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: &681 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: &682 first_sale_date: last_sale_date: last_departure_date: last_return_date: last_task_update_at: tax_withholding: &683 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: - *518 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: *519 additional_data: *520 last_contacts: *521 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: - name: Cartão Corporativo last_digits: '1111' expiration_date: '2030-05-01' issuer: Visa ticket_card: kandir_law: 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 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' updated_person_reference: summary: Person updated, without read permission description: 'Update response for a credential without the "Read all people" permission: 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 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: &684 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: - &522 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: &685 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: - *522 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: [] 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: &686 brand: MasterCard last_digits: '4117' authorization: '600551159' - &523 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: - *523 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' - &524 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: - *524 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: &687 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 sale_product: &688 id: 7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92 person: &689 id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 company: &690 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 bill: &691 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: &692 id: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63 sale_product: &693 id: e4c7a1b8-6d39-4f52-8b0a-2f5e9c3d7148 person: &694 id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 company: &695 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 bill: 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' - &525 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: - *525 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: &696 name: BAIXA DE RECIBO company: &697 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 contractor: &698 id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 seller: &699 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 intermediary: sale: &700 id: 212b54b8-27df-4859-80a9-79ad855bcd09 sale_product: &701 id: 3f8a1c92-64d5-4b0e-9a77-1e5c8d2b4f63 nf: &702 id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 created_by: &703 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: &704 name: AJUSTE MANUAL company: &705 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 contractor: seller: intermediary: sale: sale_product: nf: created_by: &706 id: 1c4d8f2a-5b73-4e91-a6c8-3d90f2e5b174 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. printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: &530 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: &531 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: &532 number: '13302' batch: '8471' protocol: '202302271003410001' verification_code: K2QW71PZ processed_at: '2023-02-27T10:05:12' errors: - &526 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: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: &527 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: &528 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: &529 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: - *526 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: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: *527 taxes: *528 nfse: *529 person: &707 id: d4e7b2a9-1f83-4c56-9e0b-7a3d5f1c8b64 company: &708 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 sale_product: &709 id: 7b1e9d43-2c85-4a06-9f37-4e8d1c6a5b92 sale: &710 id: 9f3c4f0e-6a3f-4c0e-8f4a-2c9b1d5e7a10 created_by: &711 id: 3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15 canceled_by: items: - &712 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. printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: *530 taxes: *531 nfse: *532 person: company: &713 id: e5d9aaed-33bb-4679-b392-b45e5cd78eb4 sale_product: sale: created_by: &714 id: 3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15 canceled_by: &715 id: 3c9d1f27-58ab-42e0-9b6d-0f7a4c2e8d15 items: - &716 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 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' - &533 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: - *533 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: &717 id: b2a6d7da-ff94-40e3-b069-812b2fd45b91 resource: &718 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: &719 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 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: *1 commission_percentage: *2 commission_amount: *3 over_percentage: *4 over_value: *5 du_percentage: *6 rav_percentage: *7 representation_schema: type: object description: Representative linked to a supply, with its own commercial terms. properties: *534 supply_schema: type: object description: Product supply, with the supplier and the commercial terms negotiated with it. properties: *535 insurance_scalars: document: *8 begin_date: *9 end_date: *10 destination: *11 status: *12 issue_date: *13 canceled_at: *14 observations: *15 included_services: *16 vendor_reservation_url: *17 currency: *18 exchange_rate: *19 commission_amount: *20 commission_percentage: *21 over_amount: *22 over_percentage: *23 over: *24 intermediary_commission_amount: *25 intermediary_commission_percentage: *26 intermediary_over_amount: *27 intermediary_over_percentage: *28 intermediary_over: *29 agency_service_fee: *30 agency_card_rate: *31 deductions: *32 discount_amount: *33 cc_rav_fee: *34 cruise_scalars: booking_number: *35 departure_date: *36 arrival_date: *37 ship_name: *38 cruise_destination: *39 accommodation_kind: *40 cabin_number: *41 cabin_kind: *42 cabin_category: *43 meal_plan: *44 status: *45 issue_date: *46 canceled_at: *47 observations: *48 included_services: *49 vendor_reservation_url: *50 currency: *51 exchange_rate: *52 commission_amount: *53 commission_percentage: *54 over_amount: *55 over_percentage: *56 over: *57 intermediary_commission_amount: *58 intermediary_commission_percentage: *59 intermediary_over_amount: *60 intermediary_over_percentage: *61 intermediary_over: *62 agency_service_fee: *63 agency_card_rate: *64 deductions: *65 discount_amount: *66 cc_rav_fee: *67 hotel_scalars: booking_number: *68 check_in: *69 check_out: *70 destination: *71 accommodation_kind: *72 room_category: *73 meal_plan: *74 nights: *75 status: *76 issue_date: *77 canceled_at: *78 observations: *79 included_services: *80 vendor_reservation_url: *81 currency: *82 exchange_rate: *83 commission_amount: *84 commission_percentage: *85 over_amount: *86 over_percentage: *87 over: *88 intermediary_commission_amount: *89 intermediary_commission_percentage: *90 intermediary_over_amount: *91 intermediary_over_percentage: *92 intermediary_over: *93 agency_service_fee: *94 agency_card_rate: *95 deductions: *96 discount_amount: *97 cc_rav_fee: *98 airline_ticket_scalars: locator: *99 destination: *100 status: *101 issue_date: *102 canceled_at: *103 observations: *104 included_services: *105 vendor_reservation_url: *106 currency: *107 exchange_rate: *108 commission_amount: *109 commission_percentage: *110 over_amount: *111 over_percentage: *112 over: *113 intermediary_commission_amount: *114 intermediary_commission_percentage: *115 intermediary_over_amount: *116 intermediary_over_percentage: *117 intermediary_over: *118 agency_service_fee: *119 agency_card_rate: *120 deductions: *121 discount_amount: *122 cc_rav_fee: *123 cc_du_fee: *124 train_ticket_scalars: document: *125 departure_date: *126 arrival_date: *127 status: *128 issue_date: *129 canceled_at: *130 observations: *131 included_services: *132 vendor_reservation_url: *133 currency: *134 exchange_rate: *135 commission_amount: *136 commission_percentage: *137 over_amount: *138 over_percentage: *139 over: *140 intermediary_commission_amount: *141 intermediary_commission_percentage: *142 intermediary_over_amount: *143 intermediary_over_percentage: *144 intermediary_over: *145 agency_service_fee: *146 agency_card_rate: *147 deductions: *148 discount_amount: *149 cc_rav_fee: *150 ground_transportation_scalars: document: *151 departure_date: *152 arrival_date: *153 status: *154 issue_date: *155 canceled_at: *156 observations: *157 included_services: *158 vendor_reservation_url: *159 currency: *160 exchange_rate: *161 commission_amount: *162 commission_percentage: *163 over_amount: *164 over_percentage: *165 over: *166 intermediary_commission_amount: *167 intermediary_commission_percentage: *168 intermediary_over_amount: *169 intermediary_over_percentage: *170 intermediary_over: *171 agency_service_fee: *172 agency_card_rate: *173 deductions: *174 discount_amount: *175 cc_rav_fee: *176 car_rental_scalars: document: *177 pickup_date: *178 pickup_location: *179 dropoff_date: *180 dropoff_location: *181 destination: *182 vehicle_category: *183 rental_days: *184 status: *185 issue_date: *186 canceled_at: *187 observations: *188 included_services: *189 vendor_reservation_url: *190 currency: *191 exchange_rate: *192 commission_amount: *193 commission_percentage: *194 over_amount: *195 over_percentage: *196 over: *197 intermediary_commission_amount: *198 intermediary_commission_percentage: *199 intermediary_over_amount: *200 intermediary_over_percentage: *201 intermediary_over: *202 agency_service_fee: *203 agency_card_rate: *204 deductions: *205 discount_amount: *206 cc_rav_fee: *207 travel_package_scalars: document: *208 begin_date: *209 end_date: *210 destination: *211 package_name: *212 transport: *213 status: *214 issue_date: *215 canceled_at: *216 observations: *217 included_services: *218 vendor_reservation_url: *219 currency: *220 exchange_rate: *221 commission_amount: *222 commission_percentage: *223 over_amount: *224 over_percentage: *225 over: *226 intermediary_commission_amount: *227 intermediary_commission_percentage: *228 intermediary_over_amount: *229 intermediary_over_percentage: *230 intermediary_over: *231 agency_service_fee: *232 agency_card_rate: *233 deductions: *234 discount_amount: *235 cc_rav_fee: *236 others_scalars: document: *237 destination: *238 departure_date: *239 arrival_date: *240 status: *241 issue_date: *242 canceled_at: *243 observations: *244 included_services: *245 vendor_reservation_url: *246 currency: *247 exchange_rate: *248 commission_amount: *249 commission_percentage: *250 over_amount: *251 over_percentage: *252 over: *253 intermediary_commission_amount: *254 intermediary_commission_percentage: *255 intermediary_over_amount: *256 intermediary_over_percentage: *257 intermediary_over: *258 agency_service_fee: *259 agency_card_rate: *260 deductions: *261 discount_amount: *262 cc_rav_fee: *263 quantity: *264 unit_price: *265 unit_fee: *266 operation_scalars: document: *536 departure_date: *537 arrival_date: *538 status: *539 issue_date: *540 canceled_at: *541 observations: *542 included_services: *543 vendor_reservation_url: *544 currency: *545 exchange_rate: *546 intermediary_commission_amount: *547 intermediary_commission_percentage: *548 intermediary_over_amount: *549 intermediary_over_percentage: *550 intermediary_over: *551 agency_service_fee: *552 agency_card_rate: *553 discount_amount: *554 quantity: *555 unit_price: *556 unit_fee: *557 cvc_package_scalars: package_name: *267 receipt_number: *268 departure_date: *269 arrival_date: *270 status: *271 issue_date: *272 canceled_at: *273 observations: *274 included_services: *275 vendor_reservation_url: *276 currency: *277 exchange_rate: *278 commission_amount: *279 commission_percentage: *280 over_amount: *281 over_percentage: *282 over: *283 intermediary_commission_amount: *284 intermediary_commission_percentage: *285 intermediary_over_amount: *286 intermediary_over_percentage: *287 intermediary_over: *288 agency_service_fee: *289 agency_card_rate: *290 deductions: *291 discount_amount: *292 cc_rav_fee: *293 quantity: *294 unit_price: *295 unit_fee: *296 agency_credit_card_scalars: due_date: *558 settlement_date: *559 description: *560 card_last_digits: *561 card_brand: *562 authorization: *563 agency_bank_slip_scalars: due_date: *564 settlement_date: *565 description: *566 bank_slip_number: *567 amount: *568 agency_bank_deposit_scalars: due_date: *569 settlement_date: *570 description: *571 observations: *572 amount: *573 passenger_scalars: cost_center: *298 canceled_at: *299 fees: *300 rav_fee: *301 rav_fee_discount: *302 agency_fee: *303 amount: *304 customer_amount: *305 total_amount: *306 insurance_passenger_scalars: document: *297 cost_center: *298 canceled_at: *299 fees: *300 rav_fee: *301 rav_fee_discount: *302 agency_fee: *303 amount: *304 customer_amount: *305 total_amount: *306 train_passenger_scalars: document: *308 cost_center: *309 canceled_at: *310 fees: *311 rav_fee: *312 rav_fee_discount: *313 agency_fee: *314 amount: *315 customer_amount: *316 total_amount: *317 ground_transportation_passenger_scalars: document: *319 cost_center: *320 canceled_at: *321 fees: *322 rav_fee: *323 rav_fee_discount: *324 agency_fee: *325 amount: *326 customer_amount: *327 total_amount: *328 cruise_passenger_scalars: cost_center: *329 canceled_at: *330 fees: *331 tip: *332 rav_fee: *333 rav_fee_discount: *334 agency_fee: *335 amount: *336 customer_amount: *337 total_amount: *338 default_passenger_scalars: cost_center: *339 canceled_at: *340 fees: *341 other_fees: *342 rav_fee: *343 rav_fee_discount: *344 agency_fee: *345 amount: *346 customer_amount: *347 total_amount: *348 default_passenger_read_scalars: document: *574 cost_center: *298 canceled_at: *299 fees: *300 rav_fee: *301 rav_fee_discount: *302 agency_fee: *303 amount: *304 customer_amount: *305 total_amount: *306 operation_passenger_scalars: document: *349 cost_center: *350 canceled_at: *351 fees: *352 amount: *353 customer_amount: *354 total_amount: *355 travel_package_passenger_scalars: document: *356 cost_center: *339 canceled_at: *340 fees: *341 other_fees: *342 rav_fee: *343 rav_fee_discount: *344 agency_fee: *345 amount: *346 customer_amount: *347 total_amount: *348 hotel_passenger_scalars: emission_name: *357 cost_center: *358 canceled_at: *359 fees: *360 other_fees: *361 rav_fee: *362 rav_fee_discount: *363 agency_fee: *364 amount: *365 customer_amount: *366 total_amount: *367 airline_ticket_passenger_scalars: ticket_number: *368 original_ticket_number: *369 emission_name: *370 seat: *371 cost_center: *372 canceled_at: *373 boarding_fee: *374 other_fees: *375 rav_fee: *376 rav_fee_discount: *377 du_fee: *378 du_fee_discount: *379 agency_fee: *380 amount: *381 customer_amount: *382 total_amount: *383 passenger_person_create: person: *307 passenger_person_read: person: *318 id: 322ff2c2-43e0-4376-bea5-20f88b673b6d emission_rule_schema: type: object properties: *384 required: - recipient - revenues - discounts nf_rule_scalar_properties: id: *385 description: *386 representative_scope: *387 created_at: *388 nf_rule_reference_properties: product: *575 supplier: *576 representative: *577 payer: *578 created_by: *579 nf_rule_emission_properties: payer_rule: *389 supplier_rule: *390 representative_rule: *391 refund_scalar_properties: id: *392 refund_type: *393 amount: *394 description: *395 issue_date: *396 due_date: *397 cvc_statement_scalar_properties: id: *398 receipt_number: *399 movement_date: *400 sale_date: *401 cancellation_date: *402 boarding_date: *403 return_date: *404 product_name: *405 package_name: *406 total_payments: *407 total_taxes: *408 total_discounts: *409 total_abatement: *410 calculated_commission: *411 retained_commission: *412 intermediary_commission: *413 deposit: *414 opfax: *415 opfax_balance: *416 balance: *417 imported: *418 edited: *419 checked: *420 deleted: *421 created_at: *422 nf_recipient_properties: kind: *580 name: *581 cpf_cnpj: *582 state_inscription: *583 city_inscription: *584 postal_code: *585 street: *586 street_number: *587 neighborhood: *588 additional_info: *589 phone: *590 email: *591 foreign: *592 foreign_document: *593 city: *594 nf_taxes_properties: retain_iss: *595 retain_ir: *596 retain_pis_cofins_csll: *597 iss_percentage: *598 iss_amount: *599 pis_percentage: *600 pis_amount: *601 cofins_percentage: *602 cofins_amount: *603 ir_percentage: *604 ir_amount: *605 csll_percentage: *606 csll_amount: *607 nf_nfse_properties: number: *608 batch: *609 protocol: *610 verification_code: *611 processed_at: *612 errors: *613 nf_scalar_properties: id: *423 number: *424 series: *425 issue_date: *426 status: *427 operation_nature: *428 cfop: *429 nbs_code: *430 document: *431 manual_emission: *432 amount: *433 service_amount: *434 net_amount: *435 approximate_taxes_percentage: *436 approximate_taxes_amount: *437 observations: *438 printed_at: *439 canceled_at: *440 created_at: *441 recipient: *442 taxes: *443 nfse: *444 log_scalar_properties: id: *445 kind: *446 origin: *447 description: *448 created_at: *449 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: *614 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: *615 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: *616 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: *617 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: *618 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: *619 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: *620 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: *621 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: *622 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: *623 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: *624 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: *625 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: *626 required_fields_insurance_passenger: amount: 625.95 person: *480 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: *452 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: *483 required_fields_cruise_passenger: amount: 8358.77 person: *480 cruise_passenger: 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: *452 foreign_cruise_passenger: 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: *483 hotel_passenger: 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: *452 foreign_hotel_passenger: 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: *483 airline_passenger: ticket_number: '99526874895' emission_name: Maria da Silva seat: 12A 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: *452 foreign_airline_passenger: ticket_number: '99526874896' emission_name: Kaleigh Glover seat: 12A 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: *483 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: *452 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: *483 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: *452 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: *483 required_fields_car_rental_passenger: amount: 350.0 person: *480 car_rental_passenger: 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: *452 foreign_car_rental_passenger: 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: *483 required_fields_travel_package_passenger: amount: 2500.0 person: *480 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: *452 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: *483 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: *452 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: *452 operation_passenger: document: OP2024060056 cost_center: Corporativa EXT canceled_at: fees: 0 amount: 2500.0 customer_amount: 2500.0 total_amount: 2500.0 person: *452 insurance_product: id: 1a2b3c4d-5e6f-4708-9a1b-2c3d4e5f6071 document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' destination: international status: active issue_date: '2026-09-29' canceled_at: 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: *627 supplier: *450 representative: *451 passengers: - *628 cruise_product: id: 2b3c4d5e-6f70-4819-ab2c-3d4e5f607182 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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-09-29' canceled_at: 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: *629 supplier: *450 representative: *451 passengers: - *630 hotel_product: id: 3c4d5e6f-7081-492a-bc3d-4e5f60718293 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' destination: international accommodation_kind: Duplo Casal room_category: Deluxe meal_plan: All Inclusive nights: 8 status: active issue_date: '2026-09-29' canceled_at: 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: *631 supplier: *450 representative: *451 passengers: - *632 airline_product: id: 4d5e6f70-8192-4a3b-cd4e-5f6071829304 locator: WABCJJ destination: international status: active issue_date: '2026-09-29' canceled_at: 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: *633 supplier: *634 representative: *451 segments: - *635 passengers: - *636 train_product: id: 5e6f7081-92a3-4b4c-de5f-607182930415 document: RE9988777 departure_date: '2026-10-04T10:37:36' arrival_date: '2026-10-07T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: *637 supplier: *450 representative: *451 passengers: - *638 ground_transportation_product: id: 6f708192-a3b4-4c5d-ef60-718293041526 document: GT123456 departure_date: '2026-10-04T10:37:36' arrival_date: '2026-10-07T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: *639 supplier: *450 representative: *451 passengers: - *640 car_rental_product: id: 708192a3-b4c5-4d6e-f071-829304152637 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' dropoff_location: Aeroporto de Congonhas destination: national vehicle_category: Econômico rental_days: 7 status: active issue_date: '2026-09-29' canceled_at: 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: *641 supplier: *450 representative: *451 passengers: - *642 travel_package_product: id: 8192a3b4-c5d6-4e7f-0182-930415263748 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' destination: international package_name: Pacote Europa Clássica transport: scheduled_flight status: active issue_date: '2026-09-29' canceled_at: 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: *643 supplier: *450 representative: *451 passengers: - *644 others_product: id: 8f7e6d5c-4b3a-4218-9f0e-1d2c3b4a5968 product: *645 document: OUT123456 destination: Salvador status: active issue_date: '2026-09-29' canceled_at: 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: *646 supplier: *450 representative: *451 passengers: - *647 excursion_product: id: d0e1f2a3-b4c5-4906-a1b2-3c4d5e6f7081 document: EXC123456 departure_date: '2026-10-04T10:37:36' arrival_date: '2026-10-04T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: *648 supplier: *450 representative: *451 passengers: - *649 operation_product: id: 6d5c4b3a-2f1e-4093-8d7c-6b5a49382716 product: *650 document: OP-000123 departure_date: '2026-10-06T10:37:36' arrival_date: '2026-10-06T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: *651 supplier: *450 passengers: - *652 cvc_package_product: id: 5c4b3a29-1e0d-4982-7c6b-5a4938271605 product: *653 package_name: CVC Caribe 7 noites receipt_number: '89100000183488' departure_date: '2026-10-14T10:37:36' arrival_date: '2026-10-21T10:37:36' status: active issue_date: '2026-09-29' canceled_at: 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: *654 supplier: *450 representative: *451 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: *458 cruise_passenger_create: amount: 8358.77 fees: 209.0 tip: 50.0 rav_fee: 40.0 rav_fee_discount: 10.0 agency_fee: 20.0 person: *458 hotel_passenger_create: amount: 5630.73 fees: 281.54 other_fees: 30.0 rav_fee: 60.0 rav_fee_discount: 15.0 agency_fee: 563.07 person: *458 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: *458 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: *458 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: *458 car_rental_passenger_create: amount: 350.0 fees: 17.5 other_fees: 8.0 rav_fee: 7.0 rav_fee_discount: 2.0 agency_fee: 5.0 person: *458 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: *458 insurance_product_create: local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef document: '14296922' begin_date: '2026-10-04' end_date: '2026-10-19' 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: *456 representative: *457 passengers: - *503 cruise_product_create: local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 booking_number: '987568489' departure_date: '2026-10-05' arrival_date: '2026-10-19' 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: *456 representative: *457 passengers: - *504 hotel_product_create: local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 booking_number: '1020506090' check_in: '2026-10-22' check_out: '2026-10-29' 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: *456 representative: *457 passengers: - *505 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: *485 representative: *457 segments: - *655 passengers: - *506 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: - *656 supplier: *456 representative: *457 passengers: - *507 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: - *657 supplier: *456 representative: *457 passengers: - *508 car_rental_product_create: local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 document: CR123456789 pickup_date: '2026-10-04' pickup_location: Aeroporto de Congonhas dropoff_date: '2026-10-11' 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: *456 representative: *457 passengers: - *509 travel_package_product_create: local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 document: TP123456789 begin_date: '2026-10-09' end_date: '2026-10-16' 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: *456 representative: *457 passengers: - *510 insurance_payment: local_id: a1b2c3d4-e5f6-7890-1234-567890abcdef payment_amount: 625.95 cruise_payment: local_id: b2c3d4e5-f6a7-8901-2345-678901bcdef0 payment_amount: 8358.77 hotel_payment: local_id: c3d4e5f6-a7b8-9012-3456-789012cdef01 payment_amount: 6475.34 airline_ticket_payment: local_id: d4e5f6a7-b8c9-0123-4567-890123def012 payment_amount: 1804.75 train_ticket_payment: local_id: e5f6a7b8-c9d0-1234-5678-901234ef0123 payment_amount: 264.55 ground_transportation_payment: local_id: f6a7b8c9-d0e1-2345-6789-012345f01234 payment_amount: 134.14 car_rental_payment: local_id: a7b8c9d0-e1f2-3456-7890-123456a01234 payment_amount: 350.0 travel_package_payment: local_id: b8c9d0e1-f2a3-4567-8901-234567a01234 payment_amount: 2500.0 others_payment: local_id: c9d0e1f2-a3b4-5678-9012-345678b01234 payment_amount: 2500.0 cvc_package_payment: local_id: e1f2a3b4-c5d6-7890-1234-567890d01234 payment_amount: 3160.0 operation_payment: local_id: 9f8e7d6c-5b4a-3210-fedc-ba9876543210 payment_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-10-29' settlement_date: '2026-09-29' card_brand: mastercard card_last_digits: '5678' authorization: ABC123 bank_account: *459 agency_bank_slip_payment: due_date: '2026-10-29' settlement_date: '2026-09-29' bank_account: *459 agency_bank_deposit_payment: due_date: '2026-10-29' settlement_date: '2026-09-29' observations: TED bank_account: *459 vendor_others_payment: details: Fatura vendor_minimal_payment: - *502 all_payment_methods: - *473 - *474 - *475 - *476 - *477 - *478 cruise_payment_read: amount: 8358.77 sale_product: *658 others_payment_read: amount: 2500.0 sale_product: *659 cvc_package_payment_read: amount: 3160.0 sale_product: *660 operation_payment_read: amount: 2500.0 sale_product: *661 travel_package_payment_read: amount: 2500.0 sale_product: *662 ground_transportation_payment_read: amount: 134.14 sale_product: *663 hotel_payment_read: amount: 6475.34 sale_product: *664 insurance_payment_read: amount: 625.95 sale_product: *665 all_payment_methods_read: agency: *666 vendor: *667 sale_fields_create: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 insurances: - *465 cruises: - *466 hotels: - *467 airline_tickets: - *468 train_tickets: - *469 ground_transportations: - *470 car_rentals: - *471 travel_packages: - *472 payments: - *473 - *474 - *475 - *476 - *477 - *478 sale_without_product: company_identifier: '46598887000162' sale_date: '2026-09-29' seller: *460 payer: *461 intermediary: *462 approver: *463 requester: *464 sale_financial: observations: Teste de observações financeiras vendor_bills: - *668 standalone_bills: - *669 sale_commissions: - *670 - *671 - *672 sale_commissions_create: - *673 - *674 sales_standard_pagination: size: 20 has_next_page: false next_cursor: operation_passenger_create: amount: 1200.0 fees: 60.0 document: OP-000123 person: *458 operation_product_create: local_id: 9f8e7d6c-5b4a-3210-fedc-ba9876543210 product_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 document: OP-2026-0001 departure_date: '2026-10-04' arrival_date: '2026-10-19' 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: - *675 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-10-04' arrival_date: '2026-10-19' 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 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: 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_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: *676 supplier_rule: *677 representative_rule: *678 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: created_at: '2024-01-10T09:00: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: *679 due_date: *680 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: Buscador de tarifas active: false vendor_name: 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: *519 additional_data: *520 last_contacts: *521 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: *681 additional_data: last_contacts: *682 tax_withholding: *683 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: *684 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: *685 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: *686 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: *687 sale_product: *688 person: *689 company: *690 bill: *691 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: *692 sale_product: *693 person: *694 company: *695 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: *696 company: *697 contractor: *698 seller: *699 intermediary: sale: *700 sale_product: *701 nf: *702 created_by: *703 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: *704 company: *705 contractor: seller: intermediary: sale: sale_product: nf: created_by: *706 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: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: *527 taxes: *528 nfse: *529 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. printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: *530 taxes: *531 nfse: *532 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: printed_at: '2023-02-09T17:26:29' canceled_at: created_at: '2023-02-09T17:16:14' recipient: *527 taxes: *528 nfse: *529 person: *707 company: *708 sale_product: *709 sale: *710 created_by: *711 canceled_by: items: - *712 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. printed_at: canceled_at: '2023-03-02T09:14:52' created_at: '2023-02-27T10:03:41' recipient: *530 taxes: *531 nfse: *532 person: company: *713 sale_product: sale: created_by: *714 canceled_by: *715 items: - *716 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: *717 resource: *718 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: *719 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: [] 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

' contact: name: Questions and support email: suporte@monde.com.br servers: - url: https://web.monde.com.br/api/v3